src/GeomAPI/GeomAPI_Ax2.h

   1 // Copyright (C) 2014-2023  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_Ax2_H_
  21 #define GeomAPI_Ax2_H_
  22
  23 #include <GeomAPI.h>
  24 #include <GeomAPI_Pnt.h>
  25 #include <GeomAPI_Dir.h>
  26
  27 /** \ingroup DataModel
  28  *  \brief The class represents an axis in 3D space.
  29  */
  30 class GeomAPI_Ax2 : public GeomAPI_Interface
  31 {
  32 public:
  33   /// Default constructor.
  34   GEOMAPI_EXPORT
  35   GeomAPI_Ax2();
  36
  37   /** \brief Constructor.
  38    *  \param[in] theOrigin point of origin.
  39    *  \param[in] theN direction of axis.
  40    *  \param[in] theVX x direction of axis.
  41    */
  42   GEOMAPI_EXPORT
  43   GeomAPI_Ax2(std::shared_ptr<GeomAPI_Pnt> theOrigin,
  44               std::shared_ptr<GeomAPI_Dir> theN,
  45               std::shared_ptr<GeomAPI_Dir> theVX);
  46
  47   /** \brief Constructor.
  48    *  \param[in] theOrigin point of origin.
  49    *  \param[in] theDir direction of axis.
  50    */
  51   GEOMAPI_EXPORT
  52   GeomAPI_Ax2(std::shared_ptr<GeomAPI_Pnt> theOrigin,
  53               std::shared_ptr<GeomAPI_Dir> theDir);
  54
  55   /// Sets origin point.
  56   GEOMAPI_EXPORT
  57   void setOrigin(const std::shared_ptr<GeomAPI_Pnt>& theOrigin);
  58
  59   /// \return the plane origin point.
  60   GEOMAPI_EXPORT
  61   std::shared_ptr<GeomAPI_Pnt> origin() const;
  62
  63   /// Sets direction vector.
  64   GEOMAPI_EXPORT
  65   void setDir(const std::shared_ptr<GeomAPI_Dir>& theDir);
  66
  67   /// \return direction vector.
  68   GEOMAPI_EXPORT
  69   std::shared_ptr<GeomAPI_Dir> dir() const;
  70 };
  71
  72 //! Pointer on the object
  73 typedef std::shared_ptr<GeomAPI_Ax2> GeomAx2Ptr;
  74
  75 #endif