0027772: Foundation Classes - define Standard_Boolean using C++ type "bool" instead...
[occt.git] / src / BOPTools / BOPTools_AlgoTools.hxx
1 // Created by: Peter KURNEV
2 // Copyright (c) 2010-2014 OPEN CASCADE SAS
3 // Copyright (c) 2007-2010 CEA/DEN, EDF R&D, OPEN CASCADE
4 // Copyright (c) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, CEDRAT,
5 //                         EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
6 //
7 // This file is part of Open CASCADE Technology software library.
8 //
9 // This library is free software; you can redistribute it and/or modify it under
10 // the terms of the GNU Lesser General Public License version 2.1 as published
11 // by the Free Software Foundation, with special exception defined in the file
12 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
13 // distribution for complete text of the license and disclaimer of any warranty.
14 //
15 // Alternatively, this file may be used under the terms of Open CASCADE
16 // commercial license or contractual agreement.
17
18 #ifndef _BOPTools_AlgoTools_HeaderFile
19 #define _BOPTools_AlgoTools_HeaderFile
20
21 #include <Standard.hxx>
22 #include <Standard_DefineAlloc.hxx>
23 #include <Standard_Handle.hxx>
24
25 #include <Standard_Integer.hxx>
26 #include <Standard_Real.hxx>
27 #include <BOPCol_ListOfShape.hxx>
28 #include <Standard_Boolean.hxx>
29 #include <TopAbs_ShapeEnum.hxx>
30 #include <BOPTools_ListOfCoupleOfShape.hxx>
31 #include <BOPCol_IndexedDataMapOfShapeListOfShape.hxx>
32 #include <TopAbs_State.hxx>
33 #include <BOPCol_IndexedMapOfShape.hxx>
34 #include <BOPCol_BaseAllocator.hxx>
35 class TopoDS_Vertex;
36 class gp_Pnt;
37 class IntTools_Curve;
38 class TopoDS_Edge;
39 class TopoDS_Face;
40 class TopoDS_Shape;
41 class IntTools_Context;
42 class TopoDS_Solid;
43 class IntTools_Range;
44 class TopoDS_Shell;
45
46
47
48 class BOPTools_AlgoTools 
49 {
50 public:
51
52   DEFINE_STANDARD_ALLOC
53
54   
55   Standard_EXPORT static Standard_Integer ComputeVV (const TopoDS_Vertex& aV1, const gp_Pnt& aP2, const Standard_Real aTolP2);
56   
57   Standard_EXPORT static Standard_Integer ComputeVV (const TopoDS_Vertex& aV1, const TopoDS_Vertex& aV2);
58   
59   Standard_EXPORT static void MakeVertex (const BOPCol_ListOfShape& aLV, TopoDS_Vertex& aV);
60   
61   Standard_EXPORT static void MakeEdge (const IntTools_Curve& theCurve, const TopoDS_Vertex& theV1, const Standard_Real theT1, const TopoDS_Vertex& theV2, const Standard_Real theT2, const Standard_Real theTolR3D, TopoDS_Edge& theE);
62   
63   Standard_EXPORT static void MakePCurve (const TopoDS_Edge& theE, const TopoDS_Face& theF1, const TopoDS_Face& theF2, const IntTools_Curve& theCurve, const Standard_Boolean thePC1, const Standard_Boolean thePC2);
64   
65   Standard_EXPORT static void MakeContainer (const TopAbs_ShapeEnum theType, TopoDS_Shape& theShape);
66   
67   Standard_EXPORT static Standard_Boolean IsHole (const TopoDS_Shape& aW, const TopoDS_Shape& aF);
68   
69   //! Returns True if the shape theSplit has opposite
70   //! direction than theShape
71   //! theContext - cashed geometrical tools
72   Standard_EXPORT static Standard_Boolean IsSplitToReverse (const TopoDS_Shape& theSplit, const TopoDS_Shape& theShape, Handle(IntTools_Context)& theContext);
73   
74   //! Returns True if normal direction of the face
75   //! theShape is not the same as for the face
76   //! theSplit
77   //! theContext - cashed geometrical tools
78   Standard_EXPORT static Standard_Boolean IsSplitToReverse (const TopoDS_Face& theSplit, const TopoDS_Face& theShape, Handle(IntTools_Context)& theContext);
79   
80   Standard_EXPORT static Standard_Boolean IsSplitToReverse (const TopoDS_Edge& aE1, const TopoDS_Edge& aE2, Handle(IntTools_Context)& aContext);
81   
82   Standard_EXPORT static Standard_Boolean AreFacesSameDomain (const TopoDS_Face& theF1, const TopoDS_Face& theF2, Handle(IntTools_Context)& theContext);
83   
84   Standard_EXPORT static Standard_Boolean CheckSameGeom (const TopoDS_Face& theF1, const TopoDS_Face& theF2, Handle(IntTools_Context)& theContext);
85   
86   Standard_EXPORT static Standard_Integer Sense (const TopoDS_Face& theF1, const TopoDS_Face& theF2);
87   
88   //! Returns True if the face theFace contains
89   //! the edge theEdge but with opposite orientation.
90   //! If the method  returns True theEdgeOff is the
91   //! edge founded
92   Standard_EXPORT static Standard_Boolean GetEdgeOff (const TopoDS_Edge& theEdge, const TopoDS_Face& theFace, TopoDS_Edge& theEdgeOff);
93   
94   //! For the face theFace and its edge theEdge
95   //! finds the face suitable to produce shell.
96   //! theLCEF - set of faces to search. All faces
97   //! from theLCEF must share edge theEdge
98   Standard_EXPORT static Standard_Boolean GetFaceOff (const TopoDS_Edge& theEdge, const TopoDS_Face& theFace, BOPTools_ListOfCoupleOfShape& theLCEF, TopoDS_Face& theFaceOff, Handle(IntTools_Context)& theContext);
99   
100   //! Returns True if the face theFace is inside of the
101   //! couple of faces theFace1, theFace2.
102   //! The faces theFace, theFace1, theFace2  must
103   //! share the edge theEdge
104   //! Return values:
105   //!  * 0 state is not IN
106   //!  * 1 state is IN
107   //!  * 2 state can not be found by the method of angles
108   Standard_EXPORT static Standard_Integer IsInternalFace (const TopoDS_Face& theFace, const TopoDS_Edge& theEdge, const TopoDS_Face& theFace1, const TopoDS_Face& theFace2, Handle(IntTools_Context)& theContext);
109   
110   //! Returns True if the face theFace is inside of the
111   //! appropriate couple of faces (from the set theLF)    .
112   //! The faces of the set theLF and theFace  must
113   //! share the edge theEdge
114   //!  * 0 state is not IN
115   //!  * 1 state is IN
116   //!  * 2 state can not be found by the method of angles
117   Standard_EXPORT static Standard_Integer IsInternalFace (const TopoDS_Face& theFace, const TopoDS_Edge& theEdge, BOPCol_ListOfShape& theLF, Handle(IntTools_Context)& theContext);
118   
119   //! Returns True if the face theFace is inside the
120   //! solid theSolid.
121   //! theMEF - Map Edge/Faces for theSolid
122   //! theTol - value of precision of computation
123   //! theContext- cahed geometrical tools
124   Standard_EXPORT static Standard_Boolean IsInternalFace (const TopoDS_Face& theFace, const TopoDS_Solid& theSolid, BOPCol_IndexedDataMapOfShapeListOfShape& theMEF, const Standard_Real theTol, Handle(IntTools_Context)& theContext);
125   
126   //! For the face theFace gets the edge theEdgeOnF
127   //! that is the same as theEdge
128   //! Returns True if such edge exists
129   //! Returns False if there is no such edge
130   Standard_EXPORT static Standard_Boolean GetEdgeOnFace (const TopoDS_Edge& theEdge, const TopoDS_Face& theFace, TopoDS_Edge& theEdgeOnF);
131   
132   //! Computes the 3-D state of the point thePoint
133   //! toward solid theSolid.
134   //! theTol - value of precision of computation
135   //! theContext- cahed geometrical tools
136   //! Returns 3-D state.
137   Standard_EXPORT static TopAbs_State ComputeState (const gp_Pnt& thePoint, const TopoDS_Solid& theSolid, const Standard_Real theTol, Handle(IntTools_Context)& theContext);
138   
139   //! Computes the 3-D state of the vertex theVertex
140   //! toward solid theSolid.
141   //! theTol - value of precision of computation
142   //! theContext- cahed geometrical tools
143   //! Returns 3-D state.
144   Standard_EXPORT static TopAbs_State ComputeState (const TopoDS_Vertex& theVertex, const TopoDS_Solid& theSolid, const Standard_Real theTol, Handle(IntTools_Context)& theContext);
145   
146   //! Computes the 3-D state of the edge theEdge
147   //! toward solid theSolid.
148   //! theTol - value of precision of computation
149   //! theContext- cahed geometrical tools
150   //! Returns 3-D state.
151   Standard_EXPORT static TopAbs_State ComputeState (const TopoDS_Edge& theEdge, const TopoDS_Solid& theSolid, const Standard_Real theTol, Handle(IntTools_Context)& theContext);
152   
153   //! Computes the 3-D state of the face theFace
154   //! toward solid theSolid.
155   //! theTol - value of precision of computation
156   //! theBounds - set of edges of theFace to avoid
157   //! theContext- cahed geometrical tools
158   //! Returns 3-D state.
159   Standard_EXPORT static TopAbs_State ComputeState (const TopoDS_Face& theFace, const TopoDS_Solid& theSolid, const Standard_Real theTol, BOPCol_IndexedMapOfShape& theBounds, Handle(IntTools_Context)& theContext);
160   
161   //! Computes the 3-D state of the shape theShape
162   //! toward solid theSolid.
163   //! theTol - value of precision of computation
164   //! theContext- cahed geometrical tools
165   //! Returns 3-D state.
166   Standard_EXPORT static TopAbs_State ComputeStateByOnePoint (const TopoDS_Shape& theShape, const TopoDS_Solid& theSolid, const Standard_Real theTol, Handle(IntTools_Context)& theContext);
167   
168   //! For the list of faces theLS build block
169   //! theLSCB in terms of connexity by edges
170   //! theMapAvoid - set of edges to avoid for
171   //! the treatment
172   Standard_EXPORT static void MakeConnexityBlock (BOPCol_ListOfShape& theLS, BOPCol_IndexedMapOfShape& theMapAvoid, BOPCol_ListOfShape& theLSCB, const BOPCol_BaseAllocator& theAllocator);
173   
174   //! For the compound theS build the blocks
175   //! theLCB (as list of compounds)
176   //! in terms of connexity by the shapes of theType
177   Standard_EXPORT static void MakeConnexityBlocks (const TopoDS_Shape& theS, const TopAbs_ShapeEnum theType1, const TopAbs_ShapeEnum theType2, BOPCol_ListOfShape& theLCB);
178   
179   Standard_EXPORT static void OrientFacesOnShell (TopoDS_Shape& theS);
180   
181
182   //! Provides valid values of tolerances for the shape <theS>
183   //! <theTolMax> is max value of the tolerance that can be
184   //! accepted for correction.  If real value of the tolerance
185   //! will be greater than  <aTolMax>, the correction does not
186   //! perform.
187   Standard_EXPORT static void CorrectTolerances
188               (const TopoDS_Shape& theS, 
189                const BOPCol_IndexedMapOfShape& theMapToAvoid,
190                const Standard_Real theTolMax = 0.0001,
191                const Standard_Boolean theRunParallel = Standard_False);
192
193   //! Provides valid values of tolerances for the shape <theS>
194   //! in  terms of BRepCheck_InvalidCurveOnSurface.
195   Standard_EXPORT static void CorrectCurveOnSurface
196               (const TopoDS_Shape& theS,
197                const BOPCol_IndexedMapOfShape& theMapToAvoid,
198                const Standard_Real theTolMax = 0.0001,
199                const Standard_Boolean theRunParallel = Standard_False);
200
201   //! Provides valid values of tolerances for the shape <theS>
202   //! in  terms of BRepCheck_InvalidPointOnCurve.
203   Standard_EXPORT static void CorrectPointOnCurve
204               (const TopoDS_Shape& theS,
205                const BOPCol_IndexedMapOfShape& theMapToAvoid,
206                const Standard_Real theTolMax = 0.0001,
207                const Standard_Boolean theRunParallel = Standard_False);
208
209   //! Make a vertex using 3D-point <aP1> and 3D-tolerance value <aTol>
210   Standard_EXPORT static void MakeNewVertex (const gp_Pnt& aP1, const Standard_Real aTol, TopoDS_Vertex& aNewVertex);
211   
212
213   //! Make a vertex using couple of vertices  <aV1, aV2>
214   Standard_EXPORT static void MakeNewVertex (const TopoDS_Vertex& aV1, const TopoDS_Vertex& aV2, TopoDS_Vertex& aNewVertex);
215   
216
217   //! Make a vertex in place of intersection between two edges
218   //! <aE1, aE2> with parameters <aP1, aP2>
219   Standard_EXPORT static void MakeNewVertex (const TopoDS_Edge& aE1, const Standard_Real aP1, const TopoDS_Edge& aE2, const Standard_Real aP2, TopoDS_Vertex& aNewVertex);
220   
221
222   //! Make a vertex in place of intersection between the edge <aE1>
223   //! with parameter <aP1> and the face <aF2>
224   Standard_EXPORT static void MakeNewVertex (const TopoDS_Edge& aE1, const Standard_Real aP1, const TopoDS_Face& aF2, TopoDS_Vertex& aNewVertex);
225   
226
227   //! Compute a 3D-point on the edge <aEdge> at parameter <aPrm>
228   Standard_EXPORT static void PointOnEdge (const TopoDS_Edge& aEdge, const Standard_Real aPrm, gp_Pnt& aP);
229   
230
231   //! Make the edge from base edge <aE1> and two vertices <aV1,aV2>
232   //! at parameters <aP1,aP2>
233   Standard_EXPORT static void MakeSplitEdge (const TopoDS_Edge& aE1, const TopoDS_Vertex& aV1, const Standard_Real aP1, const TopoDS_Vertex& aV2, const Standard_Real aP2, TopoDS_Edge& aNewEdge);
234   
235
236   //! Make the edge from 3D-Curve <aIC>  and two vertices <aV1,aV2>
237   //! at parameters <aP1,aP2>
238   Standard_EXPORT static void MakeSectEdge (const IntTools_Curve& aIC, const TopoDS_Vertex& aV1, const Standard_Real aP1, const TopoDS_Vertex& aV2, const Standard_Real aP2, TopoDS_Edge& aNewEdge);
239   
240
241   //! Update the tolerance value for vertex  <aV>
242   //! taking into account the fact that <aV> lays on
243   //! the curve <aIC>
244   Standard_EXPORT static void UpdateVertex (const IntTools_Curve& aIC, const Standard_Real aT, const TopoDS_Vertex& aV);
245   
246
247   //! Update the tolerance value for vertex  <aV>
248   //! taking into account the fact that <aV> lays on
249   //! the edge <aE>
250   Standard_EXPORT static void UpdateVertex (const TopoDS_Edge& aE, const Standard_Real aT, const TopoDS_Vertex& aV);
251   
252
253   //! Update the tolerance value for vertex  <aVN>
254   //! taking into account the fact that <aVN> should
255   //! cover tolerance zone of <aVF>
256   Standard_EXPORT static void UpdateVertex (const TopoDS_Vertex& aVF, const TopoDS_Vertex& aVN);
257   
258
259   //! Correct shrunk range <aSR> taking into account 3D-curve
260   //! resolution and corresp. tolerances' values of <aE1>, <aE2>
261   Standard_EXPORT static void CorrectRange (const TopoDS_Edge& aE1, const TopoDS_Edge& aE2, const IntTools_Range& aSR, IntTools_Range& aNewSR);
262   
263
264   //! Correct shrunk range <aSR> taking into account 3D-curve
265   //! resolution and corresp. tolerances' values of <aE>, <aF>
266   Standard_EXPORT static void CorrectRange (const TopoDS_Edge& aE, const TopoDS_Face& aF, const IntTools_Range& aSR, IntTools_Range& aNewSR);
267   
268
269   //! Returns TRUE if PaveBlock <aPB> lays on the face <aF>, i.e
270   //! the <PB> is IN or ON in 2D of <aF>
271   Standard_EXPORT static Standard_Boolean IsBlockInOnFace (const IntTools_Range& aShR, const TopoDS_Face& aF, const TopoDS_Edge& aE, Handle(IntTools_Context)& aContext);
272   
273
274   //! Checks if it is possible to compute shrunk range for the edge <aE>
275   //! Flag <theCheckSplittable> defines whether to take into account 
276   //! the possiblity to split the edge or not.
277   Standard_EXPORT static Standard_Boolean IsMicroEdge (const TopoDS_Edge& theEdge,
278                                                        const Handle(IntTools_Context)& theContext,
279                                                        const Standard_Boolean theCheckSplittable = Standard_True);
280   
281
282   //! Corrects tolerance values of the sub-shapes of the shape <theS> if needed.
283   Standard_EXPORT static void CorrectShapeTolerances
284               (const TopoDS_Shape& theS,
285                const BOPCol_IndexedMapOfShape& theMapToAvoid,
286                const Standard_Boolean theRunParallel = Standard_False);
287
288   //! Retutns dimension of the shape <theS>.
289   Standard_EXPORT static Standard_Integer Dimension (const TopoDS_Shape& theS);
290   
291   //! Returns true if the  shell <theShell> is open
292   Standard_EXPORT static Standard_Boolean IsOpenShell (const TopoDS_Shell& theShell);
293   
294   //! Returns true if the solid <theSolid> is inverted
295   Standard_EXPORT static Standard_Boolean IsInvertedSolid (const TopoDS_Solid& theSolid);
296   
297
298   //! Computes the necessary value of the tolerance for the edge
299   Standard_EXPORT static Standard_Boolean ComputeTolerance (const TopoDS_Face& theFace, const TopoDS_Edge& theEdge, Standard_Real& theMaxDist, Standard_Real& theMaxPar);
300
301
302
303
304 protected:
305
306
307
308
309
310 private:
311
312
313
314
315
316 };
317
318
319
320
321
322
323
324 #endif // _BOPTools_AlgoTools_HeaderFile