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
6 // This file is part of Open CASCADE Technology software library.
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.
14 // Alternatively, this file may be used under the terms of Open CASCADE
15 // commercial license or contractual agreement.
17 #ifndef _BRepTools_HeaderFile
18 #define _BRepTools_HeaderFile
20 #include <Standard.hxx>
21 #include <Standard_DefineAlloc.hxx>
22 #include <Standard_Handle.hxx>
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>
31 #include <Message_ProgressIndicator.hxx>
40 class TopoDS_CompSolid;
41 class TopoDS_Compound;
43 class Message_ProgressIndicator;
45 class BRepTools_WireExplorer;
46 class BRepTools_Modification;
47 class BRepTools_Modifier;
48 class BRepTools_TrsfModification;
49 class BRepTools_NurbsConvertModification;
50 class BRepTools_GTrsfModification;
51 class BRepTools_Substitution;
52 class BRepTools_Quilt;
53 class BRepTools_ShapeSet;
54 class BRepTools_ReShape;
60 //! The BRepTools package provides utilities for BRep
63 //! * WireExplorer : A tool to explore the topology of
64 //! a wire in the order of the edges.
66 //! * ShapeSet : Tools used for dumping, writing and
69 //! * UVBounds : Methods to compute the limits of the
70 //! boundary of a face, a wire or an edge in the
71 //! parametric space of a face.
73 //! * Update : Methods to call when a topology has
74 //! been created to compute all missing data.
76 //! * UpdateFaceUVPoints: Method to update the UV points
77 //! stored with the edges on a face.
79 //! * Compare : Method to compare two vertices.
81 //! * Compare : Method to compare two edges.
83 //! * OuterWire : A method to find the outer wire of a
86 //! * Map3DEdges : A method to map all the 3D Edges of
89 //! * Dump : A method to dump a BRep object.
97 //! Returns in UMin, UMax, VMin, VMax the bounding
98 //! values in the parametric space of F.
99 Standard_EXPORT static void UVBounds (const TopoDS_Face& F, Standard_Real& UMin, Standard_Real& UMax, Standard_Real& VMin, Standard_Real& VMax);
101 //! Returns in UMin, UMax, VMin, VMax the bounding
102 //! values of the wire in the parametric space of F.
103 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);
105 //! Returns in UMin, UMax, VMin, VMax the bounding
106 //! values of the edge in the parametric space of F.
107 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);
109 //! Adds to the box <B> the bounding values in the
110 //! parametric space of F.
111 Standard_EXPORT static void AddUVBounds (const TopoDS_Face& F, Bnd_Box2d& B);
113 //! Adds to the box <B> the bounding values of the
114 //! wire in the parametric space of F.
115 Standard_EXPORT static void AddUVBounds (const TopoDS_Face& F, const TopoDS_Wire& W, Bnd_Box2d& B);
117 //! Adds to the box <B> the bounding values of the
118 //! edge in the parametric space of F.
119 Standard_EXPORT static void AddUVBounds (const TopoDS_Face& F, const TopoDS_Edge& E, Bnd_Box2d& B);
121 //! Update a vertex (nothing is done)
122 Standard_EXPORT static void Update (const TopoDS_Vertex& V);
124 //! Update an edge, compute 2d bounding boxes.
125 Standard_EXPORT static void Update (const TopoDS_Edge& E);
127 //! Update a wire (nothing is done)
128 Standard_EXPORT static void Update (const TopoDS_Wire& W);
130 //! Update a Face, update UV points.
131 Standard_EXPORT static void Update (const TopoDS_Face& F);
133 //! Update a shell (nothing is done)
134 Standard_EXPORT static void Update (const TopoDS_Shell& S);
136 //! Update a solid (nothing is done)
137 Standard_EXPORT static void Update (const TopoDS_Solid& S);
139 //! Update a composite solid (nothing is done)
140 Standard_EXPORT static void Update (const TopoDS_CompSolid& C);
142 //! Update a compound (nothing is done)
143 Standard_EXPORT static void Update (const TopoDS_Compound& C);
145 //! Update a shape, call the corect update.
146 Standard_EXPORT static void Update (const TopoDS_Shape& S);
148 //! For each edge of the face <F> reset the UV points
149 //! to the bounding points of the parametric curve of the
150 //! edge on the face.
151 Standard_EXPORT static void UpdateFaceUVPoints (const TopoDS_Face& theF);
153 //! Removes all the triangulations of the faces of <S>
154 //! and removes all polygons on triangulations of the
156 Standard_EXPORT static void Clean (const TopoDS_Shape& S);
158 //! Removes all the pcurves of the edges of <S> that
159 //! refer to surfaces not belonging to any face of <S>
160 Standard_EXPORT static void RemoveUnusedPCurves (const TopoDS_Shape& S);
162 //! verifies that each face from the shape <S> has got
163 //! a triangulation with a deflection <= deflec and
164 //! the edges a discretisation on this triangulation.
165 Standard_EXPORT static Standard_Boolean Triangulation (const TopoDS_Shape& S, const Standard_Real deflec);
167 //! Returns True if the distance between the two
168 //! vertices is lower than their tolerance.
169 Standard_EXPORT static Standard_Boolean Compare (const TopoDS_Vertex& V1, const TopoDS_Vertex& V2);
171 //! Returns True if the distance between the two
172 //! edges is lower than their tolerance.
173 Standard_EXPORT static Standard_Boolean Compare (const TopoDS_Edge& E1, const TopoDS_Edge& E2);
175 //! Returns the outer most wire of <F>. Returns a Null
176 //! wire if <F> has no wires.
177 Standard_EXPORT static TopoDS_Wire OuterWire (const TopoDS_Face& F);
179 //! Stores in the map <M> all the 3D topology edges
181 Standard_EXPORT static void Map3DEdges (const TopoDS_Shape& S, TopTools_IndexedMapOfShape& M);
183 //! Verifies that the edge <E> is found two times on
184 //! the face <F> before calling BRep_Tool::IsClosed.
185 Standard_EXPORT static Standard_Boolean IsReallyClosed (const TopoDS_Edge& E, const TopoDS_Face& F);
187 //! Detect closedness of face in U and V directions
188 Standard_EXPORT static void DetectClosedness (const TopoDS_Face& theFace,
189 Standard_Boolean& theUclosed,
190 Standard_Boolean& theVclosed);
192 //! Dumps the topological structure and the geometry
193 //! of <Sh> on the stream <S>.
194 Standard_EXPORT static void Dump (const TopoDS_Shape& Sh, Standard_OStream& S);
196 //! Writes <Sh> on <S> in an ASCII format.
197 Standard_EXPORT static void Write (const TopoDS_Shape& Sh, Standard_OStream& S, const Handle(Message_ProgressIndicator)& PR = NULL);
199 //! Reads a Shape from <S> in returns it in <Sh>.
200 //! <B> is used to build the shape.
201 Standard_EXPORT static void Read (TopoDS_Shape& Sh, Standard_IStream& S, const BRep_Builder& B, const Handle(Message_ProgressIndicator)& PR = NULL);
203 //! Writes <Sh> in <File>.
204 Standard_EXPORT static Standard_Boolean Write (const TopoDS_Shape& Sh, const Standard_CString File, const Handle(Message_ProgressIndicator)& PR = NULL);
206 //! Reads a Shape from <File>, returns it in <Sh>.
207 //! <B> is used to build the shape.
208 Standard_EXPORT static Standard_Boolean Read (TopoDS_Shape& Sh, const Standard_CString File, const BRep_Builder& B, const Handle(Message_ProgressIndicator)& PR = NULL);
210 //! Evals real tolerance of edge <theE>.
211 //! <theC3d>, <theC2d>, <theS>, <theF>, <theL> are
212 //! correspondently 3d curve of edge, 2d curve on surface <theS> and
214 //! If calculated tolerance is more then current edge tolerance, edge is updated.
215 //! Method returns actual tolerance of edge
216 Standard_EXPORT static Standard_Real EvalAndUpdateTol(const TopoDS_Edge& theE,
217 const Handle(Geom_Curve)& theC3d,
218 const Handle(Geom2d_Curve) theC2d,
219 const Handle(Geom_Surface)& theS,
220 const Standard_Real theF,
221 const Standard_Real theL);
236 friend class BRepTools_WireExplorer;
237 friend class BRepTools_Modification;
238 friend class BRepTools_Modifier;
239 friend class BRepTools_TrsfModification;
240 friend class BRepTools_NurbsConvertModification;
241 friend class BRepTools_GTrsfModification;
242 friend class BRepTools_Substitution;
243 friend class BRepTools_Quilt;
244 friend class BRepTools_ShapeSet;
245 friend class BRepTools_ReShape;
255 #endif // _BRepTools_HeaderFile