org.cesiumjs.cs.core

Class Clock

java.lang.Object

org.cesiumjs.cs.core.Clock

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

A simple clock for keeping track of simulated time.

Author:

Serge Silaev aka iSergio

Field Summary

Fields

Modifier and Type	Field and Description
boolean	canAnimate Indicates whether tick() can advance time.
Number	clockRange Determines how the clock should behave when startTime or stopTime is reached.
Number	clockStep Determines if calls to tick() are frame dependent or system clock dependent.
JulianDate	currentTime The current time.
double	multiplier Gets or sets how much time advances when tick() is called.
Event	onTick An Event that is fired whenever tick() is called.
boolean	shouldAnimate Indicates whether 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
Clock() A simple clock for keeping track of simulated time.
Clock(ClockOptions options) A simple clock for keeping track of simulated time.

Method Summary

Modifier and Type	Method and Description
JulianDate	tick() Advances the clock from the current time based on the current configuration options. tick should be called every frame, regardless of whether animation is taking place or not.

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

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

clockRange

@JsProperty
public Number clockRange

Determines how the clock should behave when startTime or stopTime is reached. Default: ClockRange.UNBOUNDED()

clockStep

@JsProperty
public Number clockStep

Determines if calls to tick() are frame dependent or system clock dependent. Changing this property to ClockStep.SYSTEM_CLOCK() LOCK will set multiplier to 1.0, shouldAnimate to true, and currentTime to the current system clock time. Default: ClockStep.SYSTEM_CLOCK_MULTIPLIER()

currentTime

@JsProperty
public JulianDate currentTime

The current time. Changing this property will change clockStep from ClockStep.SYSTEM_CLOCK() to ClockStep.SYSTEM_CLOCK_MULTIPLIER().

multiplier

public double multiplier

Gets or sets how much time advances when tick() is called. Negative values allow for advancing backwards. If clockStep is set to ClockStep.TICK_DEPENDENT(), this is the number of seconds to advance. If clockStep is set to ClockStep.SYSTEM_CLOCK_MULTIPLIER(), this value is multiplied by the elapsed system time since the last call to tick(). Changing this property will change clockStep from ClockStep.SYSTEM_CLOCK() to ClockStep.SYSTEM_CLOCK_MULTIPLIER(). Default: 1.0.

shouldAnimate

@JsProperty
public boolean shouldAnimate

Indicates whether tick() should attempt to advance time. The clock will only advance time when both canAnimate and shouldAnimate are true. Changing this property will change clockStep from ClockStep.SYSTEM_CLOCK() to ClockStep.SYSTEM_CLOCK_MULTIPLIER(). Default: true

startTime

@JsProperty
public JulianDate startTime

The start time of the clock.

stopTime

@JsProperty
public JulianDate stopTime

The stop time of the clock.

onTick

@JsProperty
public Event onTick

An Event that is fired whenever tick() is called.

Constructor Detail

Clock

@JsConstructor
public Clock()

A simple clock for keeping track of simulated time.

Clock

@JsConstructor
public Clock(ClockOptions options)

A simple clock for keeping track of simulated time.

     Example:
     
      ClockOptions options = new ClockOptions();
      options.startTime = JulianDate.fromIso8601("2013-12-25");
      options.currentTime = JulianDate.fromIso8601("2013-12-25");
      options.stopTime = JulianDate.fromIso8601("2013-12-26");
      options.clockRange = ClockRange.LOOP_STOP();
      options.clockStep = ClockStep.SYSTEM_CLOCK_MULTIPLIER();
      Clock clock = new Clock(options);
     
 

Parameters:

options -

See Also:

ClockStep, ClockRange, JulianDate

Method Detail

tick

@JsMethod
public JulianDate tick()

Advances the clock from the current time based on the current configuration options. tick should be called every frame, regardless of whether animation is taking place or not. To control animation, use the shouldAnimate property.

Returns:

The new value of the currentTime property.