top
all js glsl

DynamicObject

DynamicObject

new DynamicObject

DynamicObject instances are the primary data store for processed CZML data. They are used primarily by the visualizers to create and maintain graphic primitives that represent the DynamicObject's properties at a specific time.

Parameters:
Name Type Argument Description
id Object <optional>
 A unique identifier for this object. If no id is provided, a GUID is generated.
See:

Members

availability :TimeInterval

The availability TimeInterval, if any, associated with this object. If availability is undefined, it is assumed that this object's other properties will return valid data for any provided time. If availability exists, the objects other properties will only provide valid data if queried within the given interval.

billboard :DynamicBillboard

Gets or sets the billboard.

cone :DynamicCone

Gets or sets the cone.

dynamicObject :DynamicObject

The object to track with the camera.

ellipse :DynamicEllipse

Gets or sets the ellipse.

ellipsoid :DynamicEllipsoid

Gets or sets the ellipsoid.

ellipsoid :Ellipsoid

The ellipsoid to use for orienting the camera.

id

A unique id associated with this object.

label :DynamicLabel

Gets or sets the label.

orientation :DynamicProperty

Gets or sets the orientation.

path :DynamicPath

Gets or sets the path.

point :DynamicPoint

Gets or sets the point graphic.

polygon :DynamicPolygon

Gets or sets the polygon.

polyline :DynamicPolyline

Gets or sets the polyline.

position :DynamicPositionProperty

Gets or sets the position.

pyramid :DynamicPyramid

Gets or sets the pyramid.

scene :Scene

The scene in which to track the object.

vertexPositions :DynamicVertexPositionsProperty

Gets or sets the vertex positions.

viewFrom :Cartesian3

Gets or sets the suggested initial offset for viewing this object with the camera. The offset is defined in the east-north-up reference frame.

Methods

<static> mergeProperties

Given two DynamicObjects, takes the position, orientation, vertexPositions and availability properties from the second and assigns them to the first, assuming such properties 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:

<static> processCzmlPacketAvailability

Processes a single CZML packet and merges its data into the provided DynamicObject's availability property. 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 availability data.
packet Object The CZML packet to process.
Returns:
Boolean true if the property was newly created while processing the packet, false otherwise.
See:

<static> processCzmlPacketOrientation

Processes a single CZML packet and merges its data into the provided DynamicObject's orientation property. 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 orientation data.
packet Object The CZML packet to process.
Returns:
Boolean true if the property was newly created while processing the packet, false otherwise.
See:

<static> processCzmlPacketPosition

Processes a single CZML packet and merges its data into the provided DynamicObject's position property. 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 position data.
packet Object The CZML packet to process.
Returns:
Boolean true if the property was newly created while processing the packet, false otherwise.
See:

<static> processCzmlPacketVertexPositions

Processes a single CZML packet and merges its data into the provided DynamicObject's vertexPositions property. 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 vertexPositions data.
packet Object The CZML packet to process.
dynamicObjectCollection DynamicObjectCollection The collection to use to resolve any CZML properly links.
Returns:
Boolean true if the property was newly created while processing the packet, false otherwise.
See:

<static> processCzmlPacketViewFrom

Processes a single CZML packet and merges its data into the provided DynamicObject's viewFrom property. 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 viewFrom data.
packet Object The CZML packet to process.
Returns:
Boolean true if the property was newly created while processing the packet, false otherwise.
See:

<static> prototype.isAvailable

Given a time, returns true if this object should have data during that time.

Parameters:
Name Type Description
time JulianDate The time to check availability for.
Throws:
DeveloperError : time is required.
Returns:
true if the object should have data during the provided time, false otherwise.

<static> prototype.update

Should be called each animation frame to update the camera to the latest settings.

Parameters:
Name Type Description
time JulianDate The current animation time.
Throws:

<static> undefineProperties

Given a DynamicObject, undefines the position, orientation, vertexPositions and availability 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:

