Class: ConstantPositionProperty

ConstantPositionProperty

new ConstantPositionProperty(value, referenceFrame)

The value of PositionProperty does not change with the definition of the referenceFrame.

Name Type Default Description
value Cartesian3 optional

Position attribute value

referenceFrame ReferenceFrame ReferenceFrame.FIXED optional

Define the reference frame for the position.

Members

readonly definitionChangedEvent

Get the event thrown when the definition of the attribute changes. If calling getValue at the same time returns different results, it is considered that the definition has been changed.

readonly isConstantBoolean

Get a boolean value indicating whether the property 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.

Default Value:
ReferenceFrame.FIXED;

Methods

equals(other){Boolean}

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

Name Type Description
other Property optional

A property value.

Returns:
Type Description
Boolean If left and right are equal, it is true; otherwise, it is false.

getValue(time, result){Object}

Obtain attribute values for a given time in a fixed reference frame

Name Type Description
time JulianDate

The time to retrieve the attribute value.

result Object optional

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

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

getValueInReferenceFrame(time, referenceFrame, result){Cartesian3}

Obtain the position attribute value of a given reference frame at a given time.

Name Type Description
time JulianDate

The time to retrieve the location attribute value.

referenceFrame ReferenceFrame

The given 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).

setValue(value, referenceFrame)

Set attribute values

Name Type Default Description
value Cartesian3

Attribute value

referenceFrame ReferenceFrame this.referenceFrame optional

Define the reference frame for the position.