src/GeomAlgoAPI/GeomAlgoAPI_Rotation.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 GeomAlgoAPI_Rotation_H_
  21 #define GeomAlgoAPI_Rotation_H_
  22
  23 #include <GeomAlgoAPI.h>
  24 #include <GeomAlgoAPI_Transform.h>
  25
  26 class GeomAPI_Ax1;
  27 class GeomAPI_Pnt;
  28
  29 /// \class GeomAlgoAPI_Rotation
  30 /// \ingroup DataAlgo
  31 /// \brief Creates a copy of the object by rotating it around the axis.
  32 class GeomAlgoAPI_Rotation : public GeomAlgoAPI_Transform
  33 {
  34 public:
  35   /// \brief Creates an object which is obtained from current object by rotating it around the axis
  36   ///        with the angle.
  37   /// \param[in] theSourceShape  a shape to be rotated.
  38   /// \param[in] theAxis         rotation axis.
  39   /// \param[in] theAngle        rotation angle(in degree).
  40   GEOMALGOAPI_EXPORT GeomAlgoAPI_Rotation(std::shared_ptr<GeomAPI_Shape> theSourceShape,
  41                                           std::shared_ptr<GeomAPI_Ax1>   theAxis,
  42                                           double                         theAngle);
  43
  44   /// \brief Creates an object which is obtained from current object by rotating it around the axis
  45   ///        withe angle using the center and two points.
  46   /// \param[in] theSourceShape  a shape to be rotated.
  47   /// \param[in] theCenterPoint  center point.
  48   /// \param[in] theStartPoint   start point.
  49   /// \param[in] theEndPoint     end point.
  50   GEOMALGOAPI_EXPORT GeomAlgoAPI_Rotation(std::shared_ptr<GeomAPI_Shape> theSourceShape,
  51                                           std::shared_ptr<GeomAPI_Pnt>   theCenterPoint,
  52                                           std::shared_ptr<GeomAPI_Pnt>   theStartPoint,
  53                                           std::shared_ptr<GeomAPI_Pnt>   theEndPoint);
  54 };
  55
  56 #endif