src/GeomAPI/GeomAPI_Ax1.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 // File:        GeomAPI_Ax1.h
   4 // Created:     12 May 2015
   5 // Author:      Dmitry Bobylev
   6
   7 #ifndef GEOMAPI_AX1_H_
   8 #define GEOMAPI_AX1_H_
   9
  10 #include <GeomAPI.h>
  11 #include <GeomAPI_Pnt.h>
  12 #include <GeomAPI_Dir.h>
  13
  14 /** \ingroup DataModel
  15  *  \brief The class represents an axis in 3D space.
  16  */
  17 class GEOMAPI_EXPORT GeomAPI_Ax1 : public GeomAPI_Interface
  18 {
  19 public:
  20   /// Default constructor.
  21   GeomAPI_Ax1();
  22
  23   /** \brief Ñonstructor.
  24   *   \param[in] theOrigin point of origin.
  25   *   \param[in] theDir direction of axis.
  26   */
  27   GeomAPI_Ax1(std::shared_ptr<GeomAPI_Pnt> theOrigin,
  28               std::shared_ptr<GeomAPI_Dir> theDir);
  29
  30   /// Sets origin point.
  31   void setOrigin(const std::shared_ptr<GeomAPI_Pnt>& theOrigin);
  32
  33   /// \return the plane origin point.
  34   std::shared_ptr<GeomAPI_Pnt> origin() const;
  35
  36   /// Sets direction vector.
  37   void setDir(const std::shared_ptr<GeomAPI_Dir>& theDir);
  38
  39   /// \return direction vector.
  40   std::shared_ptr<GeomAPI_Dir> dir() const;
  41
  42   /// Reverses the unit vector of this axis and assigns the result to this axis.
  43   void reverse();
  44
  45   /// \return reversed unit vector of this axis.
  46   std::shared_ptr<GeomAPI_Ax1> reversed();
  47 };
  48
  49 #endif