Salome HOME
Task #3016: 3.2 To add a mode «through all» for features RevolutionCut and RevolutionFuse
[modules/shaper.git] / src / FeaturesPlugin / doc / removeSubShapesFeature.rst
1 .. |remove_subshapes_btn.icon|    image:: images/remove_subshapes_btn.png
2
3 Remove Sub-Shapes
4 =================
5
6 Remove Sub-Shapes allows removing sub shapes from wires, shells, compsolids and compounds.
7
8 To Remove Sub-Shapes in the active part:
9
10 #. select in the Main Menu *Features - > Remove Sub-Shapes* item  or
11 #. click |remove_subshapes_btn.icon| **Remove Sub-Shapes** button in the toolbar
12
13 The following property panel will be opened:
14
15 .. image:: images/RemoveSubShapes.png
16   :align: center
17
18 .. centered::
19   Remove Sub-Shapes
20
21 - **Shape** shape from which sub-shapes should be removed. Only wires, shells, compsolids or compounds are allowed for selection.
22
23 There are 2 options for removing sub-shapes:
24
25 .. image:: images/remove_subshapes_32x32.png
26    :align: left
27 **By removing** allows selecting sub-shapes to be removed.
28
29 - **Sub-Shapes to remove** the list of sub-shapes which should be removed.
30
31 **TUI Command**:
32
33 .. py:function:: model.addRemoveSubShapes(Part_1_doc, object)
34
35     :param part: The current part object.
36     :param object: The object.
37     :return: Created object.
38
39 .. py:function:: Remove_SubShapes_1.setSubShapesToRemove(subShapes)
40
41     :param list: A list of objects.
42
43
44 .. image:: images/keep_subshapes_32x32.png
45    :align: left
46 **By keeping** allows select sub-shapes to be kept.
47
48 - **Sub-Shapes to keep** the list of sub-shapes which should be kept.
49
50 **TUI Command**:
51
52 .. py:function:: model.addRemoveSubShapes(Part_1_doc, object)
53
54     :param part: The current part object.
55     :param object: The object.
56     :return: Created object.
57
58 .. py:function:: Remove_SubShapes_1.setSubShapesToKeep(subShapes)
59
60     :param list: A list of sub-shapes to keep.
61
62
63 Result
64 """"""
65
66 The Result of the operation will be a shape without removed sub-shapes:
67
68 .. image:: images/remove_subshapes_result.png
69            :align: center
70
71 .. centered::
72    **Remove Sub-Shapes**
73
74 **See Also** a sample TUI Script of :ref:`tui_create_remove_subshapes` operation.