org.cesiumjs.cs.core.options

Class ClockOptions

java.lang.Object

org.cesiumjs.cs.core.options.ClockOptions

@JsType(isNative=true,
        namespace="<global>",
        name="Object")
public class ClockOptions
extends Object

Author:

Serge Silaev aka iSergio

Field Summary

Fields

Modifier and Type	Field and Description
boolean	canAnimate Indicates whether Clock#tick can advance time.
int	clockRange Determines how the clock should behave when Clock#startTime or Clock#stopTime is reached.
int	clockStep Determines if calls to Clock#tick are frame dependent or system clock dependent.
JulianDate	currentTime The current time.
double	multiplier Determines how much time advances when Clock#tick is called, negative values allow for advancing backwards.
boolean	shouldAnimate Indicates whether Clock#tick should attempt to advance time.
JulianDate	startTime The start time of the clock.
JulianDate	stopTime The stop time of the clock.

Constructor Summary

Constructors

Constructor and Description
ClockOptions()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

startTime

@JsProperty
public JulianDate startTime

The start time of the clock.

stopTime

@JsProperty
public JulianDate stopTime

The stop time of the clock.

currentTime

@JsProperty
public JulianDate currentTime

The current time.

multiplier

@JsProperty
public double multiplier

Determines how much time advances when Clock#tick is called, negative values allow for advancing backwards. Defaults: 1.0.

clockStep

@JsProperty
public int clockStep

Determines if calls to Clock#tick are frame dependent or system clock dependent. Defaults: ClockStep.SYSTEM_CLOCK_MULTIPLIER.

clockRange

@JsProperty
public int clockRange

Determines how the clock should behave when Clock#startTime or Clock#stopTime is reached. Defaults: ClockRange.UNBOUNDED.

canAnimate

@JsProperty
public boolean canAnimate

Indicates whether Clock#tick can advance time. This could be false if data is being buffered, for example. The clock will only tick when both Clock#canAnimate and Clock#shouldAnimate are true. Defaults: true.

shouldAnimate

@JsProperty
public boolean shouldAnimate

Indicates whether Clock#tick should attempt to advance time. The clock will only tick when both Clock#canAnimate and Clock#shouldAnimate are true. Default: true.

Constructor Detail

ClockOptions

@JsConstructor
public ClockOptions()