]> SALOME platform Git repositories - modules/shaper.git/blob - src/GeomAPI/GeomAPI_Shape.h
Salome HOME
Reverted some changes in salome build/run scripts.
[modules/shaper.git] / src / GeomAPI / GeomAPI_Shape.h
1 // Copyright (C) 2014-2017  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
18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
19 //
20
21 #ifndef GeomAPI_Shape_H_
22 #define GeomAPI_Shape_H_
23
24 #include "GeomAPI_Dir.h"
25
26 #include <GeomAPI_Interface.h>
27 #include <memory>
28 #include <list>
29
30 class GeomAPI_Pnt;
31 class GeomAPI_Vertex;
32 class GeomAPI_Edge;
33 class GeomAPI_Wire;
34 class GeomAPI_Face;
35 class GeomAPI_Shell;
36 class GeomAPI_Solid;
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 whether the shape is a vertex
82   GEOMAPI_EXPORT
83   virtual bool isVertex() const;
84
85   /// Returns whether the shape is an edge
86   GEOMAPI_EXPORT
87   virtual bool isEdge() const;
88
89   /// Returns whether the shape is a wire
90   GEOMAPI_EXPORT
91   virtual bool isWire() const;
92
93   /// Returns whether the shape is a face
94   GEOMAPI_EXPORT
95   virtual bool isFace() const;
96
97   /// Returns whether the shape is a shell
98   GEOMAPI_EXPORT
99   virtual bool isShell() const;
100
101   /// Returns whether the shape is a compound
102   GEOMAPI_EXPORT
103   virtual bool isCompound() const;
104
105   /// Returns whether the shape is a compound of solids
106   GEOMAPI_EXPORT
107   virtual bool isCompoundOfSolids() const;
108
109   /// Returns whether the shape is a compound where all elements are topologically connected
110   GEOMAPI_EXPORT
111   virtual bool isConnectedTopology() const;
112
113   /// Returns whether the shape is a solid
114   GEOMAPI_EXPORT
115   virtual bool isSolid() const;
116
117   /// Returns whether the shape is a compsolid
118   GEOMAPI_EXPORT
119   virtual bool isCompSolid() const;
120
121   /// Returns whether the shape is planar
122   GEOMAPI_EXPORT
123   virtual bool isPlanar() const;
124
125   /// Returns vertex or empty shape
126   GEOMAPI_EXPORT
127   std::shared_ptr<GeomAPI_Vertex> vertex() const;
128
129   /// Returns edge or empty shape
130   GEOMAPI_EXPORT
131   std::shared_ptr<GeomAPI_Edge> edge() const;
132
133   /// Returns wire or empty shape
134   GEOMAPI_EXPORT
135   std::shared_ptr<GeomAPI_Wire> wire() const;
136
137   /// Returns face or empty shape
138   GEOMAPI_EXPORT
139   std::shared_ptr<GeomAPI_Face> face() const;
140
141   /// Returns shell or empty shape
142   GEOMAPI_EXPORT
143   std::shared_ptr<GeomAPI_Shell> shell() const;
144
145   /// Returns solid or empty shape
146   GEOMAPI_EXPORT
147   std::shared_ptr<GeomAPI_Solid> solid() const;
148
149   /// Returns list of sub-shapes of the given type
150   GEOMAPI_EXPORT
151   std::list<std::shared_ptr<GeomAPI_Shape> > subShapes(ShapeType theSubShapeType) const;
152
153   /// Returns the shape type
154   GEOMAPI_EXPORT
155   virtual ShapeType shapeType() const;
156
157   /// Returns the type enumeration by the string-type
158   GEOMAPI_EXPORT static ShapeType shapeTypeByStr(std::string theType);
159
160   /// \return the shape type as string.
161   GEOMAPI_EXPORT
162   virtual std::string shapeTypeStr() const;
163
164   /// \return the shape orientation.
165   GEOMAPI_EXPORT virtual Orientation orientation() const;
166
167   /// Sets the shape orientation.
168   GEOMAPI_EXPORT virtual void setOrientation(const Orientation theOrientation);
169
170   /// Reverse shape
171   GEOMAPI_EXPORT virtual void reverse();
172
173   /// \return true if passed shape is a sub-shape of this shape.
174   /// \param theShape shape to search.
175   /// \param theCheckOrientation if false, returns true even if orientation of shape differs
176   GEOMAPI_EXPORT virtual bool isSubShape(const std::shared_ptr<GeomAPI_Shape> theShape,
177     const bool theCheckOrientation = true) const;
178
179   /// Computes boundary dimensions of the shape
180   /// Returns False if it is not possible
181   GEOMAPI_EXPORT
182   bool computeSize(double& theXmin, double& theYmin, double& theZmin,
183                    double& theXmax, double& theYmax, double& theZmax) const;
184
185   /// Return middle point on the shape
186   GEOMAPI_EXPORT
187   virtual std::shared_ptr<GeomAPI_Pnt> middlePoint() const;
188
189   /// Returns the shape as BRep stream
190   GEOMAPI_EXPORT
191   std::string getShapeStream() const;
192
193   /// Returns intersection of shapes
194   GEOMAPI_EXPORT
195   std::shared_ptr<GeomAPI_Shape> intersect(const std::shared_ptr<GeomAPI_Shape> theShape) const;
196
197   /// Returns true if min distance between shapes < tolerance.
198   GEOMAPI_EXPORT
199   bool isIntersect(const std::shared_ptr<GeomAPI_Shape> theShape) const;
200
201   /// Translates the shape along the direction for the given offset
202   GEOMAPI_EXPORT
203   void translate(const std::shared_ptr<GeomAPI_Dir> theDir, const double theOffset);
204
205   /// Returns type of shapes in the compound.
206   // If shapes are of different type then it will return SHAPE type
207   GEOMAPI_EXPORT ShapeType typeOfCompoundShapes() const;
208
209   /// Returns true if shape have self-intersections.
210   /// \param[in] theLevelOfCheck defines which interferences will be checked:<br>
211   /// 0 - only V/V;<br>
212   /// 1 - V/V and V/E;<br>
213   /// 2 - V/V, V/E and E/E;<br>
214   /// 3 - V/V, V/E, E/E and V/F;<br>
215   /// 4 - V/V, V/E, E/E, V/F and E/F;<br>
216   /// 5 - V/V, V/E, E/E, V/F, E/F and F/F;<br>
217   /// 6 - V/V, V/E, E/E, V/F, E/F, F/F and V/S;<br>
218   /// 7 - V/V, V/E, E/E, V/F, E/F, F/F, V/S and E/S;<br>
219   /// 8 - V/V, V/E, E/E, V/F, E/F, F/F, V/S, E/S and F/S;<br>
220   /// 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)
221   GEOMAPI_EXPORT bool isSelfIntersected(const int theLevelOfCheck = 9) const;
222 };
223
224 //! Pointer on list of shapes
225 typedef std::list<std::shared_ptr<GeomAPI_Shape> > ListOfShape;
226
227 //! Pointer on attribute object
228 typedef std::shared_ptr<GeomAPI_Shape> GeomShapePtr;
229
230 #endif