doc/salome/gui/VISU/input/animating.doc

   1 /*!
   2
   3 \page animating_page Animation
   4
   5 \image html animatdef.jpg "Example of Animation presentations for deformed shape"
   6
   7 \n In \b Post-Pro module you can generate real-time animation of
   8 fields. In comparison with sweeping, animations are created on the
   9 base of frames, displaying field presentations generated on \b EVERY
  10 timestamp of your field. So, the frame displaying the field
  11 presentation created on the base of the first timestamp will begin
  12 your animation and the frame displaying the field presentation created
  13 on the base of the last timestamp will end it. In sweeping <b>ONLY
  14 ONE</b> timestamp is used for its generation.
  15
  16 In the case of animation of several fields <b>Parallel Animation</b>
  17 will display the animations simultaneously, while <b>Successive
  18 Animation</b> will display them one after another.
  19 \n In the case of <b>Parallel Animation</b> you can set different
  20 kinds of presentations for each of the selected fields. This animation
  21 type also requires that the number of timestamps > 1 and is the same
  22 for all animated fields.
  23 \n For <b>Successive Aimation</b> the kind of presentation should be
  24 the same for all selected fields, which means that it is not possible
  25 to select a field from the list.  It is also necessary that the number
  26 of timestamps > 0 and the number of components is the same for all
  27 animated fields.
  28
  29 \ref slider_page functionality also allows to create real-time
  30 animation on every time stamp of the field. This is another,
  31 somewhat more user-friendly, implementation of animation on fields.
  32
  33 <em>To generate an Animation:</em>
  34 \par
  35 <ol>
  36 <li>Right-click on the field in the Object Browser.</li>
  37
  38 <li>From the pop-up menu select \b Parallel or <b>Successive
  39 Animation</b>.
  40 The following dialog box will appear:
  41
  42 \image html animation.png
  43
  44 \b Animation dialog box is destined for management of your animation.
  45 </li>
  46 <li>Click <b>Setup Animation</b> button. The following dialog box
  47 allowing to set the parameters of your animation will appear.
  48
  49 \image html setupanimation1.png
  50
  51 &ndash; <b>Use range of time stamps</b> check box allows to select the range
  52 of time stamps, which will be used for generating your animation.
  53
  54 \image html setupanimation2.png
  55
  56 &ndash; <b>Use sequence of time stamps</b> check box allows to select
  57 the time stamps, which will be used for generating your presentation
  58 from the list of time stamps
  59
  60 &ndash; \b Fields: list of fields for animation.
  61
  62 &ndash; \b Properties: Here you can adjust properties of each field
  63 selected from the list:
  64 <ul>
  65 <li>Select the \b type of field presentations, which will be used as
  66 frames in animation.</li>
  67 <li>Set properties of the <b>Scalar Bar</b> (\ref scalar_map_page "see also").</li>
  68 <li>Adjust additional \b properties of the selected type of field presentation.</li>
  69 </ul>
  70 <br>
  71 </li>
  72 <li>Click \b OK to validate your parameters. You will return back to
  73 \b Animation dialog box.</li>
  74
  75 <li>Click <b>Generate frames</b> button to generate the frames for
  76 your animation based on the parameters adjusted in <b>Setup
  77 Animation</b> dialog box.</li>
  78 </ol>
  79
  80 <br><em>Running animations:</em>
  81 \par
  82 In the main \b Animation dialog box there are several button intended
  83 for management and running your animation:
  84
  85 \image html run.jpg
  86 <center><b>Running</b> your animation</center>
  87
  88 \image html previous.jpg
  89 <center><b>Previous</b> frame (time step)</center>
  90
  91 \image html next.jpg
  92 <center><b>Next</b> frame (time step)</center>
  93
  94 \image html begining.jpg
  95 <center><b>To the beginning</b> of the animation.</center>
  96
  97 \image html end.jpg
  98 <center><b>To the end</b> of the animation.</center>
  99
 100 <br><em>Additional options of the animation:</em>
 101 \par
 102 You can <b>increase/decrease</b> the speed of your animation by moving
 103 the \b Speed wheel \b Up/Down:
 104
 105 \image html speed.jpg
 106
 107 \par
 108 <b>Cycled animation</b> check box: this option allows to start a
 109 cycled animation of your presentation.
 110 <br><br>
 111 <b>Use proportional timing</b> check box: this option allows to render
 112 your animation with proportional periods of time between every frame
 113 (not depending on the time stamps).
 114 <br><br>
 115 <b>Clean memory at each frame</b> - this option allows to optimize the
 116 performance of the operation.
 117
 118 \note <b>Save animation to AVI file</b> works only if there is \b
 119 jpeg2yuv utility installed on your computer. If this third-party
 120 product is missing, the check-box will not be selectable. This utility
 121 is a part of \b mjpegtool package, which can be downloaded from
 122 http://mjpeg.sourceforge.net/.  Run "which jpeg2yuv" to check whether
 123 this tool has been installed and the path to it was properly added to
 124 your PATH variable. If not, you need to activate \b mjpegtools
 125 indicating its location in the variable PATH. The syntax of the
 126 command should be as follows: export
 127 PATH=${INSTALL_ROOT}/mjpegtools-1.8.0/bin:${PATH}.
 128
 129 \par
 130 <b>Save Animation</b> - saves changes made in the published
 131 animation. If you have already published a study and press <b>Publish
 132 to study</b> again you get another animation in the Object Browser.
 133 <br><br>
 134 <b>Publish to Study</b> - saves your animation in the study and
 135 presents it in the Object Browser.
 136
 137 */