X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=doc%2Fsalome%2Fgui%2FGEOM%2Finput%2Fcommon_operation.doc;h=804fcfafb265f05a8fc0bef70a3ca9ed59308a7c;hb=97d9c2c6b1eb1b8c37b74e9409ebdb89c42c8c27;hp=b317eed99ad7121f2a8eb0234a3d235adda2cc07;hpb=a71c6a5e82c6a3063a15503394415ba3c3c5f2b2;p=modules%2Fgeom.git diff --git a/doc/salome/gui/GEOM/input/common_operation.doc b/doc/salome/gui/GEOM/input/common_operation.doc index b317eed99..804fcfafb 100644 --- a/doc/salome/gui/GEOM/input/common_operation.doc +++ b/doc/salome/gui/GEOM/input/common_operation.doc @@ -2,29 +2,38 @@ \page common_operation_page Common -To produce a \b Common operation in the Main Menu select Operations - > Boolean - > Common +\b Common operation cuts the common part of a list of shapes and transforms it into an independent geometrical object. -This operation cuts the common part of a list of shapes and transforms it into an independent geometrical object. +To produce it, select in the main menu Operations - > Boolean - > Common. -The \b Result will be a \b GEOM_Object. +\image html bool2.png "Common dialog" -TUI Command: geompy.MakeCommonList(theShapesList, checkSelfInte)\n -Arguments: Name + a list of shapes + an optional flag for self-intersection check.\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 Objects the common part which of should be found. +- 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 bool2.png "Common dialog" -\note This algorithm doesn't find all types of self-intersections. It is tuned +\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 please use \ref check_self_intersections_page + all self-intersections use \ref check_self_intersections_page "Detect Self-intersection tool". + + +This operation can be performed using a TUI Command: + +geompy.MakeCommonList(theShapesList, checkSelfInte) + +Arguments: Name + a list of shapes + an optional flag for self-intersection check. + +There is also a special TUI Command for the Common operation on two shapes : -For a particular case with two shapes for the Common operation there is the following TUI command: +geompy.MakeCommon(s1, s2, checkSelfInte) -TUI Command: geompy.MakeCommon(s1, s2, checkSelfInte)\n Arguments: Name + 2 shapes + an optional flag for self-intersection check. Example: @@ -38,8 +47,7 @@ Our TUI Scripts provide you with useful examples of the use of 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.