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
   8 with a set of tool objects or with a plane.
   9 \n The \b Result will be any \b GEOM_Object.
  10
  11 <br><h2>Intersection of two shapes.</h2>
  12
  13 \image html partition1.png
  14
  15 \n <b>Arguments:</b> Name + 2 lists of shapes (the shapes from the
  16 first list will be intersected with the shapes from the second list) +
  17 Resulting Type of shape.
  18
  19 \n As far as the intersection of two objects can produce any type of
  20 geometrical objects, <b>Resulting type</b> box allows choosing the
  21 preferrable result, i.e. a solid, a shell, a list of faces, etc.
  22 \n<b>Resulting type</b> has to be equal or lower than the type of the
  23 \em Objects. In other words, if the \em Objects don't contain any
  24 shape of this type, Partition fails.
  25
  26 <b>Keep shapes of lower type</b> checkbox manages standalone shapes of
  27 type other than the \em Limit. If it is checked, lower dimension
  28 objects will be preserved, else they will be lost.
  29 \n For example, you do a partition of a box (Solid) and a face (Face)
  30 without any tool. If you choose Resulting Type "Solid", you will
  31 obtain a compound of two solids (let's the box will be splitted by the
  32 face on two parts), but if you will also check <b>Keep shapes of lower
  33 type</b> checkbox, you will obtain a compound of two solids and one
  34 face (the face will have a hole where the original face lays inside
  35 the box, see corresponding \ref partition_picture_3 "picture" below).
  36
  37 \n <b>Advanced option:</b>
  38    \ref restore_presentation_parameters_page "Set presentation parameters and subshapes from arguments".
  39
  40 \n <b>TUI Command:</b> <em>geompy.MakePartition(ListOfShapes,
  41 ListOfTools, ListOfKeepInside, ListOfRemoveInside, Limit, RemoveWebs,
  42 ListOfMaterials, KeepNonlimitShapes),</em> where where \em
  43 ListOfShapes is a list of shapes to be intersected, \em ListOfTools is
  44 a list of shapes to intersect the shapes from ListOfShapes, \em Limit
  45 is a Type of resulting shapes and \em KeepNonlimitShapes is a flag
  46 that allows to preserve standalone shapes of low dimension (than
  47 Limit) in the result.
  48
  49 \n Since the implementation of a new version of PartitionAlgo other
  50 parameters are ignored by the current functionality and remain there
  51 only to support the old scripts.
  52
  53
  54 <br><h2>Intersection of a Shape and a Plane.</h2>
  55
  56 \image html partition2.png
  57
  58 \n <b>Arguments:</b> Name + a list of shapes which will be intersected
  59 + 1 cutting plane.
  60
  61 \n <b>Advanced option:</b>
  62    \ref restore_presentation_parameters_page "Set presentation parameters and subshapes from arguments".
  63
  64 \n <b>TUI Command:</b> <em> geompy.MakeHalfPartition(Shapes,
  65 Plane),</em> where \em Shapes are a list of Shapes to be intersected
  66 and \em Plane is a Tool shape, to intersect the \em Shapes.
  67
  68 \n <b>Example:</b>
  69
  70 \image html partitionsn1.png "Box intersected by a plane"
  71
  72 \image html partitionsn2.png "Result of intersection"
  73
  74 \anchor partition_picture_3
  75 \image html partitionsn3.png "Result of intersection of a box and a plane (both as \em Objects, no tools) with Resulting type \em Solid and checked \em Keep \em shapes \em of \em lower \em type"
  76
  77 Our <b>TUI Scripts</b> provide you with useful examples of the use of
  78 \ref tui_partition "Basic Operations".
  79
  80 */