diff --git a/doc/salome/gui/GEOM/images/partition1.png b/doc/salome/gui/GEOM/images/partition1.png index cc5b15544..7a6333f31 100755 Binary files a/doc/salome/gui/GEOM/images/partition1.png and b/doc/salome/gui/GEOM/images/partition1.png differ diff --git a/doc/salome/gui/GEOM/images/partition2.png b/doc/salome/gui/GEOM/images/partition2.png index 18f01e212..8125cdbb9 100755 Binary files a/doc/salome/gui/GEOM/images/partition2.png and b/doc/salome/gui/GEOM/images/partition2.png differ diff --git a/doc/salome/gui/GEOM/input/partition.doc b/doc/salome/gui/GEOM/input/partition.doc index 2b3b31eae..69f270607 100644 --- a/doc/salome/gui/GEOM/input/partition.doc +++ b/doc/salome/gui/GEOM/input/partition.doc @@ -2,31 +2,33 @@ \page partition_page Partition -\n To produce a \b Partition in the Main Menu select Operations - > Partition +To produce a \b Partition in the Main Menu select Operations - > Partition -\n This operation builds a compound by intersection of several shapes +This operation builds a compound by intersection of several shapes with a set of tool objects or with a plane. -\n The \b Result will be any \b GEOM_Object. +The \b Result will be \b GEOM_Object.

Intersection of two shapes.

\image html partition1.png -\n Arguments: Name + 2 lists of shapes (the shapes from the +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. -\n As far as the intersection of two objects can produce any type of +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. -\nResulting type has to be equal or lower than the type of 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. -\n For example, you do a partition of a box (Solid) and a face (Face) + +For example, you do a partition of a box (Solid) and a face (Face) without any tool. If you choose Resulting Type "Solid", you will obtain a compound of two solids (let's the box will be splitted by the face on two parts), but if you will also check Keep shapes of lower @@ -34,7 +36,15 @@ type checkbox, you will obtain a compound of two solids and one face (the face will have a hole where the original face lays inside the box, see corresponding \ref partition_picture_3 "picture" below). -\n Advanced option: +No shapes self intersection 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 to the +sub-shapes and intersection between those shapes will be also +computed. If this option is switched on, the intersection between +sub-shapes will be not performed. In this case the Partition algorithm +will work faster, but 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 kind of complex operation, result of it depends @@ -43,35 +53,44 @@ the box, see corresponding \ref partition_picture_3 "picture" below). and Limit Tolerance in such cases. See also \ref tui_limit_tolerance "TUI example" of shape healing. -\n TUI Command: geompy.MakePartition(ListOfShapes, +TUI Command (with sub-shapes intersection): + +geompy.MakePartition(ListOfShapes, ListOfTools, ListOfKeepInside, +ListOfRemoveInside, Limit, RemoveWebs, ListOfMaterials, +KeepNonlimitShapes) + +TUI Command (no sub-shapes intersection): + +geompy.MakePartitionNonSelfIntersectedShape(ListOfShapes, ListOfTools, ListOfKeepInside, ListOfRemoveInside, Limit, RemoveWebs, -ListOfMaterials, KeepNonlimitShapes), where where \em -ListOfShapes is a list of shapes to be intersected, \em ListOfTools is -a list of shapes to intersect the shapes from ListOfShapes, \em Limit -is a Type of resulting shapes and \em KeepNonlimitShapes is a flag -that allows to preserve standalone shapes of low dimension (than -Limit) in the result. - -\n Since the implementation of a new version of PartitionAlgo other -parameters are ignored by the current functionality and remain there -only to support the old scripts. +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 +ListOfShapes +- \em Limit is a Type of resulting shapes and \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 -\n Arguments: Name + a list of shapes which will be intersected -+ 1 cutting plane. +Arguments: Name + 1 shape to be intersected + 1 cutting plane. -\n Advanced option: - \ref restore_presentation_parameters_page "Set presentation parameters and subshapes from arguments". +Advanced option: +\ref restore_presentation_parameters_page "Set presentation parameters and subshapes from arguments". -\n TUI Command: geompy.MakeHalfPartition(Shapes, -Plane), where \em Shapes are a list of Shapes to be intersected -and \em Plane is a Tool shape, to intersect the \em Shapes. +TUI Command: -\n Example: +geompy.MakeHalfPartition(Shape, Plane) where +- \em Shape is a source shape to be intersected by \em Plane +- \em Plane is a tool shape, to intersect the \em Shape. + +Example: \image html partitionsn1.png "Box intersected by a plane"