Salome HOME
Update copyrights
[modules/shaper.git] / src / GeomAPI / GeomAPI_XYZ.h
index 38f189db6b3d0c722a8ca6d93ffe4671f0bd8378..5b5c19bff4dc7d0d042181975b5638285c246eb8 100644 (file)
@@ -1,8 +1,21 @@
-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
-
-// File:        GeomAPI_XYZ.hxx
-// Created:     23 Apr 2014
-// Author:      Mikhail PONIKAROV
+// Copyright (C) 2014-2019  CEA/DEN, EDF R&D
+//
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+//
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+//
 
 #ifndef GeomAPI_XYZ_H_
 #define GeomAPI_XYZ_H_
@@ -19,50 +32,56 @@ class GeomAPI_XYZ : public GeomAPI_Interface
 {
  public:
   /// Creation by coordinates
-  GEOMAPI_EXPORT 
+  GEOMAPI_EXPORT
   GeomAPI_XYZ(const double theX, const double theY, const double theZ);
 
   /// returns X coordinate
-  GEOMAPI_EXPORT 
+  GEOMAPI_EXPORT
   double x() const;
   /// returns Y coordinate
-  GEOMAPI_EXPORT 
+  GEOMAPI_EXPORT
   double y() const;
   /// returns Z coordinate
-  GEOMAPI_EXPORT 
+  GEOMAPI_EXPORT
   double z() const;
 
   /// sets X coordinate
-  GEOMAPI_EXPORT 
+  GEOMAPI_EXPORT
   void setX(const double theX);
   /// sets Y coordinate
-  GEOMAPI_EXPORT 
+  GEOMAPI_EXPORT
   void setY(const double theY);
   /// sets Z coordinate
-  GEOMAPI_EXPORT 
+  GEOMAPI_EXPORT
   void setZ(const double theZ);
 
   /// result is sum of coordinates of this and the given argument
-  GEOMAPI_EXPORT 
+  GEOMAPI_EXPORT
   const std::shared_ptr<GeomAPI_XYZ> added(const std::shared_ptr<GeomAPI_XYZ>& theArg);
   /// result is difference between coordinates of this and the given argument
-  GEOMAPI_EXPORT 
+  GEOMAPI_EXPORT
   const std::shared_ptr<GeomAPI_XYZ> decreased(const std::shared_ptr<GeomAPI_XYZ>& theArg);
   /// result is coordinates multiplied by the argument
-  GEOMAPI_EXPORT 
+  GEOMAPI_EXPORT
   const std::shared_ptr<GeomAPI_XYZ> multiplied(const double theArg);
 
   /// result is a scalar product of two triplets
-  GEOMAPI_EXPORT 
+  GEOMAPI_EXPORT
   double dot(const std::shared_ptr<GeomAPI_XYZ>& theArg) const;
   /// result is a cross product of two triplets
-  GEOMAPI_EXPORT 
+  GEOMAPI_EXPORT
   const std::shared_ptr<GeomAPI_XYZ> cross(const std::shared_ptr<GeomAPI_XYZ>& theArg) const;
 
   /// Distance between two triplets
-  GEOMAPI_EXPORT 
+  GEOMAPI_EXPORT
   double distance(const std::shared_ptr<GeomAPI_XYZ>& theOther) const;
+
+  /// Square length of triplet from the origin
+  GEOMAPI_EXPORT double squareModulus() const;
 };
 
+//! Pointer on object
+typedef std::shared_ptr<GeomAPI_XYZ> GeomXYZPtr;
+
 #endif