-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
-
-// File: GeomAPI_Shape.hxx
-// Created: 23 Apr 2014
-// Author: Mikhail PONIKAROV
+// Copyright (C) 2014-2019 CEA/DEN, EDF R&D
+//
+// 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_Shape
* \ingroup DataModel
* \brief Interface to the topological shape object
SHAPE
};
+ /// Shape orientation
+ enum Orientation {
+ FORWARD,
+ REVERSED,
+ INTERNAL,
+ EXTERNAL
+ };
+
public:
/// Creation of empty (null) shape
- GEOMAPI_EXPORT
+ GEOMAPI_EXPORT
GeomAPI_Shape();
+ /// \return a new Shape with the same Orientation and Location and a new TShape with the same
+ /// geometry and no sub-shapes.
+ GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Shape> emptyCopied() const;
+
/// Returns true if the underlied shape is null
- GEOMAPI_EXPORT
+ GEOMAPI_EXPORT
bool isNull() const;
/// Returns whether the shapes are equal
- GEOMAPI_EXPORT
+ GEOMAPI_EXPORT
virtual bool isEqual(const std::shared_ptr<GeomAPI_Shape> theShape) const;
+ /// Returns whether the shapes are same
+ GEOMAPI_EXPORT
+ virtual bool isSame(const std::shared_ptr<GeomAPI_Shape> theShape) const;
+
/// Returns whether the shape is a vertex
- GEOMAPI_EXPORT
+ GEOMAPI_EXPORT
virtual bool isVertex() const;
/// Returns whether the shape is an edge
- GEOMAPI_EXPORT
+ GEOMAPI_EXPORT
virtual bool isEdge() const;
+ /// Returns whether the shape is a wire
+ GEOMAPI_EXPORT
+ virtual bool isWire() const;
+
/// Returns whether the shape is a face
- GEOMAPI_EXPORT
+ GEOMAPI_EXPORT
virtual bool isFace() const;
+ /// Returns whether the shape is a shell
+ GEOMAPI_EXPORT
+ virtual bool isShell() const;
+
/// Returns whether the shape is a compound
- GEOMAPI_EXPORT
+ GEOMAPI_EXPORT
virtual bool isCompound() const;
/// Returns whether the shape is a compound of solids
- GEOMAPI_EXPORT
+ GEOMAPI_EXPORT
virtual bool isCompoundOfSolids() const;
+ /// Returns whether the shape is a compound where all elements are topologically connected
+ GEOMAPI_EXPORT
+ virtual bool isConnectedTopology() const;
+
/// Returns whether the shape is a solid
- GEOMAPI_EXPORT
+ GEOMAPI_EXPORT
virtual bool isSolid() const;
+ /// Returns whether the shape is a compsolid
+ GEOMAPI_EXPORT
+ virtual bool isCompSolid() const;
+
+ /// Returns whether the shape is planar
+ GEOMAPI_EXPORT
+ virtual bool isPlanar() const;
+
+ /// Returns vertex or empty shape
+ GEOMAPI_EXPORT
+ std::shared_ptr<GeomAPI_Vertex> vertex() const;
+
+ /// Returns edge or empty shape
+ GEOMAPI_EXPORT
+ std::shared_ptr<GeomAPI_Edge> edge() const;
+
+ /// Returns wire or empty shape
+ GEOMAPI_EXPORT
+ std::shared_ptr<GeomAPI_Wire> wire() const;
+
+ /// Returns face or empty shape
+ GEOMAPI_EXPORT
+ std::shared_ptr<GeomAPI_Face> face() const;
+
+ /// Returns shell or empty shape
+ GEOMAPI_EXPORT
+ std::shared_ptr<GeomAPI_Shell> shell() const;
+
+ /// Returns solid or empty shape
+ GEOMAPI_EXPORT
+ std::shared_ptr<GeomAPI_Solid> solid() const;
+
+ /// Returns list of sub-shapes of the given type
+ GEOMAPI_EXPORT
+ std::list<std::shared_ptr<GeomAPI_Shape> > subShapes(ShapeType theSubShapeType) const;
+
+ /// Returns the shape type
+ GEOMAPI_EXPORT
+ virtual ShapeType shapeType() const;
+
+ /// Returns the type enumeration by the string-type
+ GEOMAPI_EXPORT static ShapeType shapeTypeByStr(std::string theType);
+
+ /// \return the shape type as string.
+ GEOMAPI_EXPORT
+ virtual std::string shapeTypeStr() const;
+
+ /// \return the shape orientation.
+ GEOMAPI_EXPORT virtual Orientation orientation() const;
+
+ /// Sets the shape orientation.
+ GEOMAPI_EXPORT virtual void setOrientation(const Orientation theOrientation);
+
+ /// Reverse shape
+ GEOMAPI_EXPORT virtual void reverse();
+
+ /// \return true if passed shape is a sub-shape of this shape.
+ /// \param theShape shape to search.
+ /// \param theCheckOrientation if false, returns true even if orientation of shape differs
+ GEOMAPI_EXPORT virtual bool isSubShape(const std::shared_ptr<GeomAPI_Shape> theShape,
+ const bool theCheckOrientation = true) const;
+
/// Computes boundary dimensions of the shape
/// Returns False if it is not possible
- GEOMAPI_EXPORT
+ GEOMAPI_EXPORT
bool computeSize(double& theXmin, double& theYmin, double& theZmin,
double& theXmax, double& theYmax, double& theZmax) const;
+ /// Return middle point on the shape
+ GEOMAPI_EXPORT
+ virtual std::shared_ptr<GeomAPI_Pnt> middlePoint() const;
+
/// Returns the shape as BRep stream
- GEOMAPI_EXPORT
+ GEOMAPI_EXPORT
std::string getShapeStream() const;
+
+ /// Returns intersection of shapes
+ GEOMAPI_EXPORT
+ std::shared_ptr<GeomAPI_Shape> intersect(const std::shared_ptr<GeomAPI_Shape> theShape) const;
+
+ /// Returns true if min distance between shapes < tolerance.
+ GEOMAPI_EXPORT
+ bool isIntersect(const std::shared_ptr<GeomAPI_Shape> theShape) const;
+
+ /// Translates the shape along the direction for the given offset
+ GEOMAPI_EXPORT
+ void translate(const std::shared_ptr<GeomAPI_Dir> theDir, const double theOffset);
+
+ /// Returns type of shapes in the compound.
+ // If shapes are of different type then it will return SHAPE type
+ GEOMAPI_EXPORT ShapeType typeOfCompoundShapes() const;
+
+ /// Returns true if shape have self-intersections.
+ /// \param[in] theLevelOfCheck defines which interferences will be checked:<br>
+ /// 0 - only V/V;<br>
+ /// 1 - V/V and V/E;<br>
+ /// 2 - V/V, V/E and E/E;<br>
+ /// 3 - V/V, V/E, E/E and V/F;<br>
+ /// 4 - V/V, V/E, E/E, V/F and E/F;<br>
+ /// 5 - V/V, V/E, E/E, V/F, E/F and F/F;<br>
+ /// 6 - V/V, V/E, E/E, V/F, E/F, F/F and V/S;<br>
+ /// 7 - V/V, V/E, E/E, V/F, E/F, F/F, V/S and E/S;<br>
+ /// 8 - V/V, V/E, E/E, V/F, E/F, F/F, V/S, E/S and F/S;<br>
+ /// 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)
+ GEOMAPI_EXPORT bool isSelfIntersected(const int theLevelOfCheck = 9) const;
};
//! Pointer on list of shapes