qgstemporalnavigationobject.h

Go to the documentation of this file.

/***************************************************************************
                         qgstemporalnavigationobject.h
                         ---------------
    begin                : March 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 QGSTEMPORALNAVIGATIONOBJECT_H
#define QGSTEMPORALNAVIGATIONOBJECT_H
 
#include "qgis_core.h"
#include "qgsexpressioncontextscopegenerator.h"
#include "qgsinterval.h"
#include "qgsrange.h"
#include "qgstemporalcontroller.h"
 
#include <QList>
#include <QTimer>
 
class QgsMapLayer;

class CORE_EXPORT QgsTemporalNavigationObject : public QgsTemporalController, public QgsExpressionContextScopeGenerator
{
    Q_OBJECT
 
  public:

    QgsTemporalNavigationObject( QObject *parent SIP_TRANSFERTHIS = nullptr );

    void setAnimationState( Qgis::AnimationState state );

    Qgis::AnimationState animationState() const;

    void setNavigationMode( const Qgis::TemporalNavigationMode mode );

    Qgis::TemporalNavigationMode navigationMode() const { return mNavigationMode; }

    void setTemporalExtents( const QgsDateTimeRange &extents );

    QgsDateTimeRange temporalExtents() const;

    void setAvailableTemporalRanges( const QList< QgsDateTimeRange > &ranges );

    QList< QgsDateTimeRange > availableTemporalRanges() const;

    void setCurrentFrameNumber( long long frame );

    long long currentFrameNumber() const;

    void setFrameDuration( const QgsInterval &duration );

    QgsInterval frameDuration() const;

    QgsDateTimeRange dateTimeRangeForFrameNumber( long long frame ) const;

    void setFramesPerSecond( double rate );

    double framesPerSecond() const;

    void setTemporalRangeCumulative( bool state );

    bool temporalRangeCumulative() const;

    long long totalFrameCount() const;

    bool isLooping() const;

    void setLooping( bool loop );

    long long findBestFrameNumberForFrameStart( const QDateTime &frameStart ) const;
 
    QgsExpressionContextScope *createExpressionContextScope() const override SIP_FACTORY;

    long long totalMovieFrames() const;

    void setTotalMovieFrames( long long frames );
 
  signals:

    void stateChanged( Qgis::AnimationState state );

    void navigationModeChanged( Qgis::TemporalNavigationMode mode );

    void temporalExtentsChanged( const QgsDateTimeRange &extent );

    void temporalFrameDurationChanged( const QgsInterval &interval );

    void totalMovieFramesChanged( long long frames );
 
  public slots:

    void play();

    void pause();

    void playForward();

    void playBackward();

    void next();

    void previous();

    void rewindToStart();

    void skipToEnd();
 
  private slots:

    void timerTimeout();
 
  private:

    QgsDateTimeRange mTemporalExtents;

    QList< QgsDateTimeRange > mAllRanges;
 
    Qgis::TemporalNavigationMode mNavigationMode = Qgis::TemporalNavigationMode::Disabled;

    long long mCurrentFrameNumber = 0;

    QgsInterval mFrameDuration = QgsInterval( 1.0, Qgis::TemporalUnit::Hours );

    double mFramesPerSecond = 1;

    QTimer *mNewFrameTimer = nullptr;

    Qgis::AnimationState mPlayBackMode = Qgis::AnimationState::Idle;
 
    bool mLoopAnimation = false;
 
    bool mCumulativeTemporalRange = false;
 
    int mBlockUpdateTemporalRangeSignal = 0;

    long long mTotalMovieFrames = 100;
 
    QgsTemporalNavigationObject( const QgsTemporalNavigationObject & ) = delete;
    QgsTemporalNavigationObject &operator= ( const QgsTemporalNavigationObject & ) = delete;
};
 
#endif // QGSTEMPORALNAVIGATIONOBJECT_H