0024002: Overall code and build procedure refactoring -- automatic
[occt.git] / src / BRepFeat / BRepFeat_RibSlot.hxx
1 // Created on: 1997-10-08
2 // Created by: Olga KOULECHOVA
3 // Copyright (c) 1997-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 _BRepFeat_RibSlot_HeaderFile
18 #define _BRepFeat_RibSlot_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_DefineAlloc.hxx>
22 #include <Standard_Handle.hxx>
23
24 #include <gp_Pnt.hxx>
25 #include <Standard_Boolean.hxx>
26 #include <TopTools_DataMapOfShapeListOfShape.hxx>
27 #include <TopoDS_Shape.hxx>
28 #include <BRepFeat_PerfSelection.hxx>
29 #include <TopoDS_Wire.hxx>
30 #include <TopoDS_Face.hxx>
31 #include <TopTools_DataMapOfShapeShape.hxx>
32 #include <TopTools_ListOfShape.hxx>
33 #include <BRepFeat_StatusError.hxx>
34 #include <BRepBuilderAPI_MakeShape.hxx>
35 #include <Standard_Real.hxx>
36 #include <Standard_Integer.hxx>
37 class TopoDS_Shape;
38 class gp_Pnt;
39 class TopoDS_Edge;
40 class Geom_Plane;
41 class gp_Dir;
42 class TopoDS_Face;
43 class Geom_Curve;
44 class TopoDS_Vertex;
45 class LocOpe_Gluer;
46 class TopOpeBRepBuild_HBuilder;
47 class BRepAlgoAPI_BooleanOperation;
48
49
50 //! Provides functions to build mechanical features.
51 //! Mechanical features include ribs - protrusions and grooves (or slots) - depressions along
52 //! planar (linear) surfaces or revolution surfaces. The semantics of mechanical features is built
53 //! around giving thickness to a contour. This thickness can either be unilateral - on one side
54 //! of the contour - or bilateral - on both sides.
55 //! As in the semantics of form features, the thickness is defined by construction of shapes
56 //! in specific contexts. The development contexts differ, however,in case of mechanical features.
57 //! Here they include extrusion:
58 //! -   to a limiting face of the basis shape
59 //! -   to or from a limiting plane
60 //! -   to a height.
61 class BRepFeat_RibSlot  : public BRepBuilderAPI_MakeShape
62 {
63 public:
64
65   DEFINE_STANDARD_ALLOC
66
67   
68   //! Returns true if F a TopoDS_Shape of type edge or face has been deleted.
69   Standard_EXPORT virtual Standard_Boolean IsDeleted (const TopoDS_Shape& F) Standard_OVERRIDE;
70   
71   //! Returns the list of generated Faces F. This list may be empty.
72   Standard_EXPORT virtual const TopTools_ListOfShape& Modified (const TopoDS_Shape& F) Standard_OVERRIDE;
73   
74   //! Returns a list TopTools_ListOfShape of the faces S created in the shape.
75   Standard_EXPORT virtual const TopTools_ListOfShape& Generated (const TopoDS_Shape& S) Standard_OVERRIDE;
76   
77   //! Returns the list  of shapes created  at the bottom  of
78   //! the created form.  It may be an empty list.
79   Standard_EXPORT const TopTools_ListOfShape& FirstShape() const;
80   
81   //! Returns  the list of shapes  created at the top of the
82   //! created form.  It may be an empty list.
83   Standard_EXPORT const TopTools_ListOfShape& LastShape() const;
84   
85   //! Returns a list of the limiting and glueing faces
86   //! generated by the feature. These faces did not originally exist in the basis shape.
87   //! The list provides the information necessary for
88   //! subsequent addition of a draft to a face. It may be an empty list.
89   //! If a face has tangent edges, no draft is possible, and the tangent edges must
90   //! subsequently be removed if you want to add a draft to the face.
91   Standard_EXPORT const TopTools_ListOfShape& FacesForDraft() const;
92   
93   //! Returns a list of the limiting and glueing edges
94   //! generated by the feature. These edges did not originally exist in the basis shape.
95   //! The list provides the information necessary for
96   //! subsequent addition of fillets. It may be an empty list.
97   Standard_EXPORT const TopTools_ListOfShape& NewEdges() const;
98   
99   //! Returns a list of the tangent edges among the
100   //! limiting and glueing edges generated by the
101   //! feature. These edges did not originally exist in
102   //! the basis shape and are tangent to the face
103   //! against which the feature is built.
104   //! The list provides the information necessary for
105   //! subsequent addition of fillets. It may be an empty list.
106   //! If an edge is tangent, no fillet is possible, and
107   //! the edge must subsequently be removed if you want to add a fillet.
108   Standard_EXPORT const TopTools_ListOfShape& TgtEdges() const;
109   
110   Standard_EXPORT static Standard_Real IntPar (const Handle(Geom_Curve)& C, const gp_Pnt& P);
111   
112   Standard_EXPORT static TopoDS_Face ChoiceOfFaces (TopTools_ListOfShape& faces, const Handle(Geom_Curve)& cc, const Standard_Real par, const Standard_Real bnd, const Handle(Geom_Plane)& Pln);
113   
114   Standard_EXPORT BRepFeat_StatusError CurrentStatusError() const;
115
116
117
118
119 protected:
120
121   
122   //! Redefines the empty constructor.
123     BRepFeat_RibSlot();
124   
125   //! General perform method...
126   Standard_EXPORT void LFPerform();
127   
128   Standard_EXPORT gp_Pnt CheckPoint (const TopoDS_Edge& e, const Standard_Real bnd, const Handle(Geom_Plane)& Pln);
129   
130   Standard_EXPORT gp_Dir Normal (const TopoDS_Face& F, const gp_Pnt& P);
131   
132   Standard_EXPORT void EdgeExtention (TopoDS_Edge& e, const Standard_Real bnd, const Standard_Boolean FirstLast);
133   
134   Standard_EXPORT Standard_Real HeightMax (const TopoDS_Shape& theSbase, const TopoDS_Shape& theSUntil, gp_Pnt& p1, gp_Pnt& p2);
135   
136   Standard_EXPORT Standard_Boolean ExtremeFaces (const Standard_Boolean RevolRib, const Standard_Real bnd, const Handle(Geom_Plane)& Pln, TopoDS_Edge& FirstEdge, TopoDS_Edge& LastEdge, TopoDS_Face& FirstFace, TopoDS_Face& LastFace, TopoDS_Vertex& FirstVertex, TopoDS_Vertex& LastVertex, Standard_Boolean& OnFirstFace, Standard_Boolean& OnLastFace, Standard_Boolean& PtOnFirstEdge, Standard_Boolean& PtOnLastEdge, TopoDS_Edge& OnFirstEdge, TopoDS_Edge& OnLastEdge);
137   
138   Standard_EXPORT void PtOnEdgeVertex (const Standard_Boolean RevolRib, const TopoDS_Shape& shape, const gp_Pnt& point, const TopoDS_Vertex& FirstVertex, const TopoDS_Vertex& LastVertex, Standard_Boolean& PtOnEdge, TopoDS_Edge& OnEdge, Standard_Boolean& PtOnVertex, TopoDS_Vertex& OnVertex);
139   
140   Standard_EXPORT Standard_Boolean SlidingProfile (TopoDS_Face& Prof, const Standard_Boolean RevolRib, const Standard_Real myTol, Standard_Integer& Concavite, const Handle(Geom_Plane)& myPln, const TopoDS_Face& BndFace, const gp_Pnt& CheckPnt, const TopoDS_Face& FirstFace, const TopoDS_Face& LastFace, const TopoDS_Vertex& FirstVertex, const TopoDS_Vertex& LastVertex, const TopoDS_Edge& FirstEdge, const TopoDS_Edge& LastEdge);
141   
142   Standard_EXPORT Standard_Boolean NoSlidingProfile (TopoDS_Face& Prof, const Standard_Boolean RevolRib, const Standard_Real myTol, Standard_Integer& Concavite, const Handle(Geom_Plane)& myPln, const Standard_Real bnd, const TopoDS_Face& BndFace, const gp_Pnt& CheckPnt, const TopoDS_Face& FirstFace, const TopoDS_Face& LastFace, const TopoDS_Vertex& FirstVertex, const TopoDS_Vertex& LastVertex, const TopoDS_Edge& FirstEdge, const TopoDS_Edge& LastEdge, const Standard_Boolean OnFirstFace, const Standard_Boolean OnLastFace);
143   
144   //! Updates the data structures of descendant
145   //! shapes during the glueing operation.Returns the modified, generated
146   //! and deleted faces during the course of the glueing operation.
147   Standard_EXPORT void UpdateDescendants (const LocOpe_Gluer& G);
148   
149   Standard_EXPORT void UpdateDescendants (const Handle(TopOpeBRepBuild_HBuilder)& B, const TopoDS_Shape& SResult, const Standard_Boolean SkipFace = Standard_False);
150   
151   Standard_EXPORT void UpdateDescendants (const BRepAlgoAPI_BooleanOperation& aBOP, const TopoDS_Shape& SResult, const Standard_Boolean SkipFace = Standard_False);
152
153
154   gp_Pnt myFirstPnt;
155   gp_Pnt myLastPnt;
156   Standard_Boolean myFuse;
157   Standard_Boolean mySliding;
158   TopTools_DataMapOfShapeListOfShape myMap;
159   TopTools_DataMapOfShapeListOfShape myLFMap;
160   TopoDS_Shape myFShape;
161   TopoDS_Shape myLShape;
162   BRepFeat_PerfSelection myPerfSelection;
163   TopoDS_Wire myWire;
164   TopoDS_Shape mySbase;
165   TopoDS_Face mySkface;
166   TopoDS_Face myPbase;
167   TopoDS_Shape myGShape;
168   TopoDS_Shape mySUntil;
169   TopTools_DataMapOfShapeShape myGluedF;
170   TopTools_ListOfShape myNewEdges;
171   TopTools_ListOfShape myTgtEdges;
172   TopTools_ListOfShape myFacesForDraft;
173   BRepFeat_StatusError myStatusError;
174
175
176 private:
177
178
179
180
181
182 };
183
184
185 #include <BRepFeat_RibSlot.lxx>
186
187
188
189
190
191 #endif // _BRepFeat_RibSlot_HeaderFile