QGIS API Documentation  3.17.0-Master (a035f434f4)
Public Attributes | List of all members
QgsTemporalUtils::AnimationExportSettings Struct Reference

Contains settings relating to exporting animations. More...

#include <qgstemporalutils.h>

Public Attributes

QgsDateTimeRange animationRange
 Dictates the overall temporal range of the animation. More...
 
QList< QgsMapDecoration * > decorations
 List of decorations to draw onto exported frames. More...
 
QString fileNameTemplate
 The filename template for exporting the frames. More...
 
QgsInterval frameDuration
 Duration of individual export frames. More...
 
QString outputDirectory
 Destination directory for created image files. More...
 

Detailed Description

Contains settings relating to exporting animations.

Definition at line 49 of file qgstemporalutils.h.

Member Data Documentation

◆ animationRange

QgsDateTimeRange QgsTemporalUtils::AnimationExportSettings::animationRange

Dictates the overall temporal range of the animation.

Definition at line 52 of file qgstemporalutils.h.

◆ decorations

QList<QgsMapDecoration *> QgsTemporalUtils::AnimationExportSettings::decorations

List of decorations to draw onto exported frames.

Definition at line 70 of file qgstemporalutils.h.

◆ fileNameTemplate

QString QgsTemporalUtils::AnimationExportSettings::fileNameTemplate

The filename template for exporting the frames.

This must be in format prefix####.format, where number of # characters represents how many 0's should be left-padded to the frame number e.g. my###.jpg will create frames my001.jpg, my002.jpg, etc

Definition at line 67 of file qgstemporalutils.h.

◆ frameDuration

QgsInterval QgsTemporalUtils::AnimationExportSettings::frameDuration

Duration of individual export frames.

Definition at line 55 of file qgstemporalutils.h.

◆ outputDirectory

QString QgsTemporalUtils::AnimationExportSettings::outputDirectory

Destination directory for created image files.

Definition at line 58 of file qgstemporalutils.h.


The documentation for this struct was generated from the following file: