]> SALOME platform Git repositories - modules/shaper.git/blob - src/GeomAPI/GeomAPI_Face.h
Salome HOME
Improve code coverage for elliptic arcs.
[modules/shaper.git] / src / GeomAPI / GeomAPI_Face.h
1 // Copyright (C) 2014-2019  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 email : webmaster.salome@opencascade.com
18 //
19
20 #ifndef GeomAPI_Face_H_
21 #define GeomAPI_Face_H_
22
23 #include <GeomAPI_Shape.h>
24
25 class GeomAPI_Pln;
26 class GeomAPI_Sphere;
27 class GeomAPI_Cylinder;
28 class GeomAPI_Cone;
29 class GeomAPI_Torus;
30
31 /**\class GeomAPI_Face
32 * \ingroup DataModel
33  * \brief Interface to the face object
34  */
35 class GeomAPI_Face : public GeomAPI_Shape
36 {
37 public:
38   /// Creation of empty (null) shape
39   GEOMAPI_EXPORT
40   GeomAPI_Face();
41
42   /// Creation of face by the face-shape
43   GEOMAPI_EXPORT
44   GeomAPI_Face(const std::shared_ptr<GeomAPI_Shape>& theShape);
45
46   /// Returns true if the current face is geometrically equal to the given face
47   GEOMAPI_EXPORT
48   virtual bool isEqual(const std::shared_ptr<GeomAPI_Shape> theFace) const;
49
50   /// Returns \c true if faces have same underlying surface
51   GEOMAPI_EXPORT
52   virtual bool isSameGeometry(const std::shared_ptr<GeomAPI_Shape> theShape) const;
53
54   /// Returns true if the face is a cylindrical face
55   GEOMAPI_EXPORT
56   bool isCylindrical() const;
57
58   /// Returns the base plane of the face (if it is planar) with location in the center of the face
59   GEOMAPI_EXPORT
60   std::shared_ptr<GeomAPI_Pln> getPlane() const;
61
62   /// Returns sphere if the face is based on the spherical surface
63   GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Sphere> getSphere() const;
64
65   /// Returns cylinder if the face is based on the cylindrical surface
66   GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Cylinder> getCylinder() const;
67
68   /// Returns cone if the face is based on the conical surface
69   GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Cone> getCone() const;
70
71   /// Returns torus if the face is based on the toroidal surface
72   GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Torus> getTorus() const;
73
74   /// Return inner point in the face
75   GEOMAPI_EXPORT virtual std::shared_ptr<GeomAPI_Pnt> middlePoint() const;
76 };
77
78 //! Pointer on attribute object
79 typedef std::shared_ptr<GeomAPI_Face> GeomFacePtr;
80
81 #endif
82