src/GeomAPI/GeomAPI_Angle.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_Angle_H_
  22 #define GeomAPI_Angle_H_
  23
  24 #include <GeomAPI_Interface.h>
  25
  26 class GeomAPI_Edge;
  27 class GeomAPI_Pnt;
  28
  29 /// \class GeomAPI_Angle
  30 /// \ingroup DataModel
  31 /// \brief Build an angle
  32 class GeomAPI_Angle : public GeomAPI_Interface
  33 {
  34 public:
  35   /// Creation of an angle defined by two edges in the given intersection point.
  36   GEOMAPI_EXPORT
  37   GeomAPI_Angle(const std::shared_ptr<GeomAPI_Edge>& theEdge1,
  38                 const std::shared_ptr<GeomAPI_Edge>& theEdge2,
  39                 const std::shared_ptr<GeomAPI_Pnt>&  thePoint);
  40
  41   /// Creation of an angle defined by 3 points (the second point is an apex of an angle).
  42   GEOMAPI_EXPORT
  43   GeomAPI_Angle(const std::shared_ptr<GeomAPI_Pnt>& thePoint1,
  44                 const std::shared_ptr<GeomAPI_Pnt>& thePoint2,
  45                 const std::shared_ptr<GeomAPI_Pnt>& thePoint3);
  46
  47   /// Returns value of the angle in degrees
  48   GEOMAPI_EXPORT double angleDegree();
  49   /// Returns value of the angle in radians
  50   GEOMAPI_EXPORT double angleRadian();
  51 };
  52
  53 #endif