src/FeaturesPlugin/doc/partitionFeature.rst

   1 .. |partition_btn.icon|    image:: images/partition_btn.png
   2
   3 Partition
   4 =========
   5
   6 Partition feature implements a boolean operation for partitioning of a set of selected objects.
   7
   8 To perform a Partition in the active part:
   9
  10 #. select in the Main Menu *Features - > Partition* item  or
  11 #. click |partition_btn.icon| **Partition** button in the toolbar
  12
  13 The following property panel will be opened:
  14
  15 .. image:: images/Partition.png
  16   :align: center
  17
  18 .. centered::
  19    **Partition operation**
  20
  21 **Base Objects** contains a list of objects selected in the Object Browser or in the Viewer, which will be partitioned.
  22
  23 **TUI Command**:
  24
  25 .. py:function:: model.addPartition(Part_doc, objects)
  26
  27     :param part: The current part object.
  28     :param object: A list of objects.
  29     :return: Created object.
  30
  31 Result
  32 """"""
  33
  34 The Result of the operation will be a shape which is a partition of selected objects:
  35
  36 .. image:: images/CreatedPartition.png
  37            :align: center
  38
  39 .. centered::
  40    **Partition created**
  41
  42 **See Also** a sample TUI Script of :ref:`tui_create_partition` operation.