Salome HOME
Synchronize adm files
[modules/geom.git] / doc / salome / gui / GEOM / input / common_operation.doc
old mode 100644 (file)
new mode 100755 (executable)
index 21cd277..804fcfa
@@ -2,23 +2,54 @@
 
 \page common_operation_page Common
 
-\n To produce a \b Common operation in the <b>Main Menu</b> select <b>Operations - > Boolean - > Common</b>
+\b Common operation cuts the common part of a list of shapes and transforms it into an independent geometrical object.
 
-\n This operation cuts the common part of two shapes and transforms it into an independent geometrical object.
+To produce it, select in the main menu  <b>Operations - > Boolean - > Common</b>.
 
-\n The \b Result will be any \b GEOM_Object.
-\n <b>TUI Command:</b> <em>geompy.MakeCommon(s1, s2)</em>
-\n <b>Arguments:</b> Name + 2 shapes.
+\image html bool2.png "Common dialog"
 
-\image html bool2.png
+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>Objects</b> the common part which of should be found.
+- 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).
 
-\n <b>Example:</b>
 
-\image html fusesn1.png
+\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> 
 
-\image html commonsn.png
+<em>geompy.MakeCommonList(theShapesList, checkSelfInte)</em>
+
+<b>Arguments:</b> Name + a list of shapes + an optional flag for self-intersection check.
+
+There is also a special <b>TUI Command</b> for the Common operation on two shapes :
+
+<em>geompy.MakeCommon(s1, s2, checkSelfInte)</em>
+
+<b>Arguments:</b> Name + 2 shapes + an optional flag for self-intersection check.
+
+<b>Example:</b>
+
+\image html fusesn1.png "The initial shapes"
+
+\image html commonsn.png "The resulting object"
 
 Our <b>TUI Scripts</b> provide you with useful examples of the use of
 \ref tui_common "Boolean Operations".
 
+<b> More details </b>
+
+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.
+
 */