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 "qgsrange.h"
#include "qgsinterval.h"
#include "qgstemporalcontroller.h"
#include "qgsexpressioncontextscopegenerator.h"
 
#include <QList>
#include <QTimer>
 
class QgsMapLayer;
 
class CORE_EXPORT QgsTemporalNavigationObject : public QgsTemporalController, public QgsExpressionContextScopeGenerator
{
    Q_OBJECT
 
  public:
 
    QgsTemporalNavigationObject( QObject *parent SIP_TRANSFERTHIS = nullptr );
 
    enum NavigationMode
    {
      NavigationOff, 
      Animated, 
      FixedRange, 
    };
 
    enum AnimationState
    {
      Forward, 
      Reverse, 
      Idle, 
    };
 
    void setAnimationState( AnimationState state );
 
    AnimationState animationState() const;
 
    void setNavigationMode( const NavigationMode mode );
 
    NavigationMode 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;
 
  signals:
 
    void stateChanged( QgsTemporalNavigationObject::AnimationState state );
 
    void navigationModeChanged( QgsTemporalNavigationObject::NavigationMode mode );
 
    void temporalExtentsChanged( const QgsDateTimeRange &extent );
 
    void temporalFrameDurationChanged( const QgsInterval &interval );
 
 
  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;
 
    NavigationMode mNavigationMode = NavigationOff;
 
    long long mCurrentFrameNumber = 0;
 
    QgsInterval mFrameDuration = QgsInterval( 1.0, QgsUnitTypes::TemporalUnit::TemporalHours );
 
    double mFramesPerSecond = 1;
 
    QTimer *mNewFrameTimer = nullptr;
 
    AnimationState mPlayBackMode = Idle;
 
    bool mLoopAnimation = false;
 
    bool mCumulativeTemporalRange = false;
 
    int mBlockUpdateTemporalRangeSignal = 0;
 
    QgsTemporalNavigationObject( const QgsTemporalNavigationObject & ) = delete;
    QgsTemporalNavigationObject &operator= ( const QgsTemporalNavigationObject & ) = delete;
};
 
#endif // QGSTEMPORALNAVIGATIONOBJECT_H