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

   1 /*!
   2
   3 \page cut_operation_page Cut
   4
   5 \b Cut operation cuts a shape with a list of other shapes.
   6
   7 To produce it, select in the main menu <b>Operations - > Boolean - > Cut</b>
   8
   9 \image html bool3.png "Cut dialog"
  10
  11 In this dialog:
  12 - Input or accept the default \b Name of the resulting shape.
  13 - Click the arrow button and select in the Object Browser or in the Viewer the <b>Main Object</b>, which will be cut by tool objects.
  14 - Select the <b>Tool objects</b>, which will cut the main object.
  15 - Activate the corresponding check-box if you wish to <b> Detect Self-intersections </b>.
  16 - Activate the corresponding check-box if you wish to use a <b> fuzzy parameter </b>.
  17   If activated, you can define the fuzzy tolerance in the <b> fuzzy parameter </b> input box.
  18 - Activate \ref restore_presentation_parameters_page "Advanced options" if required.
  19 - Press "Apply" or "Apply & Close" button to get the result (GEOM_Object).
  20
  21 \note This algorithm does not find all types of self-intersections. It is tuned
  22       to detect vertex/vertex, vertex/edge, edge/edge, vertex/face and edge/face
  23       intersections. Face/face intersections detection is switched off as it
  24       is a time-consuming operation that gives an impact on performance. To find
  25       all self-intersections use \ref check_self_intersections_page
  26       "Detect Self-intersection tool".
  27
  28 This operation can be performed using a <b>TUI Command:</b>
  29
  30 <em>geompy.MakeCutList(theMainShape, theShapesList, checkSelfInte, name, fuzzyParam)</em>
  31
  32 <b>Arguments:</b> a main shape + a list of other shapes + an optional flag for self-intersection
  33 check + an optional name + an optional fuzzy parameter.
  34
  35 There is also a special <b>TUI Command:</b> for the Cut operation on two shapes (object and tool) :
  36
  37 <em>geompy.MakeCut(s1, s2, checkSelfInte, name, fuzzyParam)</em>
  38
  39 <b>Arguments:</b> the object + the tool + an optional flag for self-intersection check + an
  40 optional name + an optional fuzzy parameter.
  41
  42 <b>Example:</b>
  43
  44 \image html fusesn1.png "The initial shapes"
  45
  46 \image html cutsn.png "The resulting object"
  47
  48 Our <b>TUI Scripts</b> provide you with useful examples of the use of
  49 \ref tui_cut "Boolean Operations".
  50
  51 <b> More details </b>
  52
  53 Please refer to <a href="SALOME_BOA_PA.pdf">this document</a> for a detailed description of Boolean operations.
  54 It provides a general review of the Partition and Boolean
  55 operations algorithms, describes the usage methodology and highlights
  56 major limitations of these operations.
  57
  58 */