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 <Standard_Macro.hxx>
  27 #include <TopoDS_Shape.hxx>
  28 #include <TopoDS_Vertex.hxx>
  29
  30 #include <TopTools_ListOfShape.hxx>
  31
  32 #include <TopAbs.hxx>
  33
  34 #include <gp_Ax3.hxx>
  35 #include <gp_Vec.hxx>
  36
  37 #include <V3d_View.hxx>
  38
  39 #include <NCollection_DataMap.hxx>
  40
  41 #include <functional>
  42
  43 class Bnd_Box;
  44
  45 inline Standard_Boolean IsEqual (const TopoDS_Shape& S1, const TopoDS_Shape& S2)
  46 {
  47   return S1.IsSame(S2);
  48 }
  49
  50 class GEOMUtils {
  51
  52  public:
  53   /*!
  54    * \brief Get Local Coordinate System, corresponding to the given shape.
  55    *
  56    * Origin of the LCS is situated at the shape's center of mass.
  57    * Axes of the LCS are obtained from shape's location or,
  58    * if the shape is a planar face, from position of its plane.
  59    */
  60   Standard_EXPORT static gp_Ax3 GetPosition (const TopoDS_Shape& theShape);
  61
  62   /*!
  63    * \brief Get vector, defined by the given edge.
  64    * \param theShape The edge.
  65    * \param doConsiderOrientation If True, take into account the edge orientation.
  66    * \note It is recommended to use doConsiderOrientation=Standard_False, because
  67    *       the same edge can have different orientation depending on the way it was
  68    *       extracted from a shape.
  69    */
  70   Standard_EXPORT static gp_Vec GetVector (const TopoDS_Shape& theShape,
  71                                            Standard_Boolean doConsiderOrientation);
  72
  73   /*!
  74    * \brief Sort shapes in the list by their coordinates.
  75    * \param SL The list of shapes to sort.
  76    */
  77   struct CompareShapes : public std::binary_function<TopoDS_Shape, TopoDS_Shape, bool>
  78   {
  79     CompareShapes (bool isOldSorting)
  80       : myIsOldSorting(isOldSorting) {}
  81
  82     bool operator() (const TopoDS_Shape& lhs, const TopoDS_Shape& rhs);
  83
  84     typedef NCollection_DataMap<TopoDS_Shape, std::pair<double, double> > GEOMUtils_DataMapOfShapeDouble;
  85     GEOMUtils_DataMapOfShapeDouble myMap;
  86     bool myIsOldSorting;
  87   };
  88
  89   /*!
  90    * \brief Sort shapes by their centers of mass, using formula X*999 + Y*99 + Z*0.9
  91    */
  92   Standard_EXPORT static void SortShapes (TopTools_ListOfShape& SL,
  93                                           const Standard_Boolean isOldSorting = Standard_True);
  94
  95   /*!
  96    * \brief Convert TopoDS_COMPSOLID to TopoDS_COMPOUND.
  97    *
  98    * If the argument shape is not of type TopoDS_COMPSOLID, this method returns it as is.
  99    *
 100    * \param theCompsolid The compsolid to be converted.
 101    * \retval TopoDS_Shape Returns the resulting compound.
 102    */
 103   Standard_EXPORT static TopoDS_Shape CompsolidToCompound (const TopoDS_Shape& theCompsolid);
 104
 105   /*!
 106    * \brief Recursively extract all shapes from compounds and compsolids of the given shape into theList.
 107    *
 108    * If theShape is not compound or compsolid, theList will contain only theShape itself.
 109    *
 110    * \param theShape The shape to be exploded.
 111    * \param theList Output parameter.
 112    */
 113   Standard_EXPORT static void AddSimpleShapes (const TopoDS_Shape& theShape,
 114                                                TopTools_ListOfShape& theList);
 115
 116   /*!
 117    * \brief Build a triangulation on \a theShape if it is absent.
 118    * \param theShape The shape to check/build triangulation on.
 119    * \retval bool Returns false if the shape has no faces, i.e. impossible to build triangulation.
 120    */
 121   Standard_EXPORT static bool CheckTriangulation (const TopoDS_Shape& theShape);
 122
 123   /*!
 124    * \brief Return type of shape for explode. In case of compound it will be a type of its first sub shape.
 125    * \param theShape The shape to get type of.
 126    * \retval TopAbs_ShapeEnum Return type of shape for explode.
 127    */
 128   Standard_EXPORT static TopAbs_ShapeEnum GetTypeOfSimplePart (const TopoDS_Shape& theShape);
 129
 130   /*!
 131    * \brief Find an edge of theShape, closest to thePoint.
 132    *
 133    * \param theShape The shape to explore.
 134    * \param thePoint The point near the required edge.
 135    * \retval TopoDS_Shape Returns the found edge or an empty shape if multiple edges found.
 136    */
 137   Standard_EXPORT static TopoDS_Shape GetEdgeNearPoint (const TopoDS_Shape&  theShape,
 138                                                         const TopoDS_Vertex& thePoint);
 139
 140   /*!
 141    * \brief Compute precise bounding box of the shape based on the rough bounding box.
 142    *
 143    * \param theShape the shape.
 144    * \param theBox rough bounding box on input; precise bounding box on output.
 145    * \retval Standard_True in case of success; Standard_False otherwise.
 146    */
 147   Standard_EXPORT static Standard_Boolean PreciseBoundingBox
 148                           (const TopoDS_Shape &theShape, Bnd_Box &theBox);
 149
 150   /*!
 151    * \brief Computes minumal distance between two shapes for singular cases
 152    *        (workaround for bugs 19899, 19908 and 19910 from Mantis).
 153    *
 154    * \param aSh1 the first shape
 155    * \param aSh2 the second shape
 156    * \param Ptmp1 the output result point on the first shape
 157    * \param Ptmp2 the output result point on the second shape
 158    * \retval negative value if it is not a singular case; actual distance for singular case.
 159    */
 160   Standard_EXPORT static Standard_Real GetMinDistanceSingular
 161                                (const TopoDS_Shape& aSh1,
 162                                 const TopoDS_Shape& aSh2,
 163                                 gp_Pnt& Ptmp1, gp_Pnt& Ptmp2);
 164
 165   /*!
 166    * \brief Computes minumal distance between two shapes.
 167    *
 168    * \param theShape1 the first shape
 169    * \param theShape2 the second shape
 170    * \param thePnt1 the output result point on the first shape
 171    * \param thePnt2 the output result point on the second shape
 172    * \retval negative value in case of failure; otherwise the real distance.
 173    */
 174   Standard_EXPORT static Standard_Real GetMinDistance
 175                                (const TopoDS_Shape& theShape1,
 176                                 const TopoDS_Shape& theShape2,
 177                                 gp_Pnt& thePnt1, gp_Pnt& thePnt2);
 178
 179   /*!
 180    * \brief Returns the point clicked in 3D view.
 181    *
 182    * \param x The X coordinate in the view.
 183    * \param y The Y coordinate in the view.
 184    * \param theView View where the given point takes place.
 185    * \retval gp_Pnt Returns the point clicked in 3D view
 186    */
 187   Standard_EXPORT static gp_Pnt ConvertClickToPoint( int x, int y, Handle(V3d_View) theView );
 188
 189 };
 190
 191 #endif