Salome HOME
Fix generation of the Geometry User's documentation on Windows.
[modules/geom.git] / doc / salome / gui / GEOM / input / creating_isoline.doc
1 /*!
2
3 \page create_isoline_page Isoline
4
5 \b Isoline is a 3D curve built on a bounded face limited by <em> [Umin, Umax] </em> and <em> [Vmin, Vmax] </em>
6 values of U and V parameters. For all points of the isoline U or V parameter value is constant.
7
8 Result of this operation is either a single edge or a compound of edges.
9
10 To create an \b Isoline of a face in the <b>Main Menu</b> select <b>New Entity - > Basic - > Isoline</b>.
11
12 \image html isoline1.png
13
14 In this dialog:
15 - Input or accept the default \b Name of the resulting shape. 
16 - Click the arrow button and select in the Object Browser or in the Viewer the \b Face, for which the Isoline is built. 
17 - Select along which coordinate: \b U-Isoline or \b V-Isoline the Isoline is built;
18 - Set \b Parameter (ranging from 0 to 1), which defines the proportion, at which a face is divided by the isoline.
19 If Parameter=0.5, the isoline is a median.
20 - Press "Apply" or "Apply & Close" button to get the result (an edge or a compound of several edges).
21
22 This operation can be performed using a <b>TUI Command:</b> 
23
24 <em>geompy.MakeIsoline(theFace, IsUIsoline, theParameter)</em>
25
26 <b>Arguments:</b> Name + Face + Type (True for U-Isoline; False for V-Isoline) + Parameter.
27
28 <b>Example:</b>
29
30 \image html isoline2.png "Isoline on a rectangle face"
31
32 Our <b>TUI Scripts</b> provide you with useful examples of creation of 
33 \ref tui_creation_curve "Basic Geometric Objects".
34
35 */