Salome HOME
add documentation about "Reduce Study" functionality
[modules/geom.git] / doc / salome / gui / GEOM / input / fuse_operation.doc
index 5eb168bcddb62034a3ed64358c9ef5053d096681..e0a31b777c2a457f41675b66fbc0525bf8ee1495 100644 (file)
@@ -2,24 +2,58 @@
 
 \page fuse_operation_page Fuse
 
-\n To produce a \b Fuse operation in the <b>Main Menu</b> select
-<b>Operations - > Boolean - > Fuse</b>
+\b Fuse operation creates one shape from a list of shapes.
 
-\n This operation creates a shape from two shapes.
+To produce it, select in the Main Menu <b>Operations - > Boolean - > Fuse</b>.
 
-\n The \b Result will be any \b GEOM_Object.
-\n <b>Arguments:</b> Name + 2 shapes.
-\n <b>TUI Command:</b> <em>geompy.MakeFuse(s1, s2)</em>
+\image html bool1.png "Fuse dialog"
 
-\image html bool1.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> to be fused.
+- Activate the corresponding check-box if you wish to <b> Detect Self-intersections </b>.
+- Activate the corresponding check-box if you wish to <b> remove extra edges </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>
+\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 fusesn1.png
+<em>geompy.MakeFuseList(theShapesList, checkSelfInte, rmExtraEdges)</em>
 
-\image html fusesn2.png
+<b>Arguments:</b> Name + a list of shapes + an optional flag for
+self-intersection check + an optional flag to remove extra edges.
 
-Our <b>TUI Scripts</b> provide you with useful examples of the use of 
+There is also a special <b>TUI Command</b> for \b Fuse operation on two shapes  :
+
+<em>geompy.MakeFuse(s1, s2, checkSelfInte, rmExtraEdges)</em>
+
+<b>Arguments:</b> Name + 2 shapes + an optional flag for self-intersection
+check + an optional flag to remove extra edges.
+
+<b>Example:</b>
+
+\image html fusesn1.png "The initial shapes"
+
+\image html fusesn2.png "The resulting fuse"
+
+Our <b>TUI Scripts</b> provide you with useful examples of the use of
 \ref tui_fuse "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.
+
+Perhaps you also ask yourself : \ref partition_explanation "What is the difference between partition, compounds and fuse operation ?"
+
 */