src/GeomAlgoAPI/GeomAlgoAPI_Ellipsoid.h

   1 // Copyright (C) 2014-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 GEOMALGOAPI_ELLIPSOID_H_
  21 #define GEOMALGOAPI_ELLIPSOID_H_
  22
  23 #include <GeomAlgoAPI_MakeShape.h>
  24
  25 /**\class GeomAlgoAPI_Ellipsoid
  26  * \ingroup DataAlgo
  27  * \brief Allows to create Ellipsoid GDML Primitives.
  28  */
  29 class GeomAlgoAPI_Ellipsoid : public GeomAlgoAPI_MakeShape
  30 {
  31  public:
  32   /// Creates a ellipsoid using standard GDML parameters.
  33   /// \param theAx X dimension of the ellipsoid.
  34   /// \param theBy Y dimension of the ellipsoid.
  35   /// \param theCz Z dimension of the ellipsoid.
  36   /// \param theZCut1 Lower z cut.
  37   /// \param theZCut2 Upper z cut.
  38   GEOMALGOAPI_EXPORT GeomAlgoAPI_Ellipsoid(const double theAx,
  39                                            const double theBy,
  40                                            const double theCz,
  41                                            const double theZCut1,
  42                                            const double theZCut2);
  43
  44   /// Checks if the set of parameters used to define the ellipsoid are OK.
  45   GEOMALGOAPI_EXPORT bool check();
  46
  47   /// Builds the ellipsoid based on the parameters given in the constructor.
  48   GEOMALGOAPI_EXPORT void build();
  49
  50  private:
  51   double myAx; /// X dimension of the ellipsoid.
  52   double myBy; /// Y dimension of the ellipsoid.
  53   double myCz; /// Z dimension of the ellipsoid.
  54   double myZCut1; /// Lower z cut.
  55   double myZCut2; /// Upper z cut.
  56 };
  57
  58 #endif // GEOMALGOAPI_ELLIPSOID_H_
  59