QGIS API Documentation  3.17.0-Master (a035f434f4)
Classes | Static Public Member Functions | List of all members
QgsTemporalUtils Class Reference

Contains utility methods for working with temporal layers and projects. More...

#include <qgstemporalutils.h>

Classes

struct  AnimationExportSettings
 Contains settings relating to exporting animations. More...
 

Static Public Member Functions

static QgsDateTimeRange calculateTemporalRangeForProject (QgsProject *project)
 Calculates the temporal range for a project. More...
 
static bool exportAnimation (const QgsMapSettings &mapSettings, const AnimationExportSettings &settings, QString &error, QgsFeedback *feedback=nullptr)
 Exports animation frames by rendering the map to multiple destination images. More...
 

Detailed Description

Contains utility methods for working with temporal layers and projects.

Since
QGIS 3.14

Definition at line 36 of file qgstemporalutils.h.

Member Function Documentation

◆ calculateTemporalRangeForProject()

QgsDateTimeRange QgsTemporalUtils::calculateTemporalRangeForProject ( QgsProject project)
static

Calculates the temporal range for a project.

This method considers the temporal range available from layers contained within the project and returns the maximal combined temporal extent of these layers.

Definition at line 31 of file qgstemporalutils.cpp.

◆ exportAnimation()

bool QgsTemporalUtils::exportAnimation ( const QgsMapSettings mapSettings,
const AnimationExportSettings settings,
QString &  error,
QgsFeedback feedback = nullptr 
)
static

Exports animation frames by rendering the map to multiple destination images.

The mapSettings argument dictates the overall map settings such as extent and size, while animation and export specific settings are specified via the settings argument.

An optional feedback argument can be used to provide progress reports and cancellation support.

Parameters
mapSettingssettings controlling the map render
settingsanimation and export settings
errorwill be set to a descriptive error message if the export fails
feedbackoptional feedback object for progress reports and cancellation checks
Returns
true if the export was successful.

Definition at line 56 of file qgstemporalutils.cpp.


The documentation for this class was generated from the following files: