agi.foundation.cesium

(agi.foundation.cesium-2024r2.jar)

Class Clock

java.lang.Object

agi.foundation.cesium.Clock

public class Clock
extends Object

Defines initial clock settings associated with a CzmlDocument.

See Also:

CZML specification for the clock property

Constructor Summary

Constructors

Constructor and Description
Clock() Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
JulianDate	getCurrentTime() Gets the initial time when the document is first loaded.
TimeInterval	getInterval() Gets the time span covered by the document.
Double	getMultiplier() Gets how much time advances with each tick.
ClockRange	getRange() Gets how time behaves at Interval (get / set) boundaries.
ClockStep	getStep() Gets how time advances with each tick.
void	setCurrentTime(JulianDate value) Sets the initial time when the document is first loaded.
void	setInterval(TimeInterval value) Sets the time span covered by the document.
void	setMultiplier(Double value) Sets how much time advances with each tick.
void	setRange(ClockRange value) Sets how time behaves at Interval (get / set) boundaries.
void	setStep(ClockStep value) Sets how time advances with each tick.

Methods inherited from class java.lang.Object

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

Constructor Detail

Clock

public Clock()

Initializes a new instance.

Method Detail

getInterval

public final TimeInterval getInterval()

Gets the time span covered by the document.

setInterval

public final void setInterval(TimeInterval value)

Sets the time span covered by the document.

getCurrentTime

@Nullable
public final JulianDate getCurrentTime()

Gets the initial time when the document is first loaded.

setCurrentTime

public final void setCurrentTime(@Nullable
                                 JulianDate value)

Sets the initial time when the document is first loaded.

getRange

@Nullable
public final ClockRange getRange()

Gets how time behaves at Interval (get / set) boundaries.

setRange

public final void setRange(@Nullable
                           ClockRange value)

Sets how time behaves at Interval (get / set) boundaries.

getStep

@Nullable
public final ClockStep getStep()

Gets how time advances with each tick.

setStep

public final void setStep(@Nullable
                          ClockStep value)

Sets how time advances with each tick.

getMultiplier

@Nullable
public final Double getMultiplier()

Gets how much time advances with each tick. Negative values cause time to move backwards. If Step (get / set) is ClockStep.TICK_DEPENDENT this is the number of seconds advanced each tick. If Step (get / set) is ClockStep.SYSTEM_CLOCK_MULTIPLIER then the clock is advanced by the amount of elapsed time since the last tick multiplied by this value.

setMultiplier

public final void setMultiplier(@Nullable
                                Double value)

Sets how much time advances with each tick. Negative values cause time to move backwards. If Step (get / set) is ClockStep.TICK_DEPENDENT this is the number of seconds advanced each tick. If Step (get / set) is ClockStep.SYSTEM_CLOCK_MULTIPLIER then the clock is advanced by the amount of elapsed time since the last tick multiplied by this value.