DynamicClock

Members

clockRange :ClockRange

Determines how the clock should behave when startTime or stopTime is reached.

Default Value:

• ClockRange.LOOP_STOP

clockStep :ClockStep

Determines if clock advancement is frame dependent or system clock dependent.

Default Value:

• ClockStep.SYSTEM_CLOCK_MULTIPLIER

currentTime :JulianDate

The initial time to use when switching to this clock.

Default Value:

• Iso8601.MAXIMUM_INTERVAL.start

multiplier :Number

Determines how much time advances with each tick, 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.

Default Value:

• 1.0

startTime :JulianDate

The start time of the clock to use when looping or clamped.

Default Value:

• Iso8601.MAXIMUM_INTERVAL.start

stopTime :JulianDate

The stop time of the clock to use when looping or clamped.

Default Value:

• Iso8601.MAXIMUM_INTERVAL.stop

Methods

clone

Duplicates a DynamicClock instance.

Parameters:

Name	Type	Argument	Description
result	DynamicClock	<optional>	The object onto which to store the result.

Returns:

DynamicClock The modified result parameter or a new DynamicClock instance if one was not provided.

<static> mergeProperties

Given two DynamicObjects, takes the clock properties from the second and assigns them to the first.

Parameters:

Name	Type	Description
targetObject	DynamicObject	The DynamicObject which will have properties merged onto it.
objectToMerge	DynamicObject	The DynamicObject containing properties to be merged.

See:

• CzmlDefaults

<static> processCzmlPacket

Processes a single CZML packet and merges its data into the provided DynamicObject's clock.

Parameters:

Name	Type	Argument	Description
dynamicObject	DynamicObject		The DynamicObject which will contain the clock data.
packet	Object		The CZML packet to process.
dynamicObjectCollection	DynamicObjectCollection	<optional>	The collection into which objects are being loaded.
sourceUri	String	<optional>	The originating url of the CZML being processed.

Returns:

Boolean true if any new properties were created while processing the packet, false otherwise.

See:

• DynamicObject
• DynamicProperty
• DynamicObjectCollection
• CzmlDefaults#updaters

<static> undefineProperties

Given a DynamicObject, undefines the clock associated with it. This method is not normally called directly, but is part of the array of CZML processing functions that is passed into the CompositeDynamicObjectCollection constructor.

Parameters:

Name	Type	Description
dynamicObject	DynamicObject	The DynamicObject to remove the clock from.

See:

• CzmlDefaults