ReferenceProperty

new ReferenceProperty

A Property which transparently links to another property on a provided object.

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.

Source:

/Source/DynamicScene/ReferenceProperty.js

Methods

equals

Compares this property to the provided property and returns true if they are equal, false otherwise.

Parameters:

Name	Type	Argument	Description
`other`	Property	<optional>	The other property.

Returns:

Boolean true if left and right are equal, false otherwise.

getValue

Gets the value of the property at the provided time.

Parameters:

Name	Type	Argument	Description
`time`	JulianDate		The time for which to retrieve the value.
`result`	Object	<optional>	The object to store the value into, if omitted, a new instance is created and returned.

Returns:

Object The modified result parameter or a new instance if the result parameter was not supplied.

getValueInReferenceFrame

Gets the value of the property at the provided time and in the provided reference frame. This method is only valid if the property being referenced is a PositionProperty.

Parameters:

Name	Type	Argument	Description
`time`	JulianDate		The time for which to retrieve the value.
`referenceFrame`	ReferenceFrame		The desired referenceFrame of the result.
`result`	Cartesian3	<optional>	The object to store the value into, if omitted, a new instance is created and returned.

Returns:

Cartesian3 The modified result parameter or a new instance if the result parameter was not supplied.

<static> fromString

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 : referenceString must contain a single period delineating the target object ID and property name.

Returns:

A new instance of ReferenceProperty.