Salome HOME
Merge remote branch 'origin/akl/22379'
[modules/geom.git] / doc / salome / gui / GEOM / input / cut_operation.doc
index d00c587eb5825927ac0de953dda1543415c03eb2..30235d6de64004d146d8f4b56256e741941819a0 100644 (file)
@@ -2,23 +2,38 @@
 
 \page cut_operation_page Cut
 
-To produce a \b Cut operation in the <b>Main Menu</b> select <b>Operations - > Boolean - > Cut</b>
+\b Cut operation cuts a shape with a list of other shapes.
 
-This operation cuts a shape with a list of other shapes.
+To produce it, select in the main menu <b>Operations - > Boolean - > Cut</b>
 
-The \b Result will be a \b GEOM_Object.
+\image html bool3.png "Cut dialog"
 
-<b>TUI Command:</b> <em>geompy.MakeCutList(theMainShape, theShapesList)</em>\n
-<b>Arguments:</b> Name + a main shape + a list of other shapes.\n
-<b>Advanced option:</b>
-\ref restore_presentation_parameters_page "Set presentation parameters and sub-shapes from arguments".
+In this dialog:
+- Input or accept the default \b Name of the resulting shape. 
+- 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.
+- Select the <b>Tool objects</b>, which will cut the main object.
+- Activate the corresponding check-box if you wish to <b> Detect Self-intersections </b>.
+- Activate \ref restore_presentation_parameters_page "Advanced options" if required.
+- Press "Apply" or "Apply & Close" button to get the result (GEOM_Object).
 
-\image html bool3.png "Cut dialog"
+\note This algorithm does not find all types of self-intersections. It is tuned
+      to detect vertex/vertex, vertex/edge, edge/edge, vertex/face and edge/face
+      intersections. Face/face intersections detection is switched off as it
+      is a time-consuming operation that gives an impact on performance. To find
+      all self-intersections use \ref check_self_intersections_page
+      "Detect Self-intersection tool".
+
+This operation can be performed using a <b>TUI Command:</b> 
+
+<em>geompy.MakeCutList(theMainShape, theShapesList, checkSelfInte)</em>
+
+<b>Arguments:</b> Name + a main shape + a list of other shapes + an optional flag for self-intersection check.
+
+There is also a special <b>TUI Command:</b> for the Cut operation on two shapes (object and tool) :
 
-For a particular case with two shapes (object and tool) for the Cut operation there is the following TUI command:
+<em>geompy.MakeCut(s1, s2, checkSelfInte)</em>
 
-<b>TUI Command:</b> <em>geompy.MakeCut(s1, s2)</em>\n\r
-<b>Arguments:</b> Name + the object + the tool.\r
+<b>Arguments:</b> Name + the object + the tool + an optional flag for self-intersection check.
 
 <b>Example:</b>
 
@@ -26,13 +41,12 @@ For a particular case with two shapes (object and tool) for the Cut operation th
 
 \image html cutsn.png "The resulting object"
 
-Our <b>TUI Scripts</b> provide you with useful examples of the use of 
+Our <b>TUI Scripts</b> provide you with useful examples of the use of
 \ref tui_cut "Boolean Operations".
 
 <b> More details </b>
 
-For a detailed description of the Boolean operations please refer to
-<a href="SALOME_BOA_PA.pdf">this document</a>. 
+Please refer to <a href="SALOME_BOA_PA.pdf">this document</a> for a detailed description of Boolean operations.
 It provides a general review of the Partition and Boolean
 operations algorithms, describes the usage methodology and highlights
 major limitations of these operations.