Provide On Plane filter and reading of validators for filters GUI definition

[modules/shaper.git] / src / GeomAlgoAPI / GeomAlgoAPI_Rotation.h

diff --git a/src/GeomAlgoAPI/GeomAlgoAPI_Rotation.h b/src/GeomAlgoAPI/GeomAlgoAPI_Rotation.h
index 48f922b04e90ffcac4913121c6bc6658b79e7f52..4a884451d0f73aa3591b08605d6f11ed7c489bb4 100644 (file)
--- a/src/GeomAlgoAPI/GeomAlgoAPI_Rotation.h
+++ b/src/GeomAlgoAPI/GeomAlgoAPI_Rotation.h
@@ -1,8 +1,21 @@
-// 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_
@@ -19,7 +32,14 @@
 class GeomAlgoAPI_Rotation : public GeomAlgoAPI_MakeShape
 {
 public:
-  /// \brief Creates an object which is obtained from current object by rotating it around the axis.
+  /// 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).
@@ -27,11 +47,31 @@ public:
                                           std::shared_ptr<GeomAPI_Ax1>   theAxis,
                                           double                         theAngle);
 
+  /// \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<GeomAPI_Shape> theSourceShape,
+                                          std::shared_ptr<GeomAPI_Pnt>   theCenterPoint,
+                                          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                         theAngle);
+  MethodType myMethodType; /// Type of method used.
+  std::shared_ptr<GeomAPI_Shape> mySourceShape; /// Shape to be rotated.
+  std::shared_ptr<GeomAPI_Ax1> myAxis; /// Rotation axis.
+  double myAngle; /// Rotation angle.
+  std::shared_ptr<GeomAPI_Pnt> myCenterPoint; /// Rotation center point.
+  std::shared_ptr<GeomAPI_Pnt> myStartPoint; /// Rotation start point.
+  std::shared_ptr<GeomAPI_Pnt> myEndPoint; /// Rotation end point.
 };
 
 #endif