org.cesiumjs.cs.datasources.properties

Class ReferenceProperty

java.lang.Object

org.cesiumjs.cs.datasources.properties.Property

org.cesiumjs.cs.datasources.properties.ReferenceProperty

@JsType(isNative=true,
        namespace="Cesium",
        name="ReferenceProperty")
public class ReferenceProperty
extends Property

Author:

Serge Silaev aka iSergio

Constructor Summary

Constructors

Constructor and Description
ReferenceProperty(EntityCollection targetCollection, String targetId, String[] targetPropertyNames) A Property which transparently links to another property on a provided object.

Method Summary

Modifier and Type	Method and Description
Event	definitionChanged() Gets the event that is raised whenever the definition of this property changes.
boolean	equals(Property other) Compares this property to the provided property and returns true if they are equal, false otherwise.
ReferenceProperty	fromString(EntityCollection targetCollection, String referenceString) Creates a new instance given the entity collection that will be used to resolve it and a string indicating the target entity id and property.
String	getType(JulianDate time) Gets the Material type at the provided time.
Object	getValue(JulianDate time) Gets the value of the property at the provided time.
Object	getValue(JulianDate time, Object result) Gets the value of the property at the provided time.
Cartesian3	getValueInReferenceFrame(JulianDate time, Integer referenceFrame) Gets the value of the property at the provided time and in the provided reference frame.
Cartesian3	getValueInReferenceFrame(JulianDate time, Integer referenceFrame, Cartesian3 result) Gets the value of the property at the provided time and in the provided reference frame.
boolean	isConstant() Gets a value indicating if this property is constant.
Integer	referenceFrame() Gets the reference frame that the position is defined in.
Property	resolvedProperty() Gets the resolved instance of the underlying referenced property.
EntityCollection	targetCollection() Gets the collection containing the entity being referenced.
String	targetId() Gets the id of the entity being referenced.
String[]	targetPropertyNames() Gets the array of property names used to retrieve the referenced property.

Methods inherited from class org.cesiumjs.cs.datasources.properties.Property

getValueOrUndefined

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ReferenceProperty

@JsConstructor
public ReferenceProperty(EntityCollection targetCollection,
                                        String targetId,
                                        String[] targetPropertyNames)

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

Parameters:

targetCollection - The entity collection which will be used to resolve the reference.

targetId - The id of the entity which is being referenced.

targetPropertyNames - The names of the property on the target entity which we will use.

Method Detail

definitionChanged

@JsProperty(name="definitionChanged")
public Event definitionChanged()

Gets the event that is raised whenever the definition of this property changes. The definition is considered to have changed if a call to getValue would return a different result for the same time.

Overrides:

definitionChanged in class Property

isConstant

@JsProperty(name="isConstant")
public boolean isConstant()

Gets a value indicating if this property is constant. A property is considered constant if getValue always returns the same result for the current definition.

Overrides:

isConstant in class Property

referenceFrame

@JsProperty(name="referenceFrame")
public Integer referenceFrame()

Gets the reference frame that the position is defined in. This property is only valid if the referenced property is a PositionProperty.

resolvedProperty

@JsProperty(name="resolvedProperty")
public Property resolvedProperty()

Gets the resolved instance of the underlying referenced property.

targetCollection

@JsProperty(name="targetCollection")
public EntityCollection targetCollection()

Gets the collection containing the entity being referenced.

targetId

@JsProperty(name="targetId")
public String targetId()

Gets the id of the entity being referenced.

targetPropertyNames

@JsProperty(name="targetPropertyNames")
public String[] targetPropertyNames()

Gets the array of property names used to retrieve the referenced property.

fromString

@JsMethod
public ReferenceProperty fromString(EntityCollection targetCollection,
                                              String referenceString)

Creates a new instance given the entity collection that will be used to resolve it and a string indicating the target entity id and property. The format of the string is "objectId#foo.bar", where # separates the id from property path and . separates sub-properties. If the reference identifier or or any sub-properties contains a # . or \ they must be escaped.

Parameters:

targetCollection -

referenceString -

Returns:

A new instance of ReferenceProperty.

equals

@JsMethod
public boolean equals(Property other)

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

Overrides:

equals in class Property

Parameters:

other - The other property.

Returns:

true if left and right are equal, false otherwise.

getType

@JsMethod
public String getType(JulianDate time)

Gets the Material type at the provided time. This method is only valid if the property being referenced is a MaterialProperty.

Parameters:

time - The time for which to retrieve the type.

Returns:

The type of material.

getValue

@JsMethod
public Object getValue(JulianDate time)

Gets the value of the property at the provided time.

Overrides:

getValue in class Property

Parameters:

time - The time for which to retrieve the value.

Returns:

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

getValue

@JsMethod
public Object getValue(JulianDate time,
                                 Object result)

Gets the value of the property at the provided time.

Overrides:

getValue in class Property

Parameters:

time - The time for which to retrieve the value.

result - The object to store the value into, if omitted, a new instance is created and returned.

Returns:

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

getValueInReferenceFrame

@JsMethod
public Cartesian3 getValueInReferenceFrame(JulianDate time,
                                                     Integer referenceFrame)

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:

time - The time for which to retrieve the value.

referenceFrame - ReferenceFrame The desired referenceFrame of the result.

Returns:

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

getValueInReferenceFrame

@JsMethod
public Cartesian3 getValueInReferenceFrame(JulianDate time,
                                                     Integer referenceFrame,
                                                     Cartesian3 result)

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:

time - The time for which to retrieve the value.

referenceFrame - ReferenceFrame The desired referenceFrame of the result.

result - The object to store the value into, if omitted, a new instance is created and returned.

Returns:

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