Expose option for irregular time steps when exporting map animations

Fixes #51546
qgis · Jan 31, 2023 · 0f03bbe · 0f03bbe
1 parent f373f5b
commit 0f03bbe
Show file tree

Hide file tree

Showing 5 changed files with 22 additions and 1 deletion.
diff --git a/python/core/auto_generated/qgstemporalutils.sip.in b/python/core/auto_generated/qgstemporalutils.sip.in
@@ -58,6 +58,8 @@ The returned list may be non-contiguous and have gaps in the ranges. The ranges
 
       QList<QgsMapDecoration *> decorations;
 
+      QList<QgsDateTimeRange> availableTemporalRanges;
+
       double frameRate;
 
     };

diff --git a/src/app/qgsanimationexportdialog.cpp b/src/app/qgsanimationexportdialog.cpp
@@ -102,7 +102,8 @@ QgsAnimationExportDialog::QgsAnimationExportDialog( QWidget *parent, QgsMapCanva
           QgsUnitTypes::TemporalMonths,
           QgsUnitTypes::TemporalYears,
           QgsUnitTypes::TemporalDecades,
-          QgsUnitTypes::TemporalCenturies
+          QgsUnitTypes::TemporalCenturies,
+          QgsUnitTypes::TemporalIrregularStep
         } )
   {
     mTimeStepsComboBox->addItem( QgsUnitTypes::toString( u ), u );

diff --git a/src/app/qgstemporalcontrollerdockwidget.cpp b/src/app/qgstemporalcontrollerdockwidget.cpp
@@ -116,6 +116,8 @@ void QgsTemporalControllerDockWidget::exportAnimation()
     animationSettings.outputDirectory = outputDir;
     animationSettings.fileNameTemplate = fileNameExpression;
     animationSettings.decorations = decorations;
+    if ( frameDuration.originalUnit() == QgsUnitTypes::TemporalIrregularStep )
+      animationSettings.availableTemporalRanges = QgsTemporalUtils::usedTemporalRangesForProject( QgsProject::instance() );
 
     const bool success = QgsTemporalUtils::exportAnimation( s, animationSettings, error, &progressFeedback );
 

diff --git a/src/core/qgstemporalutils.cpp b/src/core/qgstemporalutils.cpp
@@ -99,6 +99,9 @@ bool QgsTemporalUtils::exportAnimation( const QgsMapSettings &mapSettings, const
   QgsTemporalNavigationObject navigator;
   navigator.setTemporalExtents( settings.animationRange );
   navigator.setFrameDuration( settings.frameDuration );
+  if ( settings.frameDuration.originalUnit() == QgsUnitTypes::TemporalIrregularStep )
+    navigator.setAvailableTemporalRanges( settings.availableTemporalRanges );
+
   QgsMapSettings ms = mapSettings;
   const QgsExpressionContext context = ms.expressionContext();
   ms.setFrameRate( settings.frameRate );

diff --git a/src/core/qgstemporalutils.h b/src/core/qgstemporalutils.h
@@ -167,6 +167,19 @@ class CORE_EXPORT QgsTemporalUtils
       //! List of decorations to draw onto exported frames.
       QList<QgsMapDecoration *> decorations;
 
+      /**
+       * 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
+       */
+      QList<QgsDateTimeRange> availableTemporalRanges;
+
       /**
        * Target animation frame rate in frames per second.
        *