Minimize external dependencies: libxml2 is only needed locally for XAO package

[modules/geom.git] / src / GEOMUtils / GEOMUtils.hxx

diff --git a/src/GEOMUtils/GEOMUtils.hxx b/src/GEOMUtils/GEOMUtils.hxx
index d6b10816f2e446bd784d766eeac6dc8918432d44..1b0327e46644d22b0b2a759c82673a6c8d3310ef 100644 (file)
--- a/src/GEOMUtils/GEOMUtils.hxx
+++ b/src/GEOMUtils/GEOMUtils.hxx
@@ -1,4 +1,4 @@
-// Copyright (C) 2007-2012  CEA/DEN, EDF R&D, OPEN CASCADE
+// Copyright (C) 2007-2013  CEA/DEN, EDF R&D, OPEN CASCADE
 //
 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
@@ -18,11 +18,14 @@
 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
 //
 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+//
 
 #ifndef _GEOMUtils_HXX_
 #define _GEOMUtils_HXX_
 
+#include <Standard_Macro.hxx>
 #include <TopoDS_Shape.hxx>
+#include <TopoDS_Vertex.hxx>
 
 #include <TopTools_ListOfShape.hxx>
 
@@ -35,6 +38,8 @@
 
 #include <functional>
 
+class Bnd_Box;
+
 inline Standard_Boolean IsEqual (const TopoDS_Shape& S1, const TopoDS_Shape& S2)
 {
   return S1.IsSame(S2);
@@ -54,8 +59,14 @@ class GEOMUtils {
 
   /*!
    * \brief Get vector, defined by the given edge.
+   * \param theShape The edge.
+   * \param doConsiderOrientation If True, take into account the edge orientation.
+   * \note It is recommended to use doConsiderOrientation=Standard_False, because
+   *       the same edge can have different orientation depending on the way it was
+   *       extracted from a shape.
    */
-  Standard_EXPORT static gp_Vec GetVector (const TopoDS_Shape& theShape);
+  Standard_EXPORT static gp_Vec GetVector (const TopoDS_Shape& theShape,
+                                           Standard_Boolean doConsiderOrientation);
 
   /*!
    * \brief Sort shapes in the list by their coordinates.
@@ -89,6 +100,17 @@ class GEOMUtils {
    */
   Standard_EXPORT static TopoDS_Shape CompsolidToCompound (const TopoDS_Shape& theCompsolid);
 
+  /*!
+   * \brief Recursively extract all shapes from compounds and compsolids of the given shape into theList.
+   *
+   * If theShape is not compound or compsolid, theList will contain only theShape itself.
+   *
+   * \param theShape The shape to be exploded.
+   * \param theList Output parameter.
+   */
+  Standard_EXPORT static void AddSimpleShapes (const TopoDS_Shape& theShape,
+                                               TopTools_ListOfShape& theList);
+
   /*!
    * \brief Build a triangulation on \a theShape if it is absent.
    * \param theShape The shape to check/build triangulation on.
@@ -103,6 +125,55 @@ class GEOMUtils {
    */
   Standard_EXPORT static TopAbs_ShapeEnum GetTypeOfSimplePart (const TopoDS_Shape& theShape);
 
+  /*!
+   * \brief Find an edge of theShape, closest to thePoint.
+   *
+   * \param theShape The shape to explore.
+   * \param thePoint The point near the required edge.
+   * \retval TopoDS_Shape Returns the found edge or an empty shape if multiple edges found.
+   */
+  Standard_EXPORT static TopoDS_Shape GetEdgeNearPoint (const TopoDS_Shape&  theShape,
+                                                        const TopoDS_Vertex& thePoint);
+
+  /*!
+   * \brief Compute precise bounding box of the shape based on the rough bounding box.
+   *
+   * \param theShape the shape.
+   * \param theBox rough bounding box on input; precise bounding box on output.
+   * \retval Standard_True in case of success; Standard_False otherwise.
+   */
+  Standard_EXPORT static Standard_Boolean PreciseBoundingBox
+                          (const TopoDS_Shape &theShape, Bnd_Box &theBox);
+
+  /*!
+   * \brief Computes minumal distance between two shapes for singular cases
+   *        (workaround for bugs 19899, 19908 and 19910 from Mantis).
+   *
+   * \param aSh1 the first shape
+   * \param aSh2 the second shape
+   * \param Ptmp1 the output result point on the first shape
+   * \param Ptmp2 the output result point on the second shape
+   * \retval negative value if it is not a singular case; actual distance for singular case.
+   */
+  Standard_EXPORT static Standard_Real GetMinDistanceSingular
+                               (const TopoDS_Shape& aSh1,
+                                const TopoDS_Shape& aSh2,
+                                gp_Pnt& Ptmp1, gp_Pnt& Ptmp2);
+
+  /*!
+   * \brief Computes minumal distance between two shapes.
+   *
+   * \param theShape1 the first shape
+   * \param theShape2 the second shape
+   * \param thePnt1 the output result point on the first shape
+   * \param thePnt2 the output result point on the second shape
+   * \retval negative value in case of failure; otherwise the real distance.
+   */
+  Standard_EXPORT static Standard_Real GetMinDistance
+                               (const TopoDS_Shape& theShape1,
+                                const TopoDS_Shape& theShape2,
+                                gp_Pnt& thePnt1, gp_Pnt& thePnt2);
+
 };
 
 #endif