Salome HOME
1220c84d0f4b1117c0ff4b37cd0fb05e656d7e16
[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 .. image:: images/Union.png
16   :align: center
17
18 .. centered::
19    **Union operation**
20
21 Here it is necessary to select some objects. Only faces with shared edges or solids with shared faces are allowed for selection.
22
23 **Apply** button creates a union shape.
24   
25 **Cancel** button cancels the operation.
26
27 **TUI Command**:
28
29 .. py:function:: model.addUnion(Part_doc, objects)
30
31     :param part: The current part object.
32     :param objects: A list of objects.
33     :return: Result object.
34
35 Result
36 """"""
37
38 The Result of the operation will be a shape which is a union of selected objects:
39
40 .. image:: images/CreatedUnion.png
41            :align: center
42
43 .. centered::
44    **Union created**
45
46 **See Also** a sample TUI Script of :ref:`tui_create_union` operation.