new CompositePositionProperty(referenceFrameopt)
A
CompositeProperty
which is also a PositionProperty
.
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
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.
Type:
intervals :TimeIntervalCollection
Gets the interval collection.
Type:
(readonly) isConstant :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.
Type:
- Boolean
referenceFrame :ReferenceFrame
Gets or sets the reference frame which this position presents itself as.
Each PositionProperty making up this object has it's own reference frame,
so this property merely exposes a "preferred" reference frame for clients
to use.
Type:
- ReferenceFrame
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(time, resultopt) → {Object}
Gets the value of the property at the provided time in the fixed frame.
Parameters:
Name | Type | Attributes | 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:
The modified result parameter or a new instance if the result parameter was not supplied.
- Type
- Object
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