Copyright update 2022

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

diff --git a/src/FeaturesPlugin/doc/extrusionFuseFeature.rst b/src/FeaturesPlugin/doc/extrusionFuseFeature.rst
index bcb368698eebb296b2f43e3f394aea0572f6ef63..d60db4f6a65f3c3ae81f30299c203f5e68fe995f 100644 (file)
--- a/src/FeaturesPlugin/doc/extrusionFuseFeature.rst
+++ b/src/FeaturesPlugin/doc/extrusionFuseFeature.rst
@@ -1,47 +1,51 @@
+.. |extrusion_fuse_btn.icon|    image:: images/extrusion_fuse_btn.png
 
 Extrusion Fuse
-=============
+==============
 
 Extrusion Fuse feature extrudes selected objects along their normals or the selected axis and fuses the result with other objects.
 
 To perform Extrusion Fuse in the active part:
 
 #. select in the Main Menu *Features - > Extrusion Fuse* item  or
-#. click **Extrusion Fuse** button in the toolbar
-
-.. image:: images/extrusion_fuse_btn.png
-   :align: center
-
-.. centered::
-   **Extrusion Fuse** button
+#. click |extrusion_fuse_btn.icon| **Extrusion Fuse** button in the toolbar
 
 The following property panel will be opened:
 
-.. image:: images/StartSketch.png
-  :align: center
+.. figure:: images/StartSketch.png
+   :align: center
 
-.. centered::
-  Start sketch
+   Start sketch
 
-There are two variants of the property panel for Extrusion Fuse depending on the chosen option:
+There are three variants of the property panel for Extrusion Fuse depending on the chosen option:
 
-.. image:: images/extrusion_by_sizes.png
+.. figure:: images/extrusion_by_sizes.png
    :align: left
+   :height: 24px
+
 **By Sizes** extrudes objects by specifying sizes.
 
-.. image:: images/extrusion_by_bounding_planes.png
+.. figure:: images/extrusion_by_bounding_planes.png
    :align: left
+   :height: 24px
+
 **By Bounding Planes** extrudes objects by specifying bounding planes and offsets.
 
+.. figure:: images/extrusion_through_all.png
+   :align: left
+   :height: 24px
+
+**Through All** extrudes base objects to pass through all objects fuse with.
+
+--------------------------------------------------------------------------------
 
 By sizes
 --------
 
-.. image:: images/ExtrusionFuse1.png
-  :align: center
+.. figure:: images/ExtrusionFuse1.png
+   :align: center
 
-.. centered::
-  Extrusion Fuse: definition by sizes
+   Extrusion Fuse: definition by sizes
 
 - **Base objects** - contains a list of objects selected in the Object Browser or in the Viewer, which will be extruded.
 - **Axis** - if selected, it will be the direction of extrusion, otherwise objects normals will be used.
@@ -49,31 +53,52 @@ By sizes
 - **From size** - size for extrusion in the opposite direction.
 - **Fuse with** - contains a list of objects which will be fused with the result of extrusion.
 
-**TUI Command**:  *model.addExtrusionFuse(part, objectsToExtrude, size, objectsToFuse);*
+**TUI Commands**:
 
-**Arguments**:   Part + list of objects for extrusion + size + list of objects to fuse with.
+.. py:function:: model.addExtrusionFuse(part, objectsToExtrude, size, objectsToFuse)
 
-**TUI Command**:  *model.addExtrusionFuse(part, objects, direction, size, objectsToFuse);*
+    :param part: The current part object.
+    :param list: A list of objects for extrusion.
+    :param number: Size of extrucion.
+    :param list: A list of objects to fuse with.
+    :return: Created object.
 
-**Arguments**:   Part + list of objects for extrusion + direction + size + list of objects to fuse with.
+.. py:function:: model.addExtrusionFuse(part, objects, direction, size, objectsToFuse)
 
-**TUI Command**:  *model.addExtrusionFuse(part, objects, toSize, fromSize, objectsToFuse);*
+    :param part: The current part object.
+    :param list: A list of objects for extrusion.
+    :param object: A direction of extrusion
+    :param number: Size of extrucion.
+    :param list: A list of objects to fuse with.
+    :return: Created object.
 
-**Arguments**:   Part + list of objects for extrusion + to size + from size + list of objects to fuse with.
+.. py:function:: model.addExtrusionFuse(part, objects, toSize, fromSize, objectsToFuse)
 
-**TUI Command**:  *model.addExtrusionFuse(part, objects, direction, toSize, fromSize, objectsToFuse);*
+    :param part: The current part object.
+    :param list: A list of objects for extrusion.
+    :param number: "Size to" value.
+    :param number: "Size from" value.
+    :param list: A list of objects to fuse with.
+    :return: Created object.
 
-**Arguments**:   Part + list of objects for extrusion + direction + to size + from size + list of objects to fuse with.
+.. py:function:: model.addExtrusionFuse(part, objects, direction, toSize, fromSize, objectsToFuse)
+
+    :param part: The current part object.
+    :param list: A list of objects for extrusion.
+    :param object: A direction of extrusion
+    :param number: "Size to" value.
+    :param number: "Size from" value.
+    :param list: A list of objects to fuse with.
+    :return: Created object.
 
 Result
 """"""
 
 The Result of the operation will be an extruded shape:
 
-.. image:: images/extrusion_fuse_by_sizes_result.png
-          :align: center
+.. figure:: images/extrusion_fuse_by_sizes_result.png
+   :align: center
 
-.. centered::
    **Extrusion Fuse created**
 
 **See Also** a sample TUI Script of :ref:`tui_create_extrusion_fuse_by_sizes` operation.
@@ -81,11 +106,10 @@ The Result of the operation will be an extruded shape:
 By bounding planes
 ------------------
 
-.. image:: images/ExtrusionFuse2.png
-  :align: center
+.. figure:: images/ExtrusionFuse2.png
+   :align: center
 
-.. centered::
-  Extrusion Fuse: definition by bounding planes
+   Extrusion Fuse: definition by bounding planes
 
 - **Base objects** - contains a list of objects selected in the Object Browser or in the Viewer, which will be extruded.
 - **Axis** - if selected, it will be the direction of extrusion, otherwise objects normals will be used.
@@ -95,23 +119,80 @@ By bounding planes
 - **From offset** - offset for extrusion or for bounding plane,  if selected.
 - **Fuse with** - contains a list of objects which will be fused with the result of extrusion.
 
-**TUI Command**:  *model.addExtrusionFuse(part, objects, toObject, toOffset, fromObject, fromOffset, objectsToFuse);*
+**TUI Commands**:
 
-**Arguments**:   Part + list of objects for extrusion + to object + to offset + from object + from offset + list of objects to fuse with.
+.. py:function:: model.addExtrusionFuse(part, objects, toObject, toOffset, fromObject, fromOffset, objectsToFuse)
 
-**TUI Command**:  *model.addExtrusionFuse(part, objects, direction, toObject, toOffset, fromObject, fromOffset, objectsToFuse);*
+    :param part: The current part object.
+    :param list: A list of objects for extrusion.
+    :param object: "To object".
+    :param number: "To offset".
+    :param object: "From object".
+    :param number: "From offset".
+    :param list: A list of objects to fuse with.
+    :return: Created object.
 
-**Arguments**:   Part + list of objects for extrusion + direction + to object + to offset + from object + from offset + list of objects to fuse with.
+.. py:function:: model.addExtrusionFuse(part, objects, direction, toObject, toOffset, fromObject, fromOffset, objectsToFuse)
+
+    :param part: The current part object.
+    :param list: A list of objects for extrusion.
+    :param object: A direction of extrusion
+    :param object: "To object".
+    :param number: "To offset".
+    :param object: "From object".
+    :param number: "From offset".
+    :param list: A list of objects to fuse with.
+    :return: Created object.
 
 Result
 """"""
 
 The Result of the operation will be an extruded shape:
 
-.. image:: images/extrusion_fuse_by_bounding_planes_result.png
-          :align: center
+.. figure:: images/extrusion_fuse_by_bounding_planes_result.png
+   :align: center
 
-.. centered::
    **Extrusion Fuse created**
 
 **See Also** a sample TUI Script of :ref:`tui_create_extrusion_fuse_by_bounding_planes` operation.
+
+Through all
+-----------
+
+.. figure:: images/ExtrusionFuse3.png
+   :align: center
+
+   Extrusion Fuse: definition through all objects
+
+- **Base objects** - contains a list of objects selected in the Object Browser or in the Viewer, which will be extruded.
+- **Axis** - if selected, it will be the direction of extrusion, otherwise objects normals will be used.
+- **Fuse with** - contains a list of objects which will be fused with the result of extrusion.
+
+**TUI Commands**:
+
+.. py:function:: model.addExtrusionFuse(part, objectsToExtrude, objectsToFuse)
+
+    :param part: The current part object.
+    :param list: A list of objects for extrusion.
+    :param list: A list of objects to fuse with.
+    :return: Created object.
+
+.. py:function:: model.addExtrusionFuse(part, objectsToExtrude, direction, objectsToFuse)
+
+    :param part: The current part object.
+    :param list: A list of objects for extrusion.
+    :param object: A direction of extrusion
+    :param list: A list of objects to fuse with.
+    :return: Created object.
+
+Result
+""""""
+
+The Result of the operation will be an extruded shape:
+
+.. figure:: images/extrusion_fuse_through_all_result.png
+   :align: center
+
+   **Extrusion Fuse created**
+
+**See Also** a sample TUI Script of :ref:`tui_create_extrusion_fuse_through_all` operation.