src/GeomAPI/GeomAPI_Ax2.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 // File:        GeomAPI_Ax2.h
   4 // Created:     12 May 2015
   5 // Author:      Dmitry Bobylev
   6
   7 #ifndef GeomAPI_Ax2_H_
   8 #define GeomAPI_Ax2_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_Ax2 : public GeomAPI_Interface
  18 {
  19 public:
  20   /// Default constructor.
  21   GEOMAPI_EXPORT
  22   GeomAPI_Ax2();
  23
  24   /** \brief Constructor.
  25    *  \param[in] theOrigin point of origin.
  26    *  \param[in] theN direction of axis.
  27    *  \param[in] theVX x direction of axis.
  28    */
  29   GEOMAPI_EXPORT
  30   GeomAPI_Ax2(std::shared_ptr<GeomAPI_Pnt> theOrigin,
  31               std::shared_ptr<GeomAPI_Dir> theN,
  32               std::shared_ptr<GeomAPI_Dir> theVX);
  33
  34   /** \brief Constructor.
  35    *  \param[in] theOrigin point of origin.
  36    *  \param[in] theDir direction of axis.
  37    */
  38   GEOMAPI_EXPORT
  39   GeomAPI_Ax2(std::shared_ptr<GeomAPI_Pnt> theOrigin,
  40               std::shared_ptr<GeomAPI_Dir> theDir);
  41
  42   /// Sets origin point.
  43   GEOMAPI_EXPORT
  44   void setOrigin(const std::shared_ptr<GeomAPI_Pnt>& theOrigin);
  45
  46   /// \return the plane origin point.
  47   GEOMAPI_EXPORT
  48   std::shared_ptr<GeomAPI_Pnt> origin() const;
  49
  50   /// Sets direction vector.
  51   GEOMAPI_EXPORT
  52   void setDir(const std::shared_ptr<GeomAPI_Dir>& theDir);
  53
  54   /// \return direction vector.
  55   GEOMAPI_EXPORT
  56   std::shared_ptr<GeomAPI_Dir> dir() const;
  57 };
  58
  59 #endif