src/GeomAPI/GeomAPI_Dir.h

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