Class: SampledPositionProperty

SampledPositionProperty

new SampledPositionProperty(referenceFrameopt, numberOfDerivativesopt)

A SampledProperty 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.
numberOfDerivatives Number <optional>
 0 The number of derivatives that accompany each position; i.e. velocity, acceleration, etc...
Source:

Members

backwardExtrapolationDuration :Number

Gets or sets the amount of time to extrapolate backward before the property becomes undefined. A value of 0 will extrapolate forever.
Type:
  • Number
Default Value:
  • 0
Source:

backwardExtrapolationType :ExtrapolationType

Gets or sets the type of extrapolation to perform when a value is requested at a time before any available samples.
Type:
  • ExtrapolationType
Default Value:
  • ExtrapolationType.NONE
Source:

(readonly) definitionChanged :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.
Type:
Source:

forwardExtrapolationDuration :Number

Gets or sets the amount of time to extrapolate forward before the property becomes undefined. A value of 0 will extrapolate forever.
Type:
  • Number
Default Value:
  • 0
Source:

forwardExtrapolationType :ExtrapolationType

Gets or sets the type of extrapolation to perform when a value is requested at a time after any available samples.
Type:
  • ExtrapolationType
Default Value:
  • ExtrapolationType.NONE
Source:

interpolationAlgorithm :InterpolationAlgorithm

Gets the interpolation algorithm to use when retrieving a value.
Type:
  • InterpolationAlgorithm
Default Value:
  • LinearApproximation
Source:

interpolationDegree :Number

Gets the degree of interpolation to perform when retrieving a value.
Type:
  • Number
Default Value:
  • 1
Source:

(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
Source:

numberOfDerivatives :Boolean

The number of derivatives contained by this property; i.e. 0 for just position, 1 for velocity, etc.
Type:
  • Boolean
Default Value:
  • false
Source:

referenceFrame :ReferenceFrame

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

Methods

addSample(time, position, derivativesopt)

Adds a new sample.
Parameters:
Name Type Attributes Description
time JulianDate The sample time.
position Cartesian3 The position at the provided time.
derivatives Array.<Cartesian3> <optional>
 The array of derivative values at the provided time.
Source:

addSamples(times, positions, derivativesopt)

Adds multiple samples via parallel arrays.
Parameters:
Name Type Attributes Description
times Array.<JulianDate> An array of JulianDate instances where each index is a sample time.
positions Array.<Cartesian3> An array of Cartesian3 position instances, where each value corresponds to the provided time index.
derivatives Array.<Array> <optional>
 An array where each value is another array containing derivatives for the corresponding time index.
Source:
Throws:
All arrays must be the same length.
Type
DeveloperError

addSamplesPackedArray(packedSamples, epochopt)

Adds samples as a single packed array where each new sample is represented as a date, followed by the packed representation of the corresponding value and derivatives.
Parameters:
Name Type Attributes Description
packedSamples Array.<Number> The array of packed samples.
epoch JulianDate <optional>
 If any of the dates in packedSamples are numbers, they are considered an offset from this epoch, in seconds.
Source:

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.
Source:
Returns:
true if left and right are equal, false otherwise.
Type
Boolean

getValue(time, resultopt) → {Cartesian3}

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

getValueInReferenceFrame(time, referenceFrame, resultopt) → {Cartesian3}

Gets the position 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.
Source:
Returns:
The modified result parameter or a new instance if the result parameter was not supplied.
Type
Cartesian3

setInterpolationOptions(optionsopt)

Sets the algorithm and degree to use when interpolating a position.
Parameters:
Name Type Attributes Description
options Object <optional>
 Object with the following properties:
Properties
Name Type Attributes Description
interpolationAlgorithm InterpolationAlgorithm <optional>
 The new interpolation algorithm. If undefined, the existing property will be unchanged.
interpolationDegree Number <optional>
 The new interpolation degree. If undefined, the existing property will be unchanged.
Source: