src/GeomAlgoAPI/GeomAlgoAPI_ConeSegment.h

   1 // Copyright (C) 2014-2023  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_CONESEGMENT_H_
  21 #define GEOMALGOAPI_CONESEGMENT_H_
  22
  23 #include <GeomAlgoAPI_MakeShape.h>
  24
  25 /**\class GeomAlgoAPI_ConeSegment
  26  * \ingroup DataAlgo
  27  * \brief Allows to create Cone Segment GDML Primitives.
  28  */
  29 class GeomAlgoAPI_ConeSegment : public GeomAlgoAPI_MakeShape
  30 {
  31  public:
  32   /// Creates a cone segment using standard GDML parameters.
  33   /// \param theRMin1 Cone base inner radius.
  34   /// \param theRMax1 Cone base outer radius.
  35   /// \param theRMin2 Cone top inner radius.
  36   /// \param theRMax2 Cone top outer radius.
  37   /// \param theZ Cone height.
  38   /// \param theStartPhi Start angle of the cone segment.
  39   /// \param theDeltaPhi Delta angle of the cone segment.
  40   GEOMALGOAPI_EXPORT GeomAlgoAPI_ConeSegment(const double theRMin1,
  41                                              const double theRMax1,
  42                                              const double theRMin2,
  43                                              const double theRMax2,
  44                                              const double theZ,
  45                                              const double theStartPhi,
  46                                              const double theDeltaPhi);
  47
  48   /// Checks if the set of parameters used to define the cone segment are OK.
  49   GEOMALGOAPI_EXPORT bool check();
  50
  51   /// Builds the cone segment based on the parameters given in the constructor.
  52   GEOMALGOAPI_EXPORT void build();
  53
  54  private:
  55   double myRMin1; /// Cone base inner radius.
  56   double myRMax1; /// Cone base outer radius.
  57   double myRMin2; /// Cone top inner radius.
  58   double myRMax2; /// Cone top outer radius.
  59   double myZ; /// Cone height.
  60   double myStartPhi; /// Start angle of the cone segment.
  61   double myDeltaPhi; /// Delta angle of the cone segment.
  62 };
  63
  64 #endif // GEOMALGOAPI_CONESEGMENT_H_
  65