0031353: TDocStd_Application does not have api to set progress indicator
[occt.git] / src / BRepTools / BRepTools.hxx
1 // Created on: 1992-08-28
2 // Created by: Remi LEQUETTE
3 // Copyright (c) 1992-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 _BRepTools_HeaderFile
18 #define _BRepTools_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_DefineAlloc.hxx>
22 #include <Standard_Handle.hxx>
23
24 #include <Standard_Real.hxx>
25 #include <Standard_Boolean.hxx>
26 #include <TopTools_IndexedMapOfShape.hxx>
27 #include <Standard_OStream.hxx>
28 #include <Standard_IStream.hxx>
29 #include <Standard_CString.hxx>
30
31 #include <Message_ProgressIndicator.hxx>
32
33 class TopoDS_Face;
34 class TopoDS_Wire;
35 class TopoDS_Edge;
36 class Bnd_Box2d;
37 class TopoDS_Vertex;
38 class TopoDS_Shell;
39 class TopoDS_Solid;
40 class TopoDS_CompSolid;
41 class TopoDS_Compound;
42 class TopoDS_Shape;
43 class BRep_Builder;
44 class BRepTools_WireExplorer;
45 class BRepTools_Modification;
46 class BRepTools_Modifier;
47 class BRepTools_TrsfModification;
48 class BRepTools_NurbsConvertModification;
49 class BRepTools_GTrsfModification;
50 class BRepTools_Substitution;
51 class BRepTools_Quilt;
52 class BRepTools_ShapeSet;
53 class BRepTools_ReShape;
54 class Geom_Curve;
55 class Geom2d_Curve;
56 class Geom_Surface;
57
58
59 //! The BRepTools package provides  utilities for BRep
60 //! data structures.
61 //!
62 //! * WireExplorer : A tool to explore the topology of
63 //! a wire in the order of the edges.
64 //!
65 //! * ShapeSet :  Tools used for  dumping, writing and
66 //! reading.
67 //!
68 //! * UVBounds : Methods to compute the  limits of the
69 //! boundary  of a  face,  a wire or   an edge in  the
70 //! parametric space of a face.
71 //!
72 //! *  Update : Methods  to call when   a topology has
73 //! been created to compute all missing data.
74 //!
75 //! * UpdateFaceUVPoints: Method to update the UV points
76 //! stored with the edges on a face.
77 //!
78 //! * Compare : Method to compare two vertices.
79 //!
80 //! * Compare : Method to compare two edges.
81 //!
82 //! * OuterWire : A method to find the outer wire of a
83 //! face.
84 //!
85 //! * Map3DEdges : A method to map all the 3D Edges of
86 //! a Shape.
87 //!
88 //! * Dump : A method to dump a BRep object.
89 class BRepTools 
90 {
91 public:
92
93   DEFINE_STANDARD_ALLOC
94
95   
96   //! Returns in UMin,  UMax, VMin,  VMax  the  bounding
97   //! values in the parametric space of F.
98   Standard_EXPORT static void UVBounds (const TopoDS_Face& F, Standard_Real& UMin, Standard_Real& UMax, Standard_Real& VMin, Standard_Real& VMax);
99   
100   //! Returns in UMin,  UMax, VMin,  VMax  the  bounding
101   //! values of the wire in the parametric space of F.
102   Standard_EXPORT static void UVBounds (const TopoDS_Face& F, const TopoDS_Wire& W, Standard_Real& UMin, Standard_Real& UMax, Standard_Real& VMin, Standard_Real& VMax);
103   
104   //! Returns in UMin,  UMax, VMin,  VMax  the  bounding
105   //! values of the edge in the parametric space of F.
106   Standard_EXPORT static void UVBounds (const TopoDS_Face& F, const TopoDS_Edge& E, Standard_Real& UMin, Standard_Real& UMax, Standard_Real& VMin, Standard_Real& VMax);
107   
108   //! Adds  to  the box <B>  the bounding values in  the
109   //! parametric space of F.
110   Standard_EXPORT static void AddUVBounds (const TopoDS_Face& F, Bnd_Box2d& B);
111   
112   //! Adds  to the box  <B>  the bounding  values of the
113   //! wire in the parametric space of F.
114   Standard_EXPORT static void AddUVBounds (const TopoDS_Face& F, const TopoDS_Wire& W, Bnd_Box2d& B);
115   
116   //! Adds to  the box <B>  the  bounding values  of the
117   //! edge in the parametric space of F.
118   Standard_EXPORT static void AddUVBounds (const TopoDS_Face& F, const TopoDS_Edge& E, Bnd_Box2d& B);
119   
120   //! Update a vertex (nothing is done)
121   Standard_EXPORT static void Update (const TopoDS_Vertex& V);
122   
123   //! Update an edge, compute 2d bounding boxes.
124   Standard_EXPORT static void Update (const TopoDS_Edge& E);
125   
126   //! Update a wire (nothing is done)
127   Standard_EXPORT static void Update (const TopoDS_Wire& W);
128   
129   //! Update a Face, update UV points.
130   Standard_EXPORT static void Update (const TopoDS_Face& F);
131   
132   //! Update a shell (nothing is done)
133   Standard_EXPORT static void Update (const TopoDS_Shell& S);
134   
135   //! Update a solid (nothing is done)
136   Standard_EXPORT static void Update (const TopoDS_Solid& S);
137   
138   //! Update a composite solid (nothing is done)
139   Standard_EXPORT static void Update (const TopoDS_CompSolid& C);
140   
141   //! Update a compound (nothing is done)
142   Standard_EXPORT static void Update (const TopoDS_Compound& C);
143   
144   //! Update a shape, call the corect update.
145   Standard_EXPORT static void Update (const TopoDS_Shape& S);
146   
147   //! For each edge of the face <F> reset the UV points
148   //! to the bounding points of the parametric curve of the
149   //! edge on the face.
150   Standard_EXPORT static void UpdateFaceUVPoints (const TopoDS_Face& theF);
151   
152   //! Removes all cashed polygonal representation of the shape,
153   //! i.e. the triangulations of the faces of <S> and polygons on
154   //! triangulations and polygons 3d of the edges.
155   //! In case polygonal representation is the only available representation
156   //! for the shape (shape does not have geometry) it is not removed.
157   Standard_EXPORT static void Clean (const TopoDS_Shape& S);
158   
159   //! Removes geometry (curves and surfaces) from all edges and faces of the shape
160   Standard_EXPORT static void CleanGeometry(const TopoDS_Shape& theShape);
161
162   //! Removes all the pcurves of the edges of <S> that
163   //! refer to surfaces not belonging to any face of <S>
164   Standard_EXPORT static void RemoveUnusedPCurves (const TopoDS_Shape& S);
165   
166   //! Verifies that each Face from the shape has got a triangulation with a deflection smaller or equal to specified one
167   //! and the Edges a discretization on this triangulation.
168   //! @param theShape   [in] shape to verify
169   //! @param theLinDefl [in] maximum allowed linear deflection
170   //! @param theToCheckFreeEdges [in] if TRUE, then free Edges are required to have 3D polygon
171   //! @return FALSE if input Shape contains Faces without triangulation,
172   //!               or that triangulation has worse (greater) deflection than specified one,
173   //!               or Edges in Shape lack polygons on triangulation
174   //!               or free Edges in Shape lack 3D polygons
175   Standard_EXPORT static Standard_Boolean Triangulation (const TopoDS_Shape& theShape,
176                                                          const Standard_Real theLinDefl,
177                                                          const Standard_Boolean theToCheckFreeEdges = Standard_False);
178   
179   //! Returns  True if  the    distance between the  two
180   //! vertices is lower than their tolerance.
181   Standard_EXPORT static Standard_Boolean Compare (const TopoDS_Vertex& V1, const TopoDS_Vertex& V2);
182   
183   //! Returns  True if  the    distance between the  two
184   //! edges is lower than their tolerance.
185   Standard_EXPORT static Standard_Boolean Compare (const TopoDS_Edge& E1, const TopoDS_Edge& E2);
186   
187   //! Returns the outer most wire of <F>. Returns a Null
188   //! wire if <F> has no wires.
189   Standard_EXPORT static TopoDS_Wire OuterWire (const TopoDS_Face& F);
190   
191   //! Stores in the map  <M> all the 3D topology edges
192   //! of <S>.
193   Standard_EXPORT static void Map3DEdges (const TopoDS_Shape& S, TopTools_IndexedMapOfShape& M);
194   
195   //! Verifies that the edge  <E> is found two  times on
196   //! the face <F> before calling BRep_Tool::IsClosed.
197   Standard_EXPORT static Standard_Boolean IsReallyClosed (const TopoDS_Edge& E, const TopoDS_Face& F);
198   
199   //! Detect closedness of face in U and V directions
200   Standard_EXPORT static void DetectClosedness (const TopoDS_Face& theFace,
201                                                 Standard_Boolean&  theUclosed,
202                                                 Standard_Boolean&  theVclosed);
203   
204   //! Dumps the topological structure and the geometry
205   //! of <Sh> on the stream <S>.
206   Standard_EXPORT static void Dump (const TopoDS_Shape& Sh, Standard_OStream& S);
207   
208   //! Writes <Sh> on <S> in an ASCII format.
209   Standard_EXPORT static void Write (const TopoDS_Shape& Sh, Standard_OStream& S,
210                                      const Handle(Message_ProgressIndicator)& theProgress = NULL);
211   
212   //! Reads a Shape  from <S> in  returns it in  <Sh>.
213   //! <B> is used to build the shape.
214   Standard_EXPORT static void Read (TopoDS_Shape& Sh, Standard_IStream& S, const BRep_Builder& B,
215                                     const Handle(Message_ProgressIndicator)& theProgress = NULL);
216   
217   //! Writes <Sh> in <File>.
218   Standard_EXPORT static Standard_Boolean Write
219     (const TopoDS_Shape& Sh, const Standard_CString File,
220      const Handle(Message_ProgressIndicator)& theProgress = NULL);
221   
222   //! Reads a Shape  from <File>,  returns it in  <Sh>.
223   //! <B> is used to build the shape.
224   Standard_EXPORT static Standard_Boolean Read
225     (TopoDS_Shape& Sh, const Standard_CString File, const BRep_Builder& B,
226      const Handle(Message_ProgressIndicator)& theProgress = NULL);
227
228   //! Evals real tolerance of edge  <theE>.
229   //! <theC3d>, <theC2d>, <theS>, <theF>, <theL> are
230   //! correspondently 3d curve of edge, 2d curve on surface <theS> and
231   //! rang of edge
232   //! If calculated tolerance is more then current edge tolerance, edge is updated.
233   //! Method returns actual tolerance of edge
234   Standard_EXPORT static Standard_Real EvalAndUpdateTol(const TopoDS_Edge& theE, 
235                                                         const Handle(Geom_Curve)& theC3d, 
236                                                         const Handle(Geom2d_Curve) theC2d, 
237                                                         const Handle(Geom_Surface)& theS,
238                                                         const Standard_Real theF,
239                                                         const Standard_Real theL);
240
241   //! returns the cumul  of the orientation  of <Edge>
242   //! and thc containing wire in <Face>
243   Standard_EXPORT static TopAbs_Orientation OriEdgeInFace(const TopoDS_Edge& theEdge, 
244                                                           const TopoDS_Face& theFace);
245
246   //! Removes internal sub-shapes from the shape.
247   //! The check on internal status is based on orientation of sub-shapes,
248   //! classification is not performed.
249   //! Before removal of internal sub-shapes the algorithm checks if such
250   //! removal is not going to break topological connectivity between sub-shapes.
251   //! The flag <theForce> if set to true disables the connectivity check and clears
252   //! the given shape from all sub-shapes with internal orientation.
253   Standard_EXPORT static void RemoveInternals (TopoDS_Shape& theS,
254                                                const Standard_Boolean theForce = Standard_False);
255
256 private:
257
258 friend class BRepTools_WireExplorer;
259 friend class BRepTools_Modification;
260 friend class BRepTools_Modifier;
261 friend class BRepTools_TrsfModification;
262 friend class BRepTools_NurbsConvertModification;
263 friend class BRepTools_GTrsfModification;
264 friend class BRepTools_Substitution;
265 friend class BRepTools_Quilt;
266 friend class BRepTools_ShapeSet;
267 friend class BRepTools_ReShape;
268
269 };
270
271 #endif // _BRepTools_HeaderFile