doc/salome/gui/GEOM/input/cut_operation.doc

   1 /*!
   2
   3 \page cut_operation_page Cut
   4
   5 To produce a \b Cut operation in the <b>Main Menu</b> select <b>Operations - > Boolean - > Cut</b>
   6
   7 This operation cuts a shape with a list of other shapes.
   8
   9 The \b Result will be a \b GEOM_Object.
  10
  11 <b>TUI Command:</b> <em>geompy.MakeCutList(theMainShape, theShapesList, checkSelfInte)</em>\n
  12 <b>Arguments:</b> Name + a main shape + a list of other shapes + an optional flag for self-intersection check.\n
  13 <b>Advanced option:</b>
  14 \ref restore_presentation_parameters_page "Set presentation parameters and sub-shapes from arguments".
  15
  16 \image html bool3.png "Cut dialog"
  17
  18 \note This algorithm doesn't find all types of self-intersections. It is tuned
  19       to detect vertex/vertex, vertex/edge, edge/edge, vertex/face and edge/face
  20       intersections. Face/face intersections detection is switched off as it
  21       is a time-consuming operation that gives an impact on performance. To find
  22       all self-intersections please use \ref check_self_intersections_page
  23       "Detect Self-intersection tool".
  24
  25 For a particular case with two shapes (object and tool) for the Cut operation there is the following TUI command:
  26
  27 <b>TUI Command:</b> <em>geompy.MakeCut(s1, s2, checkSelfInte)</em>\n
  28 <b>Arguments:</b> Name + the object + the tool + an optional flag for self-intersection check.
  29
  30 <b>Example:</b>
  31
  32 \image html fusesn1.png "The initial shapes"
  33
  34 \image html cutsn.png "The resulting object"
  35
  36 Our <b>TUI Scripts</b> provide you with useful examples of the use of
  37 \ref tui_cut "Boolean Operations".
  38
  39 <b> More details </b>
  40
  41 For a detailed description of the Boolean operations please refer to
  42 <a href="SALOME_BOA_PA.pdf">this document</a>.
  43 It provides a general review of the Partition and Boolean
  44 operations algorithms, describes the usage methodology and highlights
  45 major limitations of these operations.
  46
  47 */