src/GeomAPI/GeomAPI_Dir.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_Dir_H_
  22 #define GeomAPI_Dir_H_
  23
  24 #include <GeomAPI_Interface.h>
  25 #include <memory>
  26
  27 class GeomAPI_XYZ;
  28
  29 /**\class GeomAPI_Dir
  30  * \ingroup DataModel
  31  * \brief 3D direction defined by three normalized coordinates
  32  */
  33
  34 class GeomAPI_Dir : public GeomAPI_Interface
  35 {
  36  public:
  37   /// Creation of direction by coordinates
  38   GEOMAPI_EXPORT
  39   GeomAPI_Dir(const double theX, const double theY, const double theZ);
  40   /// Creation of direction by coordinates
  41   GEOMAPI_EXPORT
  42   GeomAPI_Dir(const std::shared_ptr<GeomAPI_XYZ>& theCoords);
  43
  44   /// returns X coordinate
  45   GEOMAPI_EXPORT
  46   double x() const;
  47   /// returns Y coordinate
  48   GEOMAPI_EXPORT
  49   double y() const;
  50   /// returns Z coordinate
  51   GEOMAPI_EXPORT
  52   double z() const;
  53
  54   /// returns coordinates of the direction
  55   GEOMAPI_EXPORT
  56   const std::shared_ptr<GeomAPI_XYZ> xyz();
  57
  58   /// inverses the direction
  59   GEOMAPI_EXPORT void reverse();
  60
  61   /// result is a scalar product of directions
  62   GEOMAPI_EXPORT
  63   double dot(const std::shared_ptr<GeomAPI_Dir>& theArg) const;
  64   /// result is a cross product of two directions
  65   GEOMAPI_EXPORT
  66   const std::shared_ptr<GeomAPI_XYZ> cross(const std::shared_ptr<GeomAPI_Dir>& theArg) const;
  67
  68   /// calculates angle between two directions
  69   GEOMAPI_EXPORT
  70   double angle(const std::shared_ptr<GeomAPI_Dir>& theArg) const;
  71
  72   /// \return true if the angle between this unit vector and
  73   /// theDir unit vector is equal to 0 or to Pi.
  74   GEOMAPI_EXPORT
  75   bool isParallel(const std::shared_ptr<GeomAPI_Dir> theDir,
  76                   const double theTolerance = 1.e-7) const;
  77
  78
  79 };
  80
  81 //! Pointer on the object
  82 typedef std::shared_ptr<GeomAPI_Dir> GeomDirPtr;
  83
  84 #endif
  85