src/GeomAPI/GeomAPI_Pnt2d.h

   1 // Copyright (C) 2014-2017  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
  18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
  19 //
  20
  21 #ifndef GeomAPI_Pnt2d_H_
  22 #define GeomAPI_Pnt2d_H_
  23
  24 #include <GeomAPI_Interface.h>
  25 #include <memory>
  26
  27 class GeomAPI_XY;
  28 class GeomAPI_Pnt;
  29 class GeomAPI_Dir;
  30
  31 /**\class GeomAPI_Pnt2d
  32  * \ingroup DataModel
  33  * \brief 2D point defined by two coordinates
  34  */
  35
  36 class GeomAPI_Pnt2d : public GeomAPI_Interface
  37 {
  38  public:
  39   /// Creation of point by coordinates
  40   GEOMAPI_EXPORT
  41   GeomAPI_Pnt2d(const double theX, const double theY);
  42   /// Creation of point by coordinates
  43   GEOMAPI_EXPORT
  44   GeomAPI_Pnt2d(const std::shared_ptr<GeomAPI_XY>& 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
  53   /// sets X coordinate
  54   GEOMAPI_EXPORT
  55   void setX(const double theX);
  56   /// sets Y coordinate
  57   GEOMAPI_EXPORT
  58   void setY(const double theY);
  59
  60   /// Returns the 3D point
  61   GEOMAPI_EXPORT
  62   std::shared_ptr<GeomAPI_Pnt> to3D(const std::shared_ptr<GeomAPI_Pnt>& theOrigin,
  63                                       const std::shared_ptr<GeomAPI_Dir>& theDirX,
  64                                       const std::shared_ptr<GeomAPI_Dir>& theDirY);
  65
  66   /// returns coordinates of the point
  67   GEOMAPI_EXPORT
  68   const std::shared_ptr<GeomAPI_XY> xy();
  69
  70   /// Distance between two points
  71   GEOMAPI_EXPORT
  72   double distance(const std::shared_ptr<GeomAPI_Pnt2d>& 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_Pnt2d>& theOther) const;
  77 };
  78
  79 //! Pointer on the object
  80 typedef std::shared_ptr<GeomAPI_Pnt2d> GeomPnt2dPtr;
  81
  82 #endif
  83