X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=doc%2Fsalome%2Fgui%2FGEOM%2Finput%2Fcut_operation.doc;h=30235d6de64004d146d8f4b56256e741941819a0;hb=69b2ec02a2002731ceaf0597fa9f4dd9cd57dc91;hp=5ea6c5dfca6e1128a89433f47ac9b17d7ac280f0;hpb=73555c78ebf12a1fdb85157b8e7934ad566ae90a;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 5ea6c5dfc..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 -For detail description of the Boolean operations please refer to -this document. -It provides a general review of the Partition and Boolean -operations algorithms, describes the usage methodology and highlighs -major limitations of these operations. +\b Cut operation cuts a shape with a list of other shapes. + +To produce it, select in the main menu Operations - > Boolean - > Cut + +\image html bool3.png "Cut dialog" + +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). + +\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". -To produce a \b Cut operation in the Main Menu select Operations - > Boolean - > Cut +This operation can be performed using a TUI Command: -This operation cuts a shape with another one. -The \b Result will be any \b GEOM_Object. -Arguments: Name + 2 shapes. -Advanced option: -\ref restore_presentation_parameters_page "Set presentation parameters and sub-shapes from arguments". +geompy.MakeCutList(theMainShape, theShapesList, checkSelfInte) -Dialog Box: +Arguments: Name + a main shape + a list of other shapes + an optional flag for self-intersection check. -\image html bool3.png +There is also a special TUI Command: for the Cut operation on two shapes (object and tool) : + +geompy.MakeCut(s1, s2, checkSelfInte) + +Arguments: Name + the object + the tool + an optional flag for self-intersection check. Example: @@ -26,7 +41,14 @@ The \b Result will be any \b GEOM_Object. \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 + +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. + */