]> SALOME platform Git repositories - modules/shaper.git/blob - src/FeaturesPlugin/doc/partitionFeature.rst
Salome HOME
Documentation: use 'figure' instead of 'image'; improve caption layout; fix warnings.
[modules/shaper.git] / 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 .. figure:: images/Partition.png
16    :align: center
17
18    **Partition operation**
19
20 **Base Objects** contains a list of objects selected in the Object Browser or in the Viewer, which will be partitioned.
21
22 **TUI Command**:
23
24 .. py:function:: model.addPartition(Part_doc, objects)
25
26     :param part: The current part object.
27     :param object: A list of objects.
28     :return: Created object.
29
30 Result
31 """"""
32
33 The Result of the operation will be a shape which is a partition of selected objects:
34
35 .. figure:: images/CreatedPartition.png
36    :align: center
37
38    **Partition created**
39
40 **See Also** a sample TUI Script of :ref:`tui_create_partition` operation.