src/FeaturesPlugin/doc/partitionFeature.rst

   1 .. |partition_btn.icon|    image:: images/partition_btn.png
   2
   3 .. _featurePartition:
   4
   5 Partition
   6 =========
   7
   8 Partition feature implements a boolean operation for partitioning of a set of selected objects.
   9
  10 To perform a Partition in the active part:
  11
  12 #. select in the Main Menu *Features - > Partition* item  or
  13 #. click |partition_btn.icon| **Partition** button in the toolbar
  14
  15 The following property panel will be opened:
  16
  17 .. figure:: images/Partition.png
  18    :align: center
  19
  20    **Partition operation**
  21
  22 **Base Objects** contains a list of objects selected in the Object Browser or in the Viewer,
  23 which will be partitioned. Constuction planes are allowed too if at least one non-construction
  24 entity is selected.
  25
  26 **Fuzzy Parameter** defines the additional tolerance value used to eliminate tiny results.
  27
  28 **TUI Command**:
  29
  30 .. py:function:: model.addPartition(Part_doc, objects, fuzzy)
  31
  32     :param part: The current part object.
  33     :param object: A list of objects.
  34     :param real: Additional tolerance used to eliminate tiny results (optional).
  35     :return: Created object.
  36
  37 Result
  38 """"""
  39
  40 The Result of the operation will be a shape which is a partition of selected objects:
  41
  42 .. figure:: images/CreatedPartition.png
  43    :align: center
  44
  45    **Partition created**
  46
  47 **See Also** a sample TUI Script of :ref:`tui_create_partition` operation.