DynamicObject

new DynamicObject

A utility object for tracking an object with the camera.

Parameters:
Name Type Argument Default Description
dynamicObject DynamicObject The object to track with the camera.
scene Scene The scene to use.
ellipsoid Ellipsoid <optional>
 Ellipsoid.WGS84 The ellipsoid to use for orienting the camera.

Members

availability :TimeInterval

The availability TimeInterval, if any, associated with this object. If availability is undefined, it is assumed that this object's other properties will return valid data for any provided time. If availability exists, the objects other properties will only provide valid data if queried within the given interval.

billboard :DynamicBillboard

Gets or sets the billboard.

cone :DynamicCone

Gets or sets the cone.

dynamicObject :DynamicObject

The object to track with the camera.

ellipse :DynamicEllipse

Gets or sets the ellipse.

ellipsoid :DynamicEllipsoid

Gets or sets the ellipsoid.

ellipsoid :Ellipsoid

The ellipsoid to use for orienting the camera.

id

A unique id associated with this object.

label :DynamicLabel

Gets or sets the label.

orientation :DynamicProperty

Gets or sets the orientation.

path :DynamicPath

Gets or sets the path.

point :DynamicPoint

Gets or sets the point graphic.

polygon :DynamicPolygon

Gets or sets the polygon.

polyline :DynamicPolyline

Gets or sets the polyline.

position :DynamicPositionProperty

Gets or sets the position.

pyramid :DynamicPyramid

Gets or sets the pyramid.

scene :Scene

The scene in which to track the object.

vertexPositions :DynamicVertexPositionsProperty

Gets or sets the vertex positions.

viewFrom :Cartesian3

Gets or sets the suggested initial offset for viewing this object with the camera. The offset is defined in the east-north-up reference frame.

Methods

<static> mergeProperties

Given two DynamicObjects, takes the position, orientation, vertexPositions and availability properties from the second and assigns them to the first, assuming such properties 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:

<static> processCzmlPacketAvailability

Processes a single CZML packet and merges its data into the provided DynamicObject's availability property. 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 availability data.
packet Object The CZML packet to process.
Returns:
Boolean true if the property was newly created while processing the packet, false otherwise.
See:

<static> processCzmlPacketOrientation

Processes a single CZML packet and merges its data into the provided DynamicObject's orientation property. 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 orientation data.
packet Object The CZML packet to process.
Returns:
Boolean true if the property was newly created while processing the packet, false otherwise.
See:

<static> processCzmlPacketPosition

Processes a single CZML packet and merges its data into the provided DynamicObject's position property. 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 position data.
packet Object The CZML packet to process.
Returns:
Boolean true if the property was newly created while processing the packet, false otherwise.
See:

<static> processCzmlPacketVertexPositions

Processes a single CZML packet and merges its data into the provided DynamicObject's vertexPositions property. 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 vertexPositions data.
packet Object The CZML packet to process.
dynamicObjectCollection DynamicObjectCollection The collection to use to resolve any CZML properly links.
Returns:
Boolean true if the property was newly created while processing the packet, false otherwise.
See:

<static> processCzmlPacketViewFrom

Processes a single CZML packet and merges its data into the provided DynamicObject's viewFrom property. 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 viewFrom data.
packet Object The CZML packet to process.
Returns:
Boolean true if the property was newly created while processing the packet, false otherwise.
See:

<static> prototype.isAvailable

Given a time, returns true if this object should have data during that time.

Parameters:
Name Type Description
time JulianDate The time to check availability for.
Throws:
DeveloperError : time is required.
Returns:
true if the object should have data during the provided time, false otherwise.

<static> prototype.update

Should be called each animation frame to update the camera to the latest settings.

Parameters:
Name Type Description
time JulianDate The current animation time.
Throws:

<static> undefineProperties

Given a DynamicObject, undefines the position, orientation, vertexPositions and availability 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: