src/GeomAlgoAPI/GeomAlgoAPI_Translation.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 GeomAlgoAPI_Translation_H_
  22 #define GeomAlgoAPI_Translation_H_
  23
  24 #include <GeomAlgoAPI.h>
  25 #include <GeomAlgoAPI_MakeShape.h>
  26
  27 #include <GeomAPI_Ax1.h>
  28 #include <GeomAPI_Shape.h>
  29
  30 /// \class GeomAlgoAPI_Translation
  31 /// \ingroup DataAlgo
  32 /// \brief Creates a copy of the object by moving it along the axis.
  33 class GeomAlgoAPI_Translation : public GeomAlgoAPI_MakeShape
  34 {
  35 public:
  36   /// Type of translation operation
  37   enum MethodType {
  38     BY_DISTANCE, ///< Translation by axis and distance
  39     BY_DIM,      ///< Translation by dimensions in X, Y and Z
  40     BY_POINTS    ///< Translation by two points
  41   };
  42
  43   /// \brief Creates an object which is obtained from current object by moving it along the axis.
  44   /// \param[in] theSourceShape  a shape to be moved.
  45   /// \param[in] theAxis         movement axis.
  46   /// \param[in] theDistance     movement distance.
  47   GEOMALGOAPI_EXPORT GeomAlgoAPI_Translation(std::shared_ptr<GeomAPI_Shape> theSourceShape,
  48                                              std::shared_ptr<GeomAPI_Ax1>   theAxis,
  49                                              double                         theDistance);
  50
  51   /// \brief Creates an object which is obtained from current object by moving it along a vector
  52   ///        defined by its dimensions in X, Y and Z.
  53   /// \param[in] theSourceShape  the shape to be moved.
  54   /// \param[in] theDX           the movement dimension in X.
  55   /// \param[in] theDY           the movement dimension in Y.
  56   /// \param[in] theDZ           the movement dimension in Z.
  57   GEOMALGOAPI_EXPORT GeomAlgoAPI_Translation(std::shared_ptr<GeomAPI_Shape> theSourceShape,
  58                                              double                         theDx,
  59                                              double                         theDy,
  60                                              double                         theDz);
  61
  62   /// \brief Creates an object which is obtained from current object by moving it along a vector
  63   ///        defined by two points.
  64   /// \param[in] theSourceShape  the shape to be moved.
  65   /// \param[in] theStartPoint   the movement start point.
  66   /// \param[in] theEndPoint     the movement end point.
  67   GEOMALGOAPI_EXPORT GeomAlgoAPI_Translation(std::shared_ptr<GeomAPI_Shape> theSourceShape,
  68                                              std::shared_ptr<GeomAPI_Pnt>   theStartPoint,
  69                                              std::shared_ptr<GeomAPI_Pnt>   theEndPoint);
  70
  71   /// Checks if data for the translation execution is OK.
  72   GEOMALGOAPI_EXPORT bool check();
  73
  74   /// Execute the translation.
  75   GEOMALGOAPI_EXPORT void build();
  76
  77 private:
  78   MethodType myMethodType; /// Type of method used.
  79   std::shared_ptr<GeomAPI_Shape> mySourceShape; /// Shape to be moved.
  80   std::shared_ptr<GeomAPI_Ax1> myAxis; /// Movement axis.
  81   double myDistance; /// Movement distance.
  82   double myDx; /// Movement dimension on X.
  83   double myDy; /// Movement dimension on Y.
  84   double myDz; /// Movement dimension on Z.
  85   std::shared_ptr<GeomAPI_Pnt> myStartPoint; /// Movement start point.
  86   std::shared_ptr<GeomAPI_Pnt> myEndPoint; /// Movement end point.
  87 };
  88
  89 #endif