src/GeomAPI/GeomAPI_XY.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_XY_H_
  21 #define GeomAPI_XY_H_
  22
  23 #include <GeomAPI_Interface.h>
  24 #include <memory>
  25
  26 /**\class GeomAPI_XY
  27  * \ingroup DataModel
  28  * \brief 2 coordinates: they may represent vector or point or something else
  29  */
  30
  31 class GeomAPI_XY : public GeomAPI_Interface
  32 {
  33  public:
  34   /// Creation by coordinates
  35   GEOMAPI_EXPORT
  36   GeomAPI_XY(const double theX, const double theY);
  37
  38   /// returns X coordinate
  39   GEOMAPI_EXPORT
  40   double x() const;
  41   /// returns Y coordinate
  42   GEOMAPI_EXPORT
  43   double y() const;
  44
  45   /// sets X coordinate
  46   GEOMAPI_EXPORT
  47   void setX(const double theX);
  48   /// sets Y coordinate
  49   GEOMAPI_EXPORT
  50   void setY(const double theY);
  51
  52   /// result is sum of coordinates of this and the given argument
  53   GEOMAPI_EXPORT
  54   const std::shared_ptr<GeomAPI_XY> added(const std::shared_ptr<GeomAPI_XY>& theArg);
  55   /// result is difference between coordinates of this and the given argument
  56   GEOMAPI_EXPORT
  57   const std::shared_ptr<GeomAPI_XY> decreased(const std::shared_ptr<GeomAPI_XY>& theArg);
  58   /// result is coordinates multiplied by the argument
  59   GEOMAPI_EXPORT
  60   const std::shared_ptr<GeomAPI_XY> multiplied(const double theArg);
  61
  62   /// result is a scalar product of two triplets
  63   GEOMAPI_EXPORT
  64   double dot(const std::shared_ptr<GeomAPI_XY>& theArg) const;
  65   /// result is a cross product of two triplets
  66   GEOMAPI_EXPORT
  67   double cross(const std::shared_ptr<GeomAPI_XY>& theArg) const;
  68
  69   /// Distance between two pairs
  70   GEOMAPI_EXPORT
  71   double distance(const std::shared_ptr<GeomAPI_XY>& theOther) const;
  72 };
  73
  74 #endif
  75