]> SALOME platform Git repositories - modules/shaper.git/blob - src/GeomAPI/GeomAPI_Cylinder.h
Salome HOME
Reverted some changes in salome build/run scripts.
[modules/shaper.git] / src / GeomAPI / GeomAPI_Cylinder.h
1 // Copyright (C) 2018-20xx  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_Cylinder_H_
22 #define GeomAPI_Cylinder_H_
23
24 #include <GeomAPI_Interface.h>
25 #include <memory>
26
27 class GeomAPI_Dir;
28 class GeomAPI_Pnt;
29
30 /**\class GeomAPI_Cylinder
31  * \ingroup DataModel
32  * \brief Cylindrical surface in 3D
33  */
34 class GeomAPI_Cylinder : public GeomAPI_Interface
35 {
36 public:
37   /// Creation of infinite cylinder defined by location, axis and radius
38   GEOMAPI_EXPORT GeomAPI_Cylinder(const std::shared_ptr<GeomAPI_Pnt>& theLocation,
39                                   const std::shared_ptr<GeomAPI_Dir>& theAxis,
40                                   const double theRadius);
41
42   /// Creation of cylinder defined by location, axis, radius and height
43   GEOMAPI_EXPORT GeomAPI_Cylinder(const std::shared_ptr<GeomAPI_Pnt>& theLocation,
44                                   const std::shared_ptr<GeomAPI_Dir>& theAxis,
45                                   const double theRadius,
46                                   const double theHeight);
47
48   /// Return location of the cylinder
49   GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Pnt> location() const;
50
51   /// Return axis of the cylinder
52   GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Dir> axis() const;
53
54   /// Return radius of the cylinder
55   GEOMAPI_EXPORT double radius() const;
56
57   /// Return height of the cylinder or Precision::Infinite() if the cylinder is infinite
58   GEOMAPI_EXPORT double height() const;
59
60   /// Return \c true is the cylinder is infinite
61   GEOMAPI_EXPORT bool isInfinite() const;
62
63 private:
64   double myHeight;
65 };
66
67 //! Pointer on the object
68 typedef std::shared_ptr<GeomAPI_Cylinder> GeomCylinderPtr;
69
70 #endif