SampledPositionProperty

SampledPositionProperty

new

A SampledProperty which is also a PositionProperty.

Parameters:
Name Type Argument Default Description
referenceFrame ReferenceFrame <optional>
ReferenceFrame.FIXED The reference frame in which the position is defined.
Source:

Members

:InterpolationAlgorithm

Gets or sets the interpolation algorithm to use when retrieving a value.
Default Value:
  • LinearApproximation

:Object

Gets or sets the degree of interpolation to perform when retrieving a value.
Default Value:
  • 1

:ReferenceFrame

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

Methods

Adds a new sample

Parameters:
Name Type Description
time JulianDate The sample time.
value Cartesian3 The value at the provided time.
Throws:

Adds an array of samples

Parameters:
Name Type Description
times Array An array of JulianDate instances where each index is a sample time.
values Array The array of Cartesian3 instances, where each value corresponds to the provided times index.
Throws:

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.

Parameters:
Name Type Argument Description
packedSamples Array 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.
Throws:
DeveloperError : packedSamples is required.

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

Gets the value of the property at the provided time.

Parameters:
Name Type Argument 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.
Throws:
DeveloperError : time is required.
Returns:
Cartesian3 The modified result parameter or a new instance if the result parameter was not supplied.

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