SampledPositionProperty

Members

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.

Source: DynamicScene/SampledPositionProperty.js, line 63

interpolationAlgorithm :InterpolationAlgorithm

Gets the interpolation algorithm to use when retrieving a value.

Default Value: LinearApproximation

Source: DynamicScene/SampledPositionProperty.js, line 98

interpolationDegree :Object

Gets the degree of interpolation to perform when retrieving a value.

Default Value: 1

Source: DynamicScene/SampledPositionProperty.js, line 86

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.

Source: DynamicScene/SampledPositionProperty.js, line 51

referenceFrame :ReferenceFrame

Gets the reference frame in which the position is defined.

Default Value: ReferenceFrame.FIXED;

Source: DynamicScene/SampledPositionProperty.js, line 74

Methods

addSample(time, value)

Adds a new sample

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

Source: DynamicScene/SampledPositionProperty.js, line 162

addSamples(times, values)

Adds an array of samples

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

Throws:

• DeveloperError : times and values must be the same length..

Source: DynamicScene/SampledPositionProperty.js, line 175

addSamplesPackedArray(packedSamples, epoch)

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.

Name	Type	Description
packedSamples	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: DynamicScene/SampledPositionProperty.js, line 186

equals(other) → Boolean

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.

Source: DynamicScene/SampledPositionProperty.js, line 198

getValue(time, result) → Cartesian3

Gets the value of the property at the provided time.

Name	Type	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.

Returns:

The modified result parameter or a new instance if the result parameter was not supplied.

Source: DynamicScene/SampledPositionProperty.js, line 113

getValueInReferenceFrame(time, referenceFrame, result) → 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	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.

Source: DynamicScene/SampledPositionProperty.js, line 126

setInterpolationOptions(options)

Sets the algorithm and degree to use when interpolating a position.

Name	Type	Description
options	Object	The options Name Type 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: DynamicScene/SampledPositionProperty.js, line 151