ConstantPositionProperty

ConstantPositionProperty

new

A PositionProperty whose value does not change in respect to the ReferenceFrame in which is it defined.

Parameters:
Name Type Argument Default Description
value Cartesian3 <optional>
The property value.
referenceFrame ReferenceFrame <optional>
ReferenceFrame.FIXED The reference frame in which the position is defined.
Source:

Members

:Event

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.

:Boolean

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.

:ReferenceFrame

Gets the reference frame in which the position is defined.
Default Value:
  • ReferenceFrame.FIXED;

Methods

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

Parameters:
Name Type Argument Description
other Property <optional>
The other property.
Returns:
Boolean true if left and right are equal, false otherwise.

Gets the value of the property at the provided time in the fixed frame.

Parameters:
Name Type Argument Description
time JulianDate The time for which to retrieve the value.
result Object <optional>
The object to store the value into, if omitted, a new instance is created and returned.
Returns:
Object The modified result parameter or a new instance if the result parameter was not supplied.

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

Parameters:
Name Type Argument Description
time JulianDate The time for which to retrieve the value.
referenceFrame ReferenceFrame The desired referenceFrame of the result.
result Cartesian3 <optional>
The object to store the value into, if omitted, a new instance is created and returned.
Returns:
Cartesian3 The modified result parameter or a new instance if the result parameter was not supplied.

Sets the value of the property.

Parameters:
Name Type Argument Default Description
value Cartesian3 The property value.
referenceFrame ReferenceFrame <optional>
this.referenceFrame The reference frame in which the position is defined.