doc/salome/gui/GEOM/input/fast_intersection.doc

   1 /*!
   2 \page fast_intersection_page Fast intersection
   3
   4 This operation checks if two selected shapes are overlapped.
   5
   6 This tool is useful for fast detection of intersections and gaps.
   7 In contrast to Boolean Operations, Partition and Detect Self-intersection
   8 algorithms that compute topological intersections, this algorithm computes
   9 intersections by generating tessellation (triangulation) of the source
  10 shapes and detecting overlapping of resulting meshes. High performance is
  11 achieved through the use of existing triangulation of faces.
  12 Due to this fact, the tool is not suitable for computing exact intersection
  13 of shapes; however, it can be used to quickly find zones where
  14 intersections can present, and then use these results in further analysis.
  15
  16 \note For more information about Partition and Boolean Operations Algorithms
  17 and their limitations refer to <a href="SALOME_BOA_PA.pdf">this document</a>.
  18
  19 \image html measures12.png
  20
  21 \note This dialog supports navigation through the selectable objects (in OCC 3D viewer only):
  22 - Scroll mouse wheel with pressed \em Ctrl key or press \em "S", \em "P" keys when input focus is
  23 in the viewer to navigate between selectable objects.
  24 - Press left mouse button to select an appropriate object to the dialog box.
  25 .
  26 For more details, please refer to the \em "Functionality common for OCC and VTK viewers" chapter
  27 of the GUI module's documentation.
  28
  29 In this dialog:
  30
  31 - <b> Object 1 </b> and <b> Object 2 </b> the checked objects. \b Selection button allows picking them in the viewer or in the object browser.
  32 - <b>Deflection coefficient</b> specifies the quality of shapes tessellation.
  33 - <b>Detect gaps</b> - when switched on, allows detecting gaps between shapes.
  34 - <b>Tolerance</b> - specifies the distance between shapes used for detecting gaps.
  35 - <b>Compute intersections</b> - press this button to compute interferences.
  36 - <b>Sub-shapes of Object 1</b> - list of sub-shapes from the first source shape that localize the intersection.
  37 - <b>Sub-shapes of Object 2</b> - list of sub-shapes from the second source shape that localize the intersection.
  38 - \b Apply and <b>Apply and Close</b> buttons are used to store selected intersected shapes in the study for
  39 further analysis (see below).
  40
  41 \note The result quality depends on the quality of triangulation. Changing the value of the deflection coefficient
  42 parameter can strongly affect the result. However, small values of the deflection coefficient might lead to
  43 some performance loss of the algorithm, as number of triangles of the tessellation mesh depends on this parameter.
  44
  45 Press <b>Apply and Close</b> or \b Apply button to store the selected sub-shapes in the study for further analysis.
  46 The selection will be published as a compound containing intersected sub-shapes from both source objects.
  47
  48 <b>TUI Command:</b> <em>geompy.FastIntersect(theShape1, theShape2, theTolerance = 0.0, theDeflection = 0.001),</em> \n
  49 where:
  50 - \em theShape1 First shape.
  51 - \em theShape2 Second shape.
  52 - \em theTolerance When it is negative or equal to zero, the function detects intersections;
  53                    when it is positive, the function detects gaps.
  54 - \em theDeflection Linear deflection for shapes; if deflection <= 0, default deflection 0.001 is used
  55
  56 <b>Result:</b> Boolean + two lists of IDs of sub-shapes (from input shapes) that localize the intersection.
  57
  58 See also a \ref tui_fast_intersection_page "TUI example".
  59
  60 */