mirror of
https://github.com/qgis/QGIS.git
synced 2025-11-03 00:14:12 -05:00
db1062cdad
Allows exporting of temporal animation frames to successive images, for later stitching together in an external application. Users have precise control over the image size and map extent.
66 lines
2.6 KiB
Plaintext
66 lines
2.6 KiB
Plaintext
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/qgstemporalutils.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
************************************************************************/
|
|
|
|
|
|
|
|
|
|
|
|
class QgsTemporalUtils
|
|
{
|
|
%Docstring
|
|
Contains utility methods for working with temporal layers and projects.
|
|
|
|
.. versionadded:: 3.14
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgstemporalutils.h"
|
|
%End
|
|
public:
|
|
|
|
static QgsDateTimeRange calculateTemporalRangeForProject( QgsProject *project );
|
|
%Docstring
|
|
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.
|
|
%End
|
|
|
|
static bool exportAnimation( const QgsMapSettings &mapSettings,
|
|
const QgsDateTimeRange &animationRange,
|
|
QgsInterval frameDuration,
|
|
const QString &outputDirectory,
|
|
const QString &fileNameTemplate,
|
|
QString &error /Out/,
|
|
QgsFeedback *feedback );
|
|
%Docstring
|
|
Exports animation frames by rendering the map to multiple destination images.
|
|
|
|
The ``mapSettings`` argument dictates the overall map settings such as extent
|
|
and size.
|
|
|
|
The ``animationRange`` argument specifies the overall temporal range of the animation.
|
|
Temporal duration of individual frames is given by ``frameDuration``.
|
|
|
|
An ``outputDirectory`` must be set, which controls where the created image files are
|
|
stored. ``fileNameTemplate`` gives the template for exporting the frames.
|
|
This must be in format prefix####.format, where number of
|
|
# represents how many 0 should be left-padded to the frame number
|
|
e.g. my###.jpg will create frames my001.jpg, my002.jpg, etc
|
|
%End
|
|
};
|
|
|
|
|
|
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/qgstemporalutils.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
************************************************************************/
|