Salome HOME
Correct documentation bugs, adapt for 'Read The Docs' theme (bos #18858)
[modules/shaper.git] / src / FeaturesPlugin / doc / fuseFeature.rst
index c04c1ea8a8de15dda84a1e196a8cf6a592ee08b8..739d249f6b883eecbe736eec7c0a1542aaa78d35 100644 (file)
+.. |bool_fuse.icon|    image:: images/bool_fuse.png
+   :height: 16px
 
 Fuse
 ====
 
-The feature Fuse implements a boolean operation for fision of a set of main objects with a set of tool objects.
+Fuse feature implements a Boolean operation for fusion of a set of main objects with a set of tool objects.
 
-To perform a boolean opration Fuse in the active part:
+To perform Fuse in the active part:
 
 #. select in the Main Menu *Features - > Fuse* item  or
-#. click **Fuse** button in the toolbar
+#. click |bool_fuse.icon| **Fuse** button in the toolbar
 
-.. image:: images/bool_fuse.png
+There are 2 options for creation of a Fuse:
+
+.. image:: images/bool_fuse_simple.png
+   :align: left
+   :height: 24px
+
+**Simple** simply fuses selected objects.
+
+.. image:: images/bool_fuse_advanced.png
+   :align: left
+   :height: 24px
+
+**Advanced** fuse with additional functionality for subshapes of compsolids/compounds.
+
+--------------------------------------------------------------------------------
+
+Simple
+------
+
+.. image:: images/boolean_fuse_simple_property_panel.png
    :align: center
 
 .. centered::
-   **Fuse**  button 
+   **Simple**
 
-The following property panel will be opened:
+- **Objects** - contains a list of objects selected in the Object Browser or in the Viewer, which will be fused with tool objects.
+  If a subshape that belongs to a compsolid/compound was selected, other shapes of this compsolid/compound will be ignored.
+- **Remove intersection edges** -  if enabled, edges that lie on the same surface will be removed.
+- **See preview** - button shows a result of the operation.
+
+**TUI Command**:
+
+.. py:function:: model.addFuse(Part_doc, objects, isRemoveEdges)
+
+    :param part: The current part object.
+    :param list: A list of objects.
+    :param boolean: Remove edges flag (optional).
+    :return: Created object.
+
+Result
+""""""
 
-.. image:: images/Fuse.png
-  :align: center
+The Result of the operation will be a single shape which is a fuse of selected objects:
+
+.. image:: images/CreatedFuse.png
+          :align: center
+
+.. centered::
+   **Fuse created**
+
+**See Also** a sample TUI Script of :ref:`tui_create_fuse` operation.
+
+Advanced
+--------
+
+.. image:: images/boolean_fuse_advanced_property_panel.png
+   :align: center
 
 .. centered::
-  **Fuse operation**
+   **Advanced**
+
+- **Objects** - contains a list of objects selected in the Object Browser or in the Viewer, which will be fused with tool objects.
+  If a subshape that belongs to a compsolid/compound was selected, other shapes of this compsolid/compound will be cut from
+  other objects (to avoid self intersection) and added to the result.
+- **Tools** - contains a list of objects selected in the Object Browser or in the Viewer, which will be fused with tool objects.
+  If a subshape that belongs to a compsolid/compound was selected, other shapes of this compsolid/compound will be ignored.
+- **Remove intersection edges** - if enabled, edges that lie on the same surface will be removed.
+- **See preview** - button shows a result of the operation.
 
-- **Main Objects** contains a list of objects selected in the Object Browser or in the Viewer, which will be fused with tool objects.
--  **Tool Objects** contains a list of objects selected in the Object Browser or in the Viewer, which will fused with main objects.
-- **See preview** button shows a result of the operation.
+**TUI Command**:
 
-**TUI Command**:  *model.addFuse(Part_doc, mainObjects, toolObjects)*
+.. py:function:: model.addFuse(Part_doc, objects, tools, isRemoveEdges)
 
-**Arguments**:   Part + list of main objects + list of tool objects.
+    :param part: The current part object.
+    :param list: A list of objects.
+    :param list: A list of tools.
+    :param boolean: Remove edges flag (optional).
+    :return: Created object.
 
 Result
 """"""
 
-The Result of the operation will be a shape which is a fuse of tool objects with main objects:
+The Result of the operation will be a single shape which is a fuse of selected objects and tools:
 
-.. image:: images/CreatedFuse.png
+.. image:: images/boolean_fuse_result.png
           :align: center
 
 .. centered::
    **Fuse created**
 
-**See Also** a sample TUI Script of :ref:`tui_create_fuse` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_fuse` operation.