X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=doc%2Fsalome%2Fgui%2FGEOM%2Finput%2Fcut_operation.doc;h=30235d6de64004d146d8f4b56256e741941819a0;hb=97d9c2c6b1eb1b8c37b74e9409ebdb89c42c8c27;hp=d00c587eb5825927ac0de953dda1543415c03eb2;hpb=af323ccd1d47fe27b941822a729014c33859acfe;p=modules%2Fgeom.git diff --git a/doc/salome/gui/GEOM/input/cut_operation.doc b/doc/salome/gui/GEOM/input/cut_operation.doc index d00c587eb..30235d6de 100644 --- a/doc/salome/gui/GEOM/input/cut_operation.doc +++ b/doc/salome/gui/GEOM/input/cut_operation.doc @@ -2,23 +2,38 @@ \page cut_operation_page Cut -To produce a \b Cut operation in the Main Menu select Operations - > Boolean - > Cut +\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 Operations - > Boolean - > Cut -The \b Result will be a \b GEOM_Object. +\image html bool3.png "Cut dialog" -TUI Command: geompy.MakeCutList(theMainShape, theShapesList)\n -Arguments: Name + a main shape + a list of other shapes.\n -Advanced option: -\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 Main Object, which will be cut by tool objects. +- Select the Tool objects, which will cut the main object. +- Activate the corresponding check-box if you wish to Detect Self-intersections . +- 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 TUI Command: + +geompy.MakeCutList(theMainShape, theShapesList, checkSelfInte) + +Arguments: Name + a main shape + a list of other shapes + an optional flag for self-intersection check. + +There is also a special TUI Command: 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: +geompy.MakeCut(s1, s2, checkSelfInte) -TUI Command: geompy.MakeCut(s1, s2)\n -Arguments: Name + the object + the tool. +Arguments: Name + the object + the tool + an optional flag for self-intersection check. Example: @@ -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 TUI Scripts provide you with useful examples of the use of +Our TUI Scripts provide you with useful examples of the use of \ref tui_cut "Boolean Operations". More details -For a detailed description of the Boolean operations please refer to -this document. +Please refer to this document 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.