ReferenceProperty

ReferenceProperty

new

A dynamic property which transparently links to another property, which may or may not exist yet. It is up to the caller to know which kind of property is being linked to.

Parameters:
Name Type Description
dynamicObjectCollection DynamicObjectCollection The object collection which will be used to resolve the reference.
targetObjectId String The id of the object which is being referenced.
targetPropertyName String The name of the property on the target object which we will use.
Throws:
See:
Source:

Methods

<static>

Creates a new reference property given the dynamic object collection that will be used to resolve it and a string indicating the target object id and property, delineated by a period.

Parameters:
Name Type Description
dynamicObjectCollection DynamicObject
referenceString
Throws:
  • DeveloperError : dynamicObjectCollection is required.
  • DeveloperError : referenceString is required.
  • DeveloperError : referenceString must contain a single . delineating the target object ID and property name.
Returns:
A new instance of ReferenceProperty.
See:

<static>

Retrieves the value of the property at the specified time.

Parameters:
Name Type Argument Description
time The time to evaluate the property.
result <optional>
The object to store the result in, if undefined a new instance will be created.
Returns:
The result parameter or a new instance if the parameter was omitted.

<static>

Retrieves the Cartesian value or values of the property at the specified time if the linked property is a DynamicPositionProperty, DynamicVertexPositionsProperty, or DynamicDirectionsProperty.

Parameters:
Name Type Argument Description
time The time to evaluate the property.
result <optional>
The object to store the result in, if undefined a new instance will be created.
Returns:
The result parameter or a new instance if the parameter was omitted.

<static>

Retrieves the Cartographic value or values of the property at the specified time if the linked property is a DynamicPositionProperty or DynamicVertexPositionsProperty.

Parameters:
Name Type Argument Description
time The time to evaluate the property.
result <optional>
The object to store the result in, if undefined a new instance will be created.
Returns:
The result parameter or a new instance if the parameter was omitted.

<static>

Retrieves the Spherical value or values of the property at the specified time if the linked property is a DynamicDirectionsProperty.

Parameters:
Name Type Argument Description
time The time to evaluate the property.
result <optional>
The object to store the result in, if undefined a new instance will be created.
Returns:
The result parameter or a new instance if the parameter was omitted.