View source for TUFLOW Viewer - Exporting An Animation

===Tool Description===
Animations can be exported from TUFLOW Viewer for all accepted result types (map outputs, time series, particles etc). The process for animation creation is the same regardless of the result type and leverages the QGIS print layout. The tool will export an image for each timestep in a given range and then use ffmpeg to convert the images into a video. TUFLOW Viewer offers the additional functionality of adding dynamic plots and dynamic time text. It also offers convenience functionality for adding items such as a legend, images etc, however these can also be added manually in the print layout.<br>

The following steps through the process of creating an animation with TUFLOW Viewer.<br>
<ol>
<li> Download ffmpeg - [https://ffmpeg.org/download.html https://ffmpeg.org/download.html]
* ffmpeg is a free and powerful (and open source) video converter and manipulator. TUFLOW Viewer will call ffmpeg as the last step to create the video
* TUFLOW Viewer will take care of all the interaction with ffmpeg and the user is not required to learn how to use ffmpeg
<li> Open the export animation tool via '''Export >> Export Animation'''<br>
[[File: Animation_Export_Animation_Menu.PNG]]
<li> Set the '''General''' settings<br>
[[File: Animation_Export_Animation_General_Settings.PNG]]<br>
<ol>
<li> '''Start Time''' - The output time to start on
<li> '''End Time''' - The output time to end on
<li> '''Result''' - The result to animate - currently can only animate one result (result types with the same name (time series, particles - particles will have _ptm in its name) will be included in the same animation
<li> '''Active Scalar Result''' - Active scalar result type to animate - can only choose one, can select '''-None-''' to not use any
<li> '''Active Vector Result''' - Active vector result type to animate - can only choose one, can select '''-None-''' to not use any
<li> '''Width''' - Animation video width - can be changed later in the print layout - will be overriden by template if one is specified
<li> '''Height''' - Animation video height - can be changed later in the print layout - will be overriden by template if one is specified
<li> '''Output''' - Output location of video file
<li> '''Revert to old method''' - Kept for backward compatibility - will ignore '''Target Duration''' and the duration will be determined by number of output timesteps (i.e. the frames) and the speed
<li> '''Speed''' - Animation video frames per second (fps) - unless using the 'old method' this will not affect the video duration. Will not interpolate between frames, however can still produce a smoother video in some situations over the 'old method'
<li> '''Target Duration''' - Animation duration - this setting is ignored if using the 'old method'
</ol>
<li> On the layout tab, the user has the option to use a '''Default Layout''' or a '''Custom Layout'''. A cusom layout uses a '''Print Layout Template (.qpt)''' as an input. The recommended workflow is to:
<ol>
<li> Use the '''Default Layout''' as a starting point
<li> Customise the layout using the print layout in QGIS
<li> Export the print layout as a template (.qpt)
<li> Use '''Custom Layout''' using the template file
</ol>
[[File: Animation_Export_Animation_Layout_Settings.PNG]]
<li> Assuming the above workflow, the '''Default Layout''' lets the user specify some items to add to the layout
<li> Starting with the first three, each of these has the ability to add an additional label to the item and set properties such as the font, background colour, background border, and position in the layout:
<ol>
<li> '''Title''' - Text that will be added to the layout - can be added later in the print layout
<li> '''Time''' - Dynamic text to show the current time - will use date-time format if '''Show as dates''' is on. This can be added later, however it's recommended to add it through the '''Default Layout'''. It can be added later manually in the print layout by adding a label item and giving it an id 'time' (note id is not the same as the label text).
<li> '''Legend''' - A legend item - can be added / modified later in the print layout<br>
</ol>
[[File: Animation_Layout_Item_Settings.PNG]]
<li> The next layout item is '''Plots'''. These are dynamic plot objects that will be added to the animation. To add a plot, the plot must already be available in one of the TUFLOW Viewer plotting windows<br>
[[File: Animation_Layout_Plot_Item.PNG]]
<ol>
<li> Use the add button [[File: Animation_add_button.PNG | 15px]] to add a plot
<li> Select the source of the plot lines that should be added (i.e. time series, cross section etc.)
</ol>
</ol>

===Examples===
===Links===
====Similar Tools====


====Back to TUFLOW Viewer Page====
* [[TUFLOW_Viewer#Creating_an_Animation | Back to TUFLOW Viewer Main Page]]