src/GeomAlgoAPI/GeomAlgoAPI_Rotation.h

   1 // Copyright (C) 2014-2019  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_MakeShape.h>
  25
  26 #include <GeomAPI_Ax1.h>
  27 #include <GeomAPI_Shape.h>
  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_MakeShape
  33 {
  34 public:
  35   /// Type of rotation operation
  36   enum MethodType {
  37     BY_ANGLE, ///< Rotation by axis and an angle
  38     BY_POINTS ///< Rotation by a center and two points
  39   };
  40
  41   /// \brief Creates an object which is obtained from current object by rotating it around the axis
  42   ///        with the angle.
  43   /// \param[in] theSourceShape  a shape to be rotated.
  44   /// \param[in] theAxis         rotation axis.
  45   /// \param[in] theAngle        rotation angle(in degree).
  46   GEOMALGOAPI_EXPORT GeomAlgoAPI_Rotation(std::shared_ptr<GeomAPI_Shape> theSourceShape,
  47                                           std::shared_ptr<GeomAPI_Ax1>   theAxis,
  48                                           double                         theAngle);
  49
  50   /// \brief Creates an object which is obtained from current object by rotating it around the axis
  51   ///        withe angle using the center and two points.
  52   /// \param[in] theSourceShape  a shape to be rotated.
  53   /// \param[in] theCenterPoint  center point.
  54   /// \param[in] theStartPoint   start point.
  55   /// \param[in] theEndPoint     end point.
  56   GEOMALGOAPI_EXPORT GeomAlgoAPI_Rotation(std::shared_ptr<GeomAPI_Shape> theSourceShape,
  57                                           std::shared_ptr<GeomAPI_Pnt>   theCenterPoint,
  58                                           std::shared_ptr<GeomAPI_Pnt>   theStartPoint,
  59                                           std::shared_ptr<GeomAPI_Pnt>   theEndPoint);
  60
  61   /// Checks if data for the translation execution is OK.
  62   GEOMALGOAPI_EXPORT bool check();
  63
  64   /// Execute the translation.
  65   GEOMALGOAPI_EXPORT void build();
  66
  67 private:
  68   MethodType myMethodType; /// Type of method used.
  69   std::shared_ptr<GeomAPI_Shape> mySourceShape; /// Shape to be rotated.
  70   std::shared_ptr<GeomAPI_Ax1> myAxis; /// Rotation axis.
  71   double myAngle; /// Rotation angle.
  72   std::shared_ptr<GeomAPI_Pnt> myCenterPoint; /// Rotation center point.
  73   std::shared_ptr<GeomAPI_Pnt> myStartPoint; /// Rotation start point.
  74   std::shared_ptr<GeomAPI_Pnt> myEndPoint; /// Rotation end point.
  75 };
  76
  77 #endif