DynamicBillboard

new DynamicBillboard

Represents a time-dynamic billboard, typically used in conjunction with DynamicBillboardVisualizer and DynamicObjectCollection to visualize CZML.

See:

Source:

/Source/DynamicScene/DynamicBillboard.js

Members

color :DynamicProperty

A DynamicProperty of type CzmlColor which determines the billboard's color.

Default Value:

undefined

eyeOffset :DynamicProperty

A DynamicProperty of type CzmlCartesian3 which determines the billboard's eye offset.

Default Value:

undefined

horizontalOrigin :DynamicProperty

A DynamicProperty of type CzmlHorizontalOrigin which determines the billboard's horizontal origin.

Default Value:

undefined

image :DynamicProperty

A DynamicProperty of type CzmlImage which determines the billboard's texture.

Default Value:

undefined

pixelOffset :DynamicProperty

A DynamicProperty of type CzmlCartesian2 which determines the billboard's pixel offset.

Default Value:

undefined

scale :DynamicProperty

A DynamicProperty of type CzmlNumber which determines the billboard's scale.

Default Value:

undefined

show :DynamicProperty

A DynamicProperty of type CzmlBoolean which determines the billboard's visibility.

Default Value:

undefined

verticalOrigin :DynamicProperty

A DynamicProperty of type CzmlVerticalHorigin which determines the billboard's vertical origin.

Default Value:

undefined

Methods

<static> mergeProperties

Given two DynamicObjects, takes the billboard properties from the second and assigns them to the first, assuming such a property did not already exist. 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
`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 billboard. If the DynamicObject does not have a billboard, one is created. This method is not normally called directly, but is part of the array of CZML processing functions that is passed into the DynamicObjectCollection constructor.

Parameters:

Name	Type	Argument	Description
`dynamicObject`	DynamicObject		The DynamicObject which will contain the billboard 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:

<static> undefineProperties

Given a DynamicObject, undefines the billboard 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 billboard from.

See:

CzmlDefaults