1 // Copyright (C) 2014-2019 CEA/DEN, EDF R&D
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.
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.
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
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
20 #ifndef GeomAPI_XYZ_H_
21 #define GeomAPI_XYZ_H_
23 #include <GeomAPI_Interface.h>
28 * \brief 3 coordinates: they may represent vector or point or something else
31 class GeomAPI_XYZ : public GeomAPI_Interface
34 /// Creation by coordinates
36 GeomAPI_XYZ(const double theX, const double theY, const double theZ);
38 /// returns X coordinate
41 /// returns Y coordinate
44 /// returns Z coordinate
50 void setX(const double theX);
53 void setY(const double theY);
56 void setZ(const double theZ);
58 /// result is sum of coordinates of this and the given argument
60 const std::shared_ptr<GeomAPI_XYZ> added(const std::shared_ptr<GeomAPI_XYZ>& theArg);
61 /// result is difference between coordinates of this and the given argument
63 const std::shared_ptr<GeomAPI_XYZ> decreased(const std::shared_ptr<GeomAPI_XYZ>& theArg);
64 /// result is coordinates multiplied by the argument
66 const std::shared_ptr<GeomAPI_XYZ> multiplied(const double theArg);
68 /// result is a scalar product of two triplets
70 double dot(const std::shared_ptr<GeomAPI_XYZ>& theArg) const;
71 /// result is a cross product of two triplets
73 const std::shared_ptr<GeomAPI_XYZ> cross(const std::shared_ptr<GeomAPI_XYZ>& theArg) const;
75 /// Distance between two triplets
77 double distance(const std::shared_ptr<GeomAPI_XYZ>& theOther) const;
79 /// Square length of triplet from the origin
80 GEOMAPI_EXPORT double squareModulus() const;
84 typedef std::shared_ptr<GeomAPI_XYZ> GeomXYZPtr;