X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FGeomAlgoAPI%2FGeomAlgoAPI_Rotation.h;h=4a884451d0f73aa3591b08605d6f11ed7c489bb4;hb=b7f954c1e5b9da1fc425908ac4edfebb513ebf23;hp=c3a81d54edf62d691375d61eff66b5c9876510d4;hpb=a67c27ec9c9f0be2c0e40e5c2c487945e0d75b52;p=modules%2Fshaper.git diff --git a/src/GeomAlgoAPI/GeomAlgoAPI_Rotation.h b/src/GeomAlgoAPI/GeomAlgoAPI_Rotation.h index c3a81d54e..4a884451d 100644 --- a/src/GeomAlgoAPI/GeomAlgoAPI_Rotation.h +++ b/src/GeomAlgoAPI/GeomAlgoAPI_Rotation.h @@ -1,65 +1,77 @@ -// Copyright (C) 2014-20xx CEA/DEN, EDF R&D - -// File: GeomAlgoAPI_Rotation.h -// Created: 12 May 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_Rotation_H_ #define GeomAlgoAPI_Rotation_H_ #include #include + #include -#include #include -/** \class GeomAlgoAPI_Rotation - * \ingroup DataAlgo - * \brief Creates a copy of the object by rotating it around the axis. - */ -class GeomAlgoAPI_Rotation : public GeomAPI_Interface +/// \class GeomAlgoAPI_Rotation +/// \ingroup DataAlgo +/// \brief Creates a copy of the object by rotating it around the axis. +class GeomAlgoAPI_Rotation : public GeomAlgoAPI_MakeShape { public: - /** \brief Creates an object which is obtained from current object by rotating it around the axis. - * \param[in] theSourceShape a shape to be rotated. - * \param[in] theAxis rotation axis. - * \param[in] theAngle rotation angle(in degree). - */ + /// Type of rotation operation + enum MethodType { + BY_ANGLE, ///< Rotation by axis and an angle + BY_POINTS ///< Rotation by a center and two points + }; + + /// \brief Creates an object which is obtained from current object by rotating it around the axis + /// with the angle. + /// \param[in] theSourceShape a shape to be rotated. + /// \param[in] theAxis rotation axis. + /// \param[in] theAngle rotation angle(in degree). GEOMALGOAPI_EXPORT GeomAlgoAPI_Rotation(std::shared_ptr theSourceShape, std::shared_ptr theAxis, double theAngle); - /// \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 rotation algorithm. - GEOMALGOAPI_EXPORT const std::shared_ptr& shape() const; - - /// \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 rotating it around the axis + /// withe angle using the center and two points. + /// \param[in] theSourceShape a shape to be rotated. + /// \param[in] theCenterPoint center point. + /// \param[in] theStartPoint start point. + /// \param[in] theEndPoint end point. + GEOMALGOAPI_EXPORT GeomAlgoAPI_Rotation(std::shared_ptr theSourceShape, + std::shared_ptr theCenterPoint, + std::shared_ptr theStartPoint, + std::shared_ptr theEndPoint); - /// \return interface for for History processing. - GEOMALGOAPI_EXPORT std::shared_ptr makeShape() 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 theAngle); + /// Execute the translation. + GEOMALGOAPI_EXPORT void build(); private: - /// Fields. - bool myDone; - std::shared_ptr myShape; - std::shared_ptr myMap; - std::shared_ptr myMkShape; + MethodType myMethodType; /// Type of method used. + std::shared_ptr mySourceShape; /// Shape to be rotated. + std::shared_ptr myAxis; /// Rotation axis. + double myAngle; /// Rotation angle. + std::shared_ptr myCenterPoint; /// Rotation center point. + std::shared_ptr myStartPoint; /// Rotation start point. + std::shared_ptr myEndPoint; /// Rotation end point. }; #endif