DynamicEllipse

Members

bearing :DynamicProperty

A DynamicProperty of type CzmlNumber which determines the bearing of the ellipse.

Default Value:

• undefined

semiMajorAxis :DynamicProperty

A DynamicProperty of type CzmlNumber which determines the ellipse's semiMajorAxis.

Default Value:

• undefined

semiMinorAxis :DynamicProperty

A DynamicProperty of type CzmlNumber which determines the ellipse's semiMinorAxis.

Default Value:

• undefined

Methods

<static> mergeProperties

Given two DynamicObjects, takes the ellipse 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 ellipse. If the DynamicObject does not have a ellipse, 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 ellipse 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> prototype.getValue

Gets an array of vertex positions for the ellipse at the provided time.

Parameters:

Name	Type	Description
time	JulianDate	The desired time.
ellipsoid	Ellipsoid	The ellipsoid on which the ellipse will be on.
position	Cartesian3	The position of the ellipsoid.

Returns:

An array of vertex positions.

<static> undefineProperties

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

See:

• CzmlDefaults