kotlin-cesium-widgets/cesium.widgets/AnimationViewModel

AnimationViewModel

external class AnimationViewModel(var clockViewModel: ClockViewModel)(source)

The view model for the Animation widget.

See also

Online Documentation

Constructors

AnimationViewModel

constructor(clockViewModel: ClockViewModel)

Types

object Companion

Properties

var clockViewModel: ClockViewModel

The ClockViewModel instance to use.

var dateFormatter: DateFormatter

Gets or sets the function which formats a date for display.

var dateLabel: String

Gets the string representation of the current date. This property is observable.

var faster: Command

Gets a command that increases the speed of animation.

multiplierLabel

var multiplierLabel: String

Gets the string representation of the current multiplier. This property is observable.

var pauseViewModel: ToggleButtonViewModel

Gets the pause toggle button view model.

playForwardViewModel

var playForwardViewModel: ToggleButtonViewModel

Gets the play toggle button view model.

playRealtimeViewModel

var playRealtimeViewModel: ToggleButtonViewModel

Gets the realtime toggle button view model.

playReverseViewModel

var playReverseViewModel: ToggleButtonViewModel

Gets the reverse toggle button view model.

shuttleRingAngle

var shuttleRingAngle: Double

Gets or sets the current shuttle ring angle. This property is observable.

shuttleRingDragging

var shuttleRingDragging: Boolean

Gets or sets whether the shuttle ring is currently being dragged. This property is observable.

var slower: Command

Gets a command that decreases the speed of animation.

var snapToTicks: Boolean

Gets or sets whether dragging the shuttle ring should cause the multiplier to snap to the defined tick values rather than interpolating between them. This property is observable.

var timeFormatter: TimeFormatter

Gets or sets the function which formats a time for display.

var timeLabel: String

Gets the string representation of the current time. This property is observable.

Functions

getShuttleRingTicks

fun getShuttleRingTicks(): ReadonlyArray<Double>

Gets a copy of the array of positive known clock multipliers to associate with the shuttle ring.

setShuttleRingTicks

fun setShuttleRingTicks(positiveTicks: ReadonlyArray<Double>)

Sets the array of positive known clock multipliers to associate with the shuttle ring. These values will have negative equivalents created for them and sets both the minimum and maximum range of values for the shuttle ring as well as the values that are snapped to when a single click is made. The values need not be in order, as they will be sorted automatically, and duplicate values will be removed.