src/GeomAPI/GeomAPI_Sphere.h

   1 // Copyright (C) 2018-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 GeomAPI_Sphere_H_
  21 #define GeomAPI_Sphere_H_
  22
  23 #include <GeomAPI_Interface.h>
  24 #include <memory>
  25
  26 class GeomAPI_Pnt;
  27
  28 /**\class GeomAPI_Sphere
  29  * \ingroup DataModel
  30  * \brief Spherical surface in 3D
  31  */
  32 class GeomAPI_Sphere : public GeomAPI_Interface
  33 {
  34 public:
  35
  36   /// Construct sphere by center and radius
  37   GEOMAPI_EXPORT GeomAPI_Sphere(const std::shared_ptr<GeomAPI_Pnt>& theCenter, double theRadius);
  38
  39   /// Return center of the sphere
  40   GEOMAPI_EXPORT const std::shared_ptr<GeomAPI_Pnt> center() const;
  41
  42   /// Return radius of the sphere
  43   GEOMAPI_EXPORT double radius() const;
  44 };
  45
  46 //! Pointer on the object
  47 typedef std::shared_ptr<GeomAPI_Sphere> GeomSpherePtr;
  48
  49 #endif