Class: PositionProperty

PositionProperty

new PositionProperty()

The interface for all Property objects, which define the geographic location as Cartesian3 and its associated referenceFrame. This type defines an interface and cannot be directly instantiated.

See:

Members

readonly definitionChangedEvent

Get the event thrown when the property definition changes. If calling getValue returns different results within the same time frame, it is considered that the definition has changed.

equals

Compare this attribute with the provided attribute, return true if they are equal, otherwise return false.

readonly isConstantBoolean

Get a value indicating whether the attribute is a constant. If getValue always returns the same result in the current definition, then the property is considered a constant.

referenceFrameReferenceFrame

Obtain the reference frame for defining the location.

Methods

getValue(time, result){Cartesian3}

Obtain the attribute value of a specified time in a fixed reference frame.

Name Type Description
time JulianDate

The time to retrieve the attribute value.

result Cartesian3 optional

If the object to store attributes is omitted, a new instance will be created and returned.

Returns:
Type Description
Cartesian3 The modified result parameters, or a new instance (if no result parameters are provided).

getValueInReferenceFrame(time, referenceFrame, result){Cartesian3}

Retrieve the value of a property at a specified time and reference frame.

Name Type Description
time JulianDate

The time to retrieve the value.

referenceFrame ReferenceFrame

The required result reference frame.

result Cartesian3 optional

If the object to store numerical values is omitted, a new instance will be created and returned.

Returns:
Type Description
Cartesian3 The modified result parameters, or a new instance (if no result parameters are provided).