src/GeomAPI/GeomAPI_Shape.h

   1 // Copyright (C) 2014-2019  CEA/DEN, EDF R&D
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Lesser General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2.1 of the License, or (at your option) any later version.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Lesser General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU Lesser General Public
  14 // License along with this library; if not, write to the Free Software
  15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  16 //
  17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 //
  19
  20 #ifndef GeomAPI_Shape_H_
  21 #define GeomAPI_Shape_H_
  22
  23 #include "GeomAPI_Dir.h"
  24
  25 #include <GeomAPI_Interface.h>
  26 #include <memory>
  27 #include <list>
  28
  29 class GeomAPI_Pnt;
  30 class GeomAPI_Vertex;
  31 class GeomAPI_Edge;
  32 class GeomAPI_Wire;
  33 class GeomAPI_Face;
  34 class GeomAPI_Shell;
  35 class GeomAPI_Solid;
  36 class GeomAPI_Trsf;
  37
  38 /**\class GeomAPI_Shape
  39  * \ingroup DataModel
  40  * \brief Interface to the topological shape object
  41  */
  42 class GeomAPI_Shape : public GeomAPI_Interface
  43 {
  44 public:
  45   /// Shape type enum
  46   enum ShapeType {
  47     COMPOUND, COMPSOLID, SOLID, SHELL,
  48     FACE, WIRE, EDGE, VERTEX,
  49     SHAPE
  50   };
  51
  52   /// Shape orientation
  53   enum Orientation {
  54     FORWARD,
  55     REVERSED,
  56     INTERNAL,
  57     EXTERNAL
  58   };
  59
  60  public:
  61   /// Creation of empty (null) shape
  62   GEOMAPI_EXPORT
  63   GeomAPI_Shape();
  64
  65   /// \return a new Shape with the same Orientation and Location and a new TShape with the same
  66   ///         geometry and no sub-shapes.
  67   GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Shape> emptyCopied() const;
  68
  69   /// Returns true if the underlied shape is null
  70   GEOMAPI_EXPORT
  71   bool isNull() const;
  72
  73   /// Returns whether the shapes are equal
  74   GEOMAPI_EXPORT
  75   virtual bool isEqual(const std::shared_ptr<GeomAPI_Shape> theShape) const;
  76
  77   /// Returns whether the shapes are same
  78   GEOMAPI_EXPORT
  79   virtual bool isSame(const std::shared_ptr<GeomAPI_Shape> theShape) const;
  80
  81   /// Returns \c true if shapes have same underlying geometry
  82   GEOMAPI_EXPORT
  83   virtual bool isSameGeometry(const std::shared_ptr<GeomAPI_Shape> theShape) const;
  84
  85   /// Returns whether the shape is a vertex
  86   GEOMAPI_EXPORT
  87   virtual bool isVertex() const;
  88
  89   /// Returns whether the shape is an edge
  90   GEOMAPI_EXPORT
  91   virtual bool isEdge() const;
  92
  93   /// Returns whether the shape is a wire
  94   GEOMAPI_EXPORT
  95   virtual bool isWire() const;
  96
  97   /// Returns whether the shape is a face
  98   GEOMAPI_EXPORT
  99   virtual bool isFace() const;
 100
 101   /// Returns whether the shape is a shell
 102   GEOMAPI_EXPORT
 103   virtual bool isShell() const;
 104
 105   /// Returns whether the shape is a compound
 106   GEOMAPI_EXPORT
 107   virtual bool isCompound() const;
 108
 109   /// Returns whether the shape is a compound of solids
 110   GEOMAPI_EXPORT
 111   virtual bool isCompoundOfSolids() const;
 112
 113   /// Returns whether the shape is a compound where all elements are topologically connected
 114   GEOMAPI_EXPORT
 115   virtual bool isConnectedTopology() const;
 116
 117   /// Returns whether the shape is a solid
 118   GEOMAPI_EXPORT
 119   virtual bool isSolid() const;
 120
 121   /// Returns whether the shape is a compsolid
 122   GEOMAPI_EXPORT
 123   virtual bool isCompSolid() const;
 124
 125   /// Returns whether the shape is planar
 126   GEOMAPI_EXPORT
 127   virtual bool isPlanar() const;
 128
 129   /// Returns vertex or empty shape
 130   GEOMAPI_EXPORT
 131   std::shared_ptr<GeomAPI_Vertex> vertex() const;
 132
 133   /// Returns edge or empty shape
 134   GEOMAPI_EXPORT
 135   std::shared_ptr<GeomAPI_Edge> edge() const;
 136
 137   /// Returns wire or empty shape
 138   GEOMAPI_EXPORT
 139   std::shared_ptr<GeomAPI_Wire> wire() const;
 140
 141   /// Returns face or empty shape
 142   GEOMAPI_EXPORT
 143   std::shared_ptr<GeomAPI_Face> face() const;
 144
 145   /// Returns shell or empty shape
 146   GEOMAPI_EXPORT
 147   std::shared_ptr<GeomAPI_Shell> shell() const;
 148
 149   /// Returns solid or empty shape
 150   GEOMAPI_EXPORT
 151   std::shared_ptr<GeomAPI_Solid> solid() const;
 152
 153   /// Returns list of sub-shapes of the given type
 154   GEOMAPI_EXPORT
 155   std::list<std::shared_ptr<GeomAPI_Shape> > subShapes(ShapeType theSubShapeType) const;
 156
 157   /// Returns the shape type
 158   GEOMAPI_EXPORT
 159   virtual ShapeType shapeType() const;
 160
 161   /// Returns the type enumeration by the string-type
 162   GEOMAPI_EXPORT static ShapeType shapeTypeByStr(std::string theType);
 163
 164   /// \return the shape type as string.
 165   GEOMAPI_EXPORT
 166   virtual std::string shapeTypeStr() const;
 167
 168   /// \return the shape orientation.
 169   GEOMAPI_EXPORT virtual Orientation orientation() const;
 170
 171   /// Sets the shape orientation.
 172   GEOMAPI_EXPORT virtual void setOrientation(const Orientation theOrientation);
 173
 174   /// Reverse shape
 175   GEOMAPI_EXPORT virtual void reverse();
 176
 177   /// \return true if passed shape is a sub-shape of this shape.
 178   /// \param theShape shape to search.
 179   /// \param theCheckOrientation if false, returns true even if orientation of shape differs
 180   GEOMAPI_EXPORT virtual bool isSubShape(const std::shared_ptr<GeomAPI_Shape> theShape,
 181     const bool theCheckOrientation = true) const;
 182
 183   /// Computes boundary dimensions of the shape
 184   /// Returns False if it is not possible
 185   GEOMAPI_EXPORT
 186   bool computeSize(double& theXmin, double& theYmin, double& theZmin,
 187                    double& theXmax, double& theYmax, double& theZmax) const;
 188
 189   /// Return middle point on the shape
 190   GEOMAPI_EXPORT
 191   virtual std::shared_ptr<GeomAPI_Pnt> middlePoint() const;
 192
 193   /// Returns the shape as BRep stream
 194   GEOMAPI_EXPORT
 195   std::string getShapeStream() const;
 196
 197   /// Returns intersection of shapes
 198   GEOMAPI_EXPORT
 199   std::shared_ptr<GeomAPI_Shape> intersect(const std::shared_ptr<GeomAPI_Shape> theShape) const;
 200
 201   /// Returns true if min distance between shapes < tolerance.
 202   GEOMAPI_EXPORT
 203   bool isIntersect(const std::shared_ptr<GeomAPI_Shape> theShape) const;
 204
 205   /// Translates the shape along the direction for the given offset
 206   GEOMAPI_EXPORT
 207   void translate(const std::shared_ptr<GeomAPI_Dir> theDir, const double theOffset);
 208
 209   /// Moves the shape with the given transformation matrix.
 210   GEOMAPI_EXPORT
 211     void move(const std::shared_ptr<GeomAPI_Trsf> theTransformation);
 212
 213   /// Returns type of shapes in the compound.
 214   // If shapes are of different type then it will return SHAPE type
 215   GEOMAPI_EXPORT ShapeType typeOfCompoundShapes() const;
 216
 217   /// Returns true if shape have self-intersections.
 218   /// \param[in] theLevelOfCheck defines which interferences will be checked:<br>
 219   /// 0 - only V/V;<br>
 220   /// 1 - V/V and V/E;<br>
 221   /// 2 - V/V, V/E and E/E;<br>
 222   /// 3 - V/V, V/E, E/E and V/F;<br>
 223   /// 4 - V/V, V/E, E/E, V/F and E/F;<br>
 224   /// 5 - V/V, V/E, E/E, V/F, E/F and F/F;<br>
 225   /// 6 - V/V, V/E, E/E, V/F, E/F, F/F and V/S;<br>
 226   /// 7 - V/V, V/E, E/E, V/F, E/F, F/F, V/S and E/S;<br>
 227   /// 8 - V/V, V/E, E/E, V/F, E/F, F/F, V/S, E/S and F/S;<br>
 228   /// 9 - V/V, V/E, E/E, V/F, E/F, F/F, V/S, E/S, F/S and S/S - all interferences (Default value)
 229   GEOMAPI_EXPORT bool isSelfIntersected(const int theLevelOfCheck = 9) const;
 230
 231 public:
 232   /// \brief Compare addresses of shapes
 233   class Comparator
 234   {
 235   public:
 236     /// Return \c true if the address of the first shape is less than the address of the second
 237     GEOMAPI_EXPORT
 238     bool operator ()(const std::shared_ptr<GeomAPI_Shape>& theShape1,
 239                      const std::shared_ptr<GeomAPI_Shape>& theShape2) const;
 240   };
 241
 242   /// \brief Compare addresses of shapes with respect to orientation of shapes.
 243   ///        Same TShapes with opposite orientations will be treated as different.
 244   class ComparatorWithOri
 245   {
 246   public:
 247     /// Return \c true if the address of the first shape is less than the address of the second
 248     GEOMAPI_EXPORT
 249       bool operator ()(const std::shared_ptr<GeomAPI_Shape>& theShape1,
 250                        const std::shared_ptr<GeomAPI_Shape>& theShape2) const;
 251   };
 252
 253   /// \brief Hash code for the shape
 254   class Hash
 255   {
 256   public:
 257     /// Return Hash value according to the address of the shape
 258     GEOMAPI_EXPORT
 259     int operator ()(const std::shared_ptr<GeomAPI_Shape>& theShape) const;
 260   };
 261
 262   /// \brief Compare addresses of shapes
 263   class Equal
 264   {
 265   public:
 266     /// Return \c true if the address of the shapes are equal
 267     GEOMAPI_EXPORT
 268     bool operator ()(const std::shared_ptr<GeomAPI_Shape>& theShape1,
 269                      const std::shared_ptr<GeomAPI_Shape>& theShape2) const;
 270   };
 271 };
 272
 273 //! Pointer on list of shapes
 274 typedef std::list<std::shared_ptr<GeomAPI_Shape> > ListOfShape;
 275
 276 //! Pointer on attribute object
 277 typedef std::shared_ptr<GeomAPI_Shape> GeomShapePtr;
 278
 279 #endif