org.cesiumjs.cs.widgets

Class AnimationViewModel

java.lang.Object

org.cesiumjs.cs.widgets.AnimationViewModel

@JsType(isNative=true,
        namespace="Cesium",
        name="AnimationViewModel")
public class AnimationViewModel
extends Object

The view model for the Animation widget.

Author:

Serge Silaev aka iSergio

See Also:

Animation

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AnimationViewModel.DateFormatter A function that formats a date for display.
static interface	AnimationViewModel.TimeFormatter A function that formats a time for display.

Field Summary

Fields

Modifier and Type	Field and Description
ClockViewModel	clockViewModel Gets the clock view model.
AnimationViewModel.DateFormatter	dateFormatter Gets or sets the function which formats a date for display.
String	dateLabel Gets the string representation of the current date.
static AnimationViewModel.DateFormatter	defaultDateFormatter Gets or sets the default date formatter used by new instances.
static double[]	defaultTicks Gets or sets the default array of known clock multipliers associated with new instances of the shuttle ring.
static AnimationViewModel.TimeFormatter	defaultTimeFormatter Gets or sets the default time formatter used by new instances.
Command	faster Gets a command that increases the speed of animation.
String	multiplierLabel Gets the string representation of the current multiplier.
ToggleButtonViewModel	pauseViewModel Gets the pause toggle button view model.
ToggleButtonViewModel	playForwardViewModel Gets the play toggle button view model.
ToggleButtonViewModel	playRealtimeViewModel Gets the realtime toggle button view model.
ToggleButtonViewModel	playReverseViewModel Gets the reverse toggle button view model.
double	shuttleRingAngle Gets or sets the current shuttle ring angle.
boolean	shuttleRingDragging Gets or sets whether the shuttle ring is currently being dragged.
Command	slower Gets a command that decreases the speed of animation.
boolean	snapToTicks Gets or sets whether dragging the shuttle ring should cause the multiplier to snap to the defined tick values rather than interpolating between them.
AnimationViewModel.TimeFormatter	timeFormatter Gets or sets the function which formats a time for display.
String	timeLabel Gets the string representation of the current time.

Constructor Summary

Constructors

Constructor and Description
AnimationViewModel(ClockViewModel clockViewModel) The view model for the Animation widget.

Method Summary

Modifier and Type	Method and Description
double[]	getShuttleRingTicks() Gets a copy of the array of positive known clock multipliers to associate with the shuttle ring.
void	setShuttleRingTicks(double[] positiveTicks) Sets the array of positive known clock multipliers to associate with the shuttle ring.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

defaultDateFormatter

@JsProperty
public static AnimationViewModel.DateFormatter defaultDateFormatter

Gets or sets the default date formatter used by new instances.

defaultTicks

@JsProperty
public static double[] defaultTicks

Gets or sets the default array of known clock multipliers associated with new instances of the shuttle ring.

defaultTimeFormatter

public static AnimationViewModel.TimeFormatter defaultTimeFormatter

Gets or sets the default time formatter used by new instances.

clockViewModel

@JsProperty
public ClockViewModel clockViewModel

Gets the clock view model.

dateFormatter

@JsProperty
public AnimationViewModel.DateFormatter dateFormatter

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

dateLabel

@JsProperty
public String dateLabel

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

faster

@JsProperty
public Command faster

Gets a command that increases the speed of animation.

multiplierLabel

@JsProperty
public String multiplierLabel

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

pauseViewModel

@JsProperty
public ToggleButtonViewModel pauseViewModel

Gets the pause toggle button view model.

playForwardViewModel

@JsProperty
public ToggleButtonViewModel playForwardViewModel

Gets the play toggle button view model.

playRealtimeViewModel

@JsProperty
public ToggleButtonViewModel playRealtimeViewModel

Gets the realtime toggle button view model.

playReverseViewModel

@JsProperty
public ToggleButtonViewModel playReverseViewModel

Gets the reverse toggle button view model.

shuttleRingAngle

@JsProperty
public double shuttleRingAngle

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

shuttleRingDragging

@JsProperty
public boolean shuttleRingDragging

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

slower

@JsProperty
public Command slower

Gets a command that decreases the speed of animation.

snapToTicks

@JsProperty
public boolean snapToTicks

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. Default: false

timeFormatter

public AnimationViewModel.TimeFormatter timeFormatter

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

timeLabel

@JsProperty
public String timeLabel

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

Constructor Detail

AnimationViewModel

@JsConstructor
public AnimationViewModel(ClockViewModel clockViewModel)

The view model for the Animation widget.

Parameters:

clockViewModel - The ClockViewModel instance to use.

See Also:

Animation

Method Detail

getShuttleRingTicks

@JsMethod
public double[] getShuttleRingTicks()

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

Returns:

The array of known clock multipliers associated with the shuttle ring.

setShuttleRingTicks

@JsMethod
public void setShuttleRingTicks(double[] positiveTicks)

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.

Parameters:

positiveTicks - The list of known positive clock multipliers to associate with the shuttle ring.