0024002: Overall code and build procedure refactoring -- automatic
[occt.git] / src / BRepOffset / BRepOffset_Tool.hxx
1 // Created on: 1995-10-23
2 // Created by: Yves FRICAUD
3 // Copyright (c) 1995-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 _BRepOffset_Tool_HeaderFile
18 #define _BRepOffset_Tool_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_DefineAlloc.hxx>
22 #include <Standard_Handle.hxx>
23
24 #include <TopAbs_Orientation.hxx>
25 #include <Standard_Boolean.hxx>
26 #include <TopTools_ListOfShape.hxx>
27 #include <TopAbs_State.hxx>
28 #include <Standard_Real.hxx>
29 #include <TopTools_DataMapOfShapeShape.hxx>
30 #include <TopTools_DataMapOfShapeListOfShape.hxx>
31 #include <TopTools_MapOfShape.hxx>
32 #include <TopTools_IndexedMapOfShape.hxx>
33 class TopoDS_Edge;
34 class TopoDS_Vertex;
35 class TopoDS_Face;
36 class BRepOffset_Analyse;
37 class TopoDS_Wire;
38 class TopoDS_Shape;
39 class BRepAlgo_AsDes;
40 class BRepAlgo_Image;
41 class Geom_Curve;
42
43
44
45 class BRepOffset_Tool 
46 {
47 public:
48
49   DEFINE_STANDARD_ALLOC
50
51   
52   //! <V1> is the FirstVertex ,<V2> is the Last Vertex of <Edge>
53   //! taking account the orientation of Edge.
54   Standard_EXPORT static void EdgeVertices (const TopoDS_Edge& E, TopoDS_Vertex& V1, TopoDS_Vertex& V2);
55   
56   //! returns the cumul  of the orientation  of <Edge>
57   //! and thc containing wire in <Face>
58   Standard_EXPORT static TopAbs_Orientation OriEdgeInFace (const TopoDS_Edge& E, const TopoDS_Face& F);
59   
60   //! <E> is a section  between <F1> and <F2>.  Computes
61   //! <O1> the orientation of <E> in <F1> influenced by <F2>.
62   //! idem for <O2>.
63   Standard_EXPORT static void OrientSection (const TopoDS_Edge& E, const TopoDS_Face& F1, const TopoDS_Face& F2, TopAbs_Orientation& O1, TopAbs_Orientation& O2);
64   
65   //! Returns True if  <F1> and <F2> has common Vertices
66   //! or edges , <LE> contains the common edges. <LV> the
67   //! common vertices.
68   Standard_EXPORT static Standard_Boolean HasCommonShapes (const TopoDS_Face& F1, const TopoDS_Face& F2, TopTools_ListOfShape& LE, TopTools_ListOfShape& LV);
69   
70   //! Computes the   Section betwwen  <F1> and  <F2> the
71   //! edges solution   are  stored in <LInt1>  with  the
72   //! orientation on <F1>, the sames edges are stored in
73   //! <Lint2> with the orientation on <F2>.
74   Standard_EXPORT static void Inter3D (const TopoDS_Face& F1, const TopoDS_Face& F2, TopTools_ListOfShape& LInt1, TopTools_ListOfShape& LInt2, const TopAbs_State Side, const TopoDS_Edge& RefEdge, const Standard_Boolean IsRefEdgeDefined = Standard_False);
75   
76   //! Find if the edges <Edges> of the face <F2> are on
77   //! the face <F1>.
78   //! Set in <LInt1> <LInt2> the updated edges.
79   //! If all the edges are computed, returns true.
80   Standard_EXPORT static Standard_Boolean TryProject (const TopoDS_Face& F1, const TopoDS_Face& F2, const TopTools_ListOfShape& Edges, TopTools_ListOfShape& LInt1, TopTools_ListOfShape& LInt2, const TopAbs_State Side, const Standard_Real TolConf);
81   
82   Standard_EXPORT static void PipeInter (const TopoDS_Face& F1, const TopoDS_Face& F2, TopTools_ListOfShape& LInt1, TopTools_ListOfShape& LInt2, const TopAbs_State Side);
83   
84   Standard_EXPORT static void Inter2d (const TopoDS_Face& F, const TopoDS_Edge& E1, const TopoDS_Edge& E2, TopTools_ListOfShape& LV, const Standard_Real Tol);
85   
86   Standard_EXPORT static void InterOrExtent (const TopoDS_Face& F1, const TopoDS_Face& F2, TopTools_ListOfShape& LInt1, TopTools_ListOfShape& LInt2, const TopAbs_State Side);
87   
88   Standard_EXPORT static void CheckBounds (const TopoDS_Face& F, const BRepOffset_Analyse& Analyse, Standard_Boolean& enlargeU, Standard_Boolean& enlargeVfirst, Standard_Boolean& enlargeVlast);
89   
90   //! if <ChangeGeom> is TRUE  ,   the surface  can  be
91   //! changed .
92   //! if <UpdatePCurve>  is  TRUE, update the  pcurves of the
93   //! edges of <F> on   the new surface.if the surface has  been changed,
94   //! Returns  True if The Surface of  <NF> has changed.
95   Standard_EXPORT static Standard_Boolean EnLargeFace (const TopoDS_Face& F, TopoDS_Face& NF, const Standard_Boolean ChangeGeom, const Standard_Boolean UpDatePCurve = Standard_False, const Standard_Boolean enlargeU = Standard_True, const Standard_Boolean enlargeVfirst = Standard_True, const Standard_Boolean enlargeVlast = Standard_True);
96   
97   Standard_EXPORT static void ExtentFace (const TopoDS_Face& F, TopTools_DataMapOfShapeShape& ConstShapes, TopTools_DataMapOfShapeShape& ToBuild, const TopAbs_State Side, const Standard_Real TolConf, TopoDS_Face& NF);
98   
99   //! Via the wire explorer store in <NOnV1> for
100   //! an Edge <E> of <W> his Edge neighbour on the first
101   //! vertex <V1> of <E>.
102   //! Store in NOnV2 the Neighbour of <E>on the last
103   //! vertex <V2> of <E>.
104   Standard_EXPORT static void BuildNeighbour (const TopoDS_Wire& W, const TopoDS_Face& F, TopTools_DataMapOfShapeShape& NOnV1, TopTools_DataMapOfShapeShape& NOnV2);
105   
106   //! Store in MVE for a vertex <V>  in <S> the incident
107   //! edges <E> in <S>.
108   //! An Edge is Store only one Time for a vertex.
109   Standard_EXPORT static void MapVertexEdges (const TopoDS_Shape& S, TopTools_DataMapOfShapeListOfShape& MVE);
110   
111   //! Remove the non valid   part of an offsetshape
112   //! 1 - Remove all the free boundary  and the faces
113   //! connex to such edges.
114   //! 2 - Remove all the shapes not  valid in the result
115   //! (according to the side of offseting)
116   //! in this verion only the first point is implemented.
117   Standard_EXPORT static TopoDS_Shape Deboucle3D (const TopoDS_Shape& S, const TopTools_MapOfShape& Boundary);
118   
119   Standard_EXPORT static void CorrectOrientation (const TopoDS_Shape& SI, const TopTools_IndexedMapOfShape& NewEdges, Handle(BRepAlgo_AsDes)& AsDes, BRepAlgo_Image& InitOffset, const Standard_Real Offset);
120   
121   Standard_EXPORT static Standard_Real Gabarit (const Handle(Geom_Curve)& aCurve);
122
123
124
125
126 protected:
127
128
129
130
131
132 private:
133
134
135
136
137
138 };
139
140
141
142
143
144
145
146 #endif // _BRepOffset_Tool_HeaderFile