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 .. figure:: images/RemoveSubShapes.png
  16   :align: center
  17
  18   Remove Sub-Shapes
  19
  20 .. |by_removing| image:: images/remove_subshapes_32x32.png
  21 .. |by_keeping| image:: images/keep_subshapes_32x32.png
  22
  23 - **Shape** shape from which sub-shapes should be removed. Only wires, shells, compsolids or compounds are allowed for selection.
  24
  25 There are 2 options for removing sub-shapes:
  26
  27 |by_removing| **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 |by_keeping| **By keeping** allows select sub-shapes to be kept.
  44
  45 - **Sub-Shapes to keep** the list of sub-shapes which should be kept.
  46
  47 **TUI Command**:
  48
  49 .. py:function:: model.addRemoveSubShapes(Part_1_doc, object)
  50
  51     :param part: The current part object.
  52     :param object: The object.
  53     :return: Created object.
  54
  55 .. py:function:: Remove_SubShapes_1.setSubShapesToKeep(subShapes)
  56
  57     :param list: A list of sub-shapes to keep.
  58
  59
  60 Result
  61 """"""
  62
  63 The Result of the operation will be a shape without removed sub-shapes:
  64
  65 .. figure:: images/remove_subshapes_result.png
  66    :align: center
  67
  68    **Remove Sub-Shapes**
  69
  70 **See Also** a sample TUI Script of :ref:`tui_create_remove_subshapes` operation.