]> SALOME platform Git repositories - modules/shaper.git/blob - src/GeomAPI/GeomAPI_XYZ.h
Salome HOME
Fix for the issue #2401
[modules/shaper.git] / src / GeomAPI / GeomAPI_XYZ.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_XYZ_H_
22 #define GeomAPI_XYZ_H_
23
24 #include <GeomAPI_Interface.h>
25 #include <memory>
26
27 /**\class GeomAPI_XYZ
28  * \ingroup DataModel
29  * \brief 3 coordinates: they may represent vector or point or something else
30  */
31
32 class GeomAPI_XYZ : public GeomAPI_Interface
33 {
34  public:
35   /// Creation by coordinates
36   GEOMAPI_EXPORT
37   GeomAPI_XYZ(const double theX, const double theY, const double theZ);
38
39   /// returns X coordinate
40   GEOMAPI_EXPORT
41   double x() const;
42   /// returns Y coordinate
43   GEOMAPI_EXPORT
44   double y() const;
45   /// returns Z coordinate
46   GEOMAPI_EXPORT
47   double z() const;
48
49   /// sets X coordinate
50   GEOMAPI_EXPORT
51   void setX(const double theX);
52   /// sets Y coordinate
53   GEOMAPI_EXPORT
54   void setY(const double theY);
55   /// sets Z coordinate
56   GEOMAPI_EXPORT
57   void setZ(const double theZ);
58
59   /// result is sum of coordinates of this and the given argument
60   GEOMAPI_EXPORT
61   const std::shared_ptr<GeomAPI_XYZ> added(const std::shared_ptr<GeomAPI_XYZ>& theArg);
62   /// result is difference between coordinates of this and the given argument
63   GEOMAPI_EXPORT
64   const std::shared_ptr<GeomAPI_XYZ> decreased(const std::shared_ptr<GeomAPI_XYZ>& theArg);
65   /// result is coordinates multiplied by the argument
66   GEOMAPI_EXPORT
67   const std::shared_ptr<GeomAPI_XYZ> multiplied(const double theArg);
68
69   /// result is a scalar product of two triplets
70   GEOMAPI_EXPORT
71   double dot(const std::shared_ptr<GeomAPI_XYZ>& theArg) const;
72   /// result is a cross product of two triplets
73   GEOMAPI_EXPORT
74   const std::shared_ptr<GeomAPI_XYZ> cross(const std::shared_ptr<GeomAPI_XYZ>& theArg) const;
75
76   /// Distance between two triplets
77   GEOMAPI_EXPORT
78   double distance(const std::shared_ptr<GeomAPI_XYZ>& theOther) const;
79
80   /// Square length of triplet from the origin
81   GEOMAPI_EXPORT double squareModulus() const;
82 };
83
84 #endif
85