SHAPER  9.12.0
GeomAPI_Torus.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_Torus_H_
21 #define GeomAPI_Torus_H_
22 
23 #include <GeomAPI_Interface.h>
24 #include <memory>
25 
26 class GeomAPI_Dir;
27 class GeomAPI_Pnt;
28 
34 {
35 public:
37  GEOMAPI_EXPORT GeomAPI_Torus(const std::shared_ptr<GeomAPI_Pnt>& theCenter,
38  const std::shared_ptr<GeomAPI_Dir>& theDir,
39  const double theMajorRadius,
40  const double theMinorRadius);
41 
43  GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Pnt> center() const;
44 
46  GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Dir> direction() const;
47 
49  GEOMAPI_EXPORT double majorRadius() const;
50 
52  GEOMAPI_EXPORT double minorRadius() const;
53 };
54 
56 typedef std::shared_ptr<GeomAPI_Torus> GeomTorusPtr;
57 
58 #endif
3D direction defined by three normalized coordinates
Definition: GeomAPI_Dir.h:34
General base class for all interfaces in this package.
Definition: GeomAPI_Interface.h:38
3D point defined by three coordinates
Definition: GeomAPI_Pnt.h:38
Toroidal surface in 3D.
Definition: GeomAPI_Torus.h:34
GEOMAPI_EXPORT GeomAPI_Torus(const std::shared_ptr< GeomAPI_Pnt > &theCenter, const std::shared_ptr< GeomAPI_Dir > &theDir, const double theMajorRadius, const double theMinorRadius)
Creation of torus defined by center point, direction, major and minor radii.
Definition: GeomAPI_Torus.cpp:36
GEOMAPI_EXPORT std::shared_ptr< GeomAPI_Pnt > center() const
Return center of the torus.
Definition: GeomAPI_Torus.cpp:46
GEOMAPI_EXPORT double majorRadius() const
Return major radius of the torus.
Definition: GeomAPI_Torus.cpp:60
GEOMAPI_EXPORT double minorRadius() const
Return minor radius of the torus.
Definition: GeomAPI_Torus.cpp:66
GEOMAPI_EXPORT std::shared_ptr< GeomAPI_Dir > direction() const
Return direction of the torus.
Definition: GeomAPI_Torus.cpp:53