src/GeomAlgoAPI/GeomAlgoAPI_Sphere.h

   1 // Copyright (C) 2017-2019  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 // File:        GeomAlgoAPI_Sphere.h
  21 // Created:     16 Mar 2017
  22 // Author:      Clarisse Genrault (CEA)
  23
  24 #ifndef GEOMALGOAPI_SPHERE_H_
  25 #define GEOMALGOAPI_SPHERE_H_
  26
  27 #include <GeomAlgoAPI_MakeShape.h>
  28
  29 #include <GeomAPI_Pnt.h>
  30
  31 /**\class GeomAlgoAPI_Sphere
  32  * \ingroup DataAlgo
  33  * \brief Allows to create Sphere Primitives
  34  */
  35 class GeomAlgoAPI_Sphere : public GeomAlgoAPI_MakeShape
  36 {
  37  public:
  38   /// Creates a sphere.
  39   /// \param theCenterPoint The center point of the sphere
  40   /// \param theRadius The radius of the sphere
  41   GEOMALGOAPI_EXPORT GeomAlgoAPI_Sphere(std::shared_ptr<GeomAPI_Pnt> theCenterPoint,
  42                                         const double theRadius);
  43
  44   /// Checks if data for the sphere construction is OK.
  45   GEOMALGOAPI_EXPORT bool check();
  46
  47   /// Builds the sphere.
  48   GEOMALGOAPI_EXPORT void build();
  49
  50  private:
  51   std::shared_ptr<GeomAPI_Pnt> myCenterPoint; /// Center of the sphere.
  52   double myRadius;
  53 };
  54
  55 #endif // GEOMALGOAPI_SPHERE_H_