0032539: Modeling Algorithms - Parallelize BRepExtrema_DistShapeShape algorithm
[occt.git] / src / BRepExtrema / BRepExtrema_DistShapeShape.hxx
index 8b3450e..67269db 100644 (file)
@@ -14,7 +14,7 @@
 #ifndef _BRepExtrema_DistShapeShape_HeaderFile
 #define _BRepExtrema_DistShapeShape_HeaderFile
 
-#include <Bnd_SeqOfBox.hxx>
+#include <Bnd_Array1OfBox.hxx>
 #include <BRepExtrema_SeqOfSolution.hxx>
 #include <BRepExtrema_SolutionElem.hxx>
 #include <BRepExtrema_SupportType.hxx>
 #include <Standard_DefineAlloc.hxx>
 #include <TopTools_IndexedMapOfShape.hxx>
 
-//! This class  provides tools to compute minimum distance <br>
-//! between two Shapes (Compound,CompSolid, Solid, Shell, Face, Wire, Edge, Vertex). <br>
+//! This class  provides tools to compute minimum distance 
+//! between two Shapes (Compound,CompSolid, Solid, Shell, Face, Wire, Edge, Vertex).
 class BRepExtrema_DistShapeShape
 {
  public:
 
   DEFINE_STANDARD_ALLOC
 
-  //! create empty tool <br>
+  //! create empty tool
   Standard_EXPORT BRepExtrema_DistShapeShape();
-  //! computation of the minimum distance (value and pair of points) using default deflection <br>
-  //! Default value is Precision::Confusion(). <br>
+
+  //! create tool and computation of the minimum distance (value and pair of points) 
+  //! using default deflection in single thread mode. <br>
+  //! Default deflection value is Precision::Confusion(). <br>
+  //! @param Shape1 - the first shape for distance computation
+  //! @param Shape2 - the second shape for distance computation
+  //! @param F and @param A are not used in computation and are obsolete.
+  //! @param theRange - the progress indicator of algorithm
   Standard_EXPORT BRepExtrema_DistShapeShape(const TopoDS_Shape& Shape1,
                                              const TopoDS_Shape& Shape2,
                                              const Extrema_ExtFlag F = Extrema_ExtFlag_MINMAX,
                                              const Extrema_ExtAlgo A = Extrema_ExtAlgo_Grad,
                                              const Message_ProgressRange& theRange = Message_ProgressRange());
-  //! create tool and load both shapes into it <br>
+  //! create tool and computation of the minimum distance 
+  //! (value and pair of points) in single thread mode. <br>
+  //! Default deflection value is Precision::Confusion(). <br>
+  //! @param Shape1 - the first shape for distance computation
+  //! @param Shape2 - the second shape for distance computation
+  //! @param theDeflection - the presition of distance computation
+  //! @param F and @param A are not used in computation and are obsolete.
+  //! @param theRange - the progress indicator of algorithm
   Standard_EXPORT BRepExtrema_DistShapeShape(const TopoDS_Shape& Shape1,
                                              const TopoDS_Shape& Shape2,
                                              const Standard_Real theDeflection,
@@ -53,49 +66,60 @@ class BRepExtrema_DistShapeShape
                                              const Extrema_ExtAlgo A = Extrema_ExtAlgo_Grad,
                                              const Message_ProgressRange& theRange = Message_ProgressRange());
   
+  //! Sets deflection to computation of the minimum distance <br>
   void SetDeflection(const Standard_Real theDeflection)
   {
     myEps = theDeflection;
   }
+
   //! load first shape into extrema <br>
   Standard_EXPORT void LoadS1(const TopoDS_Shape& Shape1);
+
   //! load second shape into extrema <br>
   Standard_EXPORT void LoadS2(const TopoDS_Shape& Shape1);
+
   //! computation of  the minimum  distance  (value  and <br>
   //!          couple  of points). Parameter theDeflection is used <br>
   //!          to specify a maximum deviation of extreme distances <br>
   //!          from the minimum one. <br>
   //!          Returns IsDone status. <br>
-  //! theProgress - progress indicator of algorithm
+  //! theRange - the progress indicator of algorithm
   Standard_EXPORT Standard_Boolean Perform(const Message_ProgressRange& theRange = Message_ProgressRange());
+
   //! True if the minimum distance is found. <br>
   Standard_Boolean IsDone() const
   { 
     return myIsDone;
   }
+
   //! Returns the number of solutions satisfying the minimum distance. <br>
   Standard_Integer NbSolution() const
   { 
     return mySolutionsShape1.Length();
   }
+
   //! Returns the value of the minimum distance. <br>
   Standard_EXPORT Standard_Real Value() const;
+
   //! True if one of the shapes is a solid and the other shape <br>
   //! is completely or partially inside the solid. <br>
   Standard_Boolean InnerSolution() const
   { 
     return myInnerSol;
   }
+
   //! Returns the Point corresponding to the <N>th solution on the first Shape <br>
   const gp_Pnt & PointOnShape1(const Standard_Integer N) const
   { 
     return mySolutionsShape1.Value(N).Point();
   }
+
   //! Returns the Point corresponding to the <N>th solution on the second Shape <br>
   const gp_Pnt & PointOnShape2(const Standard_Integer N) const
   { 
     return mySolutionsShape2.Value(N).Point();
   }
+
   //! gives the type of the support where the Nth solution on the first shape is situated: <br>
   //!   IsVertex => the Nth solution on the first shape is a Vertex <br>
   //!   IsOnEdge => the Nth soluion on the first shape is on a Edge <br>
@@ -105,6 +129,7 @@ class BRepExtrema_DistShapeShape
   { 
     return mySolutionsShape1.Value(N).SupportKind();
   }
+
   //! gives the type of the support where the Nth solution on the second shape is situated: <br>
   //!   IsVertex => the Nth solution on the second shape is a Vertex <br>
   //!   IsOnEdge => the Nth soluion on the secondt shape is on a Edge <br>
@@ -114,44 +139,68 @@ class BRepExtrema_DistShapeShape
   { 
     return mySolutionsShape2.Value(N).SupportKind();
   }
+
   //! gives the support where the Nth solution on the first shape is situated. <br>
   //! This support can be a Vertex, an Edge or a Face. <br>
   Standard_EXPORT TopoDS_Shape SupportOnShape1(const Standard_Integer N) const;
+
   //! gives the support where the Nth solution on the second shape is situated. <br>
   //! This support can be a Vertex, an Edge or a Face. <br>
   Standard_EXPORT TopoDS_Shape SupportOnShape2(const Standard_Integer N) const;
+
   //! gives the corresponding parameter t if the Nth solution <br>
   //! is situated on an Edge of the first shape <br>
   Standard_EXPORT void ParOnEdgeS1(const Standard_Integer N,Standard_Real& t) const;
+
   //! gives the corresponding parameter t if the Nth solution <br>
   //! is situated on an Edge of the first shape <br>
   Standard_EXPORT void ParOnEdgeS2(const Standard_Integer N,Standard_Real& t) const;
+
   //! gives the corresponding parameters (U,V) if the Nth solution <br>
   //! is situated on an face of the first shape <br>
   Standard_EXPORT void ParOnFaceS1(const Standard_Integer N,Standard_Real& u,Standard_Real& v) const;
+
   //! gives the corresponding parameters (U,V) if the Nth solution <br>
   //! is situated on an Face of the second shape <br>
   Standard_EXPORT void ParOnFaceS2(const Standard_Integer N,Standard_Real& u,Standard_Real& v) const;
+
   //! Prints on the stream o information on the current state of the object. <br>
   Standard_EXPORT void Dump(Standard_OStream& o) const;
 
+  //! Sets unused parameter
+  //! Obsolete 
   void SetFlag(const Extrema_ExtFlag F)
   {
     myFlag = F;
   }
 
+  //! Sets unused parameter
+  //! Obsolete 
   void SetAlgo(const Extrema_ExtAlgo A)
   {
     myAlgo = A;
   }
 
+  //! If isMultiThread == Standard_True then computation will be performed in parallel.
+  void SetMultiThread(Standard_Boolean theIsMultiThread)
+  {
+    myIsMultiThread = theIsMultiThread;
+  }
+
+  //! Returns Standard_True then computation will be performed in parallel
+  //! Default value is Standard_False
+  Standard_Boolean IsMultiThread() const
+  {
+    return myIsMultiThread;
+  }
+
 private:
 
   //! computes the minimum distance between two maps of shapes (Face,Edge,Vertex) <br>
   Standard_Boolean DistanceMapMap(const TopTools_IndexedMapOfShape& Map1,
                                   const TopTools_IndexedMapOfShape& Map2,
-                                  const Bnd_SeqOfBox&               LBox1,
-                                  const Bnd_SeqOfBox&               LBox2,
+                                  const Bnd_Array1OfBox&            LBox1,
+                                  const Bnd_Array1OfBox&            LBox2,
                                   const Message_ProgressRange&      theRange);
 
   //! computes the minimum distance between two maps of vertices <br>
@@ -183,12 +232,13 @@ private:
   Standard_Boolean myIsInitS2;
   Extrema_ExtFlag myFlag;
   Extrema_ExtAlgo myAlgo;
-  Bnd_SeqOfBox myBV1;
-  Bnd_SeqOfBox myBV2;
-  Bnd_SeqOfBox myBE1;
-  Bnd_SeqOfBox myBE2;
-  Bnd_SeqOfBox myBF1;
-  Bnd_SeqOfBox myBF2;
+  Bnd_Array1OfBox myBV1;
+  Bnd_Array1OfBox myBV2;
+  Bnd_Array1OfBox myBE1;
+  Bnd_Array1OfBox myBE2;
+  Bnd_Array1OfBox myBF1;
+  Bnd_Array1OfBox myBF2;
+  Standard_Boolean myIsMultiThread;
 };
 
 #endif