Salome HOME
Copyright update 2022
[modules/shaper.git] / src / GeomAPI / GeomAPI_Angle.h
1 // Copyright (C) 2018-2022  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 email : webmaster.salome@opencascade.com
18 //
19
20 #ifndef GeomAPI_Angle_H_
21 #define GeomAPI_Angle_H_
22
23 #include <GeomAPI_Interface.h>
24
25 class GeomAPI_Edge;
26 class GeomAPI_Pnt;
27
28 /// \class GeomAPI_Angle
29 /// \ingroup DataModel
30 /// \brief Build an angle
31 class GeomAPI_Angle : public GeomAPI_Interface
32 {
33 public:
34   /// Creation of an angle defined by two edges in the given intersection point.
35   GEOMAPI_EXPORT
36   GeomAPI_Angle(const std::shared_ptr<GeomAPI_Edge>& theEdge1,
37                 const std::shared_ptr<GeomAPI_Edge>& theEdge2,
38                 const std::shared_ptr<GeomAPI_Pnt>&  thePoint);
39
40   /// Creation of an angle defined by 3 points (the second point is an apex of an angle).
41   GEOMAPI_EXPORT
42   GeomAPI_Angle(const std::shared_ptr<GeomAPI_Pnt>& thePoint1,
43                 const std::shared_ptr<GeomAPI_Pnt>& thePoint2,
44                 const std::shared_ptr<GeomAPI_Pnt>& thePoint3);
45
46   /// Returns value of the angle in degrees
47   GEOMAPI_EXPORT double angleDegree();
48   /// Returns value of the angle in radians
49   GEOMAPI_EXPORT double angleRadian();
50 };
51
52 #endif