Salome HOME
Merge from V6_main_20120808 08Aug12
[modules/geom.git] / doc / salome / gui / GEOM / input / glue_edges_operation.doc
1 /*!
2
3 \page glue_edges_operation_page Glue Edges
4
5 \n To <b>Glue Edges</b> in the <b>Main Menu</b> select <b>Repair - > Glue Edges</b>.
6
7 \n This operation glues edges that are coincident with respect to the
8 given tolerance value.
9
10 \n <b>Arguments:</b> Name + Compound of shapes + Tolerance value.
11 \n <b>Advanced option:</b>
12    \ref restore_presentation_parameters_page "Set presentation parameters and sub-shapes from arguments".
13 \n The \b Result will be a \b GEOM_Object.
14
15
16 \image html glue4.png
17
18 \n <b>TUI Command:</b>
19 \n <em>geompy.MakeGlueEdges(theShape,theTolerance)</em>,
20 \n where \em theShape is a compound of shapes to be glued, and \em 
21  theTolerance is a maximum distance between two faces/edges, which can
22  be considered as coincident. 
23
24 \n It is also possible to manually select the edges that will be 
25 glued - select the shape, specify the tolerance and press \b Detect button.
26
27 \image html glue5.png
28
29 \n \b Geometry module detects the edges where gluing can be
30 performed and displays a notification.
31
32 \image html glue7.png
33
34 \n The edges that can be glued are colored in red. It is
35 possible to select the edges for gluing in the 3D viewer.
36 The selected edges will be marked in white.
37
38 \n <b>TUI Command:</b>
39 \n <em>geompy.GetGlueEdges(theShape,theTolerance)</em>,
40 \n where \em theShape is a compound of shapes to be glued, \em
41  theTolerance is a maximum distance between two edges, which can
42  be considered as coincident. The \b Result will be a list of \b
43  GEOM_Objects, containing one sub-shape per each detected set of
44  coincident sub-shapes.
45
46 \n <em>geompy.MakeGlueEdgesByList(theShape,theTolerance,theEdges)</em>,
47 \n where \em theShape is a compound of shapes to be glued, \em
48  theTolerance is a maximum distance between two edges, which can
49  be considered as coincident, \em theEdges is a list of
50  sub-shapes to be glued. 
51
52 \n <b>Example:</b>
53
54 \image html glue8.png
55 <center><em>Box with an edge that can be glued</em></center>
56
57 Our <b>TUI Scripts</b> provide you with useful examples of the use of
58 <b>Repairing Operations</b> \ref tui_glue_edges "Glue Edges".
59
60 */