src/GeomAPI/GeomAPI_Solid.h

   1 // Copyright (C) 2018-20xx  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 GeomAPI_Solid_H_
  22 #define GeomAPI_Solid_H_
  23
  24 #include <GeomAPI_Shape.h>
  25
  26 class GeomAPI_Sphere;
  27 class GeomAPI_Cylinder;
  28 class GeomAPI_Cone;
  29 class GeomAPI_Torus;
  30 class GeomAPI_Box;
  31
  32 /// \class GeomAPI_Solid
  33 /// \ingroup DataModel
  34 /// \brief Interface to the solid object
  35 class GeomAPI_Solid: public GeomAPI_Shape
  36 {
  37 public:
  38   /// Makes an undefined solid.
  39   GEOMAPI_EXPORT GeomAPI_Solid();
  40
  41   /// Creation of solid by the solid-shape
  42   GEOMAPI_EXPORT GeomAPI_Solid(const std::shared_ptr<GeomAPI_Shape>& theShape);
  43
  44   /// Returns sphere if the solid is only bounded by faces
  45   /// which are based on the same spherical surface
  46   GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Sphere> getSphere() const;
  47
  48   /// Returns cylinder if the solid is bounded by faces based on the same cylindrical surface
  49   /// and a pair of parallel planar faces
  50   GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Cylinder> getCylinder() const;
  51
  52   /// Returns cone if the solid is bounded by faces based on the same conical surface
  53   /// and a pair of parallel planar faces
  54   GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Cone> getCone() const;
  55
  56   /// Returns torus if the shell solid is only bounded by faces
  57   /// which are based on the same toroidal surface
  58   GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Torus> getTorus() const;
  59
  60   /// Returns box if the solid is bounded by 6 rectangular faces composing a box
  61   GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Box> getParallelepiped() const;
  62
  63   /// Return inner point in the solid
  64   GEOMAPI_EXPORT virtual std::shared_ptr<GeomAPI_Pnt> middlePoint() const;
  65 };
  66
  67 typedef std::shared_ptr<GeomAPI_Solid> GeomSolidPtr;
  68
  69 #endif