Class: QgsTemporalNavigationObject¶

Implements a temporal controller based on a frame by frame navigation and animation.

Added in version 3.14.

Class Hierarchy¶

Base classes¶

`QgsTemporalController`	A controller base class for temporal objects, contains a signal for notifying updates of the objects temporal range.
QObject
`QgsExpressionContextScopeGenerator`	Abstract interface for generating an expression context scope.

Enums

`AnimationState`	Animation states.
`NavigationMode`	alias of `TemporalNavigationMode`

Methods

`animationState`	Returns the current animation state.
`availableTemporalRanges`	Returns the list of all available temporal ranges which have data available.
`currentFrameNumber`	Returns the current frame number.
`dateTimeRangeForFrameNumber`	Calculates the temporal range associated with a particular animation frame.
`findBestFrameNumberForFrameStart`	Returns the best suited frame number for the specified datetime, based on the start of the corresponding temporal range.
`frameDuration`	Returns the current set frame duration, which dictates the temporal length of each frame in the animation.
`framesPerSecond`	Returns the animation frame rate, in frames per second.
`isLooping`	Returns `True` if the animation should loop after hitting the end or start frame.
`navigationMode`	Returns the current temporal navigation mode.
`next`	Advances to the next frame.
`pause`	Pauses the temporal navigation.
`play`	Starts playing the temporal navigation from its current frame, using the direction specified by `animationState()`
`playBackward`	Starts the animation playing in a reverse direction until the beginning of the time range.
`playForward`	Starts the animation playing in a forward direction up till the end of all frames.
`previous`	Jumps back to the previous frame.
`rewindToStart`	Rewinds the temporal navigation to start of the temporal extent.
`setAnimationState`	Sets the current animation state.
`setAvailableTemporalRanges`	Sets the list of all available temporal ranges which have data available.
`setCurrentFrameNumber`	Sets the current animation frame number.
`setFrameDuration`	Sets the frame duration, which dictates the temporal length of each frame in the animation.
`setFramesPerSecond`	Sets the animation frame rate, in frames per second.
`setLooping`	Sets whether the animation should loop after hitting the end or start frame.
`setNavigationMode`	Sets the temporal navigation mode.
`setTemporalExtents`	Sets the navigation temporal extents, which dictate the earliest and latest date time possible in the animation.
`setTemporalRangeCumulative`	Sets the animation temporal range as cumulative.
`setTotalMovieFrames`	Sets the total number of frames for the movie.
`skipToEnd`	Skips the temporal navigation to end of the temporal extent.
`temporalExtents`	Returns the navigation temporal extents, which dictate the earliest and latest date time possible in the animation.
`temporalRangeCumulative`	Returns the animation temporal range cumulative settings.
`totalFrameCount`	Returns the total number of frames for the navigation.
`totalMovieFrames`	Returns the total number of frames for the movie.

Signals

`navigationModeChanged`	Emitted whenever the navigation mode changes.
`stateChanged`	Emitted whenever the animation state changes.
`temporalExtentsChanged`	Emitted whenever the temporalExtent extent changes.
`temporalFrameDurationChanged`	Emitted whenever the frameDuration interval of the controller changes.
`totalMovieFramesChanged`	Emitted whenever the total number of frames in the movie is changed.

class qgis.core.QgsTemporalNavigationObject[source]¶

Bases: QgsTemporalController, QgsExpressionContextScopeGenerator

__init__(parent: QObject | None = None)

Constructor for QgsTemporalNavigationObject, with the specified parent object.

Parameters:: parent (Optional[QObject] = None)

class AnimationState(*values)¶

Bases: IntEnum

Animation states.

Note

Prior to QGIS 3.36 this was available as QgsTemporalNavigationObject.AnimationState

Added in version 3.36.

Forward: Animation is playing forward.
Reverse: Animation is playing in reverse.
Idle: Animation is paused.

NavigationMode¶: alias of TemporalNavigationMode

animationState(self) → Qgis.AnimationState[source]¶

Returns the current animation state.

See also

setAnimationState()

Return type:: Qgis.AnimationState

availableTemporalRanges(self) → List[QgsDateTimeRange]¶

Returns the list of all available temporal ranges which have data available.

The ranges list can be a list of non-contiguous ranges (i.e. containing gaps) which together describe the complete range of times which contain data.

See also

setAvailableTemporalRanges()

Added in version 3.20.

Return type:: List[QgsDateTimeRange]

currentFrameNumber(self) → int¶

Returns the current frame number.

See also

setCurrentFrameNumber()

Return type:: int

dateTimeRangeForFrameNumber(self, frame: int) → QgsDateTimeRange[source]¶

Calculates the temporal range associated with a particular animation frame.

This is calculated from the navigation start time (taken from temporalExtents()), the specified frame number, and the frame duration (see frameDuration()).

Parameters:: frame (int)
Return type:: QgsDateTimeRange

findBestFrameNumberForFrameStart(self, frameStart: QDateTime | datetime.datetime) → int¶

Returns the best suited frame number for the specified datetime, based on the start of the corresponding temporal range.

Parameters:: frameStart (Union[QDateTime, datetime.datetime])
Return type:: int

frameDuration(self) → QgsInterval[source]¶

Returns the current set frame duration, which dictates the temporal length of each frame in the animation.

See also

setFrameDuration()

Return type:: QgsInterval

framesPerSecond(self) → float[source]¶

Returns the animation frame rate, in frames per second.

This setting controls the overall playback speed of the animation, i.e. how quickly a playing animation will advance to the next frame.

See also

setFramesPerSecond()

Return type:: float

isLooping(self) → bool[source]¶

Returns True if the animation should loop after hitting the end or start frame.

See also

setLooping()

Return type:: bool

navigationMode(self) → Qgis.TemporalNavigationMode[source]¶

Returns the current temporal navigation mode.

See also

setNavigationMode()

Return type:: Qgis.TemporalNavigationMode

signal navigationModeChanged(mode: Qgis.TemporalNavigationMode)[source]¶

Emitted whenever the navigation mode changes.

Parameters:: mode (Qgis.TemporalNavigationMode)

next(self)[source]¶: Advances to the next frame.

Note

Calling this slot does not change the current animation state, i.e. a paused animation will remain paused.

pause(self)[source]¶

Pauses the temporal navigation.

Calling this slot changes the animation state to idle, preventing automatic advancement of frames.

It does not affect the current animation frame number or the current temporal range of the controller.

play(self)[source]¶: Starts playing the temporal navigation from its current frame, using the direction specified by animationState()

playBackward(self)[source]¶: Starts the animation playing in a reverse direction until the beginning of the time range.

playForward(self)[source]¶: Starts the animation playing in a forward direction up till the end of all frames.

previous(self)[source]¶: Jumps back to the previous frame.

Note

Calling this slot does not change the current animation state, i.e. a paused animation will remain paused.

rewindToStart(self)[source]¶: Rewinds the temporal navigation to start of the temporal extent.

setAnimationState(self, state: Qgis.AnimationState)[source]¶

Sets the current animation state.

See also

animationState()

Parameters:: state (Qgis.AnimationState)

setAvailableTemporalRanges(self, ranges: Iterable[QgsDateTimeRange])[source]¶

Sets the list of all available temporal ranges which have data available.

The ranges list can be a list of non-contiguous ranges (i.e. containing gaps) which together describe the complete range of times which contain data.

See also

availableTemporalRanges()

Added in version 3.20.