src/FeaturesPlugin/doc/splitFeature.rst

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