1 // Copyright (C) 2018-20xx CEA/DEN, EDF R&D
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.
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.
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
17 // See http://www.salome-platform.org/ or
18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
21 #ifndef GeomAPI_Cone_H_
22 #define GeomAPI_Cone_H_
24 #include <GeomAPI_Interface.h>
30 /**\class GeomAPI_Cone
32 * \brief Conical surface in 3D
34 class GeomAPI_Cone : public GeomAPI_Interface
37 /// Creation of infinite cone defined by apex, axis and semi-angle
38 GEOMAPI_EXPORT GeomAPI_Cone(const std::shared_ptr<GeomAPI_Pnt>& theApex,
39 const std::shared_ptr<GeomAPI_Dir>& theAxis,
40 const double theSemiAngle);
42 /// Creation of semi-infinite cone by location and radius of reference circle, axis, semi-angle
43 GEOMAPI_EXPORT GeomAPI_Cone(const std::shared_ptr<GeomAPI_Pnt>& theLocation,
44 const std::shared_ptr<GeomAPI_Dir>& theAxis,
45 const double theSemiAngle,
46 const double theRadius);
48 /// Creating of cone by location of reference circle, axis, semi-angle and
49 /// radii of boundary circles
50 GEOMAPI_EXPORT GeomAPI_Cone(const std::shared_ptr<GeomAPI_Pnt>& theLocation,
51 const std::shared_ptr<GeomAPI_Dir>& theAxis,
52 const double theSemiAngle,
53 const double theRadius1,
54 const double theRadius2);
56 /// Return apex of the cone
57 GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Pnt> apex() const;
59 /// Return location of the cone (center of the circle nearest to the apex)
60 GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Pnt> location() const;
62 /// Return axis of the cone
63 GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Dir> axis() const;
65 /// Return semi-angle of the cone
66 GEOMAPI_EXPORT double semiAngle() const;
68 /// Return first radius of the cone or Precision::Infinite() if the cone is infinite
69 GEOMAPI_EXPORT double radius1() const;
71 /// Return second radius of the cone or Precision::Infinite() if the cone is infinite
72 GEOMAPI_EXPORT double radius2() const;
74 /// Return height of the cone
75 GEOMAPI_EXPORT double height() const;
77 /// Return \c true is the cone is semi-infinite
78 GEOMAPI_EXPORT bool isSemiInfinite() const;
80 /// Return \c true is the cone is infinite
81 GEOMAPI_EXPORT bool isInfinite() const;
84 double myRadius1, myRadius2;
87 //! Pointer on the object
88 typedef std::shared_ptr<GeomAPI_Cone> GeomConePtr;