qgstemporalutils.h

Go to the documentation of this file.

/***************************************************************************
  qgstemporalutils.h
  ------------------
  Date                 : March 2020
  Copyright            : (C) 2020 by Nyall Dawson
  Email                : nyall dot dawson at gmail dot com
 ***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef QGSTEMPORALUTILS_H
#define QGSTEMPORALUTILS_H
 
#include "qgis_core.h"
#include "qgsrange.h"
#include "qgsinterval.h"
 
class QgsProject;
class QgsMapSettings;
class QgsFeedback;
class QgsMapDecoration;
 
class CORE_EXPORT QgsTemporalUtils
{
  public:
 
    static QgsDateTimeRange calculateTemporalRangeForProject( QgsProject *project );
 
    struct AnimationExportSettings
    {
      QgsDateTimeRange animationRange;
 
      QgsInterval frameDuration;
 
      QString outputDirectory;
 
      QString fileNameTemplate;
 
      QList<QgsMapDecoration *> decorations;
 
    };
 
    static bool exportAnimation( const QgsMapSettings &mapSettings, const AnimationExportSettings &settings, QString &error SIP_OUT, QgsFeedback *feedback = nullptr );
 
    static QDateTime calculateFrameTime( const QDateTime &start, const long long frame, const QgsInterval interval );
};
 
 
#endif // QGSTEMPORALUTILS_H