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 opration 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/Cut.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 -  **Tool Objects** contains a list of objects selected in the Object Browser or in the Viewer, which will be cut main objects.
  29 - **See preview** button shows a  result of the operation.
  30
  31 **TUI Command**:  *model.addCut(Part_doc, mainObjects, toolObjects)*
  32
  33 **Arguments**:   Part + list of main objects + list of tool objects.
  34
  35 Result
  36 """"""
  37
  38 The Result of the operation will be a shape which is a cut of tool objects from main objects:
  39
  40 .. image:: images/CreatedCut.png
  41            :align: center
  42
  43 .. centered::
  44    **Cut created**
  45
  46 **See Also** a sample TUI Script of a :ref:`tui_create_cut` operation.