KBE3D / KBCore / Cesium / SampledPositionProperty

类: SampledPositionProperty

A SampledProperty which is also a PositionProperty.

参数

The reference frame in which the position is defined.

参数

The number of derivatives that accompany each position; i.e. velocity, acceleration, etc...

属性

isConstant

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.

---

definitionChanged

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.

---

referenceFrame

referenceFrame: ReferenceFrame

Gets the reference frame in which the position is defined.

---

interpolationDegree

readonly interpolationDegree: number

Gets the degree of interpolation to perform when retrieving a value. Call <code>setInterpolationOptions</code> to set this.

---

interpolationAlgorithm

readonly interpolationAlgorithm: InterpolationAlgorithm

Gets the interpolation algorithm to use when retrieving a value. Call <code>setInterpolationOptions</code> to set this.

---

numberOfDerivatives

numberOfDerivatives: number

The number of derivatives contained by this property; i.e. 0 for just position, 1 for velocity, etc.

---

forwardExtrapolationType

forwardExtrapolationType: ExtrapolationType

Gets or sets the type of extrapolation to perform when a value is requested at a time after any available samples.

---

forwardExtrapolationDuration

forwardExtrapolationDuration: number

Gets or sets the amount of time to extrapolate forward before the property becomes undefined. A value of 0 will extrapolate forever.

---

backwardExtrapolationType

backwardExtrapolationType: ExtrapolationType

Gets or sets the type of extrapolation to perform when a value is requested at a time before any available samples.

---

backwardExtrapolationDuration

backwardExtrapolationDuration: number

Gets or sets the amount of time to extrapolate backward before the property becomes undefined. A value of 0 will extrapolate forever.

方法

getValue()

getValue(time?: JulianDate, result?: Cartesian3): Cartesian3 | undefined

Gets the position at the provided time.

参数

time?

JulianDate

The time for which to retrieve the value. If omitted, the current system time is used.

result?

Cartesian3

The object to store the value into, if omitted, a new instance is created and returned.

返回

Cartesian3 | undefined

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

---

getValueInReferenceFrame()

getValueInReferenceFrame(time: JulianDate, referenceFrame: ReferenceFrame, result?: Cartesian3): Cartesian3 | undefined

Gets the position at the provided time and in the provided reference frame.

参数

time

JulianDate

The time for which to retrieve the value.

referenceFrame

ReferenceFrame

The desired referenceFrame of the result.

result?

Cartesian3

The object to store the value into, if omitted, a new instance is created and returned.

返回

Cartesian3 | undefined

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

---

setInterpolationOptions()

setInterpolationOptions(options?: { interpolationAlgorithm?: InterpolationAlgorithm; interpolationDegree?: number; }): void

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

参数

options?

Object with the following properties:

interpolationAlgorithm?

InterpolationAlgorithm

The new interpolation algorithm. If undefined, the existing property will be unchanged.

interpolationDegree?

number

The new interpolation degree. If undefined, the existing property will be unchanged.

返回

void

---

addSample()

addSample(time: JulianDate, position: Cartesian3, derivatives?: Cartesian3[]): void

Adds a new sample.

参数

time

JulianDate

The sample time.

position

Cartesian3

The position at the provided time.

derivatives?

Cartesian3[]

The array of derivative values at the provided time.

返回

void

---

addSamples()

addSamples(times: JulianDate[], positions: Cartesian3[], derivatives?: any[][]): void

Adds multiple samples via parallel arrays.

参数

times

JulianDate[]

An array of JulianDate instances where each index is a sample time.

positions

Cartesian3[]

An array of Cartesian3 position instances, where each value corresponds to the provided time index.

derivatives?

any[][]

An array where each value is another array containing derivatives for the corresponding time index.

返回

void

---

addSamplesPackedArray()

addSamplesPackedArray(packedSamples: number[], epoch?: JulianDate): void

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.

参数

packedSamples

number[]

The array of packed samples.

epoch?

JulianDate

If any of the dates in packedSamples are numbers, they are considered an offset from this epoch, in seconds.

返回

void

---

removeSample()

removeSample(time: JulianDate): boolean

Removes a sample at the given time, if present.

参数

time

JulianDate

The sample time.

返回

boolean

true if a sample at time was removed, false otherwise.

---

removeSamples()

removeSamples(time: TimeInterval): void

Removes all samples for the given time interval.

参数

time

TimeInterval

The time interval for which to remove all samples.

返回

void

---

equals()

equals(other?: Property): boolean

Compares this property to the provided property and returns <code>true</code> if they are equal, <code>false</code> otherwise.

参数

other?

Property

The other property.

返回

boolean

true if left and right are equal, false otherwise.

构造函数

构造函数

new SampledPositionProperty(referenceFrame?: ReferenceFrame, numberOfDerivatives?: number): SampledPositionProperty

参数

referenceFrame?

ReferenceFrame

numberOfDerivatives?

number

返回

SampledPositionProperty