src/GeomAlgoAPI/GeomAlgoAPI_Cylinder.h

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