new PositionPropertyArray(valueopt, referenceFrameopt)
A
PositionProperty
whose value is an array whose items are the computed value
of other PositionProperty instances.
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
value |
Array.<Property> |
<optional> |
An array of Property instances. | |
referenceFrame |
ReferenceFrame |
<optional> |
ReferenceFrame.FIXED | 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.
Type:
(readonly) isConstant :Boolean
Gets a value indicating if this property is constant. This property
is considered constant if all property items in the array are constant.
Type:
- Boolean
referenceFrame :ReferenceFrame
Gets the reference frame in which the position is defined.
Type:
- ReferenceFrame
- Default Value:
- ReferenceFrame.FIXED;
- Source:
Methods
equals(otheropt) → {Boolean}
Compares this property to the provided property and returns
true
if they are equal, false
otherwise.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
other |
Property |
<optional> |
The other property. |
Returns:
true
if left and right are equal, false
otherwise.
- Type
- Boolean
getValue(timeopt, resultopt) → {Array.<Cartesian3>}
Gets the value of the property.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
time |
JulianDate |
<optional> |
The time for which to retrieve the value. This parameter is unused since the value does not change with respect to time. |
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.
- Type
- Array.<Cartesian3>
getValueInReferenceFrame(time, referenceFrame, resultopt) → {Cartesian3}
Gets the value of the property at the provided time and in the provided reference frame.
Parameters:
Name | Type | Attributes | 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:
The modified result parameter or a new instance if the result parameter was not supplied.
- Type
- Cartesian3
setValue(value)
Sets the value of the property.
Parameters:
Name | Type | Description |
---|---|---|
value |
Array.<Property> | An array of Property instances. |