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>Resulting type</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 \n <b>Advanced option:</b>
  27    \ref restore_presentation_parameters_page "Set presentation parameters and subshapes from arguments".
  28
  29 \image html partition1.png
  30
  31 <b>Keep shapes of lower type</b> checkbox allows building geometrical objects.
  32 Only lower type objects will be preserved without the upper ones.
  33
  34
  35 <br><h2>Intersection of a Shape and a Plane.</h2>
  36
  37 \n <b>TUI Command:</b> <em> geompy.MakeHalfPartition(Shapes,
  38 Plane),</em> where \em Shapes are a list of Shapes to be intersected
  39 and \em Plane is a Tool shape, to intersect the \em Shapes.
  40 \n <b>Arguments:</b> Name + a list of shapes which will be intersected
  41 + 1 cutting plane.
  42 \n <b>Advanced option:</b>
  43    \ref restore_presentation_parameters_page "Set presentation parameters and subshapes from arguments".
  44
  45 \image html partition2.png
  46
  47 \n <b>Example:</b>
  48
  49 \image html partitionsn1.png "Box intersected by a plane"
  50
  51 \image html partitionsn2.png "Result of intersection"
  52
  53 Our <b>TUI Scripts</b> provide you with useful examples of the use of
  54 \ref tui_partition "Basic Operations".
  55
  56 */