Salome HOME
Task #3016: 3.2 To add a mode «through all» for features RevolutionCut and RevolutionFuse
[modules/shaper.git] / src / FeaturesPlugin / doc / revolutionFeature.rst
index ca419aa147039b958e2399133c45704ebd00f08e..cdf8790e347f8efa829bd87429b749ed1b80e851 100644 (file)
@@ -1,8 +1,16 @@
-.. _featureRevolution:
+.. |revolution_btn.icon|    image:: images/revolution_btn.png
 
 Revolution
 ==========
 
+Revolution feature revolves selected objects around selected axis.
+
+To perform a Revolution in the active part:
+
+#. select in the Main Menu *Features - > Revolution* item  or
+#. click |revolution_btn.icon| **Revolution** button in the toolbar
+
+The following property panel will be opened:
 
 .. image:: images/StartSketch.png
   :align: center
@@ -10,6 +18,19 @@ Revolution
 .. centered::
   Start sketch
 
+There are two variants of the property panel for Revolution depending on the chosen option:
+
+.. image:: images/revolution_by_angles.png
+   :align: left
+**By Angles** revolves objects by specifying angles.
+
+.. image:: images/revolution_by_bounding_planes.png
+   :align: left
+**By Bounding Planes** revolves objects by specifying bounding planes and angles.
+
+
+By angles
+--------
 
 .. image:: images/Revolution1.png
   :align: center
@@ -17,9 +38,81 @@ Revolution
 .. centered::
   Revolution: definition by angles
 
+- **Base objects** - contains a list of objects selected in the Object Browser or in the Viewer, which will be revolved.
+- **Axis** - axis of revolution.
+- **To angle** - end angle of revolution.
+- **From angle** - start angle of revolution.
+
+**TUI Commands**:
+
+.. py:function:: model.addRevolution(part, objects, axis, angle)
+
+    :param part: The current part object.
+    :param list: A list of objects for revolution.
+    :param object: An axis.
+    :param real: An angle.
+    :return: Created object.
+
+.. py:function:: model.addRevolution(part, objects, axis, toSize, fromSize)
+
+    :param part: The current part object.
+    :param list: A list of objects for revolution.
+    :param object: An axis.
+    :param real: To angle.
+    :param real: From angle.
+    :return: Created object.
+
+Result
+""""""
+
+The Result of the operation will be a revolved shape:
+
+.. image:: images/revolution_by_angles_result.png
+          :align: center
+
+.. centered::
+   **Revolution created**
+
+**See Also** a sample TUI Script of :ref:`tui_create_revolution_by_angles` operation.
+
+By bounding planes
+------------------
 
 .. image:: images/Revolution2.png
   :align: center
 
 .. centered::
-  Extrusion: definition by bounding planes
+  Revolution: definition by bounding planes
+
+- **Base objects** - contains a list of objects selected in the Object Browser or in the Viewer, which will be revolved.
+- **Axis** - axis of revolution.
+- **To plane**  - a planar face can be selected to bound revolution from one side.
+- **To offset** - offset for revolution or for bounding plane, if selected.
+- **From plane** - a planar face can be selected to bound revolution from other side.
+- **From offset** - offset for revolution or for bounding plane, if selected.
+
+**TUI Command**:
+
+.. py:function:: model.addRevolution(part, objects, axis, toObject, toOffset, fromObject, fromOffset)
+
+    :param part: The current part object.
+    :param list: A list of objects for revolution.
+    :param object: An axis.
+    :param object: To object.
+    :param real: To offset.
+    :param object: From object.
+    :param real: From offset.
+    :return: Created object.
+
+Result
+""""""
+
+The Result of the operation will be a revolved shape:
+
+.. image:: images/revolution_by_bounding_planes_result.png
+          :align: center
+
+.. centered::
+   **Revolution created**
+
+**See Also** a sample TUI Script of :ref:`tui_create_revolution_by_bounding_planes` operation.
\ No newline at end of file