Salome HOME
Copyright update 2022
[modules/shaper.git] / src / GeomAPI / GeomAPI_Pnt.h
index af4cce8493b180a4b189f733a3025b1b5c5f188c..10cd12a8e4b751a021a1a33cff187598ee1f7224 100644 (file)
-// File:        GeomAPI_Pnt.hxx
-// Created:     23 Apr 2014
-// Author:      Mikhail PONIKAROV
+// Copyright (C) 2014-2022  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_Pnt_H_
 #define GeomAPI_Pnt_H_
 
 #include <GeomAPI_Interface.h>
-#include <boost/shared_ptr.hpp>
+#include <memory>
 
+class GeomAPI_Ax1;
 class GeomAPI_XYZ;
 class GeomAPI_Pnt2d;
 class GeomAPI_Dir;
+class GeomAPI_Pln;
 
 /**\class GeomAPI_Pnt
  * \ingroup DataModel
  * \brief 3D point defined by three coordinates
  */
 
-class GEOMAPI_EXPORT GeomAPI_Pnt : public GeomAPI_Interface
+class GeomAPI_Pnt : public GeomAPI_Interface
 {
  public:
   /// Creation of point by coordinates
+  GEOMAPI_EXPORT
   GeomAPI_Pnt(const double theX, const double theY, const double theZ);
   /// Creation of point by coordinates
-  GeomAPI_Pnt(const boost::shared_ptr<GeomAPI_XYZ>& theCoords);
+  GEOMAPI_EXPORT
+  GeomAPI_Pnt(const std::shared_ptr<GeomAPI_XYZ>& theCoords);
 
   /// returns X coordinate
+  GEOMAPI_EXPORT
   double x() const;
   /// returns Y coordinate
+  GEOMAPI_EXPORT
   double y() const;
   /// returns Z coordinate
+  GEOMAPI_EXPORT
   double z() const;
 
   /// sets X coordinate
+  GEOMAPI_EXPORT
   void setX(const double theX);
   /// sets Y coordinate
+  GEOMAPI_EXPORT
   void setY(const double theY);
   /// sets Z coordinate
+  GEOMAPI_EXPORT
   void setZ(const double theZ);
 
   /// returns coordinates of the point
-  const boost::shared_ptr<GeomAPI_XYZ> xyz();
+  GEOMAPI_EXPORT
+  const std::shared_ptr<GeomAPI_XYZ> xyz();
 
   /// Distance between two points
-  double distance(const boost::shared_ptr<GeomAPI_Pnt>& theOther) const;
+  GEOMAPI_EXPORT
+  double distance(const std::shared_ptr<GeomAPI_Pnt>& theOther) const;
+
+  /// Returns whether the distance between two points is less then precision confusion
+  GEOMAPI_EXPORT
+  bool isEqual(const std::shared_ptr<GeomAPI_Pnt>& theOther) const;
+
+  /// Returns \c true, if the current point is less than theOther.
+  /// The point is less than other, if X coordinate is less.
+  /// In case of X's are equal, if Y is less than other.
+  /// If Y's are equal too, compare Z's.
+  GEOMAPI_EXPORT
+  bool isLess(const std::shared_ptr<GeomAPI_Pnt>& theOther,
+              const double theTolerance = 1.e-7) const;
+
+  /// Projects a point to the plane defined by the origin and 2 axes vectors in this plane
+  GEOMAPI_EXPORT
+  std::shared_ptr<GeomAPI_Pnt2d> to2D(const std::shared_ptr<GeomAPI_Pnt>& theOrigin,
+                                        const std::shared_ptr<GeomAPI_Dir>& theDirX,
+                                        const std::shared_ptr<GeomAPI_Dir>& theDirY);
 
   /// Projects a point to the plane defined by the origin and 2 axes vectors in this plane
-  boost::shared_ptr<GeomAPI_Pnt2d> to2D(const boost::shared_ptr<GeomAPI_Pnt>& theOrigin,
-                                        const boost::shared_ptr<GeomAPI_Dir>& theDirX,
-                                        const boost::shared_ptr<GeomAPI_Dir>& theDirY);
+  GEOMAPI_EXPORT
+  std::shared_ptr<GeomAPI_Pnt2d> to2D(const std::shared_ptr<GeomAPI_Pln>& thePln) const;
+
+  /// Translates the point along direction theDir on distance theDist
+  GEOMAPI_EXPORT
+  void translate(const std::shared_ptr<GeomAPI_Dir>& theDir, double theDist);
+
+  /// Rotates the point along axis for the given angle (in degrees)
+  GEOMAPI_EXPORT void rotate(const std::shared_ptr<GeomAPI_Ax1>& theAxis, double theAngle);
 };
 
+//! Pointer on the object
+typedef std::shared_ptr<GeomAPI_Pnt> GeomPointPtr;
+
 #endif