DynamicObject - Cesium Documentation

DynamicObject

new DynamicObject

DynamicObject instances are the primary data store for processed 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`	String	<optional>	A unique identifier for this object. If no id is provided, a GUID is generated.

See:

Source:

/Source/DynamicScene/DynamicObject.js

Members

availability :TimeIntervalCollection

The availability, 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.

definitionChanged :Event

Gets the event that is raised whenever a new property is assigned.

description :Property

Gets or sets the description.

ellipse :DynamicEllipse

Gets or sets the ellipse.

ellipsoid :DynamicEllipsoid

Gets or sets the ellipsoid.

id :String

Gets the unique ID associated with this object.

label :DynamicLabel

Gets or sets the label.

model :DynamicLabel

Gets or sets the model.

name :String

Gets or sets the name of the object. The name is intended for end-user consumption and does not need to be unique.

orientation :Property

Gets or sets the orientation.

parent :DynamicObject

Gets or sets the parent object.

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 :PositionProperty

Gets or sets the position.

propertyNames :Event

Gets the names of all properties registed on this instance.

pyramid :DynamicPyramid

Gets or sets the pyramid.

vector :DynamicVector

Gets or sets the vector.

vertexPositions :Property

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

addProperty

Adds a property to this object. Once a property is added, it can be observed with DynamicObject.definitionChanged and composited with CompositeDynamicObjectCollection

Parameters:

Name	Type	Description
`propertyName`		The name of the property to add.

Throws:

DeveloperError : "propertyName" is a reserved property name.
DeveloperError : "propertyName" is already a registered property.

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.

Returns:

true if the object should have data during the provided time, false otherwise.

merge

Assigns each unassigned property on this object to the value of the same property on the provided source object.

Parameters:

Name	Type	Description
`source`	DynamicObject	The object to be merged into this object.

removeProperty

Removed a property previously added with addProperty.

Parameters:

Name	Type	Description
`propertyName`		The name of the property to remove.

Throws:

DeveloperError : "propertyName" is a reserved property name.
DeveloperError : "propertyName" is not a registered property.