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