src/FeaturesPlugin/doc/splitFeature.rst

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