SHAPER 9.16.0
GeomAPI_Cylinder.h
1// Copyright (C) 2018-2026 CEA, EDF
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_Cylinder_H_
21#define GeomAPI_Cylinder_H_
22
23#include <GeomAPI_Interface.h>
24#include <memory>
25
26class GeomAPI_Dir;
27class GeomAPI_Pnt;
28
34{
35public:
37 GEOMAPI_EXPORT GeomAPI_Cylinder(const std::shared_ptr<GeomAPI_Pnt>& theLocation,
38 const std::shared_ptr<GeomAPI_Dir>& theAxis,
39 const double theRadius);
40
42 GEOMAPI_EXPORT GeomAPI_Cylinder(const std::shared_ptr<GeomAPI_Pnt>& theLocation,
43 const std::shared_ptr<GeomAPI_Dir>& theAxis,
44 const double theRadius,
45 const double theHeight);
46
48 GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Pnt> location() const;
49
51 GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Dir> axis() const;
52
54 GEOMAPI_EXPORT double radius() const;
55
57 GEOMAPI_EXPORT double height() const;
58
60 GEOMAPI_EXPORT bool isInfinite() const;
61
63 GEOMAPI_EXPORT bool isCoincident(const std::shared_ptr<GeomAPI_Cylinder> theCylinder,
64 const double theTolerance = 1.e-7);
65
66private:
67 double myHeight;
68};
69
71typedef std::shared_ptr<GeomAPI_Cylinder> GeomCylinderPtr;
72
73#endif
Cylindrical surface in 3D.
Definition: GeomAPI_Cylinder.h:34
GEOMAPI_EXPORT std::shared_ptr< GeomAPI_Dir > axis() const
Return axis of the cylinder.
Definition: GeomAPI_Cylinder.cpp:61
GEOMAPI_EXPORT bool isInfinite() const
Return true is the cylinder is infinite.
Definition: GeomAPI_Cylinder.cpp:80
GEOMAPI_EXPORT double radius() const
Return radius of the cylinder.
Definition: GeomAPI_Cylinder.cpp:68
GEOMAPI_EXPORT bool isCoincident(const std::shared_ptr< GeomAPI_Cylinder > theCylinder, const double theTolerance=1.e-7)
Returns true if cylinders have same axis and radii.
Definition: GeomAPI_Cylinder.cpp:86
GEOMAPI_EXPORT std::shared_ptr< GeomAPI_Pnt > location() const
Return location of the cylinder.
Definition: GeomAPI_Cylinder.cpp:54
GEOMAPI_EXPORT double height() const
Return height of the cylinder or Precision::Infinite() if the cylinder is infinite.
Definition: GeomAPI_Cylinder.cpp:74
GEOMAPI_EXPORT GeomAPI_Cylinder(const std::shared_ptr< GeomAPI_Pnt > &theLocation, const std::shared_ptr< GeomAPI_Dir > &theAxis, const double theRadius)
Creation of infinite cylinder defined by location, axis and radius.
Definition: GeomAPI_Cylinder.cpp:35
3D direction defined by three normalized coordinates
Definition: GeomAPI_Dir.h:34
General base class for all interfaces in this package.
Definition: GeomAPI_Interface.h:38
3D point defined by three coordinates
Definition: GeomAPI_Pnt.h:38