src/GeomAPI/GeomAPI_Dir2d.h

   1 // Copyright (C) 2014-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_Dir2d_H_
  21 #define GeomAPI_Dir2d_H_
  22
  23 #include <GeomAPI_Interface.h>
  24 #include <memory>
  25
  26 class GeomAPI_XY;
  27
  28 /**\class GeomAPI_Dir2d
  29  * \ingroup DataModel
  30  * \brief 2D direction defined by three normalized coordinates
  31  */
  32
  33 class GeomAPI_Dir2d : public GeomAPI_Interface
  34 {
  35  public:
  36   /// Creation of direction by coordinates
  37   GEOMAPI_EXPORT
  38   GeomAPI_Dir2d(const double theX, const double theY);
  39   /// Creation of direction by coordinates
  40   GEOMAPI_EXPORT
  41   GeomAPI_Dir2d(const std::shared_ptr<GeomAPI_XY>& theCoords);
  42
  43   /// returns X coordinate
  44   GEOMAPI_EXPORT
  45   double x() const;
  46   /// returns Y coordinate
  47   GEOMAPI_EXPORT
  48   double y() const;
  49
  50   /// returns coordinates of the direction
  51   GEOMAPI_EXPORT
  52   const std::shared_ptr<GeomAPI_XY> xy();
  53
  54   /// inverses the direction
  55   GEOMAPI_EXPORT void reverse();
  56
  57   /// result is a scalar product of directions
  58   GEOMAPI_EXPORT
  59   double dot(const std::shared_ptr<GeomAPI_Dir2d>& theArg) const;
  60   /// result is a cross product of two directions
  61   GEOMAPI_EXPORT
  62   double cross(const std::shared_ptr<GeomAPI_Dir2d>& theArg) const;
  63
  64   /// calculates angle between two directions
  65   GEOMAPI_EXPORT
  66   double angle(const std::shared_ptr<GeomAPI_Dir2d>& theArg) const;
  67 };
  68
  69 //! Pointer on the object
  70 typedef std::shared_ptr<GeomAPI_Dir2d> GeomDir2dPtr;
  71
  72 #endif
  73