Salome HOME
22756: [EDF] Intersection operation
[modules/geom.git] / doc / salome / gui / GEOM / input / section_operation.doc
index 5d60cf433d0a40342e920c52883b280294fd71ab..fc29eb8f1db5b11377796336dbdd056809eb4351 100644 (file)
@@ -2,19 +2,25 @@
 
 \page section_opeartion_page Section
 
-To produce a \b Section operation in the <b>Main Menu</b> select
-<b>Operations - > Boolean - > Section</b>
+\b Section operation creates a vertex, an edge, a wire or a compound
+of them representing the intersection of two shapes.
 
-This operation creates the section between 2 shapes.
+To produce it, select in the main menu <b>Operations - > Boolean - > Section</b>
 
-The \b Result will be any \b GEOM_Object (EDGE or WIRE).
+\image html neo-section.png "Section dialog"
 
-<b>TUI Command:</b> <em>geompy.MakeSection(s1, s2)</em>\n
-<b>Arguments:</b> Name + 2 shapes.\n
-<b>Advanced option:</b>
-\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 intersecting <b>Objects</b>.
+- Activate the corresponding check-box if you wish to <b> Detect Self-intersections</b>. If a self-intersection detected the operation fails.
+- Activate \ref restore_presentation_parameters_page "Advanced options" if required.
+- Press "Apply" or "Apply & Close" button to get the result (VERTEX, EDGE, WIRE or COMPOUND).
 
-\image html neo-section.png "Section dialog"
+This operation can be performed using a <b>TUI Command:</b> 
+
+<em>geompy.MakeSection(s1, s2, checkSelfInte)</em>
+
+<b>Arguments:</b> Name + 2 shapes + an optional flag for self-intersection check.
 
 <b>Example:</b>
 
@@ -22,13 +28,12 @@ The \b Result will be any \b GEOM_Object (EDGE or WIRE).
 
 \image html sectionsn.png "The resulting object"
 
-Our <b>TUI Scripts</b> provide you with useful examples of the use of 
+Our <b>TUI Scripts</b> provide you with useful examples of the use of
 \ref tui_section "Boolean Operations".
 
 <b> More details </b>
 
-For a detailed description of the Boolean operations please refer to
-<a href="SALOME_BOA_PA.pdf">this document</a>. 
+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.