qgsprojecttimesettings.h

Go to the documentation of this file.

/***************************************************************************
                         qgsprojecttimesettings.h
                         ---------------
    begin                : February 2020
    copyright            : (C) 2020 by Samweli Mwakisambwe
    email                : samweli at kartoza 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 QGSPROJECTTIMESETTINGS_H
#define QGSPROJECTTIMESETTINGS_H
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgsrange.h"
 
#include <QObject>
 
class QDomElement;
class QgsReadWriteContext;
class QDomDocument;

class CORE_EXPORT QgsProjectTimeSettings : public QObject
{
    Q_OBJECT
 
  public:

    QgsProjectTimeSettings( QObject *parent SIP_TRANSFERTHIS = nullptr );

    void reset();

    QgsDateTimeRange temporalRange() const;

    void setTemporalRange( const QgsDateTimeRange &range );

    bool readXml( const QDomElement &element, const QgsReadWriteContext &context );

    QDomElement writeXml( QDomDocument &document, const QgsReadWriteContext &context ) const;

    Qgis::TemporalUnit timeStepUnit() const;

    void setTimeStepUnit( Qgis::TemporalUnit unit );

    double timeStep() const;

    void setTimeStep( double step );

    void setFramesPerSecond( double rate );

    double framesPerSecond() const;

    void setIsTemporalRangeCumulative( bool state );

    bool isTemporalRangeCumulative() const;

    long long totalMovieFrames() const;

    void setTotalMovieFrames( long long frames );
 
  signals:

    void temporalRangeChanged();
 
  private:
 
    QgsDateTimeRange mRange;
    Qgis::TemporalUnit mTimeStepUnit = Qgis::TemporalUnit::Hours;
    double mTimeStep = 1;
    double mFrameRate = 1;
    bool mCumulativeTemporalRange = false;
    long long mTotalMovieFrames = 100;
};
 
 
#endif // QGSPROJECTTIMESETTINGS_H