doc/salome/gui/GEOM/input/section_operation.doc

   1 /*!
   2
   3 \page section_opeartion_page Section
   4
   5 \b Section operation creates a vertex, an edge, a wire or a compound
   6 of them representing the intersection of two shapes.
   7
   8 To produce it, select in the main menu <b>Operations - > Boolean - > Section</b>
   9
  10 \image html neo-section.png "Section dialog"
  11
  12 In this dialog:
  13 - Input or accept the default \b Name of the resulting shape.
  14 - Click the arrow button and select in the Object Browser or in the Viewer the intersecting <b>Objects</b>.
  15 - Activate the corresponding check-box if you wish to <b> Detect Self-intersections</b>. If a self-intersection detected the operation fails.
  16 - Activate \ref restore_presentation_parameters_page "Advanced options" if required.
  17 - Press "Apply" or "Apply & Close" button to get the result (VERTEX, EDGE, WIRE or COMPOUND).
  18
  19 \note This dialog supports navigation through the selectable objects (in OCC 3D viewer only):
  20 - Scroll mouse wheel with pressed \em Ctrl key or press \em "S", \em "P" keys when input focus is
  21 in the viewer to navigate between selectable objects.
  22 - Press left mouse button to select an appropriate object to the dialog box.
  23 .
  24 For more details, please refer to the \em "Functionality common for OCC and VTK viewers" chapter
  25 of the GUI module's documentation.
  26
  27 This operation can be performed using a <b>TUI Command:</b>
  28
  29 <em>geompy.MakeSection(s1, s2, checkSelfInte)</em>
  30
  31 <b>Arguments:</b> Name + 2 shapes + an optional flag for self-intersection check.
  32
  33 <b>Example:</b>
  34
  35 \image html fusesn1.png "The initial shapes"
  36
  37 \image html sectionsn.png "The resulting object"
  38
  39 Our <b>TUI Scripts</b> provide you with useful examples of the use of
  40 \ref tui_section "Boolean Operations".
  41
  42 <b> More details </b>
  43
  44 Please refer to <a href="SALOME_BOA_PA.pdf">this document</a> for a detailed description of Boolean operations.
  45 It provides a general review of the Partition and Boolean
  46 operations algorithms, describes the usage methodology and highlights
  47 major limitations of these operations.
  48
  49 */