Salome HOME
CEA : Lot2 - Geometry calculation
[modules/shaper.git] / src / FeaturesPlugin / doc / revolutionFeature.rst
index ca419aa147039b958e2399133c45704ebd00f08e..093be89fd3331a46684e2fd487d600f9a3f4672b 100644 (file)
+.. |revolution_btn.icon|    image:: images/revolution_btn.png
+
 .. _featureRevolution:
 
 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:
+
+.. figure:: images/StartSketch.png
+   :align: center
+
+   Start sketch
+
+There are two variants of the property panel for Revolution depending on the chosen option:
+
+.. figure:: images/revolution_by_angles.png
+   :align: left
+   :height: 24px
+
+**By Angles** revolves objects by specifying angles.
+
+.. figure:: images/revolution_by_bounding_planes.png
+   :align: left
+   :height: 24px
+
+**By Bounding Planes** revolves objects by specifying bounding planes and angles.
+
+--------------------------------------------------------------------------------
+
+By angles
+---------
+
+.. figure:: images/Revolution1.png
+   :align: center
+
+   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:
+
+.. figure:: images/revolution_by_angles_result.png
+   :align: center
+
+   **Revolution created**
+
+**See Also** a sample TUI Script of :ref:`tui_create_revolution_by_angles` operation.
+
+By bounding planes
+------------------
+
+.. figure:: images/Revolution2.png
+   :align: center
+
+   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.
 
-.. image:: images/StartSketch.png
-  :align: center
+**TUI Command**:
 
-.. centered::
-  Start sketch
+.. 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.
 
-.. image:: images/Revolution1.png
-  :align: center
+Result
+""""""
 
-.. centered::
-  Revolution: definition by angles
+The Result of the operation will be a revolved shape:
 
+.. figure:: images/revolution_by_bounding_planes_result.png
+   :align: center
 
-.. image:: images/Revolution2.png
-  :align: center
+   **Revolution created**
 
-.. centered::
-  Extrusion: definition by bounding planes
+**See Also** a sample TUI Script of :ref:`tui_create_revolution_by_bounding_planes` operation.