/*!
\page partition_page Partition
To produce a \b Partition in the Main Menu select Operations - > Partition
This operation builds a compound by intersection of several shapes
with a set of tool objects or with a plane.
The \b Result will be a \b GEOM_Object.
Intersection of two shapes.
\image html partition1.png
Arguments: Name + 2 lists of shapes (the shapes from the
first list will be intersected with the shapes from the second list) +
Resulting Type of shape.
As far as the intersection of two objects can produce any type of
geometrical objects, Resulting type box allows choosing the
preferrable result, i.e. a solid, a shell, a list of faces, etc.
The Resulting type has to be equal or lower than the type of the
\em Objects. In other words, if the \em Objects don't contain any
shape of this type, Partition fails.
Keep shapes of lower type checkbox manages standalone shapes of
type other than the \em Limit. If it is checked, lower dimension
objects will be preserved, else they will be lost.
For example, you partition a box (Solid) and a face (Face)
without any tool (the box is split in two parts by the shape). If you
choose the Resulting Type "Solid", you will
obtain a compound of two solids, but if you also check Keep shapes of lower
type checkbox, you will obtain a compound of two solids and one
face (there will be a hole in the resulting face, where the original
face intersects with the box, see the corresponding \ref partition_picture_3 "picture" below).
No sub-shapes intersection (Compounds only) check box affects
only input shapes of the Compound type. If this option is switched off (default
behavior) each input compound will be automatically exploded into
sub-shapes and the intersection between these shapes will be also
computed. If this option is switched on, the intersection between
sub-shapes will not be performed. In this case the Partition algorithm
will work faster, but the result might differ from the default behavior.
Advanced option:
\ref restore_presentation_parameters_page "Set presentation parameters and subshapes from arguments".
\note Partition is a complex operation, so its result of it depends
on the quality of the initial shapes. Sometimes, if partition fails,
such healing operations as Shape Processing
and Limit Tolerance can help to attune source shapes to obtain correct result of the Partition.
See also \ref tui_limit_tolerance "TUI example" of shape healing.
TUI Command (with sub-shapes intersection):
geompy.MakePartition(ListOfShapes, ListOfTools, ListOfKeepInside,
ListOfRemoveInside, Limit, RemoveWebs, ListOfMaterials,
KeepNonlimitShapes)
TUI Command (without sub-shapes intersection):
geompy.MakePartitionNonSelfIntersectedShape(ListOfShapes,
ListOfTools, ListOfKeepInside, ListOfRemoveInside, Limit, RemoveWebs,
ListOfMaterials, KeepNonlimitShapes)
Here,
- \em ListOfShapes is a list of shapes to be intersected
- \em ListOfTools is a list of shapes to intersect the shapes from
\em ListOfShapes
- \em Limit is a Type of resulting shapes
- \em KeepNonlimitShapes is a flag that allows to preserve standalone
shapes of low dimension (than \em Limit) in the result.
- Other parameters are obsolete and kept only for compatibility with
previous versions of SALOME.
Intersection of a Shape and a Plane.
\image html partition2.png
Arguments: Name + 1 shape to be intersected + 1 cutting plane.
Advanced option:
\ref restore_presentation_parameters_page "Set presentation parameters and subshapes from arguments".
TUI Command:
geompy.MakeHalfPartition(Shape, Plane), where:
- \em Shape is a source shape to be intersected by the \em Plane
- \em Plane is a tool shape, to intersect the \em Shape.
Examples:
\image html partitionsn1.png "Box intersected by a plane"
\image html partitionsn2.png "Result of intersection"
\anchor partition_picture_3
\image html partitionsn3.png "Result of intersection of a box and a plane (both as \em Objects, no tools) with the Resulting type \em Solid and checked 'Keep shapes of lower type'"
Our TUI Scripts provide you with useful examples of \ref tui_partition "Basic Operations".
*/