0027207: New universal method for extracting of results of work of HLRBRep_Algo algorithm
[occt.git] / src / HLRBRep / HLRBRep_HLRToShape.hxx
1 // Created on: 1993-10-11
2 // Created by: Christophe MARION
3 // Copyright (c) 1993-1999 Matra Datavision
4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
5 //
6 // This file is part of Open CASCADE Technology software library.
7 //
8 // This library is free software; you can redistribute it and/or modify it under
9 // the terms of the GNU Lesser General Public License version 2.1 as published
10 // by the Free Software Foundation, with special exception defined in the file
11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
12 // distribution for complete text of the license and disclaimer of any warranty.
13 //
14 // Alternatively, this file may be used under the terms of Open CASCADE
15 // commercial license or contractual agreement.
16
17 #ifndef _HLRBRep_HLRToShape_HeaderFile
18 #define _HLRBRep_HLRToShape_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_DefineAlloc.hxx>
22 #include <Standard_Handle.hxx>
23
24 #include <TopoDS_Shape.hxx>
25 #include <Standard_Integer.hxx>
26 #include <Standard_Boolean.hxx>
27 #include <HLRBRep_TypeOfResultingEdge.hxx>
28 class HLRBRep_Algo;
29 class TopoDS_Shape;
30 class HLRBRep_Data;
31 class HLRBRep_EdgeData;
32
33
34 //! A framework for filtering the computation
35 //! results of an HLRBRep_Algo algorithm by extraction.
36 //! From the results calculated by the algorithm on
37 //! a shape, a filter returns the type of edge you
38 //! want to identify. You can choose any of the following types of output:
39 //! -   visible sharp edges
40 //! -   hidden sharp edges
41 //! -   visible smooth edges
42 //! -   hidden smooth edges
43 //! -   visible sewn edges
44 //! -   hidden sewn edges
45 //! -   visible outline edges
46 //! -   hidden outline edges.
47 //! -   visible isoparameters and
48 //! -   hidden isoparameters.
49 //! Sharp edges present a C0 continuity (non G1).
50 //! Smooth edges present a G1 continuity (non G2).
51 //! Sewn edges present a C2 continuity.
52 //! The result is composed of 2D edges in the
53 //! projection plane of the view which the
54 //! algorithm has worked with. These 2D edges
55 //! are not included in the data structure of the visualized shape.
56 //! In order to obtain a complete image, you must
57 //! combine the shapes given by each of the chosen filters.
58 //! The construction of the shape does not call a
59 //! new computation of the algorithm, but only
60 //! reads its internal results.
61 //! The methods of this shape are almost identic to those of the HLRBrep_PolyHLRToShape class.
62 class HLRBRep_HLRToShape 
63 {
64 public:
65
66   DEFINE_STANDARD_ALLOC
67
68   
69   //! Constructs a framework for filtering the
70   //! results of the HLRBRep_Algo algorithm, A.
71   //! Use the extraction filters to obtain the results you want for A.
72   Standard_EXPORT HLRBRep_HLRToShape(const Handle(HLRBRep_Algo)& A);
73   
74     TopoDS_Shape VCompound();
75   
76     TopoDS_Shape VCompound (const TopoDS_Shape& S);
77   
78     TopoDS_Shape Rg1LineVCompound();
79   
80     TopoDS_Shape Rg1LineVCompound (const TopoDS_Shape& S);
81   
82     TopoDS_Shape RgNLineVCompound();
83   
84     TopoDS_Shape RgNLineVCompound (const TopoDS_Shape& S);
85   
86     TopoDS_Shape OutLineVCompound();
87   
88     TopoDS_Shape OutLineVCompound3d();
89   
90     TopoDS_Shape OutLineVCompound (const TopoDS_Shape& S);
91   
92     TopoDS_Shape IsoLineVCompound();
93   
94     TopoDS_Shape IsoLineVCompound (const TopoDS_Shape& S);
95   
96     TopoDS_Shape HCompound();
97   
98     TopoDS_Shape HCompound (const TopoDS_Shape& S);
99   
100     TopoDS_Shape Rg1LineHCompound();
101   
102     TopoDS_Shape Rg1LineHCompound (const TopoDS_Shape& S);
103   
104     TopoDS_Shape RgNLineHCompound();
105   
106     TopoDS_Shape RgNLineHCompound (const TopoDS_Shape& S);
107   
108     TopoDS_Shape OutLineHCompound();
109   
110     TopoDS_Shape OutLineHCompound (const TopoDS_Shape& S);
111   
112     TopoDS_Shape IsoLineHCompound();
113   
114     TopoDS_Shape IsoLineHCompound (const TopoDS_Shape& S);
115   
116     //! Returns compound of resulting edges
117     //! of required type and visibility,
118     //! taking into account the kind of space
119     //! (2d or 3d)
120     TopoDS_Shape CompoundOfEdges(const HLRBRep_TypeOfResultingEdge type,
121                                  const Standard_Boolean            visible,
122                                  const Standard_Boolean            In3d);
123
124     //! For specified shape 
125     //! returns compound of resulting edges
126     //! of required type and visibility,
127     //! taking into account the kind of space
128     //! (2d or 3d)
129     TopoDS_Shape CompoundOfEdges(const TopoDS_Shape& S,
130                                  const HLRBRep_TypeOfResultingEdge type,
131                                  const Standard_Boolean            visible,
132                                  const Standard_Boolean            In3d);
133
134
135
136 protected:
137
138
139
140
141
142 private:
143
144   
145   Standard_EXPORT TopoDS_Shape InternalCompound (const Standard_Integer typ, const Standard_Boolean visible, const TopoDS_Shape& S, const Standard_Boolean In3d = Standard_False);
146   
147   Standard_EXPORT void DrawFace (const Standard_Boolean visible, const Standard_Integer typ, const Standard_Integer iface, Handle(HLRBRep_Data)& DS, TopoDS_Shape& Result, Standard_Boolean& added, const Standard_Boolean In3d = Standard_False) const;
148   
149   Standard_EXPORT void DrawEdge (const Standard_Boolean visible, const Standard_Boolean inFace, const Standard_Integer typ, HLRBRep_EdgeData& ed, TopoDS_Shape& Result, Standard_Boolean& added, const Standard_Boolean In3d = Standard_False) const;
150
151
152   Handle(HLRBRep_Algo) myAlgo;
153
154
155 };
156
157
158 #include <HLRBRep_HLRToShape.lxx>
159
160
161
162
163
164 #endif // _HLRBRep_HLRToShape_HeaderFile