doc/salome/gui/GEOM/input/partition.doc

   1 /*!
   2
   3 \page partition_page Partition
   4
   5 <ul>
   6 <li>For a detailed description of the Partition operation please refer to
   7 <a href="SALOME_BOA_PA.pdf">this document</a>.
   8 It provides a general review of the Partition and Boolean
   9 operations algorithms, describes the usage methodology and highlights
  10 major limitations of these operations.</li>
  11
  12 <li>Perhaps you also ask yourself : \ref partition_explanation "What's the difference between partition, compounds and fuse operation ?"</li>
  13 </ul>
  14
  15 To produce a \b Partition in the <b>Main Menu</b> select <b>Operations - > Partition</b>
  16
  17 This operation builds a compound by intersection of several shapes
  18 with a set of tool objects or with a plane.
  19 The \b Result will be a \b GEOM_Object.
  20
  21 <br><h2>Intersection of two shapes.</h2>
  22
  23 \image html partition1.png
  24
  25 <b>Arguments:</b> Name + 2 lists of shapes (the shapes from the
  26 first list will be intersected with the shapes from the second list) +
  27 Resulting Type of shape.
  28
  29 As far as the intersection of two objects can produce any type of
  30 geometrical objects, <b>Resulting type</b> box allows choosing the
  31 preferrable result, i.e. a solid, a shell, a list of faces, etc.
  32
  33 The <b>Resulting type</b> has to be equal or lower than the type of the
  34 \em Objects. In other words, if the \em Objects don't contain any
  35 shape of this type, Partition fails.
  36
  37 <b>Keep shapes of lower type</b> checkbox manages standalone shapes of
  38 type other than the \em Limit. If it is checked, lower dimension
  39 objects will be preserved, else they will be lost.
  40
  41 For example, you partition a box (Solid) and a face (Face)
  42 without any tool (the box is split in two parts by the shape). If you
  43 choose the Resulting Type "Solid", you will
  44 obtain a compound of two solids, but if you also check <b>Keep shapes of lower
  45 type</b> checkbox, you will obtain a compound of two solids and one
  46 face (there will be a hole in the resulting face, where the original
  47 face intersects with the box, see the corresponding \ref partition_picture_3 "picture" below).
  48
  49 <b>No sub-shapes intersection (Compounds only)</b> check box affects
  50 only input shapes of the Compound type. If this option is switched off (default
  51 behavior) each input compound will be automatically exploded into
  52 sub-shapes and the intersection between these shapes will be also
  53 computed. If this option is switched on, the intersection between
  54 sub-shapes will not be performed. In this case the Partition algorithm
  55 will work faster, but the result might differ from the default behavior.
  56
  57 <b>Detect Self-intersections</b> check box is used to check arguments
  58 self-intersections. If this option is switched on (default behavior)
  59 each input shape is checked for self-intersection. In case of its detection
  60 the operation is aborted. If this option is switched off, the partition
  61 algorithm is performed without self-intersection checks.
  62
  63  <b>Advanced option:</b>
  64    \ref restore_presentation_parameters_page "Set presentation parameters and sub-shapes from arguments".
  65
  66 \note Partition is a complex operation, so its result of it depends
  67       on the quality of the initial shapes. Sometimes, if partition fails,
  68       such healing operations as <b>Shape Processing</b>
  69       and <b>Limit Tolerance</b> can help to attune source shapes to obtain correct result of the Partition.
  70       See also \ref tui_limit_tolerance "TUI example" of shape healing.
  71
  72 <b>TUI Command (with sub-shapes intersection):</b>
  73
  74 <em>geompy.MakePartition(ListOfShapes, ListOfTools, ListOfKeepInside,
  75 ListOfRemoveInside, Limit, RemoveWebs, ListOfMaterials,
  76 KeepNonlimitShapes, checkSelfInte)</em>
  77
  78 <b>TUI Command (without sub-shapes intersection):</b>
  79
  80 <em>geompy.MakePartitionNonSelfIntersectedShape(ListOfShapes,
  81 ListOfTools, ListOfKeepInside, ListOfRemoveInside, Limit, RemoveWebs,
  82 ListOfMaterials, KeepNonlimitShapes, checkSelfInte)</em>
  83
  84 Here,
  85 - \em ListOfShapes is a list of shapes to be intersected
  86 - \em ListOfTools is a list of shapes to intersect the shapes from
  87 \em ListOfShapes
  88 - \em Limit is a Type of resulting shapes
  89 - \em KeepNonlimitShapes is a flag that allows to preserve standalone
  90 shapes of low dimension (than \em Limit) in the result.
  91 - \em checkSelfInte is a flag that tells if the arguments should
  92 be checked for self-intersection prior to the operation.
  93 - Other parameters are obsolete and kept only for compatibility with
  94 previous versions of SALOME.
  95
  96 <br><h2>Intersection of a Shape and a Plane.</h2>
  97
  98 \image html partition2.png
  99
 100 <b>Arguments:</b> Name + 1 shape to be intersected + 1 cutting plane.
 101
 102 <b>Advanced option:</b>
 103 \ref restore_presentation_parameters_page "Set presentation parameters and sub-shapes from arguments".
 104
 105 <b>TUI Command:</b>
 106
 107 <em>geompy.MakeHalfPartition(Shape, Plane, checkSelfInte)</em>, where:
 108 - \em Shape is a source shape to be intersected by the \em Plane
 109 - \em Plane is a tool shape, to intersect the \em Shape.
 110 - \em checkSelfInte is a flag that tells if the arguments should
 111 be checked for self-intersection prior to the operation.
 112
 113 <b>Examples:</b>
 114
 115 \image html partitionsn1.png "Box intersected by a plane"
 116
 117 \image html partitionsn2.png "Result of intersection"
 118
 119 \anchor partition_picture_3
 120 \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'"
 121
 122 Our <b>TUI Scripts</b> provide you with useful examples of \ref tui_partition "Basic Operations".
 123
 124 */