Salome HOME
Merge branch 'master' of https://codev-tuleap.cea.fr/plugins/git/salome/shaper
[modules/shaper.git] / src / FeaturesPlugin / doc / intersectionFeature.rst
1 .. |intersection_btn.icon|    image:: images/intersection_btn.png
2
3 Intersection
4 ============
5
6 Intersection feature a boolean operation for intersection of a set of main objects with a set of tool objects.
7
8 To perform a boolean operation Intersection in the active part:
9
10 #. select in the Main Menu *Features - > Intersection* item  or
11 #. click |intersection_btn.icon| **Intersection** button in the toolbar
12
13 The following property panel will be opened:
14
15 .. figure:: images/intersection_property_panel.png
16    :align: center
17
18    **Intersection operation**
19
20 **Objects** - contains a list of objects selected in the Object Browser or in the Viewer, which will be intersected.
21
22 **TUI Command**:
23
24 .. py:function:: model.addIntersection(Part_doc, Objects)
25
26     :param part: The current part object.
27     :param list: A list of objects.
28     :return: Created object.
29
30 Result
31 """"""
32
33 The Result of the operation will be a shape which is an intersection of selected objects:
34
35 .. figure:: images/CreatedIntersection.png
36    :align: center
37
38    **Intersection created**
39
40 **See Also** a sample TUI Script of :ref:`tui_create_intersection` operation.