src/FeaturesPlugin/doc/cutFeature.rst

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