src/GeomAPI/GeomAPI_Angle2d.h

   1 // Copyright (C) 2014-2017  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_Angle2d_H_
  22 #define GeomAPI_Angle2d_H_
  23
  24 #include <GeomAPI_Interface.h>
  25
  26 class GeomAPI_Lin2d;
  27 class GeomAPI_Pnt2d;
  28
  29 /// \class GeomAPI_Angle2d
  30 /// \ingroup DataModel
  31 /// \brief Build an angle in plane
  32 class GeomAPI_Angle2d : public GeomAPI_Interface
  33 {
  34 public:
  35   /// Creation of an angle defined by two lines' start, end points
  36   GEOMAPI_EXPORT
  37   GeomAPI_Angle2d(const std::shared_ptr<GeomAPI_Pnt2d>& theStartLine1,
  38                   const std::shared_ptr<GeomAPI_Pnt2d>& theEndLine1,
  39                   const std::shared_ptr<GeomAPI_Pnt2d>& theStartLine2,
  40                   const std::shared_ptr<GeomAPI_Pnt2d>& theEndLine2);
  41   /// Creation of an angle defined by two lines taking into account their orientation
  42   GEOMAPI_EXPORT
  43   GeomAPI_Angle2d(const std::shared_ptr<GeomAPI_Lin2d>& theLine1, bool theReversed1,
  44                   const std::shared_ptr<GeomAPI_Lin2d>& theLine2, bool theReversed2);
  45   /// Creation of an angle defined by three points
  46   GEOMAPI_EXPORT
  47   GeomAPI_Angle2d(const std::shared_ptr<GeomAPI_Pnt2d>& theCenter,
  48                   const std::shared_ptr<GeomAPI_Pnt2d>& thePoint1,
  49                   const std::shared_ptr<GeomAPI_Pnt2d>& thePoint2);
  50
  51   /// Returns central point of the angle
  52   GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Pnt2d> center();
  53   /// Returns point on the first edge
  54   GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Pnt2d> firstPoint();
  55   /// Returns point on the second edge
  56   GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Pnt2d> secondPoint();
  57
  58   /// Returns value of the angle in degrees
  59   GEOMAPI_EXPORT double angleDegree();
  60   /// Returns value of the angle in radians
  61   GEOMAPI_EXPORT double angleRadian();
  62
  63   /// Returns \c true if the line is reversed during angle calculation.
  64   /// If theIndex = 0, the result corresponds to the first line,
  65   /// if theIndex = 1, the to the second line
  66   GEOMAPI_EXPORT bool isReversed(int theIndex);
  67 };
  68
  69 #endif
  70