src/FeaturesPlugin/doc/cutFeature.rst

   1 .. _featureCut:
   2
   3 Cut
   4 ===
   5
   6 The feature Cut implements a boolean operation to cut tool objects from a main objects.
   7
   8 To perform a boolean operation Cut in the active part:
   9
  10 #. select in the Main Menu *Features - > Cut* item  or
  11 #. click **Cut** button in the toolbar
  12
  13 .. image:: images/bool_cut.png
  14    :align: center
  15
  16 .. centered::
  17    **Cut**  button
  18
  19 The following property panel will be opened:
  20
  21 .. image:: images/boolean_cut_property_panel.png
  22   :align: center
  23
  24 .. centered::
  25   **Cut operation**
  26
  27 - **Main Objects** contains a list of objects selected in the Object Browser or in the Viewer, which will be cut by tool objects.
  28   Any kind of shape can be selected. Also allows selection of compsolids/compound subshapes.
  29   In this case only selected subshapes will be cut, other will stay untoched (as much as possible).
  30 - **Tool Objects** contains a list of objects selected in the Object Browser or in the Viewer, which will be cut main objects.
  31   Any kind of shape can be selected. Also allows selection of compsolids/compounds subshapes.
  32   Non-selected subshapes from compsolids/compounds will be ignored.
  33 - **See preview** button shows a result of the operation.
  34
  35 **TUI Command**:  *model.addCut(Part_doc, mainObjects, toolObjects)*
  36
  37 **Arguments**:   Part + list of main objects + list of tool objects.
  38
  39 Result
  40 """"""
  41
  42 For each selected object will be produced a result shape which is a cut of tool objects from main object:
  43
  44 .. image:: images/CreatedCut.png
  45    :align: center
  46
  47 .. centered::
  48    **Cut created**
  49
  50 In case if subsolid (yellow wireframe) of compsolid was selected:
  51
  52 .. image:: images/boolean_cut_subsolids_arguments.png
  53    :align: center
  54
  55 .. centered::
  56    **Cut arguments**
  57
  58 then it will be cut in 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 a :ref:`tui_create_cut` operation.