8b3450e0745e691fc0e13ff076627c4a5bef7baa
[occt.git] / src / BRepExtrema / BRepExtrema_DistShapeShape.hxx
1 // Copyright (c) 1999-2014 OPEN CASCADE SAS
2 //
3 // This file is part of Open CASCADE Technology software library.
4 //
5 // This library is free software; you can redistribute it and/or modify it under
6 // the terms of the GNU Lesser General Public License version 2.1 as published
7 // by the Free Software Foundation, with special exception defined in the file
8 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
9 // distribution for complete text of the license and disclaimer of any warranty.
10 //
11 // Alternatively, this file may be used under the terms of Open CASCADE
12 // commercial license or contractual agreement.
13
14 #ifndef _BRepExtrema_DistShapeShape_HeaderFile
15 #define _BRepExtrema_DistShapeShape_HeaderFile
16
17 #include <Bnd_SeqOfBox.hxx>
18 #include <BRepExtrema_SeqOfSolution.hxx>
19 #include <BRepExtrema_SolutionElem.hxx>
20 #include <BRepExtrema_SupportType.hxx>
21 #include <Extrema_ExtAlgo.hxx>
22 #include <Extrema_ExtFlag.hxx>
23 #include <gp_Pnt.hxx>
24 #include <Message_ProgressRange.hxx>
25 #include <TopoDS_Shape.hxx>
26 #include <TopTools_IndexedMapOfShape.hxx>
27 #include <Standard_OStream.hxx>
28 #include <Standard_DefineAlloc.hxx>
29 #include <TopTools_IndexedMapOfShape.hxx>
30
31 //! This class  provides tools to compute minimum distance <br>
32 //! between two Shapes (Compound,CompSolid, Solid, Shell, Face, Wire, Edge, Vertex). <br>
33 class BRepExtrema_DistShapeShape
34 {
35  public:
36
37   DEFINE_STANDARD_ALLOC
38
39   //! create empty tool <br>
40   Standard_EXPORT BRepExtrema_DistShapeShape();
41   //! computation of the minimum distance (value and pair of points) using default deflection <br>
42   //! Default value is Precision::Confusion(). <br>
43   Standard_EXPORT BRepExtrema_DistShapeShape(const TopoDS_Shape& Shape1,
44                                              const TopoDS_Shape& Shape2,
45                                              const Extrema_ExtFlag F = Extrema_ExtFlag_MINMAX,
46                                              const Extrema_ExtAlgo A = Extrema_ExtAlgo_Grad,
47                                              const Message_ProgressRange& theRange = Message_ProgressRange());
48   //! create tool and load both shapes into it <br>
49   Standard_EXPORT BRepExtrema_DistShapeShape(const TopoDS_Shape& Shape1,
50                                              const TopoDS_Shape& Shape2,
51                                              const Standard_Real theDeflection,
52                                              const Extrema_ExtFlag F = Extrema_ExtFlag_MINMAX,
53                                              const Extrema_ExtAlgo A = Extrema_ExtAlgo_Grad,
54                                              const Message_ProgressRange& theRange = Message_ProgressRange());
55   
56   void SetDeflection(const Standard_Real theDeflection)
57   {
58     myEps = theDeflection;
59   }
60   //! load first shape into extrema <br>
61   Standard_EXPORT void LoadS1(const TopoDS_Shape& Shape1);
62   //! load second shape into extrema <br>
63   Standard_EXPORT void LoadS2(const TopoDS_Shape& Shape1);
64   //! computation of  the minimum  distance  (value  and <br>
65   //!          couple  of points). Parameter theDeflection is used <br>
66   //!          to specify a maximum deviation of extreme distances <br>
67   //!          from the minimum one. <br>
68   //!          Returns IsDone status. <br>
69   //! theProgress - progress indicator of algorithm
70   Standard_EXPORT Standard_Boolean Perform(const Message_ProgressRange& theRange = Message_ProgressRange());
71   //! True if the minimum distance is found. <br>
72   Standard_Boolean IsDone() const
73   { 
74     return myIsDone;
75   }
76   //! Returns the number of solutions satisfying the minimum distance. <br>
77   Standard_Integer NbSolution() const
78   { 
79     return mySolutionsShape1.Length();
80   }
81   //! Returns the value of the minimum distance. <br>
82   Standard_EXPORT Standard_Real Value() const;
83   //! True if one of the shapes is a solid and the other shape <br>
84   //! is completely or partially inside the solid. <br>
85   Standard_Boolean InnerSolution() const
86   { 
87     return myInnerSol;
88   }
89   //! Returns the Point corresponding to the <N>th solution on the first Shape <br>
90   const gp_Pnt & PointOnShape1(const Standard_Integer N) const
91   { 
92     return mySolutionsShape1.Value(N).Point();
93   }
94   //! Returns the Point corresponding to the <N>th solution on the second Shape <br>
95   const gp_Pnt & PointOnShape2(const Standard_Integer N) const
96   { 
97     return mySolutionsShape2.Value(N).Point();
98   }
99   //! gives the type of the support where the Nth solution on the first shape is situated: <br>
100   //!   IsVertex => the Nth solution on the first shape is a Vertex <br>
101   //!   IsOnEdge => the Nth soluion on the first shape is on a Edge <br>
102   //!   IsInFace => the Nth solution on the first shape is inside a face <br>
103   //! the corresponding support is obtained by the method SupportOnShape1 <br>
104   BRepExtrema_SupportType SupportTypeShape1(const Standard_Integer N) const
105   { 
106     return mySolutionsShape1.Value(N).SupportKind();
107   }
108   //! gives the type of the support where the Nth solution on the second shape is situated: <br>
109   //!   IsVertex => the Nth solution on the second shape is a Vertex <br>
110   //!   IsOnEdge => the Nth soluion on the secondt shape is on a Edge <br>
111   //!   IsInFace => the Nth solution on the second shape is inside a face <br>
112   //! the corresponding support is obtained by the method SupportOnShape2 <br>
113   BRepExtrema_SupportType SupportTypeShape2(const Standard_Integer N) const
114   { 
115     return mySolutionsShape2.Value(N).SupportKind();
116   }
117   //! gives the support where the Nth solution on the first shape is situated. <br>
118   //! This support can be a Vertex, an Edge or a Face. <br>
119   Standard_EXPORT TopoDS_Shape SupportOnShape1(const Standard_Integer N) const;
120   //! gives the support where the Nth solution on the second shape is situated. <br>
121   //! This support can be a Vertex, an Edge or a Face. <br>
122   Standard_EXPORT TopoDS_Shape SupportOnShape2(const Standard_Integer N) const;
123   //! gives the corresponding parameter t if the Nth solution <br>
124   //! is situated on an Edge of the first shape <br>
125   Standard_EXPORT void ParOnEdgeS1(const Standard_Integer N,Standard_Real& t) const;
126   //! gives the corresponding parameter t if the Nth solution <br>
127   //! is situated on an Edge of the first shape <br>
128   Standard_EXPORT void ParOnEdgeS2(const Standard_Integer N,Standard_Real& t) const;
129   //! gives the corresponding parameters (U,V) if the Nth solution <br>
130   //! is situated on an face of the first shape <br>
131   Standard_EXPORT void ParOnFaceS1(const Standard_Integer N,Standard_Real& u,Standard_Real& v) const;
132   //! gives the corresponding parameters (U,V) if the Nth solution <br>
133   //! is situated on an Face of the second shape <br>
134   Standard_EXPORT void ParOnFaceS2(const Standard_Integer N,Standard_Real& u,Standard_Real& v) const;
135   //! Prints on the stream o information on the current state of the object. <br>
136   Standard_EXPORT void Dump(Standard_OStream& o) const;
137
138   void SetFlag(const Extrema_ExtFlag F)
139   {
140     myFlag = F;
141   }
142
143   void SetAlgo(const Extrema_ExtAlgo A)
144   {
145     myAlgo = A;
146   }
147
148 private:
149
150   //! computes the minimum distance between two maps of shapes (Face,Edge,Vertex) <br>
151   Standard_Boolean DistanceMapMap(const TopTools_IndexedMapOfShape& Map1,
152                                   const TopTools_IndexedMapOfShape& Map2,
153                                   const Bnd_SeqOfBox&               LBox1,
154                                   const Bnd_SeqOfBox&               LBox2,
155                                   const Message_ProgressRange&      theRange);
156
157   //! computes the minimum distance between two maps of vertices <br>
158   Standard_Boolean DistanceVertVert(const TopTools_IndexedMapOfShape& theMap1,
159                                     const TopTools_IndexedMapOfShape& theMap2,
160                                     const Message_ProgressRange& theRange);
161
162   Standard_Boolean SolidTreatment(const TopoDS_Shape& theShape,
163                                   const TopTools_IndexedMapOfShape& theMap,
164                                   const Message_ProgressRange& theRange);
165
166 private:
167
168   Standard_Real myDistRef;
169   Standard_Boolean myIsDone;
170   BRepExtrema_SeqOfSolution mySolutionsShape1;
171   BRepExtrema_SeqOfSolution mySolutionsShape2;
172   Standard_Boolean myInnerSol;
173   Standard_Real myEps;
174   TopoDS_Shape myShape1;
175   TopoDS_Shape myShape2;
176   TopTools_IndexedMapOfShape myMapV1;
177   TopTools_IndexedMapOfShape myMapV2;
178   TopTools_IndexedMapOfShape myMapE1;
179   TopTools_IndexedMapOfShape myMapE2;
180   TopTools_IndexedMapOfShape myMapF1;
181   TopTools_IndexedMapOfShape myMapF2;
182   Standard_Boolean myIsInitS1;
183   Standard_Boolean myIsInitS2;
184   Extrema_ExtFlag myFlag;
185   Extrema_ExtAlgo myAlgo;
186   Bnd_SeqOfBox myBV1;
187   Bnd_SeqOfBox myBV2;
188   Bnd_SeqOfBox myBE1;
189   Bnd_SeqOfBox myBE2;
190   Bnd_SeqOfBox myBF1;
191   Bnd_SeqOfBox myBF2;
192 };
193
194 #endif