src/GeomAPI/GeomAPI_Pnt.h

   1 // Copyright (C) 2014-2019  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 email : webmaster.salome@opencascade.com
  18 //
  19
  20 #ifndef GeomAPI_Pnt_H_
  21 #define GeomAPI_Pnt_H_
  22
  23 #include <GeomAPI_Interface.h>
  24 #include <memory>
  25
  26 class GeomAPI_XYZ;
  27 class GeomAPI_Pnt2d;
  28 class GeomAPI_Dir;
  29 class GeomAPI_Pln;
  30
  31 /**\class GeomAPI_Pnt
  32  * \ingroup DataModel
  33  * \brief 3D point defined by three coordinates
  34  */
  35
  36 class GeomAPI_Pnt : public GeomAPI_Interface
  37 {
  38  public:
  39   /// Creation of point by coordinates
  40   GEOMAPI_EXPORT
  41   GeomAPI_Pnt(const double theX, const double theY, const double theZ);
  42   /// Creation of point by coordinates
  43   GEOMAPI_EXPORT
  44   GeomAPI_Pnt(const std::shared_ptr<GeomAPI_XYZ>& theCoords);
  45
  46   /// returns X coordinate
  47   GEOMAPI_EXPORT
  48   double x() const;
  49   /// returns Y coordinate
  50   GEOMAPI_EXPORT
  51   double y() const;
  52   /// returns Z coordinate
  53   GEOMAPI_EXPORT
  54   double z() const;
  55
  56   /// sets X coordinate
  57   GEOMAPI_EXPORT
  58   void setX(const double theX);
  59   /// sets Y coordinate
  60   GEOMAPI_EXPORT
  61   void setY(const double theY);
  62   /// sets Z coordinate
  63   GEOMAPI_EXPORT
  64   void setZ(const double theZ);
  65
  66   /// returns coordinates of the point
  67   GEOMAPI_EXPORT
  68   const std::shared_ptr<GeomAPI_XYZ> xyz();
  69
  70   /// Distance between two points
  71   GEOMAPI_EXPORT
  72   double distance(const std::shared_ptr<GeomAPI_Pnt>& theOther) const;
  73
  74   /// Returns whether the distance between two points is less then precision confusion
  75   GEOMAPI_EXPORT
  76   bool isEqual(const std::shared_ptr<GeomAPI_Pnt>& theOther) const;
  77
  78   /// Returns \c true, if the current point is less than theOther.
  79   /// The point is less than other, if X coordinate is less.
  80   /// In case of X's are equal, if Y is less than other.
  81   /// If Y's are equal too, compare Z's.
  82   GEOMAPI_EXPORT
  83   bool isLess(const std::shared_ptr<GeomAPI_Pnt>& theOther) const;
  84
  85   /// Projects a point to the plane defined by the origin and 2 axes vectors in this plane
  86   GEOMAPI_EXPORT
  87   std::shared_ptr<GeomAPI_Pnt2d> to2D(const std::shared_ptr<GeomAPI_Pnt>& theOrigin,
  88                                         const std::shared_ptr<GeomAPI_Dir>& theDirX,
  89                                         const std::shared_ptr<GeomAPI_Dir>& theDirY);
  90
  91   /// Projects a point to the plane defined by the origin and 2 axes vectors in this plane
  92   GEOMAPI_EXPORT
  93   std::shared_ptr<GeomAPI_Pnt2d> to2D(const std::shared_ptr<GeomAPI_Pln>& thePln) const;
  94
  95   /// Translates the point along direction theDir on distance theDist
  96   GEOMAPI_EXPORT
  97   void translate(const std::shared_ptr<GeomAPI_Dir>& theDir, double theDist);
  98 };
  99
 100 //! Pointer on the object
 101 typedef std::shared_ptr<GeomAPI_Pnt> GeomPointPtr;
 102
 103 #endif