mapsglmaps/com.xweather.mapsgl.anim/Timeline

Timeline

class Timeline(opts: AnimationOptions, controller: MapController) : TimeAnimation

A TimeAnimation that manages and controls one or more individual animations. Using a timeline, you can control the playback of multiple animations at once and keep them in sync.

Constructors

Timeline

constructor(opts: AnimationOptions, controller: MapController)

Types

Companion

object Companion

Properties

alwaysPlayFromBeginning

val alwaysPlayFromBeginning: Boolean

Whether the animation should always play from the beginning. When false, the animation will resume from its current position when restarted. Defaults to false.

autoPlay

var autoPlay: Boolean

Whether the animation should begin playing immediately.

config

val config: State<AnimationOptions>

containsFuture

val containsFuture: Boolean

containsPast

val containsPast: Boolean

currentDate

var currentDate: Date

delay

var delay: Double

Duration to wait before starting the animation, in seconds.

deltaTime

val deltaTime: Long

duration

var duration: Double

Duration the animation should take to complete, in seconds.

elapsedTime

val elapsedTime: Double

enabled

var enabled: Boolean

end

var end: Date

End date of the timeline's time range.

endDelay

var endDelay: Double

DDuration to hold the end of the animation before repeating, in seconds.

eventFlow

val eventFlow: MutableSharedFlow<Event>

val id: String

isActive

val isActive: Boolean

isAnimating

val isAnimating: Boolean

isFuture

val isFuture: Boolean

isPast

val isPast: Boolean

isPaused

val isPaused: Boolean

liveState

val liveState: LiveData<AnimationState>

position

open override var position: Double

repeat

var repeat: Boolean

Whether the animation should restart after completing playback.

start

var start: Date

Start date of the timeline's time range.

state

val state: AnimationState

TAG

open val TAG: String

timeScale

var timeScale: Double

Factor used to scale the time of the animation where a value of 1 is normal speed, 0.5 is half speed, and 2 is double speed, etc. Only positive values are allowed.

totalDuration

val totalDuration: Double

Functions

clampDateRange

fun clampDateRange(min: Date, max: Date)

Restricts the animation to a specific date range relative to the overall start and end date. This is useful if you want to limit the animation to a subset of the overall time range without changing the overall start and end date values.

disable

fun disable()

enable

fun enable()

goTo

open override fun goTo(position: Double, useTotalDuration: Boolean)

Update the map to reflect a position on the timeline from 0.0 to 1.0

goToDate

open override fun goToDate(date: Date)

Advances the playhead to the specified date where date is within the time range between the timeline's startDate and endDate values.

goToOffset

fun goToOffset(offset: Long)

Advances the playhead past the start time by the given number of milliseconds.

off

fun off(event: String, listener: (Any) -> Unit)

fun on(event: String, listener: (Any) -> Unit)

pause

open override fun pause()

Pauses the animation at its current position.

play

open override fun play(positionInput: Double?)

Begins playing the animation.

playFromDate

fun playFromDate(fromDate: Date)

Begins playing the animation from the specified date where date is within the time range between the timeline's startDate and endDate values.

reset

open override fun reset()

Stops playing the animation if currently playing and updates the playhead back to its original starting position.

restart

open override fun restart()

resume

open override fun resume()

Resumes playing the animation from its current position, such as after being paused.

setEndDateUsingOffset

fun setEndDateUsingOffset(offset: Long, relativeTo: Date = Date())

Updates the timeline end date by applying the specified time offset to the relative date. If no relative date is provided, then the current time and date will be used.

setEndDateUsingRelativeTime

fun setEndDateUsingRelativeTime(offset: String, relativeTo: Date = Date())

Updates the timeline end date by calculating the date using a relative time string, such as "-2 hours" or "1 day".

setStartDateUsingOffset

fun setStartDateUsingOffset(offset: Long, relativeTo: Date = Date())

Updates the timeline start date by applying the specified time offset to the relative date. If no relative date is provided, then the current time and date will be used.

setStartDateUsingRelativeTime

fun setStartDateUsingRelativeTime(offset: String, relativeTo: Date = Date())

Updates the timeline start date by calculating the date using a relative time string, such as "-2 hours" or "1 day".

stop

open override fun stop()

Stops playing the animation. The timeline position will be updated to the time closest to the current time, which may be at the start or end of the time range or somewhere in between.

toggle

open override fun toggle()

Toggles the current state of the animation between paused and playing if currently active.

trigger

fun trigger(event: Event)

fun trigger(event: String)