Salome HOME
Porting to the current version of TInspector.
[modules/shaper.git] / src / GeomAlgoAPI / GeomAlgoAPI_Translation.h
index 8f27aaa6f6ce073ec9b80efda19b7c5388cffab6..dc5bf46f22691b463479ef545826002b0eec29d4 100644 (file)
@@ -1,8 +1,22 @@
-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
-
-// File:        GeomAlgoAPI_Translation.h
-// Created:     8 June 2015
-// Author:      Dmitry Bobylev
+// Copyright (C) 2014-2017  CEA/DEN, EDF R&D
+//
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+//
+// See http://www.salome-platform.org/ or
+// email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
+//
 
 #ifndef GeomAlgoAPI_Translation_H_
 #define GeomAlgoAPI_Translation_H_
 class GeomAlgoAPI_Translation : public GeomAlgoAPI_MakeShape
 {
 public:
+  /// Type of translation operation
+  enum MethodType {
+    BY_DISTANCE, ///< Translation by axis and distance
+    BY_DIM,      ///< Translation by dimensions in X, Y and Z
+    BY_POINTS    ///< Translation by two points
+  };
+
   /// \brief Creates an object which is obtained from current object by moving it along the axis.
   /// \param[in] theSourceShape  a shape to be moved.
   /// \param[in] theAxis         movement axis.
@@ -27,11 +48,42 @@ public:
                                              std::shared_ptr<GeomAPI_Ax1>   theAxis,
                                              double                         theDistance);
 
+  /// \brief Creates an object which is obtained from current object by moving it along a vector
+  ///        defined by its dimensions in X, Y and Z.
+  /// \param[in] theSourceShape  the shape to be moved.
+  /// \param[in] theDX           the movement dimension in X.
+  /// \param[in] theDY           the movement dimension in Y.
+  /// \param[in] theDZ           the movement dimension in Z.
+  GEOMALGOAPI_EXPORT GeomAlgoAPI_Translation(std::shared_ptr<GeomAPI_Shape> theSourceShape,
+                                             double                         theDx,
+                                             double                         theDy,
+                                             double                         theDz);
+
+  /// \brief Creates an object which is obtained from current object by moving it along a vector
+  ///        defined by two points.
+  /// \param[in] theSourceShape  the shape to be moved.
+  /// \param[in] theStartPoint   the movement start point.
+  /// \param[in] theEndPoint     the movement end point.
+  GEOMALGOAPI_EXPORT GeomAlgoAPI_Translation(std::shared_ptr<GeomAPI_Shape> theSourceShape,
+                                             std::shared_ptr<GeomAPI_Pnt>   theStartPoint,
+                                             std::shared_ptr<GeomAPI_Pnt>   theEndPoint);
+
+  /// Checks if data for the translation execution is OK.
+  GEOMALGOAPI_EXPORT bool check();
+
+  /// Execute the translation.
+  GEOMALGOAPI_EXPORT void build();
+
 private:
-  /// Builds resulting shape.
-  void build(std::shared_ptr<GeomAPI_Shape> theSourceShape,
-             std::shared_ptr<GeomAPI_Ax1>   theAxis,
-             double                         theDistance);
+  MethodType myMethodType; /// Type of method used.
+  std::shared_ptr<GeomAPI_Shape> mySourceShape; /// Shape to be moved.
+  std::shared_ptr<GeomAPI_Ax1> myAxis; /// Movement axis.
+  double myDistance; /// Movement distance.
+  double myDx; /// Movement dimension on X.
+  double myDy; /// Movement dimension on Y.
+  double myDz; /// Movement dimension on Z.
+  std::shared_ptr<GeomAPI_Pnt> myStartPoint; /// Movement start point.
+  std::shared_ptr<GeomAPI_Pnt> myEndPoint; /// Movement end point.
 };
 
 #endif