A
Property
whose value is an array whose items are the computed value
of other PositionProperty instances.
Name | Type | Default | Description |
---|---|---|---|
value |
Array.<Property> | optional An array of Property instances. | |
referenceFrame |
ReferenceFrame |
ReferenceFrame.FIXED
|
optional The reference frame in which the position is defined. |
Members
readonly definitionChanged : Event
Gets the event that is raised whenever the definition of this property changes.
The definition is changed whenever setValue is called with data different
than the current value or one of the properties in the array also changes.
Gets a value indicating if this property is constant. This property
is considered constant if all property items in the array are constant.
referenceFrame : 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.
Name | Type | Description |
---|---|---|
other |
Property | optional The other property. |
Returns:
true
if left and right are equal, false
otherwise.
getValue(time, result) → Array.<Cartesian3>
Gets the value of the property.
Name | Type | Default | Description |
---|---|---|---|
time |
JulianDate |
JulianDate.now()
|
optional The time for which to retrieve the value. If omitted, the current system time is used. |
result |
Array.<Cartesian3> | optional 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.
getValueInReferenceFrame(time, referenceFrame, result) → Array.<Cartesian3>
Gets the value of the property at the provided time and in the provided reference frame.
Name | Type | Description |
---|---|---|
time |
JulianDate | The time for which to retrieve the value. |
referenceFrame |
ReferenceFrame | The desired referenceFrame of the result. |
result |
Array.<Cartesian3> | optional 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.
Sets the value of the property.
Name | Type | Description |
---|---|---|
value |
Array.<Property> | An array of Property instances. |