org.cesiumjs.cs.widgets

Class ClockViewModel

java.lang.Object

org.cesiumjs.cs.widgets.ClockViewModel

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

A view model which exposes a Clock for user interfaces.

Author:

Serge Silaev aka iSergio

See Also:

Clock

Field Summary

Fields

Modifier and Type	Field and Description
boolean	canAnimate Gets or sets whether the clock can animate.
Clock	clock Gets the underlying Clock.
Number	clockRange Gets or sets the clock range setting.
Number	clockStep Gets or sets the clock step setting.
JulianDate	currentTime Gets or sets the current time.
double	multiplier Gets or sets the clock multiplier.
boolean	shouldAnimate Gets or sets whether the clock should animate.
JulianDate	startTime Gets or sets the start time of the clock.
JulianDate	stopTime Gets or sets the stop time of the clock.
JulianDate	systemTime Gets the current system time.

Constructor Summary

Constructors

Constructor and Description
ClockViewModel() A view model which exposes a Clock for user interfaces.
ClockViewModel(Clock clock) A view model which exposes a Clock for user interfaces.

Method Summary

Modifier and Type	Method and Description
void	destroy() Destroys the view model.
boolean	isDestroyed()
void	synchronize() Updates the view model with the contents of the underlying clock.

Methods inherited from class java.lang.Object

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

Field Detail

canAnimate

@JsProperty
public boolean canAnimate

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

clock

@JsProperty
public Clock clock

Gets the underlying Clock.

clockRange

@JsProperty
public Number clockRange

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

clockStep

@JsProperty
public Number clockStep

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

currentTime

@JsProperty
public JulianDate currentTime

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

multiplier

@JsProperty
public double multiplier

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

shouldAnimate

@JsProperty
public boolean shouldAnimate

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

startTime

@JsProperty
public JulianDate startTime

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

stopTime

@JsProperty
public JulianDate stopTime

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

systemTime

@JsProperty
public JulianDate systemTime

Gets the current system time. This property is observable.

Constructor Detail

ClockViewModel

@JsConstructor
public ClockViewModel()

A view model which exposes a Clock for user interfaces.

See Also:

Clock

ClockViewModel

@JsConstructor
public ClockViewModel(Clock clock)

A view model which exposes a Clock for user interfaces.

Parameters:

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

See Also:

Clock

Method Detail

destroy

@JsMethod
public void destroy()

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

isDestroyed

@JsMethod
public boolean isDestroyed()

Returns:

true if the object has been destroyed, false otherwise.

synchronize

@JsMethod
public void 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.