SHAPER  9.12.0
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 
34 {
35  public:
37  GEOMAPI_EXPORT
38  GeomAPI_Dir2d(const double theX, const double theY);
40  GEOMAPI_EXPORT
41  GeomAPI_Dir2d(const std::shared_ptr<GeomAPI_XY>& theCoords);
42 
44  GEOMAPI_EXPORT
45  double x() const;
47  GEOMAPI_EXPORT
48  double y() const;
49 
51  GEOMAPI_EXPORT
52  const std::shared_ptr<GeomAPI_XY> xy();
53 
55  GEOMAPI_EXPORT void reverse();
56 
58  GEOMAPI_EXPORT
59  double dot(const std::shared_ptr<GeomAPI_Dir2d>& theArg) const;
61  GEOMAPI_EXPORT
62  double cross(const std::shared_ptr<GeomAPI_Dir2d>& theArg) const;
63 
65  GEOMAPI_EXPORT
66  double angle(const std::shared_ptr<GeomAPI_Dir2d>& theArg) const;
67 };
68 
70 typedef std::shared_ptr<GeomAPI_Dir2d> GeomDir2dPtr;
71 
72 #endif
73 
2D direction defined by three normalized coordinates
Definition: GeomAPI_Dir2d.h:34
GEOMAPI_EXPORT double angle(const std::shared_ptr< GeomAPI_Dir2d > &theArg) const
calculates angle between two directions
Definition: GeomAPI_Dir2d.cpp:67
GEOMAPI_EXPORT double y() const
returns Y coordinate
Definition: GeomAPI_Dir2d.cpp:42
GEOMAPI_EXPORT const std::shared_ptr< GeomAPI_XY > xy()
returns coordinates of the direction
Definition: GeomAPI_Dir2d.cpp:47
GEOMAPI_EXPORT GeomAPI_Dir2d(const double theX, const double theY)
Creation of direction by coordinates.
Definition: GeomAPI_Dir2d.cpp:27
GEOMAPI_EXPORT double cross(const std::shared_ptr< GeomAPI_Dir2d > &theArg) const
result is a cross product of two directions
Definition: GeomAPI_Dir2d.cpp:62
GEOMAPI_EXPORT void reverse()
inverses the direction
Definition: GeomAPI_Dir2d.cpp:52
GEOMAPI_EXPORT double x() const
returns X coordinate
Definition: GeomAPI_Dir2d.cpp:37
GEOMAPI_EXPORT double dot(const std::shared_ptr< GeomAPI_Dir2d > &theArg) const
result is a scalar product of directions
Definition: GeomAPI_Dir2d.cpp:57
General base class for all interfaces in this package.
Definition: GeomAPI_Interface.h:38
2 coordinates: they may represent vector or point or something else
Definition: GeomAPI_XY.h:32