src/GEOMUtils/GEOMUtils.hxx

   1 // Copyright (C) 2007-2013  CEA/DEN, EDF R&D, OPEN CASCADE
   2 //
   3 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5 //
   6 // This library is free software; you can redistribute it and/or
   7 // modify it under the terms of the GNU Lesser General Public
   8 // License as published by the Free Software Foundation; either
   9 // version 2.1 of the License.
  10 //
  11 // This library is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 // Lesser General Public License for more details.
  15 //
  16 // You should have received a copy of the GNU Lesser General Public
  17 // License along with this library; if not, write to the Free Software
  18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19 //
  20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21 //
  22
  23 #ifndef _GEOMUtils_HXX_
  24 #define _GEOMUtils_HXX_
  25
  26 #include <TopoDS_Shape.hxx>
  27 #include <TopoDS_Vertex.hxx>
  28
  29 #include <TopTools_ListOfShape.hxx>
  30
  31 #include <TopAbs.hxx>
  32
  33 #include <gp_Ax3.hxx>
  34 #include <gp_Vec.hxx>
  35
  36 #include <NCollection_DataMap.hxx>
  37
  38 #include <functional>
  39
  40 class Bnd_Box;
  41
  42 inline Standard_Boolean IsEqual (const TopoDS_Shape& S1, const TopoDS_Shape& S2)
  43 {
  44   return S1.IsSame(S2);
  45 }
  46
  47 class GEOMUtils {
  48
  49  public:
  50   /*!
  51    * \brief Get Local Coordinate System, corresponding to the given shape.
  52    *
  53    * Origin of the LCS is situated at the shape's center of mass.
  54    * Axes of the LCS are obtained from shape's location or,
  55    * if the shape is a planar face, from position of its plane.
  56    */
  57   Standard_EXPORT static gp_Ax3 GetPosition (const TopoDS_Shape& theShape);
  58
  59   /*!
  60    * \brief Get vector, defined by the given edge.
  61    * \param theShape The edge.
  62    * \param doConsiderOrientation If True, take into account the edge orientation.
  63    * \note It is recommended to use doConsiderOrientation=Standard_False, because
  64    *       the same edge can have different orientation depending on the way it was
  65    *       extracted from a shape.
  66    */
  67   Standard_EXPORT static gp_Vec GetVector (const TopoDS_Shape& theShape,
  68                                            Standard_Boolean doConsiderOrientation);
  69
  70   /*!
  71    * \brief Sort shapes in the list by their coordinates.
  72    * \param SL The list of shapes to sort.
  73    */
  74   struct CompareShapes : public std::binary_function<TopoDS_Shape, TopoDS_Shape, bool>
  75   {
  76     CompareShapes (bool isOldSorting)
  77       : myIsOldSorting(isOldSorting) {}
  78
  79     bool operator() (const TopoDS_Shape& lhs, const TopoDS_Shape& rhs);
  80
  81     typedef NCollection_DataMap<TopoDS_Shape, std::pair<double, double> > GEOMUtils_DataMapOfShapeDouble;
  82     GEOMUtils_DataMapOfShapeDouble myMap;
  83     bool myIsOldSorting;
  84   };
  85
  86   /*!
  87    * \brief Sort shapes by their centers of mass, using formula X*999 + Y*99 + Z*0.9
  88    */
  89   Standard_EXPORT static void SortShapes (TopTools_ListOfShape& SL,
  90                                           const Standard_Boolean isOldSorting = Standard_True);
  91
  92   /*!
  93    * \brief Convert TopoDS_COMPSOLID to TopoDS_COMPOUND.
  94    *
  95    * If the argument shape is not of type TopoDS_COMPSOLID, this method returns it as is.
  96    *
  97    * \param theCompsolid The compsolid to be converted.
  98    * \retval TopoDS_Shape Returns the resulting compound.
  99    */
 100   Standard_EXPORT static TopoDS_Shape CompsolidToCompound (const TopoDS_Shape& theCompsolid);
 101
 102   /*!
 103    * \brief Recursively extract all shapes from compounds and compsolids of the given shape into theList.
 104    *
 105    * If theShape is not compound or compsolid, theList will contain only theShape itself.
 106    *
 107    * \param theShape The shape to be exploded.
 108    * \param theList Output parameter.
 109    */
 110   Standard_EXPORT static void AddSimpleShapes (const TopoDS_Shape& theShape,
 111                                                TopTools_ListOfShape& theList);
 112
 113   /*!
 114    * \brief Build a triangulation on \a theShape if it is absent.
 115    * \param theShape The shape to check/build triangulation on.
 116    * \retval bool Returns false if the shape has no faces, i.e. impossible to build triangulation.
 117    */
 118   Standard_EXPORT static bool CheckTriangulation (const TopoDS_Shape& theShape);
 119
 120   /*!
 121    * \brief Return type of shape for explode. In case of compound it will be a type of its first sub shape.
 122    * \param theShape The shape to get type of.
 123    * \retval TopAbs_ShapeEnum Return type of shape for explode.
 124    */
 125   Standard_EXPORT static TopAbs_ShapeEnum GetTypeOfSimplePart (const TopoDS_Shape& theShape);
 126
 127   /*!
 128    * \brief Find an edge of theShape, closest to thePoint.
 129    *
 130    * \param theShape The shape to explore.
 131    * \param thePoint The point near the required edge.
 132    * \retval TopoDS_Shape Returns the found edge or an empty shape if multiple edges found.
 133    */
 134   Standard_EXPORT static TopoDS_Shape GetEdgeNearPoint (const TopoDS_Shape&  theShape,
 135                                                         const TopoDS_Vertex& thePoint);
 136
 137   /*!
 138    * \brief Compute precise bounding box of the shape based on the rough bounding box.
 139    *
 140    * \param theShape the shape.
 141    * \param theBox rough bounding box on input; precise bounding box on output.
 142    * \retval Standard_True in case of success; Standard_False otherwise.
 143    */
 144   Standard_EXPORT static Standard_Boolean PreciseBoundingBox
 145                           (const TopoDS_Shape &theShape, Bnd_Box &theBox);
 146
 147   /*!
 148    * \brief Computes minumal distance between two shapes for singular cases
 149    *        (workaround for bugs 19899, 19908 and 19910 from Mantis).
 150    *
 151    * \param aSh1 the first shape
 152    * \param aSh2 the second shape
 153    * \param Ptmp1 the output result point on the first shape
 154    * \param Ptmp2 the output result point on the second shape
 155    * \retval negative value if it is not a singular case; actual distance for singular case.
 156    */
 157   Standard_EXPORT static Standard_Real GetMinDistanceSingular
 158                                (const TopoDS_Shape& aSh1,
 159                                 const TopoDS_Shape& aSh2,
 160                                 gp_Pnt& Ptmp1, gp_Pnt& Ptmp2);
 161
 162   /*!
 163    * \brief Computes minumal distance between two shapes.
 164    *
 165    * \param theShape1 the first shape
 166    * \param theShape2 the second shape
 167    * \param thePnt1 the output result point on the first shape
 168    * \param thePnt2 the output result point on the second shape
 169    * \retval negative value in case of failure; otherwise the real distance.
 170    */
 171   Standard_EXPORT static Standard_Real GetMinDistance
 172                                (const TopoDS_Shape& theShape1,
 173                                 const TopoDS_Shape& theShape2,
 174                                 gp_Pnt& thePnt1, gp_Pnt& thePnt2);
 175
 176 };
 177
 178 #endif