Salome HOME
Merge branch 'master' into V9_dev
[modules/geom.git] / doc / salome / gui / GEOM / input / section_operation.doc
index 383f1c5de39413eddfbefd3c719427c19ac529ad..0832ea8865cf72e7355bfea841141ef2efc16c58 100644 (file)
@@ -1,25 +1,34 @@
 /*!
 
-\page section_opeartion_page Section
+\page section_opeartion_page Intersection
 
-For detail description of the Boolean operations please refer to
-<a href="SALOME_BOA_PA.pdf">this document</a>. 
-It provides a general review of the Partition and Boolean
-operations algorithms, describes the usage methodology and highlighs
-major limitations of these operations.
+\b Intersection operation creates a vertex, an edge, a wire or a compound
+of them representing the intersection of two shapes.
+
+To produce it, select in the main menu <b>Operations - > Boolean - > Intersection</b>
+
+\image html neo-section.png "Intersection dialog"
+
+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).
 
-To produce a \b Section operation in the <b>Main Menu</b> select
-<b>Operations - > Boolean - > Section</b>
+\note This dialog supports navigation through the selectable objects (in OCC 3D viewer only):
+- Scroll mouse wheel with pressed \em Ctrl key or press \em "S", \em "P" keys when input focus is
+in the viewer to navigate between selectable objects.
+- Press left mouse button to select an appropriate object to the dialog box.
+.
+For more details, please refer to the \em "Functionality common for OCC and VTK viewers" chapter
+of the GUI module's documentation.
 
-This operation creates the section between 2 shapes.
+This operation can be performed using a <b>TUI Command:</b> 
 
-The \b Result will be any \b GEOM_Object (EDGE or WIRE).
-<b>TUI Command:</b> <em>geompy.MakeSection(s1, s2)</em>
-<b>Arguments:</b> Name + 2 shapes.
-<b>Advanced option:</b>
-\ref restore_presentation_parameters_page "Set presentation parameters and sub-shapes from arguments".
+<em>geompy.MakeSection(s1, s2, checkSelfInte)</em>
 
-\image html neo-section.png
+<b>Arguments:</b> Name + 2 shapes + an optional flag for self-intersection check.
 
 <b>Example:</b>
 
@@ -27,7 +36,14 @@ 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>
+
+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.
+
 */