Fix for keeping the partition results if some argument was appended. Based on "CEA...

[modules/shaper.git] / src / FeaturesPlugin / doc / revolutionFeature.rst

diff --git a/src/FeaturesPlugin/doc/revolutionFeature.rst b/src/FeaturesPlugin/doc/revolutionFeature.rst
index 648deb89d83b6bcb40a4abdd66b65830630bf9d9..eb492261cdd11f0ce9c509a6301bb34af7a61b9f 100644 (file)
--- a/src/FeaturesPlugin/doc/revolutionFeature.rst
+++ b/src/FeaturesPlugin/doc/revolutionFeature.rst
@@ -2,6 +2,20 @@
 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** button in the toolbar
+
+.. image:: images/revolution_btn.png
+   :align: center
+
+.. centered::
+   **Revolution** button
+
+The following property panel will be opened:
 
 .. image:: images/StartSketch.png
   :align: center
@@ -9,6 +23,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
@@ -16,9 +43,61 @@ 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 Command**:  *model.addRevolution(part, objects, axis, angle);*
+
+**Arguments**:   Part + list of objects + axis + angle.
+
+**TUI Command**:  *model.addRevolution(part, objects, axis, toSize, fromSize);*
+
+**Arguments**:   Part + list of objects + axis + to angle + from angle.
+
+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**:  *model.addRevolution(part, objects, axis, toObject, toOffset, fromObject, fromOffset);*
+
+**Arguments**:   Part + list of objects + axis + to object + to offset + from object + from offset.
+
+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