Salome HOME
Merge from BR_V5_DEV 16Feb09
[modules/visu.git] / doc / salome / gui / VISU / input / cut_lines.doc
1 /*!
2
3 \page cut_lines_page Cut Lines presentation
4 \image html cutlinesprsnt.png "Example of Cut Lines presentation"
5
6 \n <b>Cut Lines</b> is a type of presentation which displays colored
7 cells with applied scalar values on the mesh where lines are placed.
8 \n The procedure of construction of <b>Cut Lines</b> presentation
9 reuses the algorithm of creation <b>Cut Planes</b> presentation and
10 consists of two steps:
11 <ol>
12 <li>From <b>Cut Planes</b> presentation one plane is taken and it is
13 used as base plane for construction of cut lines.</li>
14 <li>This plane is cut by a regular array of planes. The result of this
15 operation is a regular array of lines in space,  belonging to the same
16 plane and having the same orientation. They are located inside or on
17 the mesh.</li>
18 </ol>
19
20 <em>To create a Cut Lines presentation:</em>
21 \par
22 &ndash; Right-click on one of the time stamps of the field in the
23 Object browser and from the pop-up menu choose <b>Cut Lines</b>, or
24 \n &ndash; Click on one of the time stamps of the field in the Object
25 browser and select from the main menu <b>Visualization > Cut
26 Lines</b>, or click <em>"Cut Lines"</em> icon in the <b>Visualization
27 Toolbar</b>.
28
29 \image html cutlinesicn.jpg
30 <center><em>"Cut Lines" icon</em></center>
31
32 \image html cutlines.png
33
34 \par
35 <b>Plane of lines:</b> this tab of the dialog box contains the
36 parameters of the base plane, on which the cut lines will be located.
37 <ul>
38 <li><b>Orientation</b> check boxes allow to set the orientation of cut
39 planes in 3D space. You should select two of three axis (XY, YZ, or
40 ZX) in which your planes will be located in 3D space.</li>
41 <li><b>Rotations</b> of the planes in 3d space around the axes of the
42 selected orientation. (The angle of rotation is set in degrees)</li>
43 <li><b>Base plane position:</b> position of the base plane. This value
44 can be set by default or entered manually.</li>
45 <li><b>Displacement</b> of the plane. This parameter defines position
46 of the base plane in 3d space.</li>
47 <li><b>Show preview</b> check box allows to edit the parameters of the
48 presentation and simultaneously observe the preview of this
49 presentation in the viewer.</li>
50 <li><b>Invert all curves</b> check box allows to invert the resulting
51 curves.</li>
52 <li><b>Use absolute length</b> check box allows to see the real length
53 of the line, instead of [0,1] interval.</li>
54 <li><b>Generate Data Table:</b> If this check box is marked, Post-Pro
55 will automatically generate a data table on the basis of your Cut
56 Lines presentation. This table will be created in the structure of the
57 study.</li>
58 <li><b>Generate Curves:</b> If this check box is marked, Post Pro
59 will automatically generate curve lines on the basis of values taken
60 from the generated data table. These curves will be created in the
61 structure of the study and can be visualized in a XY plot.</li>
62 </ul>
63 See more about table presentations and curve lines 
64 \ref table_presentations_page "here".
65
66 \par
67 <b>Cut Planes:</b> this tab of the dialog box contains the parameters of cut
68 planes, which will be used for construction of the cut lines.
69 <br><br>
70 <b>Scalar Bar</b> tab allows to define the parameters of the scalar bar
71 displayed with this presentation (\ref scalar_map_page "see also").
72
73 After you have finished with setting these parameters, click \b
74 OK. Your presentation with scalar bar will be immediately displayed in
75 the viewer:
76
77 <b>Tip:</b> From <b>Cut Lines</b> presentation you can create a
78 <b>data table</b>. This table will consist of the field scalar values
79 located on each cut line of the constructed presentation (see also:
80 \ref creating_tables_from_cut_lines_page "Creating tables from Cut
81 Lines presentations"). After that your data table can be used for
82 construction of a 2d plot of curves based on the scalar values from
83 the table (see also: \ref creating_curves_page "Creating curves" and 
84 \ref creating_plot2d_page "Creating Plot 2D presentation").
85
86 */