// File: GeomAlgoAPI_Translation.h
// Created: 8 June 2015
// Author: Dmitry Bobylev
+//
+// Modified by Clarisse Genrault (CEA) : 17 Nov 2016
#ifndef GeomAlgoAPI_Translation_H_
#define GeomAlgoAPI_Translation_H_
#include <GeomAlgoAPI.h>
#include <GeomAlgoAPI_MakeShape.h>
+
#include <GeomAPI_Ax1.h>
-#include <GeomAPI_DataMapOfShapeShape.h>
#include <GeomAPI_Shape.h>
-#include <GeomAPI_Trsf.h>
-/** \class GeomAlgoAPI_Translation
- * \ingroup DataAlgo
- * \brief Creates a copy of the object by moving it along the axis.
- */
-class GeomAlgoAPI_Translation : public GeomAPI_Interface
+/// \class GeomAlgoAPI_Translation
+/// \ingroup DataAlgo
+/// \brief Creates a copy of the object by moving it along the axis.
+class GeomAlgoAPI_Translation : public GeomAlgoAPI_MakeShape
{
public:
- /** \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.
- * \param[in] theDistance movement distance.
- */
+ /// 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.
+ /// \param[in] theDistance movement distance.
GEOMALGOAPI_EXPORT GeomAlgoAPI_Translation(std::shared_ptr<GeomAPI_Shape> theSourceShape,
std::shared_ptr<GeomAPI_Ax1> theAxis,
double theDistance);
- /// \return true if algorithm succeed.
- GEOMALGOAPI_EXPORT const bool isDone() const
- { return myDone; }
-
- /// \return true if resulting shape is valid.
- GEOMALGOAPI_EXPORT const bool isValid() const;
-
- /// \return true if resulting shape has volume.
- GEOMALGOAPI_EXPORT const bool hasVolume() const;
-
- /// \return result of the movement algorithm.
- GEOMALGOAPI_EXPORT const std::shared_ptr<GeomAPI_Shape>& shape() const;
-
- /// \return map of sub-shapes of the result. To be used for History keeping.
- GEOMALGOAPI_EXPORT std::shared_ptr<GeomAPI_DataMapOfShapeShape> mapOfShapes() const;
+ /// \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);
- /// \return interface for for History processing.
- GEOMALGOAPI_EXPORT std::shared_ptr<GeomAlgoAPI_MakeShape> makeShape() const;
+ /// \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);
- /// Returns the simple transformation
- GEOMALGOAPI_EXPORT std::shared_ptr<GeomAPI_Trsf> transformation() const;
+ /// Checks if data for the translation execution is OK.
+ GEOMALGOAPI_EXPORT bool check();
-private:
- /// Builds resulting shape.
- void build(std::shared_ptr<GeomAPI_Shape> theSourceShape,
- std::shared_ptr<GeomAPI_Ax1> theAxis,
- double theDistance);
+ /// Execute the translation.
+ GEOMALGOAPI_EXPORT void build();
private:
- /// Fields.
- bool myDone;
- std::shared_ptr<GeomAPI_Shape> myShape;
- std::shared_ptr<GeomAPI_DataMapOfShapeShape> myMap;
- std::shared_ptr<GeomAlgoAPI_MakeShape> myMkShape;
- std::shared_ptr<GeomAPI_Trsf> myTrsf;
+ 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
