org.cesiumjs.cs.datasources.properties

Class Property<T>

java.lang.Object

org.cesiumjs.cs.datasources.properties.Property<T>

Direct Known Subclasses:

CallbackProperty, CompositeProperty, ConstantProperty, MaterialProperty, NodeTransformationProperty, PositionProperty, ReferenceProperty, SampledProperty, TimeIntervalCollectionProperty, VelocityOrientationProperty, VelocityVectorProperty

@JsType(isNative=true,
        namespace="Cesium",
        name="Property")
public class Property<T>
extends Object

The interface for all properties, which represent a value that can optionally vary over time. This type defines an interface and cannot be instantiated directly.

Author:

Serge Silaev aka iSergio

See Also:

CompositeProperty, ConstantProperty, SampledProperty, TimeIntervalCollectionProperty, MaterialProperty, PositionProperty, ReferenceProperty

Constructor Summary

Constructors

Constructor and Description
Property()

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<T> other) Compares this property to the provided property and returns true if they are equal, false otherwise.
T	getValue(JulianDate time) Gets the value of the property at the provided time.
T	getValue(JulianDate time, T result) Gets the value of the property at the provided time.
static <T> T	getValueOrUndefined(Property property, JulianDate time, T result)
boolean	isConstant() Gets a value indicating if this property is constant.

Methods inherited from class java.lang.Object

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

Constructor Detail

Property

public Property()

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.

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.

equals

public boolean equals(Property<T> other)

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

Parameters:

other - The other property.

Returns:

true if left and right are equal, false otherwise.

getValue

@JsMethod
public T getValue(JulianDate time)

Gets the value of the property at the provided time.

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 T getValue(JulianDate time,
                            T result)

Gets the value of the property at the provided time.

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.

getValueOrUndefined

@JsOverlay
public static <T> T getValueOrUndefined(Property property,
                                                   JulianDate time,
                                                   T result)