X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;ds=sidebyside;f=src%2FGeomAlgoAPI%2FGeomAlgoAPI_Translation.h;h=f7b3be95e627a2dcbe0eb621d9550a2075829c90;hb=2cb4458b35ae6c9561a35b3b18dbdb673d0c12c9;hp=95f9c55f7801e1a1767c4753fc828d9000bc55fb;hpb=fbfcc4fd956a374c8d380c2da280c61eaa57bcfd;p=modules%2Fshaper.git diff --git a/src/GeomAlgoAPI/GeomAlgoAPI_Translation.h b/src/GeomAlgoAPI/GeomAlgoAPI_Translation.h index 95f9c55f7..f7b3be95e 100644 --- a/src/GeomAlgoAPI/GeomAlgoAPI_Translation.h +++ b/src/GeomAlgoAPI/GeomAlgoAPI_Translation.h @@ -1,73 +1,88 @@ -// Copyright (C) 2014-20xx CEA/DEN, EDF R&D - -// File: GeomAlgoAPI_Translation.h -// Created: 8 June 2015 -// Author: Dmitry Bobylev +// Copyright (C) 2014-2019 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 +// #ifndef GeomAlgoAPI_Translation_H_ #define GeomAlgoAPI_Translation_H_ #include #include + #include -#include #include -#include -/** \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. - * \param[in] theSimpleTransform makes just transformation of shape without changing of topology or geometry - */ - GEOMALGOAPI_EXPORT GeomAlgoAPI_Translation(std::shared_ptr theSourceShape, - std::shared_ptr theAxis, - double theDistance, - bool theSimpleTransform = false); - - /// \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; + /// 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 + }; - /// \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& shape() const; + /// \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 theSourceShape, + std::shared_ptr theAxis, + double theDistance); - /// \return map of sub-shapes of the result. To be used for History keeping. - GEOMALGOAPI_EXPORT std::shared_ptr 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 theSourceShape, + double theDx, + double theDy, + double theDz); - /// \return interface for for History processing. - GEOMALGOAPI_EXPORT std::shared_ptr 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 theSourceShape, + std::shared_ptr theStartPoint, + std::shared_ptr theEndPoint); - /// Returns the simple transformation - GEOMALGOAPI_EXPORT std::shared_ptr transformation() const; + /// Checks if data for the translation execution is OK. + GEOMALGOAPI_EXPORT bool check(); -private: - /// Builds resulting shape. - void build(std::shared_ptr theSourceShape, - std::shared_ptr theAxis, - double theDistance, - bool theSimpleTransform); + /// Execute the translation. + GEOMALGOAPI_EXPORT void build(); private: - /// Fields. - bool myDone; - std::shared_ptr myShape; - std::shared_ptr myMap; - std::shared_ptr myMkShape; - std::shared_ptr myTrsf; ///< transformation of the shape in case theSimpleTransform + MethodType myMethodType; /// Type of method used. + std::shared_ptr mySourceShape; /// Shape to be moved. + std::shared_ptr 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 myStartPoint; /// Movement start point. + std::shared_ptr myEndPoint; /// Movement end point. }; #endif