src/GeomAPI/GeomAPI_Cylinder.h

   1 // Copyright (C) 2018-2023  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
  26 class GeomAPI_Dir;
  27 class GeomAPI_Pnt;
  28
  29 /**\class GeomAPI_Cylinder
  30  * \ingroup DataModel
  31  * \brief Cylindrical surface in 3D
  32  */
  33 class GeomAPI_Cylinder : public GeomAPI_Interface
  34 {
  35 public:
  36   /// Creation of infinite cylinder defined by location, axis and radius
  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
  41   /// Creation of cylinder defined by location, axis, radius and height
  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
  47   /// Return location of the cylinder
  48   GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Pnt> location() const;
  49
  50   /// Return axis of the cylinder
  51   GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Dir> axis() const;
  52
  53   /// Return radius of the cylinder
  54   GEOMAPI_EXPORT double radius() const;
  55
  56   /// Return height of the cylinder or Precision::Infinite() if the cylinder is infinite
  57   GEOMAPI_EXPORT double height() const;
  58
  59   /// Return \c true is the cylinder is infinite
  60   GEOMAPI_EXPORT bool isInfinite() const;
  61
  62   /// Returns true if cylinders have same axis and radii.
  63   GEOMAPI_EXPORT bool isCoincident(const std::shared_ptr<GeomAPI_Cylinder> theCylinder,
  64                                    const double theTolerance = 1.e-7);
  65
  66 private:
  67   double myHeight;
  68 };
  69
  70 //! Pointer on the object
  71 typedef std::shared_ptr<GeomAPI_Cylinder> GeomCylinderPtr;
  72
  73 #endif