src/GeomAPI/GeomAPI_Ax2.h

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