ClockViewModel

open external class ClockViewModel(var clock: Clock = definedExternally)(source)

A view model which exposes a Clock for user interfaces.

See also

Constructors

Link copied to clipboard
constructor(clock: Clock = definedExternally)

Properties

Link copied to clipboard
external var canAnimate: Boolean

Gets or sets whether the clock can animate. See Clock.canAnimate. This property is observable.

Link copied to clipboard
external var clock: Clock

The clock object wrapped by this view model, if undefined a new instance will be created.

Link copied to clipboard
external var clockRange: ClockRange

Gets or sets the clock range setting. See Clock.clockRange. This property is observable.

Link copied to clipboard
external var clockStep: ClockStep

Gets or sets the clock step setting. See Clock.clockStep. This property is observable.

Link copied to clipboard
external var currentTime: JulianDate

Gets or sets the current time. See Clock.currentTime. This property is observable.

Link copied to clipboard
external var multiplier: Double

Gets or sets the clock multiplier. See Clock.multiplier. This property is observable.

Link copied to clipboard
external var shouldAnimate: Boolean

Gets or sets whether the clock should animate. See Clock.shouldAnimate. This property is observable.

Link copied to clipboard
external var startTime: JulianDate

Gets or sets the start time of the clock. See Clock.startTime. This property is observable.

Link copied to clipboard
external var stopTime: JulianDate

Gets or sets the stop time of the clock. See Clock.stopTime. This property is observable.

Link copied to clipboard
external var systemTime: JulianDate

Gets the current system time. This property is observable.

Functions

Link copied to clipboard
external fun destroy()

Destroys the view model. Should be called to properly clean up the view model when it is no longer needed.

Link copied to clipboard
external fun isDestroyed(): Boolean
Link copied to clipboard
external fun synchronize()

Updates the view model with the contents of the underlying clock. Can be called to force an update of the viewModel if the underlying clock has changed and Clock.tick has not yet been called.