src/GeomAlgoAPI/GeomAlgoAPI_Translation.h

   1 // Copyright (C) 2014-2021  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_Translation_H_
  21 #define GeomAlgoAPI_Translation_H_
  22
  23 #include <GeomAlgoAPI.h>
  24 #include <GeomAlgoAPI_Transform.h>
  25
  26 class GeomAPI_Ax1;
  27 class GeomAPI_Pnt;
  28
  29 /// \class GeomAlgoAPI_Translation
  30 /// \ingroup DataAlgo
  31 /// \brief Creates a copy of the object by moving it along the axis.
  32 class GeomAlgoAPI_Translation : public GeomAlgoAPI_Transform
  33 {
  34 public:
  35   /// \brief Creates an object which is obtained from current object by moving it along the axis.
  36   /// \param[in] theSourceShape  a shape to be moved.
  37   /// \param[in] theAxis         movement axis.
  38   /// \param[in] theDistance     movement distance.
  39   GEOMALGOAPI_EXPORT GeomAlgoAPI_Translation(std::shared_ptr<GeomAPI_Shape> theSourceShape,
  40                                              std::shared_ptr<GeomAPI_Ax1>   theAxis,
  41                                              double                         theDistance);
  42
  43   /// \brief Creates an object which is obtained from current object by moving it along a vector
  44   ///        defined by its dimensions in X, Y and Z.
  45   /// \param[in] theSourceShape  the shape to be moved.
  46   /// \param[in] theDX           the movement dimension in X.
  47   /// \param[in] theDY           the movement dimension in Y.
  48   /// \param[in] theDZ           the movement dimension in Z.
  49   GEOMALGOAPI_EXPORT GeomAlgoAPI_Translation(std::shared_ptr<GeomAPI_Shape> theSourceShape,
  50                                              double                         theDx,
  51                                              double                         theDy,
  52                                              double                         theDz);
  53
  54   /// \brief Creates an object which is obtained from current object by moving it along a vector
  55   ///        defined by two points.
  56   /// \param[in] theSourceShape  the shape to be moved.
  57   /// \param[in] theStartPoint   the movement start point.
  58   /// \param[in] theEndPoint     the movement end point.
  59   GEOMALGOAPI_EXPORT GeomAlgoAPI_Translation(std::shared_ptr<GeomAPI_Shape> theSourceShape,
  60                                              std::shared_ptr<GeomAPI_Pnt>   theStartPoint,
  61                                              std::shared_ptr<GeomAPI_Pnt>   theEndPoint);
  62 };
  63
  64 #endif