GeomAPI_Shape.h

// Copyright (C) 2014-2025  CEA, EDF
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// 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
//
// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
//
 
#ifndef GeomAPI_Shape_H_
#define GeomAPI_Shape_H_
 
#include "GeomAPI_Dir.h"
 
#include <GeomAPI_Interface.h>
#include <memory>
#include <list>
 
class GeomAPI_Pnt;
class GeomAPI_Vertex;
class GeomAPI_Edge;
class GeomAPI_Wire;
class GeomAPI_Face;
class GeomAPI_Shell;
class GeomAPI_Solid;
class GeomAPI_Trsf;
 
class GeomAPI_Shape : public GeomAPI_Interface
{
public:
  enum ShapeType {
    COMPOUND, COMPSOLID, SOLID, SHELL,
    FACE, WIRE, EDGE, VERTEX,
    SHAPE
  };
 
  enum Orientation {
    FORWARD,
    REVERSED,
    INTERNAL,
    EXTERNAL
  };
 
 public:
  GEOMAPI_EXPORT
  GeomAPI_Shape();
 
  GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Shape> emptyCopied() const;
 
  GEOMAPI_EXPORT
  bool isNull() const;
 
  GEOMAPI_EXPORT
  virtual bool isEqual(const std::shared_ptr<GeomAPI_Shape> theShape) const;
 
  GEOMAPI_EXPORT
  virtual bool isSame(const std::shared_ptr<GeomAPI_Shape> theShape) const;
 
  GEOMAPI_EXPORT
  virtual bool isSameGeometry(const std::shared_ptr<GeomAPI_Shape> theShape) const;
 
  GEOMAPI_EXPORT
  virtual bool isVertex() const;
 
  GEOMAPI_EXPORT
  virtual bool isEdge() const;
 
  GEOMAPI_EXPORT
  virtual bool isWire() const;
 
  GEOMAPI_EXPORT
  virtual bool isFace() const;
 
  GEOMAPI_EXPORT
  virtual bool isShell() const;
 
  GEOMAPI_EXPORT
  virtual bool isCompound() const;
 
  GEOMAPI_EXPORT
  virtual bool isCompoundOfSolids() const;
 
  GEOMAPI_EXPORT
  virtual bool isCollectionOfSolids() const;
 
  GEOMAPI_EXPORT
  virtual bool isConnectedTopology() const;
 
  GEOMAPI_EXPORT
  virtual bool isSolid() const;
 
  GEOMAPI_EXPORT
  virtual bool isCompSolid() const;
 
  GEOMAPI_EXPORT
  virtual bool isPlanar() const;
 
  GEOMAPI_EXPORT
  std::shared_ptr<GeomAPI_Vertex> vertex() const;
 
  GEOMAPI_EXPORT
  std::shared_ptr<GeomAPI_Edge> edge() const;
 
  GEOMAPI_EXPORT
  std::shared_ptr<GeomAPI_Wire> wire() const;
 
  GEOMAPI_EXPORT
  std::shared_ptr<GeomAPI_Face> face() const;
 
  GEOMAPI_EXPORT
  std::shared_ptr<GeomAPI_Shell> shell() const;
 
  GEOMAPI_EXPORT
  std::shared_ptr<GeomAPI_Solid> solid() const;
 
  GEOMAPI_EXPORT
  std::list< std::shared_ptr<GeomAPI_Shape> > subShapes(const ShapeType theSubShapeType,
                                                        const bool theOnlyUnique = false) const;
 
  GEOMAPI_EXPORT
  virtual ShapeType shapeType() const;
 
  GEOMAPI_EXPORT static ShapeType shapeTypeByStr(std::string theType);
 
  GEOMAPI_EXPORT
  virtual std::string shapeTypeStr() const;
 
  GEOMAPI_EXPORT virtual Orientation orientation() const;
 
  GEOMAPI_EXPORT virtual void setOrientation(const Orientation theOrientation);
 
  GEOMAPI_EXPORT virtual void reverse();
 
  GEOMAPI_EXPORT virtual bool isSubShape(const std::shared_ptr<GeomAPI_Shape> theShape,
    const bool theCheckOrientation = true) const;
 
  GEOMAPI_EXPORT
  bool computeSize(double& theXmin, double& theYmin, double& theZmin,
                   double& theXmax, double& theYmax, double& theZmax) const;
 
  GEOMAPI_EXPORT
  virtual std::shared_ptr<GeomAPI_Pnt> middlePoint() const;
 
  GEOMAPI_EXPORT
  std::string getShapeStream(const bool theWithTriangulation = true) const;
 
  GEOMAPI_EXPORT
  std::shared_ptr<GeomAPI_Shape> intersect(const std::shared_ptr<GeomAPI_Shape> theShape) const;
 
  GEOMAPI_EXPORT
  bool isIntersect(const std::shared_ptr<GeomAPI_Shape> theShape) const;
 
  GEOMAPI_EXPORT
  void translate(const std::shared_ptr<GeomAPI_Dir> theDir, const double theOffset);
 
  GEOMAPI_EXPORT
    void move(const std::shared_ptr<GeomAPI_Trsf> theTransformation);
 
  // If shapes are of different type then it will return SHAPE type
  GEOMAPI_EXPORT ShapeType typeOfCompoundShapes() const;
 
  GEOMAPI_EXPORT bool isSelfIntersected(const int theLevelOfCheck = 9) const;
 
public:
  class Comparator
  {
  public:
    GEOMAPI_EXPORT
    bool operator ()(const std::shared_ptr<GeomAPI_Shape>& theShape1,
                     const std::shared_ptr<GeomAPI_Shape>& theShape2) const;
  };
 
  class ComparatorWithOri
  {
  public:
    GEOMAPI_EXPORT
      bool operator ()(const std::shared_ptr<GeomAPI_Shape>& theShape1,
                       const std::shared_ptr<GeomAPI_Shape>& theShape2) const;
  };
 
  class Hash
  {
  public:
    GEOMAPI_EXPORT
    int operator ()(const std::shared_ptr<GeomAPI_Shape>& theShape) const;
  };
 
  class Equal
  {
  public:
    GEOMAPI_EXPORT
    bool operator ()(const std::shared_ptr<GeomAPI_Shape>& theShape1,
                     const std::shared_ptr<GeomAPI_Shape>& theShape2) const;
  };
};
 
typedef std::list<std::shared_ptr<GeomAPI_Shape> > ListOfShape;
 
typedef std::shared_ptr<GeomAPI_Shape> GeomShapePtr;
 
#endif