1 // Copyright (C) 2014-2023 CEA, EDF
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.
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.
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
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
20 #ifndef GeomAPI_Shape_H_
21 #define GeomAPI_Shape_H_
23 #include "GeomAPI_Dir.h"
25 #include <GeomAPI_Interface.h>
38 /**\class GeomAPI_Shape
40 * \brief Interface to the topological shape object
42 class GeomAPI_Shape : public GeomAPI_Interface
47 COMPOUND, COMPSOLID, SOLID, SHELL,
48 FACE, WIRE, EDGE, VERTEX,
61 /// Creation of empty (null) shape
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;
69 /// Returns true if the underlied shape is null
73 /// Returns whether the shapes are equal
75 virtual bool isEqual(const std::shared_ptr<GeomAPI_Shape> theShape) const;
77 /// Returns whether the shapes are same
79 virtual bool isSame(const std::shared_ptr<GeomAPI_Shape> theShape) const;
81 /// Returns \c true if shapes have same underlying geometry
83 virtual bool isSameGeometry(const std::shared_ptr<GeomAPI_Shape> theShape) const;
85 /// Returns whether the shape is a vertex
87 virtual bool isVertex() const;
89 /// Returns whether the shape is an edge
91 virtual bool isEdge() const;
93 /// Returns whether the shape is a wire
95 virtual bool isWire() const;
97 /// Returns whether the shape is a face
99 virtual bool isFace() const;
101 /// Returns whether the shape is a shell
103 virtual bool isShell() const;
105 /// Returns whether the shape is a compound
107 virtual bool isCompound() const;
109 /// Returns whether the shape is a compound of solids
111 virtual bool isCompoundOfSolids() const;
113 /// Returns true, if the shape contains only solids, compsolids
114 /// and compounds of solids and compsolids of any nesting depth
116 virtual bool isCollectionOfSolids() const;
118 /// Returns whether the shape is a compound where all elements are topologically connected
120 virtual bool isConnectedTopology() const;
122 /// Returns whether the shape is a solid
124 virtual bool isSolid() const;
126 /// Returns whether the shape is a compsolid
128 virtual bool isCompSolid() const;
130 /// Returns whether the shape is planar
132 virtual bool isPlanar() const;
134 /// Returns vertex or empty shape
136 std::shared_ptr<GeomAPI_Vertex> vertex() const;
138 /// Returns edge or empty shape
140 std::shared_ptr<GeomAPI_Edge> edge() const;
142 /// Returns wire or empty shape
144 std::shared_ptr<GeomAPI_Wire> wire() const;
146 /// Returns face or empty shape
148 std::shared_ptr<GeomAPI_Face> face() const;
150 /// Returns shell or empty shape
152 std::shared_ptr<GeomAPI_Shell> shell() const;
154 /// Returns solid or empty shape
156 std::shared_ptr<GeomAPI_Solid> solid() const;
158 /// Returns list of sub-shapes of the given type
159 /// \param theSubShapeType type of sub-shapes to search.
160 /// \param theOnlyUnique set it to \c true to omit subsequent
161 /// inclusions of the same sub-shape. By default it is \c false.
163 std::list< std::shared_ptr<GeomAPI_Shape> > subShapes(const ShapeType theSubShapeType,
164 const bool theOnlyUnique = false) const;
166 /// Returns the shape type
168 virtual ShapeType shapeType() const;
170 /// Returns the type enumeration by the string-type
171 GEOMAPI_EXPORT static ShapeType shapeTypeByStr(std::string theType);
173 /// \return the shape type as string.
175 virtual std::string shapeTypeStr() const;
177 /// \return the shape orientation.
178 GEOMAPI_EXPORT virtual Orientation orientation() const;
180 /// Sets the shape orientation.
181 GEOMAPI_EXPORT virtual void setOrientation(const Orientation theOrientation);
184 GEOMAPI_EXPORT virtual void reverse();
186 /// \return true if passed shape is a sub-shape of this shape.
187 /// \param theShape shape to search.
188 /// \param theCheckOrientation if false, returns true even if orientation of shape differs
189 GEOMAPI_EXPORT virtual bool isSubShape(const std::shared_ptr<GeomAPI_Shape> theShape,
190 const bool theCheckOrientation = true) const;
192 /// Computes boundary dimensions of the shape
193 /// Returns False if it is not possible
195 bool computeSize(double& theXmin, double& theYmin, double& theZmin,
196 double& theXmax, double& theYmax, double& theZmax) const;
198 /// Return middle point on the shape
200 virtual std::shared_ptr<GeomAPI_Pnt> middlePoint() const;
202 /// Returns the shape as BRep stream
204 std::string getShapeStream(const bool theWithTriangulation = true) const;
206 /// Returns intersection of shapes
208 std::shared_ptr<GeomAPI_Shape> intersect(const std::shared_ptr<GeomAPI_Shape> theShape) const;
210 /// Returns true if min distance between shapes < tolerance.
212 bool isIntersect(const std::shared_ptr<GeomAPI_Shape> theShape) const;
214 /// Translates the shape along the direction for the given offset
216 void translate(const std::shared_ptr<GeomAPI_Dir> theDir, const double theOffset);
218 /// Moves the shape with the given transformation matrix.
220 void move(const std::shared_ptr<GeomAPI_Trsf> theTransformation);
222 /// Returns type of shapes in the compound.
223 // If shapes are of different type then it will return SHAPE type
224 GEOMAPI_EXPORT ShapeType typeOfCompoundShapes() const;
226 /// Returns true if shape have self-intersections.
227 /// \param[in] theLevelOfCheck defines which interferences will be checked:<br>
228 /// 0 - only V/V;<br>
229 /// 1 - V/V and V/E;<br>
230 /// 2 - V/V, V/E and E/E;<br>
231 /// 3 - V/V, V/E, E/E and V/F;<br>
232 /// 4 - V/V, V/E, E/E, V/F and E/F;<br>
233 /// 5 - V/V, V/E, E/E, V/F, E/F and F/F;<br>
234 /// 6 - V/V, V/E, E/E, V/F, E/F, F/F and V/S;<br>
235 /// 7 - V/V, V/E, E/E, V/F, E/F, F/F, V/S and E/S;<br>
236 /// 8 - V/V, V/E, E/E, V/F, E/F, F/F, V/S, E/S and F/S;<br>
237 /// 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)
238 GEOMAPI_EXPORT bool isSelfIntersected(const int theLevelOfCheck = 9) const;
241 /// \brief Compare addresses of shapes
245 /// Return \c true if the address of the first shape is less than the address of the second
247 bool operator ()(const std::shared_ptr<GeomAPI_Shape>& theShape1,
248 const std::shared_ptr<GeomAPI_Shape>& theShape2) const;
251 /// \brief Compare addresses of shapes with respect to orientation of shapes.
252 /// Same TShapes with opposite orientations will be treated as different.
253 class ComparatorWithOri
256 /// Return \c true if the address of the first shape is less than the address of the second
258 bool operator ()(const std::shared_ptr<GeomAPI_Shape>& theShape1,
259 const std::shared_ptr<GeomAPI_Shape>& theShape2) const;
262 /// \brief Hash code for the shape
266 /// Return Hash value according to the address of the shape
268 int operator ()(const std::shared_ptr<GeomAPI_Shape>& theShape) const;
271 /// \brief Compare addresses of shapes
275 /// Return \c true if the address of the shapes are equal
277 bool operator ()(const std::shared_ptr<GeomAPI_Shape>& theShape1,
278 const std::shared_ptr<GeomAPI_Shape>& theShape2) const;
282 //! Pointer on list of shapes
283 typedef std::list<std::shared_ptr<GeomAPI_Shape> > ListOfShape;
285 //! Pointer on attribute object
286 typedef std::shared_ptr<GeomAPI_Shape> GeomShapePtr;