1 // Copyright (C) 2014-2019 CEA/DEN, EDF R&D
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_Face_H_
21 #define GeomAPI_Face_H_
23 #include <GeomAPI_Shape.h>
27 class GeomAPI_Cylinder;
31 /**\class GeomAPI_Face
33 * \brief Interface to the face object
35 class GeomAPI_Face : public GeomAPI_Shape
38 /// Creation of empty (null) shape
42 /// Creation of face by the face-shape
44 GeomAPI_Face(const std::shared_ptr<GeomAPI_Shape>& theShape);
46 /// Returns true if the current face is geometrically equal to the given face
48 virtual bool isEqual(const std::shared_ptr<GeomAPI_Shape> theFace) const;
50 /// Returns true if the face is a cylindrical face
52 bool isCylindrical() const;
54 /// Returns the base plane of the face (if it is planar) with location in the center of the face
56 std::shared_ptr<GeomAPI_Pln> getPlane() const;
58 /// Returns sphere if the face is based on the spherical surface
59 GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Sphere> getSphere() const;
61 /// Returns cylinder if the face is based on the cylindrical surface
62 GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Cylinder> getCylinder() const;
64 /// Returns cone if the face is based on the conical surface
65 GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Cone> getCone() const;
67 /// Returns torus if the face is based on the toroidal surface
68 GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Torus> getTorus() const;
70 /// Return inner point in the face
71 GEOMAPI_EXPORT virtual std::shared_ptr<GeomAPI_Pnt> middlePoint() const;
74 //! Pointer on attribute object
75 typedef std::shared_ptr<GeomAPI_Face> GeomFacePtr;