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