src/FeaturesPlugin/doc/splitFeature.rst

   1 .. |bool_split.icon|    image:: images/bool_split.png
   2    :height: 16px
   3
   4 .. _featureSplit:
   5
   6 Split
   7 =====
   8
   9 Split feature implements a Boolean operation splitting of main objects by parts of tool objects.
  10
  11 To perform Split in the active part:
  12
  13 #. select in the Main Menu *Features - > Split* item  or
  14 #. click |bool_split.icon| **Split** button in the toolbar
  15
  16 The following property panel will be opened:
  17
  18 .. figure:: images/Split_panel.png
  19    :align: center
  20
  21    **Split operation**
  22
  23 - **Main Objects** contains a list of objects selected in the Object Browser or in the Viewer, which will be cut and splitted by tool objects.
  24 - **Tool Objects** contains a list of objects selected in the Object Browser or in the Viewer, which will cut and split the main objects. Construction planes may be selected too.
  25 - **See preview** button shows a result of the operation.
  26
  27 **TUI Command**:
  28
  29 .. py:function:: model.addSplit(Part_doc, mainObjects, toolObjects)
  30
  31     :param part: The current part object.
  32     :param list: A list of main objects.
  33     :param list: A list of tool objects.
  34     :return: Result object.
  35
  36 Result
  37 """"""
  38
  39 The Result of the operation will be a shape, which is a split of tool objects with main objects:
  40
  41 .. figure:: images/CreatedSplit.png
  42    :align: center
  43
  44    **Split created**
  45
  46 **See Also** a sample TUI Script of :ref:`tui_create_bool_split` operation.