]> SALOME platform Git repositories - modules/shaper.git/blob - src/FeaturesPlugin/doc/cutFeature.rst
Salome HOME
Updated copyright comment
[modules/shaper.git] / src / FeaturesPlugin / doc / cutFeature.rst
1 .. |bool_cut.icon|    image:: images/bool_cut.png
2    :height: 16px
3
4 .. _featureCut:
5
6 Cut
7 ===
8
9 Cut feature implements a Boolean operation to cut tool objects from main objects.
10
11 To perform a Cut operationin the active part:
12
13 #. select in the Main Menu *Features - > Cut* item  or
14 #. click |bool_cut.icon| **Cut** button in the toolbar
15
16 The following property panel will be opened:
17
18 .. figure:: images/boolean_cut_property_panel.png
19    :align: center
20
21    **Cut operation**
22
23 - **Main Objects** contains a list of objects selected in the Object Browser or in the Viewer, which will be cut by tool objects.
24   Any kind of shape can be selected, including subshapes of compsolids/compounds.
25   In this case only selected subshapes will be cut, others will stay untouched (as much as possible).
26 - **Tool Objects** contains a list of objects selected in the Object Browser or in the Viewer, which will cut main objects.
27   Any kind of shape can be selected, including subshapes of compsolids/compounds.
28   Non-selected subshapes from compsolids/compounds will be ignored.
29 - **Fuzzy Parameter** defines the additional tolerance value used to eliminate tiny results.
30 - **See preview** button shows a result of the operation.
31
32 The minimal dimension of Tool Objects should be not less than the maximal dimension of Main Objects.
33
34 **TUI Command**:
35
36 .. py:function:: model.addCut(Part_doc, mainObjects, toolObjects, fuzzy)
37
38     :param part: The current part object
39     :param list: A list of main objects.
40     :param list: A list of tool objects.
41     :param real: Additional tolerance used to eliminate tiny results (optional).
42     :return: Created object
43
44 Result
45 """"""
46
47 A result shape which is a cut by tool objects from main object, will be produced for each selected object:
48
49 .. figure:: images/CreatedCut.png
50    :align: center
51
52    **Created cut**
53
54 If a subsolid (yellow wireframe) of a compsolid was selected:
55
56 .. figure:: images/boolean_cut_subsolids_arguments.png
57    :align: center
58
59    **Cut arguments**
60
61 it will be cut in the result and not selected subsolids will be added to it:
62
63 .. figure:: images/boolean_cut_subsolids_result.png
64    :align: center
65
66    **Cut subsolid result**
67
68
69 **See Also** a sample TUI Script of :ref:`tui_create_cut` operation.