src/GeomAPI/GeomAPI_Dir.h

   1 // File:        GeomAPI_Dir.hxx
   2 // Created:     23 Apr 2014
   3 // Author:      Mikhail PONIKAROV
   4
   5 #ifndef GeomAPI_Dir_H_
   6 #define GeomAPI_Dir_H_
   7
   8 #include <GeomAPI_Interface.h>
   9 #include <memory>
  10
  11 class GeomAPI_XYZ;
  12
  13 /**\class GeomAPI_Dir
  14  * \ingroup DataModel
  15  * \brief 3D direction defined by three normalized coordinates
  16  */
  17
  18 class GEOMAPI_EXPORT GeomAPI_Dir : public GeomAPI_Interface
  19 {
  20  public:
  21   /// Creation of direction by coordinates
  22   GeomAPI_Dir(const double theX, const double theY, const double theZ);
  23   /// Creation of direction by coordinates
  24   GeomAPI_Dir(const std::shared_ptr<GeomAPI_XYZ>& theCoords);
  25
  26   /// returns X coordinate
  27   double x() const;
  28   /// returns Y coordinate
  29   double y() const;
  30   /// returns Z coordinate
  31   double z() const;
  32
  33   /// returns coordinates of the direction
  34   const std::shared_ptr<GeomAPI_XYZ> xyz();
  35
  36   /// result is a scalar product of directions
  37   double dot(const std::shared_ptr<GeomAPI_Dir>& theArg) const;
  38   /// result is a cross product of two directions
  39   const std::shared_ptr<GeomAPI_XYZ> cross(const std::shared_ptr<GeomAPI_Dir>& theArg) const;
  40 };
  41
  42 #endif
  43