src/GeomAPI/GeomAPI_Cone.h

   1 // Copyright (C) 2018-2024  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_Cone_H_
  21 #define GeomAPI_Cone_H_
  22
  23 #include <GeomAPI_Interface.h>
  24 #include <memory>
  25
  26 class GeomAPI_Dir;
  27 class GeomAPI_Pnt;
  28
  29 /**\class GeomAPI_Cone
  30  * \ingroup DataModel
  31  * \brief Conical surface in 3D
  32  */
  33 class GeomAPI_Cone : public GeomAPI_Interface
  34 {
  35 public:
  36   /// Creation of infinite cone defined by apex, axis and semi-angle
  37   GEOMAPI_EXPORT GeomAPI_Cone(const std::shared_ptr<GeomAPI_Pnt>& theApex,
  38                               const std::shared_ptr<GeomAPI_Dir>& theAxis,
  39                               const double theSemiAngle);
  40
  41   /// Creation of semi-infinite cone by location and radius of reference circle, axis, semi-angle
  42   GEOMAPI_EXPORT GeomAPI_Cone(const std::shared_ptr<GeomAPI_Pnt>& theLocation,
  43                               const std::shared_ptr<GeomAPI_Dir>& theAxis,
  44                               const double theSemiAngle,
  45                               const double theRadius);
  46
  47   /// Creating of cone by location of reference circle, axis, semi-angle and
  48   /// radii of boundary circles
  49   GEOMAPI_EXPORT GeomAPI_Cone(const std::shared_ptr<GeomAPI_Pnt>& theLocation,
  50                               const std::shared_ptr<GeomAPI_Dir>& theAxis,
  51                               const double theSemiAngle,
  52                               const double theRadius1,
  53                               const double theRadius2);
  54
  55   /// Return apex of the cone
  56   GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Pnt> apex() const;
  57
  58   /// Return location of the cone (center of the circle nearest to the apex)
  59   GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Pnt> location() const;
  60
  61   /// Return axis of the cone
  62   GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Dir> axis() const;
  63
  64   /// Return semi-angle of the cone
  65   GEOMAPI_EXPORT double semiAngle() const;
  66
  67   /// Return first radius of the cone or Precision::Infinite() if the cone is infinite
  68   GEOMAPI_EXPORT double radius1() const;
  69
  70   /// Return second radius of the cone or Precision::Infinite() if the cone is infinite
  71   GEOMAPI_EXPORT double radius2() const;
  72
  73   /// Return height of the cone
  74   GEOMAPI_EXPORT double height() const;
  75
  76   /// Return \c true is the cone is semi-infinite
  77   GEOMAPI_EXPORT bool isSemiInfinite() const;
  78
  79   /// Return \c true is the cone is infinite
  80   GEOMAPI_EXPORT bool isInfinite() const;
  81
  82 private:
  83   double myRadius1, myRadius2;
  84 };
  85
  86 //! Pointer on the object
  87 typedef std::shared_ptr<GeomAPI_Cone> GeomConePtr;
  88
  89 #endif