updated copyright message

[modules/shaper.git] / src / GeomAPI / GeomAPI_Shape.h

diff --git a/src/GeomAPI/GeomAPI_Shape.h b/src/GeomAPI/GeomAPI_Shape.h
index d0bc66339fef8778b8a6ab01864de3d5a201087f..91aa17d19238d807499cdfae0ae775308fd86507 100644 (file)
--- a/src/GeomAPI/GeomAPI_Shape.h
+++ b/src/GeomAPI/GeomAPI_Shape.h
@@ -1,4 +1,4 @@
-// Copyright (C) 2014-2017  CEA/DEN, EDF R&D
+// Copyright (C) 2014-2023  CEA, EDF
 //
 // This library is free software; you can redistribute it and/or
 // modify it under the terms of the GNU Lesser General Public
@@ -12,10 +12,9 @@
 //
 // You should have received a copy of the GNU Lesser General Public
 // License along with this library; if not, write to the Free Software
-// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
 //
-// See http://www.salome-platform.org/ or
-// email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
 //
 
 #ifndef GeomAPI_Shape_H_
@@ -34,6 +33,7 @@ class GeomAPI_Wire;
 class GeomAPI_Face;
 class GeomAPI_Shell;
 class GeomAPI_Solid;
+class GeomAPI_Trsf;
 
 /**\class GeomAPI_Shape
  * \ingroup DataModel
@@ -78,6 +78,10 @@ public:
   GEOMAPI_EXPORT
   virtual bool isSame(const std::shared_ptr<GeomAPI_Shape> theShape) const;
 
+  /// Returns \c true if shapes have same underlying geometry
+  GEOMAPI_EXPORT
+  virtual bool isSameGeometry(const std::shared_ptr<GeomAPI_Shape> theShape) const;
+
   /// Returns whether the shape is a vertex
   GEOMAPI_EXPORT
   virtual bool isVertex() const;
@@ -106,6 +110,11 @@ public:
   GEOMAPI_EXPORT
   virtual bool isCompoundOfSolids() const;
 
+  /// Returns true, if the shape contains only solids, compsolids
+  /// and compounds of solids and compsolids of any nesting depth
+  GEOMAPI_EXPORT
+  virtual bool isCollectionOfSolids() const;
+
   /// Returns whether the shape is a compound where all elements are topologically connected
   GEOMAPI_EXPORT
   virtual bool isConnectedTopology() const;
@@ -147,8 +156,12 @@ public:
   std::shared_ptr<GeomAPI_Solid> solid() const;
 
   /// Returns list of sub-shapes of the given type
+  /// \param theSubShapeType type of sub-shapes to search.
+  /// \param theOnlyUnique set it to \c true to omit subsequent
+  ///        inclusions of the same sub-shape. By default it is \c false.
   GEOMAPI_EXPORT
-  std::list<std::shared_ptr<GeomAPI_Shape> > subShapes(ShapeType theSubShapeType) const;
+  std::list< std::shared_ptr<GeomAPI_Shape> > subShapes(const ShapeType theSubShapeType,
+                                                        const bool theOnlyUnique = false) const;
 
   /// Returns the shape type
   GEOMAPI_EXPORT
@@ -188,7 +201,7 @@ public:
 
   /// Returns the shape as BRep stream
   GEOMAPI_EXPORT
-  std::string getShapeStream() const;
+  std::string getShapeStream(const bool theWithTriangulation = true) const;
 
   /// Returns intersection of shapes
   GEOMAPI_EXPORT
@@ -202,6 +215,10 @@ public:
   GEOMAPI_EXPORT
   void translate(const std::shared_ptr<GeomAPI_Dir> theDir, const double theOffset);
 
+  /// Moves the shape with the given transformation matrix.
+  GEOMAPI_EXPORT
+    void move(const std::shared_ptr<GeomAPI_Trsf> theTransformation);
+
   /// Returns type of shapes in the compound.
   // If shapes are of different type then it will return SHAPE type
   GEOMAPI_EXPORT ShapeType typeOfCompoundShapes() const;
@@ -221,6 +238,7 @@ public:
   GEOMAPI_EXPORT bool isSelfIntersected(const int theLevelOfCheck = 9) const;
 
 public:
+  /// \brief Compare addresses of shapes
   class Comparator
   {
   public:
@@ -229,6 +247,36 @@ public:
     bool operator ()(const std::shared_ptr<GeomAPI_Shape>& theShape1,
                      const std::shared_ptr<GeomAPI_Shape>& theShape2) const;
   };
+
+  /// \brief Compare addresses of shapes with respect to orientation of shapes.
+  ///        Same TShapes with opposite orientations will be treated as different.
+  class ComparatorWithOri
+  {
+  public:
+    /// Return \c true if the address of the first shape is less than the address of the second
+    GEOMAPI_EXPORT
+      bool operator ()(const std::shared_ptr<GeomAPI_Shape>& theShape1,
+                       const std::shared_ptr<GeomAPI_Shape>& theShape2) const;
+  };
+
+  /// \brief Hash code for the shape
+  class Hash
+  {
+  public:
+    /// Return Hash value according to the address of the shape
+    GEOMAPI_EXPORT
+    int operator ()(const std::shared_ptr<GeomAPI_Shape>& theShape) const;
+  };
+
+  /// \brief Compare addresses of shapes
+  class Equal
+  {
+  public:
+    /// Return \c true if the address of the shapes are equal
+    GEOMAPI_EXPORT
+    bool operator ()(const std::shared_ptr<GeomAPI_Shape>& theShape1,
+                     const std::shared_ptr<GeomAPI_Shape>& theShape2) const;
+  };
 };
 
 //! Pointer on list of shapes