25 mNewFrameTimer =
new QTimer(
this );
27 connect( mNewFrameTimer, &QTimer::timeout,
28 this, &QgsTemporalNavigationObject::timerTimeout );
31void QgsTemporalNavigationObject::timerTimeout()
33 switch ( mPlayBackMode )
35 case AnimationState::Forward:
40 mCurrentFrameNumber = -1;
46 case AnimationState::Reverse:
48 if ( mCurrentFrameNumber <= 0 )
57 case AnimationState::Idle:
65 return mLoopAnimation;
70 mLoopAnimation = loopAnimation;
75 std::unique_ptr< QgsExpressionContextScope > scope = std::make_unique< QgsExpressionContextScope >( QStringLiteral(
"temporal" ) );
76 scope->setVariable( QStringLiteral(
"frame_rate" ), mFramesPerSecond,
true );
77 scope->setVariable( QStringLiteral(
"frame_number" ), mCurrentFrameNumber,
true );
78 scope->setVariable( QStringLiteral(
"frame_duration" ), mFrameDuration,
true );
79 scope->setVariable( QStringLiteral(
"frame_timestep" ), mFrameDuration.
originalDuration(),
true );
80 scope->setVariable( QStringLiteral(
"frame_timestep_unit" ), mFrameDuration.
originalUnit(),
true );
82 scope->setVariable( QStringLiteral(
"animation_start_time" ), mTemporalExtents.begin(),
true );
83 scope->setVariable( QStringLiteral(
"animation_end_time" ), mTemporalExtents.end(),
true );
84 scope->setVariable( QStringLiteral(
"animation_interval" ), mTemporalExtents.end() - mTemporalExtents.begin(),
true );
86 scope->addHiddenVariable( QStringLiteral(
"frame_timestep_unit" ) );
88 return scope.release();
93 const QDateTime start = mTemporalExtents.begin();
98 const long long nextFrame = frame + 1;
104 if ( mAllRanges.empty() )
105 return QgsDateTimeRange();
107 return frame < mAllRanges.size() ? mAllRanges.at( frame ) : mAllRanges.constLast();
115 QDateTime frameStart = begin;
117 if ( mCumulativeTemporalRange )
120 return QgsDateTimeRange( frameStart, end,
true,
false );
125 if ( mNavigationMode == mode )
128 mNavigationMode = mode;
131 if ( !mBlockUpdateTemporalRangeSignal )
133 switch ( mNavigationMode )
159 switch ( mNavigationMode )
171 if ( !mBlockUpdateTemporalRangeSignal )
182 return mTemporalExtents;
197 if ( mCurrentFrameNumber != frameNumber )
199 mCurrentFrameNumber = std::max( 0LL, std::min( frameNumber,
totalFrameCount() - 1 ) );
202 if ( !mBlockUpdateTemporalRangeSignal )
209 return mCurrentFrameNumber;
228 if ( !mBlockUpdateTemporalRangeSignal && mNavigationMode ==
Animated )
234 return mFrameDuration;
239 if ( framesPerSeconds > 0 )
241 mFramesPerSecond = framesPerSeconds;
242 mNewFrameTimer->setInterval(
static_cast< int >( ( 1.0 / mFramesPerSecond ) * 1000 ) );
248 return mFramesPerSecond;
253 mCumulativeTemporalRange = state;
258 return mCumulativeTemporalRange;
263 mNewFrameTimer->start(
static_cast< int >( ( 1.0 / mFramesPerSecond ) * 1000 ) );
268 mNewFrameTimer->stop();
286 if ( mPlayBackMode ==
Idle && mCurrentFrameNumber <= 0 )
321 return mAllRanges.count();
325 const QgsInterval totalAnimationLength = mTemporalExtents.end() - mTemporalExtents.begin();
326 return static_cast< long long >( std::ceil( totalAnimationLength.
seconds() / mFrameDuration.
seconds() ) );
332 if ( mode != mPlayBackMode )
334 mPlayBackMode = mode;
341 return mPlayBackMode;
346 long long bestFrame = 0;
349 for (
const QgsDateTimeRange &range : mAllRanges )
351 if ( range.contains( frameStart ) )
353 else if ( range.begin() > frameStart )
355 return std::max( 0LL, bestFrame - 1 );
358 return mAllRanges.count() - 1;
362 const QgsDateTimeRange testFrame = QgsDateTimeRange( frameStart, frameStart );
364 long long roughFrameStart = 0;
372 if ( mTemporalExtents.contains( frameStart ) )
374 roughFrameStart =
static_cast< long long >( std::floor( ( frameStart - mTemporalExtents.begin() ).seconds() / mFrameDuration.
seconds() ) );
376 roughFrameEnd = roughFrameStart + 100;
378 for (
long long i = roughFrameStart; i < roughFrameEnd; ++i )
381 if ( range.overlaps( testFrame ) )
Single scope for storing variables and functions for use within a QgsExpressionContext.
A representation of the interval between two datetime values.
double originalDuration() const
Returns the original interval duration.
double seconds() const
Returns the interval duration in seconds.
QgsUnitTypes::TemporalUnit originalUnit() const
Returns the original interval temporal unit.
A controller base class for temporal objects, contains a signal for notifying updates of the objects ...
void updateTemporalRange(const QgsDateTimeRange &range)
Signals that a temporal range has changed and needs to be updated in all connected objects.
bool isLooping() const
Returns true if the animation should loop after hitting the end or start frame.
void previous()
Jumps back to the previous frame.
double framesPerSecond() const
Returns the animation frame rate, in frames per second.
void setAvailableTemporalRanges(const QList< QgsDateTimeRange > &ranges)
Sets the list of all available temporal ranges which have data available.
void setFrameDuration(const QgsInterval &duration)
Sets the frame duration, which dictates the temporal length of each frame in the animation.
long long findBestFrameNumberForFrameStart(const QDateTime &frameStart) const
Returns the best suited frame number for the specified datetime, based on the start of the correspond...
void stateChanged(QgsTemporalNavigationObject::AnimationState state)
Emitted whenever the animation state changes.
QgsExpressionContextScope * createExpressionContextScope() const override
This method needs to be reimplemented in all classes which implement this interface and return an exp...
void playForward()
Starts the animation playing in a forward direction up till the end of all frames.
NavigationMode
Represents the current temporal navigation mode.
@ NavigationOff
Temporal navigation is disabled.
@ FixedRange
Temporal navigation relies on a fixed datetime range.
@ Animated
Temporal navigation relies on frames within a datetime range.
long long currentFrameNumber() const
Returns the current frame number.
void rewindToStart()
Rewinds the temporal navigation to start of the temporal extent.
void pause()
Pauses the temporal navigation.
void setCurrentFrameNumber(long long frame)
Sets the current animation frame number.
long long totalFrameCount() const
Returns the total number of frames for the navigation.
void skipToEnd()
Skips the temporal navigation to end of the temporal extent.
void temporalFrameDurationChanged(const QgsInterval &interval)
Emitted whenever the frameDuration interval of the controller changes.
void setFramesPerSecond(double rate)
Sets the animation frame rate, in frames per second.
QgsDateTimeRange temporalExtents() const
Returns the navigation temporal extents, which dictate the earliest and latest date time possible in ...
AnimationState
Represents the current animation state.
@ Idle
Animation is paused.
bool temporalRangeCumulative() const
Returns the animation temporal range cumulative settings.
void next()
Advances to the next frame.
QgsDateTimeRange dateTimeRangeForFrameNumber(long long frame) const
Calculates the temporal range associated with a particular animation frame.
void setTemporalExtents(const QgsDateTimeRange &extents)
Sets the navigation temporal extents, which dictate the earliest and latest date time possible in the...
void setTemporalRangeCumulative(bool state)
Sets the animation temporal range as cumulative.
QList< QgsDateTimeRange > availableTemporalRanges() const
Returns the list of all available temporal ranges which have data available.
void navigationModeChanged(QgsTemporalNavigationObject::NavigationMode mode)
Emitted whenever the navigation mode changes.
void play()
Starts playing the temporal navigation from its current frame, using the direction specified by anima...
void setLooping(bool loop)
Sets whether the animation should loop after hitting the end or start frame.
void playBackward()
Starts the animation playing in a reverse direction until the beginning of the time range.
void temporalExtentsChanged(const QgsDateTimeRange &extent)
Emitted whenever the temporalExtent extent changes.
void setAnimationState(AnimationState state)
Sets the current animation state.
void setNavigationMode(const NavigationMode mode)
Sets the temporal navigation mode.
QgsTemporalNavigationObject(QObject *parent=nullptr)
Constructor for QgsTemporalNavigationObject, with the specified parent object.
AnimationState animationState() const
Returns the current animation state.
QgsInterval frameDuration() const
Returns the current set frame duration, which dictates the temporal length of each frame in the anima...
static QDateTime calculateFrameTime(const QDateTime &start, const long long frame, const QgsInterval &interval)
Calculates the frame time for an animation.
static Q_INVOKABLE QString toString(QgsUnitTypes::DistanceUnit unit)
Returns a translated string representing a distance unit.
@ TemporalIrregularStep
Special "irregular step" time unit, used for temporal data which uses irregular, non-real-world unit ...
@ TemporalDecades
Decades.
@ TemporalCenturies
Centuries.