Salome HOME
Merge from BR_V5_DEV 16Feb09
[modules/visu.git] / doc / salome / gui / VISU / input / sweeping.doc
1 /*!
2
3 \page sweeping_page Sweeping
4
5 \n In \b Post-Pro there is an option allowing to display
6 pseudo-animation of a field presentation. For creation of this
7 pseudo-animation you should take one field presentation generated on
8 the base of ONE Time Step (for comparison, \ref animating_page "Animation" is generated on
9 the base of ALL Time Steps of a field). The frame displaying this
10 field presentation will be the \em basic. \b Post-Pro automatically
11 generates another frame displaying the \em initial field presentation,
12 which is composed of cells with \em minimum acceptable values regarding
13 the values applied to the cells of the \em basic presentation. It also
14 automatically generates a user-defined number of frames (\b steps),
15 which will display the process of transformation of the field
16 presentation from the \em initial state in the \em basic state. \b Sweeping is
17 a type of animation composed of these frames: the frame displaying the
18 \em initial field presentation will start the animation, the frame
19 displaying the \em basic field presentation will end it.
20
21 <em>To sweep a field presentation:</em>
22
23 \ref creating_field_presentations_page "Create a field presentation".
24  
25 In the Main menu select <b>View -> Windows -> Sweep</b>. The following
26 dialog will appear.
27
28 \image html sweep1.png
29
30 \b Navigation tab provides possibilities for managing and running
31 the sweep:
32 <ul>
33 <li>Control buttons allow to launch or end the sweeping, run it forward or backward,
34 move to the next or the previous frame.</li>
35 <li> \b Cycled checkbox allows to view the sweep in the loop.</li>
36 </ul>
37
38 \image html sweep2.png 
39
40 \b Properties tab allows to set sweep properties.
41 <ul>
42 <li> \b Mode gives the choice between \b Linear, \b Sine and \b Cosine
43 sweeping. </li>
44 <li> <b>Number of steps</b> - allows to set the number of steps,
45 which will compose the whole animation.</li>
46 <li> <b>Step delay</b> - allows to set the time of representation of
47 one step. </li> 
48 </ul>
49
50 It is also possible to fast-launch \b Sweep with default parameters by
51 right-clicking on the presentation in the Object Browser or in the
52 viewer and selecting \b Sweep in the context menu.
53
54 Default parameters for \b Sweep can be set in the Main menu in <b>File
55 -> Preferences -> Post-Pro -> Sweep, Animation</b> tab
56
57 */