Contains settings relating to exporting animations. More...

#include <qgstemporalutils.h>

Public Attributes
QgsDateTimeRange	animationRange
	Dictates the overall temporal range of the animation.

QList< QgsDateTimeRange >	availableTemporalRanges
	Contains the list of all available temporal ranges which have data available.

QList< QgsMapDecoration * >	decorations
	List of decorations to draw onto exported frames.

QString	fileNameTemplate
	The filename template for exporting the frames.

QgsInterval	frameDuration
	Duration of individual export frames.

double	frameRate = 30
	Target animation frame rate in frames per second.

QString	outputDirectory
	Destination directory for created image files.

Detailed Description

Contains settings relating to exporting animations.

Definition at line 147 of file qgstemporalutils.h.

Member Data Documentation

◆ animationRange

QgsDateTimeRange QgsTemporalUtils::AnimationExportSettings::animationRange

Dictates the overall temporal range of the animation.

Definition at line 150 of file qgstemporalutils.h.

◆ availableTemporalRanges

QList<QgsDateTimeRange> QgsTemporalUtils::AnimationExportSettings::availableTemporalRanges

Contains the list of all available temporal ranges which have data available.

The list can be a list of non-contiguous ranges (i.e. containing gaps) which together describe the complete range of times which contain data.

This list is required whenever the QgsUnitTypes::TemporalIrregularStep interval is used for an animation.

Since: QGIS 3.30

Definition at line 181 of file qgstemporalutils.h.

◆ decorations

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

List of decorations to draw onto exported frames.

Definition at line 168 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 165 of file qgstemporalutils.h.

◆ frameDuration

QgsInterval QgsTemporalUtils::AnimationExportSettings::frameDuration

Duration of individual export frames.

Definition at line 153 of file qgstemporalutils.h.

◆ frameRate

double QgsTemporalUtils::AnimationExportSettings::frameRate = 30

Target animation frame rate in frames per second.

Since: QGIS 3.26

Definition at line 188 of file qgstemporalutils.h.

◆ outputDirectory

QString QgsTemporalUtils::AnimationExportSettings::outputDirectory

Destination directory for created image files.

Definition at line 156 of file qgstemporalutils.h.

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

/build/qgis-3.41.0+git20241225+af5edcb665c+99sid/src/core/qgstemporalutils.h

Public Attributes