Salome HOME
Task #3016: 3.2 To add a mode «through all» for features RevolutionCut and RevolutionFuse
[modules/shaper.git] / src / FeaturesPlugin / doc / revolutionFuseFeature.rst
index b78b1d2e4d06ab7822f6b737f773285af41ab207..a608a03d9c735a0686f84bcfbeba86c5e274c4a7 100644 (file)
@@ -1,19 +1,14 @@
+.. |revolution_fuse_btn.icon|    image:: images/revolution_fuse_btn.png
 
 Revolution Fuse
 ===============
 
-Revolution Fuse feature revolves selected objects around selected axis and fuses result from other objects.
+Revolution Fuse feature revolves the selected objects around the selected axis and fuses the result with other objects.
 
 To perform Revolution Fuse in the active part:
 
 #. select in the Main Menu *Features - > Revolution Fuse* item  or
-#. click **Revolution Fuse** button in the toolbar
-
-.. image:: images/revolution_fuse_btn.png
-   :align: center
-
-.. centered::
-   **Revolution Fuse** button
+#. click |revolution_fuse_btn.icon| **Revolution Fuse** button in the toolbar
 
 The following property panel will be opened:
 
@@ -22,8 +17,8 @@ The following property panel will be opened:
 
 .. centered::
   Start sketch
-
-After selecting one of the options property panel for Revolution Fuse will be opened with two variants:
+  
+There are three variants of the property panel for Revolution Fuse depending on the chosen option:
 
 .. image:: images/revolution_by_angles.png
    :align: left
@@ -33,6 +28,10 @@ After selecting one of the options property panel for Revolution Fuse will be op
    :align: left
 **By Bounding Planes** revolves objects by specifying bounding planes and angles.
 
+.. image:: images/revolution_through_all.png
+   :align: left
+**Through All** revolves objects by 360 degrees.
+
 
 By angles
 --------
@@ -43,24 +42,37 @@ By angles
 .. centered::
   Revolution Fuse: 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.
-- **Fuse with** contains a list of objects which will but fuse with the result of revolution.
+- **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.
+- **Fuse with** contains a list of objects which will be fused with the result of revolution.
+
+**TUI Command**:
 
-**TUI Command**:  *model.addRevolutionFuse(part, objectsToRevolve, axis, angle, objectToFuse);*
+.. py:function:: model.addRevolutionFuse(part, objectsToRevolve, axis, angle, objectToFuse)
 
-**Arguments**:   Part + list of objects for revolution + axis + angle + list of objects to fuse with.
+    :param part: The current part object.
+    :param list: A list of objects for revolution.
+    :param object: An axis.
+    :param real: Angle.
+    :param list: A list of objects to fuse with.
+    :return: Created object.
 
-**TUI Command**:  *model.addRevolutionFuse(part, objectsToRevolve, axis, toAngle, fromAngle, objectToFuse);*
+.. py:function:: model.addRevolutionFuse(part, objectsToRevolve, axis, toAngle, fromAngle, objectToFuse)
 
-**Arguments**:   Part + list of objects for revolution + axis + to angle + from angle + list of objects to fuse with.
+    :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.
+    :param list: A list of objects to fuse with.
+    :return: Created object.
 
 Result
 """"""
 
-The Result of the operation will be an revolved shape:
+The Result of the operation will be a revolved shape:
 
 .. image:: images/revolution_fuse_by_angles_result.png
           :align: center
@@ -68,7 +80,7 @@ The Result of the operation will be an revolved shape:
 .. centered::
    **Revolution Fuse created**
 
-**See Also** a sample TUI Script of :ref:`tui_create_revolution_fuse_by_angles` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_revolution_fuse_by_angles` operation.
 
 By bounding planes
 ------------------
@@ -79,22 +91,32 @@ By bounding planes
 .. centered::
   Revolution Fuse: 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** planar face can be selected to bound revolution from one side.
-- **To offset** offset for revolution or for bounding plane if selected.
-- **From plane** planar face can be selected to bound revolution from other side.
-- **From offset** offset for revolution or for bounding plane if selected.
-- **Fuse with** contains a list of objects which will but fuse with the result of revolution.
+- **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.
+- **Fuse with** - contains a list of objects which will be fused with the result of revolution.
 
-**TUI Command**:  *model.addRevolutionFuse(part, objectsToRevolve, axis, toObject, toOffset, fromObject, fromOffset, objectToFuse);*
+**TUI Command**:
 
-**Arguments**:   Part + list of objects for revolution + axis + to object + to offset + from object + from offset + list of objects to fuse with.
+.. py:function:: model.addRevolutionFuse(part, objectsToRevolve, axis, toObject, toOffset, fromObject, fromOffset, objectToFuse)
+
+    :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.
+    :param list: A list of objects to fuse with.
+    :return: Created object.
 
 Result
 """"""
 
-The Result of the operation will be an revolved shape:
+The Result of the operation will be a revolved shape:
 
 .. image:: images/revolution_fuse_by_bounding_planes_result.png
           :align: center
@@ -102,4 +124,40 @@ The Result of the operation will be an revolved shape:
 .. centered::
    **Revolution Fuse created**
 
-**See Also** a sample TUI Script of a :ref:`tui_create_revolution_fuse_by_bounding_planes` operation.
\ No newline at end of file
+**See Also** a sample TUI Script of :ref:`tui_create_revolution_fuse_by_bounding_planes` operation.
+
+Through All
+-----------
+
+.. image:: images/RevolutionFuse3.png
+  :align: center
+
+.. centered::
+  Revolution Fuse: 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.
+- **Fuse with** - contains a list of objects which will be fused with the result of revolution.
+
+**TUI Command**:
+
+.. py:function:: model.addRevolutionFuse(part, objectsToRevolve, axis, objectToFuse)
+
+    :param part: The current part object.
+    :param list: A list of objects for revolution.
+    :param object: An axis.
+    :param list: A list of objects to fuse with.
+    :return: Created object.
+
+Result
+""""""
+
+The Result of the operation will be a revolved shape:
+
+.. image:: images/revolution_fuse_through_all_result.png
+          :align: center
+
+.. centered::
+   **Revolution Fuse created**
+
+**See Also** a sample TUI Script of :ref:`tui_create_revolution_fuse_through_all` operation.