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