1 // Copyright (C) 2014-2017 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
18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
21 #ifndef GEOMALGOAPI_CYLINDER_H_
22 #define GEOMALGOAPI_CYLINDER_H_
24 #include <GeomAlgoAPI_MakeShape.h>
26 #include <GeomAPI_Ax2.h>
27 #include <GeomAPI_Pnt.h>
29 /**\class GeomAlgoAPI_Cylinder
31 * \brief Allows to create Cylinder Primitives
33 class GeomAlgoAPI_Cylinder : public GeomAlgoAPI_MakeShape
36 GEOMALGOAPI_EXPORT GeomAlgoAPI_Cylinder();
38 /// Creates a cylinder.
39 /// \param theAxis The axis of the cylinder
40 /// \param theRadius The radius of the cylinder
41 /// \param theHeight The height of the cylinder
42 GEOMALGOAPI_EXPORT GeomAlgoAPI_Cylinder(std::shared_ptr<GeomAPI_Ax2> theAxis,
43 const double theRadius,
44 const double theHeight);
46 /// Creates a cylinder.
47 /// \param theAxis The axis of the cylinder
48 /// \param theRadius The radius of the cylinder
49 /// \param theHeight The height of the cylinder
50 /// \param theAngle The covering angle of the cylinder
51 GEOMALGOAPI_EXPORT GeomAlgoAPI_Cylinder(std::shared_ptr<GeomAPI_Ax2> theAxis,
52 const double theRadius,
53 const double theHeight,
54 const double theAngle);
56 /// Checks if data for the cylinder construction is OK.
57 GEOMALGOAPI_EXPORT bool check();
59 /// Builds the cylinder.
60 GEOMALGOAPI_EXPORT void build();
63 bool withAngle; /// Boolean indicating if the type of cylinder (full or portion).
64 std::shared_ptr<GeomAPI_Pnt> myBasePoint; /// Center of the lower base of the cylinder.
65 std::shared_ptr<GeomAPI_Ax2> myAxis; /// Axis of the cylinder.
66 double myRadius; /// Radius of the cylinder.
67 double myHeight; /// Height of the cylinder.
68 double myAngle; /// Covering polar angle of the cylinder;
72 #endif // GEOMALGOAPI_CYLINDER_H_