1 // Copyright (C) 2014-2019 CEA/DEN, EDF R&D
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.
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.
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
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
20 #ifndef GeomAlgoAPI_Translation_H_
21 #define GeomAlgoAPI_Translation_H_
23 #include <GeomAlgoAPI.h>
24 #include <GeomAlgoAPI_MakeShape.h>
26 #include <GeomAPI_Ax1.h>
27 #include <GeomAPI_Shape.h>
29 /// \class GeomAlgoAPI_Translation
31 /// \brief Creates a copy of the object by moving it along the axis.
32 class GeomAlgoAPI_Translation : public GeomAlgoAPI_MakeShape
35 /// Type of translation operation
37 BY_DISTANCE, ///< Translation by axis and distance
38 BY_DIM, ///< Translation by dimensions in X, Y and Z
39 BY_POINTS ///< Translation by two points
42 /// \brief Creates an object which is obtained from current object by moving it along the axis.
43 /// \param[in] theSourceShape a shape to be moved.
44 /// \param[in] theAxis movement axis.
45 /// \param[in] theDistance movement distance.
46 GEOMALGOAPI_EXPORT GeomAlgoAPI_Translation(std::shared_ptr<GeomAPI_Shape> theSourceShape,
47 std::shared_ptr<GeomAPI_Ax1> theAxis,
50 /// \brief Creates an object which is obtained from current object by moving it along a vector
51 /// defined by its dimensions in X, Y and Z.
52 /// \param[in] theSourceShape the shape to be moved.
53 /// \param[in] theDX the movement dimension in X.
54 /// \param[in] theDY the movement dimension in Y.
55 /// \param[in] theDZ the movement dimension in Z.
56 GEOMALGOAPI_EXPORT GeomAlgoAPI_Translation(std::shared_ptr<GeomAPI_Shape> theSourceShape,
61 /// \brief Creates an object which is obtained from current object by moving it along a vector
62 /// defined by two points.
63 /// \param[in] theSourceShape the shape to be moved.
64 /// \param[in] theStartPoint the movement start point.
65 /// \param[in] theEndPoint the movement end point.
66 GEOMALGOAPI_EXPORT GeomAlgoAPI_Translation(std::shared_ptr<GeomAPI_Shape> theSourceShape,
67 std::shared_ptr<GeomAPI_Pnt> theStartPoint,
68 std::shared_ptr<GeomAPI_Pnt> theEndPoint);
70 /// Checks if data for the translation execution is OK.
71 GEOMALGOAPI_EXPORT bool check();
73 /// Execute the translation.
74 GEOMALGOAPI_EXPORT void build();
77 MethodType myMethodType; /// Type of method used.
78 std::shared_ptr<GeomAPI_Shape> mySourceShape; /// Shape to be moved.
79 std::shared_ptr<GeomAPI_Ax1> myAxis; /// Movement axis.
80 double myDistance; /// Movement distance.
81 double myDx; /// Movement dimension on X.
82 double myDy; /// Movement dimension on Y.
83 double myDz; /// Movement dimension on Z.
84 std::shared_ptr<GeomAPI_Pnt> myStartPoint; /// Movement start point.
85 std::shared_ptr<GeomAPI_Pnt> myEndPoint; /// Movement end point.