new ConstantPositionProperty
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 | The property value. | ||
referenceFrame |
ReferenceFrame |
<optional> |
ReferenceFrame.FIXED | The reference frame in which the position is defined. |
Throws:
DeveloperError
: value is required.
Example
//Create a constant position in the inertial frame. var constantProperty = new ConstantPositionProperty(new Cartesian3(-4225824.0, 1261219.0, -5148934.0), ReferenceFrame.INERTIAL);
Members
-
referenceFrame :ReferenceFrame
-
Gets the reference frame in which the position is defined.
- Default Value:
- ReferenceFrame.FIXED;
Methods
-
equals
-
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:
Booleantrue
if left and right are equal,false
otherwise. -
getValue
-
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. Throws:
DeveloperError : time is required.Returns:
Object The modified result parameter or a new instance if the result parameter was not supplied. -
getValueInReferenceFrame
-
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. Throws:
-
DeveloperError : time is required.
-
DeveloperError : referenceFrame is required.
Returns:
Cartesian3 The modified result parameter or a new instance if the result parameter was not supplied. -