DynamicPyramid

Members

directions :DynamicDirectionsProperty

A DynamicDirectionsProperty which determines the projection of the pyramid.

Default Value:

• undefined

intersectionColor :DynamicProperty

A DynamicProperty of type CzmlColor which determines the color of the line formed by the intersection of the pyramid and other central bodies.

Default Value:

• undefined

intersectionWidth :DynamicProperty

A DynamicProperty of type CzmlNumber which determines the approximate pixel width of the line formed by the intersection of the pyramid and other central bodies.

Default Value:

• undefined

material :DynamicMaterialProperty

A DynamicMaterialProperty which determines the material.

Default Value:

• undefined

radius :DynamicProperty

A DynamicProperty of type CzmlNumber which determines the pyramid's radius.

Default Value:

• undefined

show :DynamicProperty

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

Default Value:

• undefined

showIntersection :DynamicProperty

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

Default Value:

• undefined

Methods

<static> mergeProperties

Given two DynamicObjects, takes the pyramid 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 pyramid. If the DynamicObject does not have a pyramid, 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	Description
dynamicObject	DynamicObject	The DynamicObject which will contain the pyramid data.
packet	Object	The CZML packet to process.
dynamicObjectCollection	DynamicObject	The DynamicObjectCollection to which the DynamicObject belongs.

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 pyramid 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 pyramid from.

See:

• CzmlDefaults