X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=doc%2Fsalome%2Fgui%2FGEOM%2Finput%2Fcommon_operation.doc;h=804fcfafb265f05a8fc0bef70a3ca9ed59308a7c;hb=ac61a2cdfc5f166fb3bc17f82e89a460555548cb;hp=e24645f31eb9280ad6149c911ff55725b30a28c4;hpb=af323ccd1d47fe27b941822a729014c33859acfe;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 e24645f31..804fcfafb 100644 --- a/doc/salome/gui/GEOM/input/common_operation.doc +++ b/doc/salome/gui/GEOM/input/common_operation.doc @@ -2,37 +2,52 @@ \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)\n -Arguments: Name + a list of 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 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" - -For a particular case with two shapes for the Common operation there is the following TUI command: -TUI Command: geompy.MakeCommon(s1, s2)\n -Arguments: Name + 2 shapes. +\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.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 : + +geompy.MakeCommon(s1, s2, checkSelfInte) + +Arguments: Name + 2 shapes + an optional flag for self-intersection check. Example: \image html fusesn1.png "The initial shapes" -\image html commonsn.png "The resulting object" +\image html commonsn.png "The resulting object" Our TUI Scripts provide you with useful examples of the use of \ref tui_common "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.