SHAPER 9.16.0
GeomAPI_Dir.h
1// Copyright (C) 2014-2026 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_Dir_H_
21#define GeomAPI_Dir_H_
22
23#include <GeomAPI_Interface.h>
24#include <memory>
25
26class GeomAPI_XYZ;
27
34{
35 public:
37 GEOMAPI_EXPORT
38 GeomAPI_Dir(const double theX, const double theY, const double theZ);
40 GEOMAPI_EXPORT
41 GeomAPI_Dir(const std::shared_ptr<GeomAPI_XYZ>& theCoords);
42
44 GEOMAPI_EXPORT
45 double x() const;
47 GEOMAPI_EXPORT
48 double y() const;
50 GEOMAPI_EXPORT
51 double z() const;
52
54 GEOMAPI_EXPORT
55 const std::shared_ptr<GeomAPI_XYZ> xyz();
56
58 GEOMAPI_EXPORT void reverse();
59
61 GEOMAPI_EXPORT
62 double dot(const std::shared_ptr<GeomAPI_Dir>& theArg) const;
64 GEOMAPI_EXPORT
65 const std::shared_ptr<GeomAPI_XYZ> cross(const std::shared_ptr<GeomAPI_Dir>& theArg) const;
66
68 GEOMAPI_EXPORT
69 double angle(const std::shared_ptr<GeomAPI_Dir>& theArg) const;
70
73 GEOMAPI_EXPORT
74 bool isParallel(const std::shared_ptr<GeomAPI_Dir> theDir,
75 const double theTolerance = 1.e-7) const;
76
77
78};
79
81typedef std::shared_ptr<GeomAPI_Dir> GeomDirPtr;
82
83#endif
84
3D direction defined by three normalized coordinates
Definition: GeomAPI_Dir.h:34
GEOMAPI_EXPORT double y() const
returns Y coordinate
Definition: GeomAPI_Dir.cpp:42
GEOMAPI_EXPORT const std::shared_ptr< GeomAPI_XYZ > xyz()
returns coordinates of the direction
Definition: GeomAPI_Dir.cpp:52
GEOMAPI_EXPORT double x() const
returns X coordinate
Definition: GeomAPI_Dir.cpp:37
GEOMAPI_EXPORT double dot(const std::shared_ptr< GeomAPI_Dir > &theArg) const
result is a scalar product of directions
Definition: GeomAPI_Dir.cpp:62
GEOMAPI_EXPORT double z() const
returns Z coordinate
Definition: GeomAPI_Dir.cpp:47
GEOMAPI_EXPORT void reverse()
inverses the direction
Definition: GeomAPI_Dir.cpp:57
GEOMAPI_EXPORT const std::shared_ptr< GeomAPI_XYZ > cross(const std::shared_ptr< GeomAPI_Dir > &theArg) const
result is a cross product of two directions
Definition: GeomAPI_Dir.cpp:67
GEOMAPI_EXPORT double angle(const std::shared_ptr< GeomAPI_Dir > &theArg) const
calculates angle between two directions
Definition: GeomAPI_Dir.cpp:74
GEOMAPI_EXPORT bool isParallel(const std::shared_ptr< GeomAPI_Dir > theDir, const double theTolerance=1.e-7) const
Definition: GeomAPI_Dir.cpp:79
GEOMAPI_EXPORT GeomAPI_Dir(const double theX, const double theY, const double theZ)
Creation of direction by coordinates.
Definition: GeomAPI_Dir.cpp:27
General base class for all interfaces in this package.
Definition: GeomAPI_Interface.h:38
3 coordinates: they may represent vector or point or something else
Definition: GeomAPI_XYZ.h:32