src/FeaturesPlugin/doc/cutFeature.rst

   1
   2 Cut
   3 ===
   4
   5 The feature Cut implements a boolean operation to cut tool objects from a main objects.
   6
   7 To perform a boolean opration Cut in the active part:
   8
   9 #. select in the Main Menu *Features - > Cut* item  or
  10 #. click **Cut** button in the toolbar
  11
  12 .. image:: images/bool_cut.png
  13    :align: center
  14
  15 .. centered::
  16    **Cut**  button
  17
  18 The following property panel will be opened:
  19
  20 .. image:: images/Cut.png
  21   :align: center
  22
  23 .. centered::
  24   **Cut operation**
  25
  26 - **Main Objects** contains a list of objects selected in the Object Browser or in the Viewer, which will be cut by tool objects.
  27 -  **Tool Objects** contains a list of objects selected in the Object Browser or in the Viewer, which will be cut main objects.
  28 - **See preview** button shows a  result of the operation.
  29
  30 **TUI Command**:  *model.addCut(Part_doc, mainObjects, toolObjects)*
  31
  32 **Arguments**:   Part + list of main objects + list of tool objects.
  33
  34 Result
  35 """"""
  36
  37 The Result of the operation will be a shape which is a cut of tool objects from main objects:
  38
  39 .. image:: images/CreatedCut.png
  40            :align: center
  41
  42 .. centered::
  43    **Cut created**
  44
  45 **See Also** a sample TUI Script of a :ref:`tui_create_cut` operation.