src/GEOMUtils/GEOMUtils.hxx

   1 // Copyright (C) 2007-2012  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 #ifndef _GEOMUtils_HXX_
  23 #define _GEOMUtils_HXX_
  24
  25 #include <TopoDS_Shape.hxx>
  26 #include <TopoDS_Vertex.hxx>
  27
  28 #include <TopTools_ListOfShape.hxx>
  29
  30 #include <TopAbs.hxx>
  31
  32 #include <gp_Ax3.hxx>
  33 #include <gp_Vec.hxx>
  34
  35 #include <NCollection_DataMap.hxx>
  36
  37 #include <functional>
  38
  39 inline Standard_Boolean IsEqual (const TopoDS_Shape& S1, const TopoDS_Shape& S2)
  40 {
  41   return S1.IsSame(S2);
  42 }
  43
  44 class GEOMUtils {
  45
  46  public:
  47   /*!
  48    * \brief Get Local Coordinate System, corresponding to the given shape.
  49    *
  50    * Origin of the LCS is situated at the shape's center of mass.
  51    * Axes of the LCS are obtained from shape's location or,
  52    * if the shape is a planar face, from position of its plane.
  53    */
  54   Standard_EXPORT static gp_Ax3 GetPosition (const TopoDS_Shape& theShape);
  55
  56   /*!
  57    * \brief Get vector, defined by the given edge.
  58    */
  59   Standard_EXPORT static gp_Vec GetVector (const TopoDS_Shape& theShape);
  60
  61   /*!
  62    * \brief Sort shapes in the list by their coordinates.
  63    * \param SL The list of shapes to sort.
  64    */
  65   struct CompareShapes : public std::binary_function<TopoDS_Shape, TopoDS_Shape, bool>
  66   {
  67     CompareShapes (bool isOldSorting)
  68       : myIsOldSorting(isOldSorting) {}
  69
  70     bool operator() (const TopoDS_Shape& lhs, const TopoDS_Shape& rhs);
  71
  72     typedef NCollection_DataMap<TopoDS_Shape, std::pair<double, double> > GEOMUtils_DataMapOfShapeDouble;
  73     GEOMUtils_DataMapOfShapeDouble myMap;
  74     bool myIsOldSorting;
  75   };
  76
  77   /*!
  78    * \brief Sort shapes by their centers of mass, using formula X*999 + Y*99 + Z*0.9
  79    */
  80   Standard_EXPORT static void SortShapes (TopTools_ListOfShape& SL,
  81                                           const Standard_Boolean isOldSorting = Standard_True);
  82
  83   /*!
  84    * \brief Convert TopoDS_COMPSOLID to TopoDS_COMPOUND.
  85    *
  86    * If the argument shape is not of type TopoDS_COMPSOLID, this method returns it as is.
  87    *
  88    * \param theCompsolid The compsolid to be converted.
  89    * \retval TopoDS_Shape Returns the resulting compound.
  90    */
  91   Standard_EXPORT static TopoDS_Shape CompsolidToCompound (const TopoDS_Shape& theCompsolid);
  92
  93   /*!
  94    * \brief Recursively extract all shapes from compounds and compsolids of the given shape into theList.
  95    *
  96    * If theShape is not compound or compsolid, theList will contain only theShape itself.
  97    *
  98    * \param theShape The shape to be exploded.
  99    * \param theList Output parameter.
 100    */
 101   Standard_EXPORT static void AddSimpleShapes (const TopoDS_Shape& theShape,
 102                                                TopTools_ListOfShape& theList);
 103
 104   /*!
 105    * \brief Build a triangulation on \a theShape if it is absent.
 106    * \param theShape The shape to check/build triangulation on.
 107    * \retval bool Returns false if the shape has no faces, i.e. impossible to build triangulation.
 108    */
 109   Standard_EXPORT static bool CheckTriangulation (const TopoDS_Shape& theShape);
 110
 111   /*!
 112    * \brief Return type of shape for explode. In case of compound it will be a type of its first sub shape.
 113    * \param theShape The shape to get type of.
 114    * \retval TopAbs_ShapeEnum Return type of shape for explode.
 115    */
 116   Standard_EXPORT static TopAbs_ShapeEnum GetTypeOfSimplePart (const TopoDS_Shape& theShape);
 117
 118   /*!
 119    * \brief Find an edge of theShape, closest to thePoint.
 120    *
 121    * \param theShape The shape to explore.
 122    * \param thePoint The point near the required edge.
 123    * \retval TopoDS_Shape Returns the found edge or an empty shape if multiple edges found.
 124    */
 125   Standard_EXPORT static TopoDS_Shape GetEdgeNearPoint (const TopoDS_Shape&  theShape,
 126                                                         const TopoDS_Vertex& thePoint);
 127
 128 };
 129
 130 #endif