Salome HOME
documentation improvement
[modules/geom.git] / doc / salome / gui / GEOM / input / extension_operation.doc
1 /*!
2
3 \page extension_operation_page Extension of an Edge or a Face
4
5 \n To produce an \b Extension in the <b>Main Menu</b> select
6 <b>Operations - > Transformation - > Extension</b>
7
8 \n This operation resizes an \b Edge by means of first
9  and last parameters modification or a \b Face by means of modification
10  of minimal and maximal U- and V-Parameters. \n
11 \ref restore_presentation_parameters_page "Advanced options".
12
13 The type of extension is defined using the radio buttons.
14
15 Firstly it is possible to resize an \b Edge.
16 \n <b>TUI Command:</b> <em>geompy.ExtendEdge(theEdge, theMin, theMax)</em>,
17 where \em theEdge the input edge to be resized, \em theMin the minimal
18 parameter value, \em theMax the maximal parameter value.
19 \n <b>Arguments:</b> Name + Object (Edge) + 2 values (Min and Max Parameters).
20
21 \image html extension1.png "Extension of an Edge"
22
23 \n <b>Example:</b>
24
25 \image html extend_edge_example.png "Original edge (white) and extended edge"
26
27 \note The input Edge parameters range is [0, 1]. If \b theMin parameter is
28       negative, the input Edge is extended, otherwise it is shrinked by
29       \b theMin parameter. If \b theMax is greater than 1, the Edge is
30       extended, otherwise it is shrinked by \b theMax parameter.
31
32 Secondly it is possible to resize a \b Face.
33 \n <b>TUI Command:</b> <em>geompy.ExtendFace(theFace, theUMin, theUMax,
34 theVMin, theVMax)</em>, where \em theFace the input face to be resized,
35 \em theUMin the minimal U-Parameter value, \em theUMax the maximal U-Parameter
36 value, \em theVMin the minimal V-Parameter value, \em theVMax the maximal
37 V-Parameter value.
38 \n <b>Arguments:</b> Name + Object (Face) + 4 values (Min and Max U- and
39 V-Parameters).
40
41 \image html extension2.png "Extension of a Face"
42
43 \n <b>Example:</b>
44
45 \image html extend_face_example.png "The original face (gray) and a result
46        face shrinked along U-Direction and extended along V-Direction"
47
48 \note The input Face U- and V-Parameters range is [0, 1]. If \b theUMin
49       parameter is negative, the input Face is extended, otherwise it is
50       shrinked along U-Direction by \b theUMin parameter. If theUMax is
51       greater than 1, the Face is extended, otherwise it is shrinked along
52       U-Direction by \b theUMax parameter. So as for \b theVMin, \b theVMax
53       and V-Direction of the input Face.
54
55 Our <b>TUI Scripts</b> provide you with useful examples of the use of
56 \ref tui_extend "Extension Operations".
57
58 */