8873a0718473e1311fca3a79f6ffe80803a7b790
[occt.git] / src / BRepClass3d / BRepClass3d_SolidExplorer.hxx
1 // Created on: 1994-03-10
2 // Created by: Laurent BUCHARD
3 // Copyright (c) 1994-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 _BRepClass3d_SolidExplorer_HeaderFile
18 #define _BRepClass3d_SolidExplorer_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_DefineAlloc.hxx>
22 #include <Standard_Handle.hxx>
23
24 #include <Bnd_Box.hxx>
25 #include <TopoDS_Shape.hxx>
26 #include <Standard_Boolean.hxx>
27 #include <Standard_Integer.hxx>
28 #include <Standard_Real.hxx>
29 #include <TopExp_Explorer.hxx>
30 #include <BRepClass3d_MapOfInter.hxx>
31 #include <TopAbs_State.hxx>
32 class TopoDS_Shape;
33 class gp_Pnt;
34 class TopoDS_Face;
35 class gp_Vec;
36 class BRepAdaptor_HSurface;
37 class TopoDS_Shell;
38 class gp_Lin;
39 class Bnd_Box;
40 class IntCurvesFace_Intersector;
41
42
43 //! Provide an   exploration of a  BRep Shape   for the
44 //! classification.
45 class BRepClass3d_SolidExplorer 
46 {
47 public:
48
49   DEFINE_STANDARD_ALLOC
50
51   
52   Standard_EXPORT BRepClass3d_SolidExplorer();
53   
54   //! Raise if called.
55   Standard_EXPORT BRepClass3d_SolidExplorer(const BRepClass3d_SolidExplorer& Oth);
56   
57   Standard_EXPORT BRepClass3d_SolidExplorer(const TopoDS_Shape& S);
58   
59   Standard_EXPORT virtual void Delete();
60 Standard_EXPORT virtual ~BRepClass3d_SolidExplorer(){Destroy() ; }
61   
62   Standard_EXPORT void InitShape (const TopoDS_Shape& S);
63   
64   //! Should return True if P outside of bounding vol. of the shape
65   Standard_EXPORT virtual Standard_Boolean Reject (const gp_Pnt& P) const;
66   
67   //! compute a point P in the face  F. Param is a Real in
68   //! ]0,1[ and   is  used to  initialise  the algorithm. For
69   //! different values , different points are returned.
70   Standard_EXPORT static Standard_Boolean FindAPointInTheFace (const TopoDS_Face& F, gp_Pnt& P, Standard_Real& Param);
71   
72   Standard_EXPORT static Standard_Boolean FindAPointInTheFace (const TopoDS_Face& F, gp_Pnt& P, Standard_Real& u, Standard_Real& v, Standard_Real& Param);
73   
74   Standard_EXPORT static Standard_Boolean FindAPointInTheFace (const TopoDS_Face& F, gp_Pnt& P, Standard_Real& u, Standard_Real& v, Standard_Real& Param, gp_Vec& theVecD1U, gp_Vec& theVecD1V);
75   
76   Standard_EXPORT static Standard_Boolean FindAPointInTheFace (const TopoDS_Face& F, gp_Pnt& P, Standard_Real& u, Standard_Real& v);
77   
78   Standard_EXPORT static Standard_Boolean FindAPointInTheFace (const TopoDS_Face& F, gp_Pnt& P);
79   
80   Standard_EXPORT static Standard_Boolean FindAPointInTheFace (const TopoDS_Face& F, Standard_Real& u, Standard_Real& v);
81   
82   Standard_EXPORT Standard_Boolean PointInTheFace (const TopoDS_Face& F, gp_Pnt& P, Standard_Real& u, Standard_Real& v, Standard_Real& Param, Standard_Integer& Index) const;
83   
84   Standard_EXPORT Standard_Boolean PointInTheFace (const TopoDS_Face& F, gp_Pnt& P, Standard_Real& u, Standard_Real& v, Standard_Real& Param, Standard_Integer& Index, const Handle(BRepAdaptor_HSurface)& surf, const Standard_Real u1, const Standard_Real v1, const Standard_Real u2, const Standard_Real v2) const;
85   
86   //! <Index> gives point index  to  search from and returns
87   //! point index of succeseful search
88   Standard_EXPORT Standard_Boolean PointInTheFace (const TopoDS_Face& F, gp_Pnt& P, Standard_Real& u, Standard_Real& v, Standard_Real& Param, Standard_Integer& Index, const Handle(BRepAdaptor_HSurface)& surf, const Standard_Real u1, const Standard_Real v1, const Standard_Real u2, const Standard_Real v2, gp_Vec& theVecD1U, gp_Vec& theVecD1V) const;
89   
90   //! Starts an exploration of the shells.
91   Standard_EXPORT void InitShell();
92   
93   //! Returns True if there is a current shell.
94   Standard_EXPORT Standard_Boolean MoreShell() const;
95   
96   //! Sets the explorer to the next shell.
97   Standard_EXPORT void NextShell();
98   
99   //! Returns the current shell.
100   Standard_EXPORT TopoDS_Shell CurrentShell() const;
101   
102   //! Returns True if the Shell is rejected.
103   Standard_EXPORT virtual Standard_Boolean RejectShell (const gp_Lin& L) const;
104   
105   //! Starts an exploration of the faces of the current shell.
106   Standard_EXPORT void InitFace();
107   
108   //! Returns True if current face in current shell.
109   Standard_EXPORT Standard_Boolean MoreFace() const;
110   
111   //! Sets the explorer to the next Face of the current shell.
112   Standard_EXPORT void NextFace();
113   
114   //! Returns the current face.
115   Standard_EXPORT TopoDS_Face CurrentFace() const;
116   
117   //! returns True if the face is rejected.
118   Standard_EXPORT virtual Standard_Boolean RejectFace (const gp_Lin& L) const;
119   
120   //! Returns  in <L>, <Par>  a segment having at least
121   //! one  intersection  with  the  shape  boundary  to
122   //! compute  intersections.
123   Standard_EXPORT Standard_Integer Segment (const gp_Pnt& P, gp_Lin& L, Standard_Real& Par);
124   
125   //! Returns  in <L>, <Par>  a segment having at least
126   //! one  intersection  with  the  shape  boundary  to
127   //! compute  intersections.
128   //!
129   //! The First Call to this method returns a line which
130   //! point to a point of the first face of the shape.
131   //! The Second Call provide a line to the second face
132   //! and so on.
133   Standard_EXPORT Standard_Integer OtherSegment (const gp_Pnt& P, gp_Lin& L, Standard_Real& Par);
134   
135   //! Returns the index of face for which
136   //! last segment is calculated.
137   Standard_EXPORT Standard_Integer GetFaceSegmentIndex() const;
138   
139   Standard_EXPORT virtual void DumpSegment (const gp_Pnt& P, const gp_Lin& L, const Standard_Real Par, const TopAbs_State S) const;
140   
141   Standard_EXPORT const Bnd_Box& Box() const;
142   
143   Standard_EXPORT IntCurvesFace_Intersector& Intersector (const TopoDS_Face& F) const;
144   
145   Standard_EXPORT void Destroy();
146
147
148
149
150 protected:
151
152
153
154
155
156 private:
157
158
159
160   Bnd_Box myBox;
161   TopoDS_Shape myShape;
162   Standard_Boolean myReject;
163   Standard_Integer myFirstFace;
164   Standard_Real myParamOnEdge;
165   TopExp_Explorer myShellExplorer;
166   TopExp_Explorer myFaceExplorer;
167   BRepClass3d_MapOfInter myMapOfInter;
168
169
170 };
171
172
173
174
175
176
177
178 #endif // _BRepClass3d_SolidExplorer_HeaderFile