Salome HOME
Implementation of [bos #35140] [EDF] (2023-T1) Memory communication between SHAPER...
[modules/geom.git] / doc / salome / gui / GEOM / input / check_self_intersections.doc
1 /*!
2
3 \page check_self_intersections_page Detect Self-intersections
4
5 \n To <b>Detect Self-intersections,</b> select in the <b>Main Menu</b> 
6 <b>Inspection - > Detect Self-intersections</b>.
7
8 There are two ways to check self-intersections.
9
10 \anchor check_self_intersections_topological
11 <br><h3>Check topological intersections</h3>
12
13 This operation checks the topology of the selected shape to detect self-intersections.
14
15 \image html measures11.png
16
17 In this dialog:
18
19 - \b Object - the checked object. \b Selection button allows picking it in the viewer or in the object browser.
20 - <b>Level of check</b> - combo box allows setting the level of self-interference checking. It defines, which interferences will be checked. The default value is "All interferences".
21 - <b>Compute self-intersections</b> button performs the computation.
22 - \b Summary section contains the general report about self-intersections of the object and/or errors that occurred during the computation.
23 - \b Self-intersections list contains the list of detected self-intersections. Select the intersection to show <b>Sub-shapes</b> in the field to the right. 
24 - \b Apply and <b>Apply and Close</b> buttons store the interferences selected in the <b>Self-intersections</b> list box in the study for further analysis. 
25 If no interferences are selected, all of them are published in the study. Each interference is published as a child compound of the source shape and contains a couple of intersecting sub-shapes.
26
27 \note This tool is useful for detection of shapes that are not suitable as
28 arguments of Boolean operations and Partition algorithm.
29 For more information about Partition and Boolean Operations Algorithms
30 and their limitations refer to <a href="SALOME_BOA_PA.pdf">this document</a>.
31
32 \n <b>Result:</b> Boolean.
33 \n <b>TUI Command:</b> <em>geompy.CheckSelfIntersections(theShape, theCheckLevel = GEOM.SI_ALL),</em> \n
34 where: \n
35 \em theShape is the shape checked for validity. \n
36 \em theCheckLevel is the level of check. Default value is GEOM.SI_ALL to check all interferences.
37
38 See also a \ref tui_check_self_intersections_page "TUI example".
39
40 \anchor check_self_intersections_fast
41 <br><h3>Fast intersection</h3>
42
43 This operation allows quickly detecting self-interferences of the given shape using the algorithm based on mesh intersections.
44
45 The algorithm works on the face level, i.e. it computes only face-to-face intersections. No additional intersection types are computed.
46
47 This can be useful to detect all intersections between subshapes of type "surface" in an assembly.
48 The result quality will depend on the tessellation quality. However, small deflection values can significantly decrease the performance of the algorithm.
49 Nevertheless, the performance of Fast Intersect algorithm is much higher than that of the topological intersection.
50
51 \image html measures13.png
52
53 In this dialog:
54
55 - \b Object - the checked object. \b Selection button allows picking it in the viewer or in the object browser.
56 - <b>Deflection coefficient</b> -  a linear deflection coefficient that defines the tessellation quality. If theDeflection <= 0, default deflection 0.001 is used.
57 - <b>Detect gaps with tolerance</b> specifies the distance between shapes used for detecting gaps:
58      - if theTolerance <= 0, the algorithm detects intersections;
59      - if theTolerance > 0, the algorithm detects gapss. 
60 - <b>Compute self-intersections</b> button performs the computation.
61 - \b Summary section contains the general report about self-intersections of the object and/or errors that occurred during the computation.
62 - \b Self-intersections list contains the list of detected self-intersections. Select the intersection to show <b>Sub-shapes</b> in the field to the right. 
63 - \b Apply and <b>Apply and Close</b> buttons store the interferences selected in the <b>Self-intersections</b> list box in the study for further analysis. 
64 If no interferences are selected, all of them are published in the study. Each interference is published as a child compound of the source shape and contains a couple of intersecting sub-shapes.
65
66 \n <b>Result:</b> Boolean.
67 \n <b>TUI Command:</b> <em>geompy.CheckSelfIntersectionsFast(theShape, theDeflection, theTolerance),</em> \n
68 where: \n
69 \em theShape is the shape checked for validity. \n
70 \em theDeflection that specifies the quality of tessellation. 
71 \em theTolerance Specifies the distance between shapes used for detecting gaps.
72
73 See also a \ref tui_check_self_intersections_fast_page "TUI example".
74
75 */