Salome HOME
Documentation: use 'figure' instead of 'image'; improve caption layout; fix warnings.
[modules/shaper.git] / src / FeaturesPlugin / doc / unionFeature.rst
index 6e3d9a2b0c474682fb659a2e03ddd6eec2b9d37d..989e9368477b16828be907694cf6a4171f46bf79 100644 (file)
@@ -1,10 +1,44 @@
+.. |union_btn.icon|    image:: images/union_btn.png
 
 Union
 =====
 
+Union feature implements a Boolean operation for creation of a union of selected objects.
 
-.. image:: images/Union.png
-  :align: center
+To create a Union in the active part:
 
-.. centered::
-  Union definition
+#. select in the Main Menu *Features - > Union* item  or
+#. click |union_btn.icon| **Union** button in the toolbar
+
+The following property panel will be opened:
+
+.. figure:: images/Union.png
+   :align: center
+
+   **Union operation**
+
+Here it is necessary to select some objects. Only faces with shared edges or solids with shared faces are allowed for selection.
+
+**Apply** button creates a union shape.
+  
+**Cancel** button cancels the operation.
+
+**TUI Command**:
+
+.. py:function:: model.addUnion(Part_doc, objects)
+
+    :param part: The current part object.
+    :param objects: A list of objects.
+    :return: Result object.
+
+Result
+""""""
+
+The Result of the operation will be a shape which is a union of selected objects:
+
+.. figure:: images/CreatedUnion.png
+   :align: center
+
+   **Union created**
+
+**See Also** a sample TUI Script of :ref:`tui_create_union` operation.