src/GeomAlgoAPI/GeomAlgoAPI_Ellipsoid.h

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