0031939: Coding - correction of spelling errors in comments [part 4]
[occt.git] / src / HLRBRep / HLRBRep_Data.hxx
1 // Created on: 1993-01-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_Data_HeaderFile
18 #define _HLRBRep_Data_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_Type.hxx>
22
23 #include <Standard_Integer.hxx>
24 #include <TopTools_IndexedMapOfShape.hxx>
25 #include <HLRBRep_Array1OfEData.hxx>
26 #include <HLRBRep_Array1OfFData.hxx>
27 #include <TColStd_Array1OfInteger.hxx>
28 #include <Standard_ShortReal.hxx>
29 #include <HLRAlgo_Projector.hxx>
30 #include <HLRBRep_CLProps.hxx>
31 #include <HLRBRep_SLProps.hxx>
32 #include <Standard_Real.hxx>
33 #include <HLRBRep_FaceIterator.hxx>
34 #include <Standard_Address.hxx>
35 #include <GeomAbs_SurfaceType.hxx>
36 #include <Standard_Boolean.hxx>
37 #include <GeomAbs_CurveType.hxx>
38 #include <TopAbs_Orientation.hxx>
39 #include <HLRBRep_Intersector.hxx>
40 #include <HLRAlgo_Interference.hxx>
41 #include <Standard_Transient.hxx>
42 #include <BRepTopAdaptor_MapOfShapeTool.hxx>
43 #include <TopAbs_State.hxx>
44 #include <HLRAlgo_InterferenceList.hxx>
45 class BRepTopAdaptor_TopolTool;
46 class StdFail_UndefinedDerivative;
47 class HLRAlgo_Projector;
48 class HLRAlgo_Interference;
49 class gp_Dir2d;
50 class HLRBRep_EdgeData;
51 class HLRBRep_FaceData;
52 class IntRes2d_IntersectionPoint;
53 class TableauRejection;
54
55 class HLRBRep_Data;
56 DEFINE_STANDARD_HANDLE(HLRBRep_Data, Standard_Transient)
57
58 class HLRBRep_Data : public Standard_Transient
59 {
60
61 public:
62
63   
64   //! Create an  empty data structure  of <NV> vertices,
65   //! <NE> edges and <NF> faces.
66   Standard_EXPORT HLRBRep_Data(const Standard_Integer NV, const Standard_Integer NE, const Standard_Integer NF);
67   
68   //! Write <DS>    in   me  with   a     translation of
69   //! <dv>,<de>,<df>.
70   Standard_EXPORT void Write (const Handle(HLRBRep_Data)& DS, const Standard_Integer dv, const Standard_Integer de, const Standard_Integer df);
71   
72     HLRBRep_Array1OfEData& EDataArray();
73   
74     HLRBRep_Array1OfFData& FDataArray();
75   
76   //! Set the  tolerance for the  rejections  during the
77   //! exploration
78     void Tolerance (const Standard_ShortReal tol);
79   
80   //! returns  the tolerance for the  rejections  during
81   //! the exploration
82     Standard_ShortReal Tolerance() const;
83   
84   //! end of building  of the Data and updating
85   //! all the information linked to the projection.
86   Standard_EXPORT void Update (const HLRAlgo_Projector& P);
87   
88     HLRAlgo_Projector& Projector();
89   
90     Standard_Integer NbVertices() const;
91   
92     Standard_Integer NbEdges() const;
93   
94     Standard_Integer NbFaces() const;
95   
96     TopTools_IndexedMapOfShape& EdgeMap();
97   
98     TopTools_IndexedMapOfShape& FaceMap();
99   
100   //! to compare with only non rejected edges.
101   Standard_EXPORT void InitBoundSort (const HLRAlgo_EdgesBlock::MinMaxIndices& MinMaxTot, const Standard_Integer e1, const Standard_Integer e2);
102   
103   //! Begin an iteration only  on visible Edges
104   //! crossing the face number <FI>.
105   Standard_EXPORT void InitEdge (const Standard_Integer FI, BRepTopAdaptor_MapOfShapeTool& MST);
106   
107   Standard_EXPORT Standard_Boolean MoreEdge();
108   
109   Standard_EXPORT void NextEdge (const Standard_Boolean skip = Standard_True);
110   
111   //! Returns the  current Edge
112   Standard_EXPORT Standard_Integer Edge() const;
113   
114   //! Returns true if   the  current edge to   be hidden
115   //! belongs to the hiding face.
116     Standard_Boolean HidingTheFace() const;
117   
118   //! Returns true if the current hiding face is not  an
119   //! auto-intersected one.
120     Standard_Boolean SimpleHidingFace() const;
121   
122   //! Intersect  the current  Edge  with the boundary of
123   //! the hiding  face.   The interferences are given by
124   //! the More, Next, and Value methods.
125   Standard_EXPORT void InitInterference();
126   
127     Standard_Boolean MoreInterference() const;
128   
129   Standard_EXPORT void NextInterference();
130   
131   //! Returns  True if the  interference is rejected.
132   Standard_EXPORT Standard_Boolean RejectedInterference();
133   
134   //! Returns True if the rejected interference is above
135   //! the face.
136   Standard_EXPORT Standard_Boolean AboveInterference();
137   
138     HLRAlgo_Interference& Interference();
139   
140   //! Returns the local description of the projection of
141   //! the current LEdge  at parameter  <Param>.
142   Standard_EXPORT void LocalLEGeometry2D (const Standard_Real Param, gp_Dir2d& Tg, gp_Dir2d& Nm, Standard_Real& Cu);
143   
144   //! Returns the local description of the projection of
145   //! the current FEdge  at parameter  <Param>.
146   Standard_EXPORT void LocalFEGeometry2D (const Standard_Integer FE, const Standard_Real Param, gp_Dir2d& Tg, gp_Dir2d& Nm, Standard_Real& Cu);
147   
148   //! Returns the local  3D   state of the  intersection
149   //! between the current edge and the current face at the
150   //! <p1> and <p2> parameters.
151   Standard_EXPORT void EdgeState (const Standard_Real p1, const Standard_Real p2, TopAbs_State& stbef, TopAbs_State& staf);
152   
153   //! Returns the  true if the  Edge <ED> belongs to the
154   //! Hiding Face.
155     Standard_Boolean EdgeOfTheHidingFace (const Standard_Integer E, const HLRBRep_EdgeData& ED) const;
156   
157   //! Returns the number of  levels of hiding face above
158   //! the   first  point  of   the    edge <ED>.     The
159   //! InterferenceList is  given to  compute far away of
160   //! the Interferences and then come back.
161   Standard_EXPORT Standard_Integer HidingStartLevel (const Standard_Integer E, const HLRBRep_EdgeData& ED, const HLRAlgo_InterferenceList& IL);
162   
163   //! Returns   the  state   of  the   Edge  <ED>  after
164   //! classification.
165   Standard_EXPORT TopAbs_State Compare (const Standard_Integer E, const HLRBRep_EdgeData& ED);
166   
167   //! Simple classification of part of edge [p1,  p2].
168   //! Returns OUT if at least 1 of Nbp points of edge is out; otherwise returns IN.
169   //! It is used to check "suspicion" hidden part of edge.
170   Standard_EXPORT TopAbs_State SimplClassify (const Standard_Integer E, const HLRBRep_EdgeData& ED, const Standard_Integer Nbp, const Standard_Real p1, const Standard_Real p2);
171   
172   //! Classification of an edge.
173   Standard_EXPORT TopAbs_State Classify (const Standard_Integer E, const HLRBRep_EdgeData& ED, const Standard_Boolean LevelFlag, Standard_Integer& Level, const Standard_Real param);
174
175   //! Returns true if the current face is bad.
176   Standard_EXPORT Standard_Boolean IsBadFace() const;
177
178   Standard_EXPORT void Destroy();
179 ~HLRBRep_Data()
180 {
181   Destroy();
182 }
183
184   DEFINE_STANDARD_RTTIEXT(HLRBRep_Data,Standard_Transient)
185
186 private:
187
188   //! Orient the   OutLines  ( left  must  be  inside in
189   //! projection ). Returns True if the face of a closed
190   //! shell has been inverted;
191   Standard_EXPORT Standard_Boolean OrientOutLine (const Standard_Integer I, HLRBRep_FaceData& FD);
192   
193   //! Orient the Edges which  are not  Internal OutLine,
194   //! not Double and not IsoLine.
195   Standard_EXPORT void OrientOthEdge (const Standard_Integer I, HLRBRep_FaceData& FD);
196   
197   //! Returns  True  if the  intersection is  rejected.
198   Standard_EXPORT Standard_Boolean RejectedPoint (const IntRes2d_IntersectionPoint& PInter, const TopAbs_Orientation BoundOri, const Standard_Integer NumSeg);
199   
200   //! Returns True if there is a common vertex between myLE and myFE depending on <head1> and <head2>.
201   Standard_EXPORT Standard_Boolean SameVertex (const Standard_Boolean head1, const Standard_Boolean head2);
202
203 private:
204
205   Standard_Integer myNbVertices;
206   Standard_Integer myNbEdges;
207   Standard_Integer myNbFaces;
208   TopTools_IndexedMapOfShape myEMap;
209   TopTools_IndexedMapOfShape myFMap;
210   HLRBRep_Array1OfEData myEData;
211   HLRBRep_Array1OfFData myFData;
212   TColStd_Array1OfInteger myEdgeIndices;
213   Standard_ShortReal myToler;
214   HLRAlgo_Projector myProj;
215   HLRBRep_CLProps myLLProps;
216   HLRBRep_CLProps myFLProps;
217   HLRBRep_SLProps mySLProps;
218   Standard_Real myBigSize;
219   HLRBRep_FaceIterator myFaceItr1;
220   HLRBRep_FaceIterator myFaceItr2;
221   Standard_Integer iFace;
222   HLRBRep_FaceData* iFaceData;
223   Standard_Address iFaceGeom;
224   HLRAlgo_EdgesBlock::MinMaxIndices* iFaceMinMax;
225   GeomAbs_SurfaceType iFaceType;
226   Standard_Boolean iFaceBack;
227   Standard_Boolean iFaceSimp;
228   Standard_Boolean iFaceSmpl;
229   Standard_Boolean iFaceTest;
230   Standard_Integer myHideCount;
231   Standard_Real myDeca[16];
232   Standard_Real mySurD[16];
233   Standard_Integer myCurSortEd;
234   Standard_Integer myNbrSortEd;
235   Standard_Integer myLE;
236   Standard_Boolean myLEOutLine;
237   Standard_Boolean myLEInternal;
238   Standard_Boolean myLEDouble;
239   Standard_Boolean myLEIsoLine;
240   HLRBRep_EdgeData* myLEData;
241   const HLRBRep_Curve* myLEGeom;
242   HLRAlgo_EdgesBlock::MinMaxIndices* myLEMinMax;
243   GeomAbs_CurveType myLEType;
244   Standard_ShortReal myLETol;
245   Standard_Integer myFE;
246   TopAbs_Orientation myFEOri;
247   Standard_Boolean myFEOutLine;
248   Standard_Boolean myFEInternal;
249   Standard_Boolean myFEDouble;
250   HLRBRep_EdgeData* myFEData;
251   HLRBRep_Curve* myFEGeom;
252   GeomAbs_CurveType myFEType;
253   Standard_ShortReal myFETol;
254   HLRBRep_Intersector myIntersector;
255   Handle(BRepTopAdaptor_TopolTool) myClassifier;
256   Standard_Boolean mySameVertex;
257   Standard_Boolean myIntersected;
258   Standard_Integer myNbPoints;
259   Standard_Integer myNbSegments;
260   Standard_Integer iInterf;
261   HLRAlgo_Interference myIntf;
262   Standard_Boolean myAboveIntf;
263   TableauRejection* myReject;
264
265 };
266
267 #include <HLRBRep_Data.lxx>
268
269
270 #endif // _HLRBRep_Data_HeaderFile