org.cesiumjs.cs.datasources.properties

Class PositionProperty

java.lang.Object

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

org.cesiumjs.cs.datasources.properties.PositionProperty

Direct Known Subclasses:

CompositePositionProperty, ConstantPositionProperty, SampledPositionProperty, TimeIntervalCollectionPositionProperty

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

Author:

Serge Silaev aka iSergio

Field Summary

Fields

Modifier and Type	Field and Description
Number	referenceFrame Gets the reference frame that the position is defined in.

Constructor Summary

Constructors

Constructor and Description
PositionProperty() The interface for all Property objects that define a world location as a Cartesian3 with an associated ReferenceFrame.

Method Summary

Modifier and Type	Method and Description
Cartesian3	getValueInReferenceFrame(JulianDate time, Number referenceFrame) Gets the value of the property at the provided time and in the provided reference frame.
Cartesian3	getValueInReferenceFrame(JulianDate time, Number referenceFrame, Cartesian3 result) Gets the value of the property at the provided time and in the provided reference frame.

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

definitionChanged, equals, getValue, getValue, getValueOrUndefined, isConstant

Methods inherited from class java.lang.Object

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

Field Detail

referenceFrame

@JsProperty
public Number referenceFrame

Gets the reference frame that the position is defined in.

See Also:

ReferenceFrame

Constructor Detail

PositionProperty

@JsConstructor
public PositionProperty()

The interface for all Property objects that define a world location as a Cartesian3 with an associated ReferenceFrame. This type defines an interface and cannot be instantiated directly.

See Also:

CompositePositionProperty, ConstantPositionProperty, SampledPositionProperty, TimeIntervalCollectionPositionProperty

Method Detail

getValueInReferenceFrame

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

Gets the value of the property at the provided time and in the provided reference frame.

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,
                                                     Number referenceFrame,
                                                     Cartesian3 result)

Gets the value of the property at the provided time and in the provided reference frame.

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.