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

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