Salome HOME
9e21806153e436f34e4ba96bb781d22c8ee6473e
[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 .. image:: images/intersection_property_panel.png
16   :align: center
17
18 .. centered::
19    **Intersection operation**
20
21 **Objects** - contains a list of objects selected in the Object Browser or in the Viewer, which will be intersected.
22
23 **TUI Command**:
24
25 .. py:function:: model.addIntersection(Part_doc, Objects)
26
27     :param part: The current part object.
28     :param list: A list of objects.
29     :return: Created object.
30
31 Result
32 """"""
33
34 The Result of the operation will be a shape which is an intersection of selected objects:
35
36 .. image:: images/CreatedIntersection.png
37            :align: center
38
39 .. centered::
40    **Intersection created**
41
42 **See Also** a sample TUI Script of :ref:`tui_create_intersection` operation.