Salome HOME
989e9368477b16828be907694cf6a4171f46bf79
[modules/shaper.git] / src / FeaturesPlugin / doc / unionFeature.rst
1 .. |union_btn.icon|    image:: images/union_btn.png
2
3 Union
4 =====
5
6 Union feature implements a Boolean operation for creation of a union of selected objects.
7
8 To create a Union in the active part:
9
10 #. select in the Main Menu *Features - > Union* item  or
11 #. click |union_btn.icon| **Union** button in the toolbar
12
13 The following property panel will be opened:
14
15 .. figure:: images/Union.png
16    :align: center
17
18    **Union operation**
19
20 Here it is necessary to select some objects. Only faces with shared edges or solids with shared faces are allowed for selection.
21
22 **Apply** button creates a union shape.
23   
24 **Cancel** button cancels the operation.
25
26 **TUI Command**:
27
28 .. py:function:: model.addUnion(Part_doc, objects)
29
30     :param part: The current part object.
31     :param objects: A list of objects.
32     :return: Result object.
33
34 Result
35 """"""
36
37 The Result of the operation will be a shape which is a union of selected objects:
38
39 .. figure:: images/CreatedUnion.png
40    :align: center
41
42    **Union created**
43
44 **See Also** a sample TUI Script of :ref:`tui_create_union` operation.