Salome HOME
7dfc5310d482e911256372420d5269e11c2e01b4
[modules/geom.git] / doc / salome / gui / GEOM / input / partition.doc
1 /*!
2
3 \page partition_page Partition
4
5 \n To produce a \b Partition in the <b>Main Menu</b> select <b>Operations - > Partition</b>
6
7 \n This operation builds a compound by intersection of several shapes with a tool object or a plane.
8 \n The \b Result will be any \b GEOM_Object.
9
10 <br><h2>Intersection of two shapes.</h2>
11
12 \n As far as the intersection of two objects can produce any type of
13 geometrical objects, <b>Reconstruction Limit</b> box allows choosing the
14 preferrable result, i.e. a solid, a shell, a list of faces, etc.
15 \n <b>TUI Command:</b> <em>geompy.MakePartition(ListOfShapes,
16 ListOfTools, ListOfKeepInside, ListOfRemoveInside, Limit, RemoveWebs,
17 ListOfMaterials),</em> where where \em ListOfShapes is a list of shapes to
18 be intersected and \em ListOfTools is a list of shapes to intersect the
19 shapes from ListOfShapes.
20 \n Since the implementation of a new version of PartitionAlgo other
21 parameters are ignored by the current functionality and remain there
22 only to support the old scripts.
23 \n <b>Arguments:</b> Name + 2 lists of shapes (the shapes from the
24 first list will be intersected with the shapes from the second list) +
25 reconstruction limit.
26
27 \image html partition1.png
28
29 <b>Keep nonlimit shapes</b> checkbox allows building geometrical objects of
30 all types at the same time i.e. no reconstruction limit is applied.
31
32
33 <br><h2>Intersection of a Shape and a Plane.</h2>
34
35 \n <b>TUI Command:</b> <em> geompy.MakeHalfPartition(Shapes,
36 Plane),</em> where \em Shapes are a list of Shapes to be intersected
37 and \em Plane is a Tool shape, to intersect the \em Shapes.
38 \n <b>Arguments:</b> Name + a list of shapes which will be intersected
39 + 1 cutting plane.
40
41 \image html partition2.png
42
43 \n <b>Example:</b>
44
45 \image html partitionsn1.png
46
47 \image html partitionsn2.png
48
49 Our <b>TUI Scripts</b> provide you with useful examples of the use of
50 \ref tui_partition "Basic Operations".
51
52 */