SHAPER  9.12.0
GeomAPI_XYZ.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_XYZ_H_
21 #define GeomAPI_XYZ_H_
22 
23 #include <GeomAPI_Interface.h>
24 #include <memory>
25 
32 {
33  public:
35  GEOMAPI_EXPORT
36  GeomAPI_XYZ(const double theX, const double theY, const double theZ);
37 
39  GEOMAPI_EXPORT
40  double x() const;
42  GEOMAPI_EXPORT
43  double y() const;
45  GEOMAPI_EXPORT
46  double z() const;
47 
49  GEOMAPI_EXPORT
50  void setX(const double theX);
52  GEOMAPI_EXPORT
53  void setY(const double theY);
55  GEOMAPI_EXPORT
56  void setZ(const double theZ);
57 
59  GEOMAPI_EXPORT
60  const std::shared_ptr<GeomAPI_XYZ> added(const std::shared_ptr<GeomAPI_XYZ>& theArg);
62  GEOMAPI_EXPORT
63  const std::shared_ptr<GeomAPI_XYZ> decreased(const std::shared_ptr<GeomAPI_XYZ>& theArg);
65  GEOMAPI_EXPORT
66  const std::shared_ptr<GeomAPI_XYZ> multiplied(const double theArg);
67 
69  GEOMAPI_EXPORT
70  double dot(const std::shared_ptr<GeomAPI_XYZ>& theArg) const;
72  GEOMAPI_EXPORT
73  const std::shared_ptr<GeomAPI_XYZ> cross(const std::shared_ptr<GeomAPI_XYZ>& theArg) const;
74 
76  GEOMAPI_EXPORT
77  double distance(const std::shared_ptr<GeomAPI_XYZ>& theOther) const;
78 
80  GEOMAPI_EXPORT double squareModulus() const;
81 };
82 
84 typedef std::shared_ptr<GeomAPI_XYZ> GeomXYZPtr;
85 
86 #endif
87 
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
GEOMAPI_EXPORT GeomAPI_XYZ(const double theX, const double theY, const double theZ)
Creation by coordinates.
Definition: GeomAPI_XYZ.cpp:26
GEOMAPI_EXPORT double z() const
returns Z coordinate
Definition: GeomAPI_XYZ.cpp:41
GEOMAPI_EXPORT double squareModulus() const
Square length of triplet from the origin.
Definition: GeomAPI_XYZ.cpp:102
GEOMAPI_EXPORT const std::shared_ptr< GeomAPI_XYZ > added(const std::shared_ptr< GeomAPI_XYZ > &theArg)
result is sum of coordinates of this and the given argument
Definition: GeomAPI_XYZ.cpp:61
GEOMAPI_EXPORT void setY(const double theY)
sets Y coordinate
Definition: GeomAPI_XYZ.cpp:51
GEOMAPI_EXPORT const std::shared_ptr< GeomAPI_XYZ > multiplied(const double theArg)
result is coordinates multiplied by the argument
Definition: GeomAPI_XYZ.cpp:77
GEOMAPI_EXPORT const std::shared_ptr< GeomAPI_XYZ > decreased(const std::shared_ptr< GeomAPI_XYZ > &theArg)
result is difference between coordinates of this and the given argument
Definition: GeomAPI_XYZ.cpp:69
GEOMAPI_EXPORT const std::shared_ptr< GeomAPI_XYZ > cross(const std::shared_ptr< GeomAPI_XYZ > &theArg) const
result is a cross product of two triplets
Definition: GeomAPI_XYZ.cpp:89
GEOMAPI_EXPORT double dot(const std::shared_ptr< GeomAPI_XYZ > &theArg) const
result is a scalar product of two triplets
Definition: GeomAPI_XYZ.cpp:84
GEOMAPI_EXPORT double y() const
returns Y coordinate
Definition: GeomAPI_XYZ.cpp:36
GEOMAPI_EXPORT void setZ(const double theZ)
sets Z coordinate
Definition: GeomAPI_XYZ.cpp:56
GEOMAPI_EXPORT void setX(const double theX)
sets X coordinate
Definition: GeomAPI_XYZ.cpp:46
GEOMAPI_EXPORT double x() const
returns X coordinate
Definition: GeomAPI_XYZ.cpp:31
GEOMAPI_EXPORT double distance(const std::shared_ptr< GeomAPI_XYZ > &theOther) const
Distance between two triplets.
Definition: GeomAPI_XYZ.cpp:96