org.cesiumjs.cs.datasources.properties

Class SampledProperty<T extends Packable>

java.lang.Object

org.cesiumjs.cs.datasources.properties.Property<T>

org.cesiumjs.cs.datasources.properties.SampledProperty<T>

@JsType(isNative=true,
        namespace="Cesium",
        name="SampledProperty")
public class SampledProperty<T extends Packable>
extends Property<T>

Author:

Serge Silaev aka iSergio

Field Summary

Fields

Modifier and Type	Field and Description
double	backwardExtrapolationDuration Gets or sets the amount of time to extrapolate backward before the property becomes undefined.
Integer	backwardExtrapolationType Gets or sets the type of extrapolation to perform when a value is requested at a time before any available samples.
Packable[]	derivativeTypes Gets the derivative types used by this property.
double	forwardExtrapolationDuration Gets or sets the amount of time to extrapolate forward before the property becomes undefined.
Integer	forwardExtrapolationType Gets or sets the type of extrapolation to perform when a value is requested at a time after any available samples.
InterpolationAlgorithm	interpolationAlgorithm Gets the interpolation algorithm to use when retrieving a value.
double	interpolationDegree Gets the degree of interpolation to perform when retrieving a value.
T	type Gets the type of property.

Constructor Summary

Constructors

Constructor and Description
SampledProperty(T type) A Property whose value is interpolated for a given time from the provided set of samples and specified interpolation algorithm and degree.
SampledProperty(T type, T[] derivativeTypes) A Property whose value is interpolated for a given time from the provided set of samples and specified interpolation algorithm and degree.

Method Summary

Modifier and Type	Method and Description
void	addSample(JulianDate time, T value) Adds a new sample
void	addSample(JulianDate time, T value, T[] derivatives) Adds a new sample
void	addSamples(JulianDate[] times, T[] values) Adds an array of samples
void	addSamples(JulianDate[] times, T[] values, T[] derivativeValues) Adds an array of samples
void	addSamplesPackedArray(double[] packedSamples, JulianDate 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 and derivatives.
boolean	removeSample(JulianDate time) Removes a sample at the given time, if present.
void	removeSamples(TimeInterval time) Removes all samples for the given time interval.
void	setInterpolationOptions(SampledPropertyInterpolationOptions options) Sets the algorithm and degree to use when interpolating a value.

Methods inherited from class org.cesiumjs.cs.datasources.properties.Property

definitionChanged, equals, getValue, getValue, getValueOrUndefined, isConstant

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

backwardExtrapolationDuration

@JsProperty
public double backwardExtrapolationDuration

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

backwardExtrapolationType

@JsProperty
public Integer backwardExtrapolationType

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

derivativeTypes

@JsProperty
public Packable[] derivativeTypes

Gets the derivative types used by this property.

forwardExtrapolationDuration

@JsProperty
public double forwardExtrapolationDuration

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

forwardExtrapolationType

@JsProperty
public Integer forwardExtrapolationType

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

interpolationAlgorithm

@JsProperty
public InterpolationAlgorithm interpolationAlgorithm

Gets the interpolation algorithm to use when retrieving a value. Default: LinearApproximation

interpolationDegree

@JsProperty
public double interpolationDegree

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

type

@JsProperty
public T extends Packable type

Gets the type of property.

Constructor Detail

SampledProperty

@JsConstructor
public SampledProperty(T type)

A Property whose value is interpolated for a given time from the provided set of samples and specified interpolation algorithm and degree.

Parameters:

type - The type of property.

SampledProperty

@JsConstructor
public SampledProperty(T type,
                                      T[] derivativeTypes)

A Property whose value is interpolated for a given time from the provided set of samples and specified interpolation algorithm and degree.

Parameters:

type - The type of property.

derivativeTypes - When supplied, indicates that samples will contain derivative information of the specified types.

Method Detail

addSample

@JsMethod
public void addSample(JulianDate time,
                                T value)

Adds a new sample

Parameters:

time - The sample time.

value - The value at the provided time.

addSample

@JsMethod
public void addSample(JulianDate time,
                                T value,
                                T[] derivatives)

Adds a new sample

Parameters:

time - The sample time.

value - The value at the provided time.

derivatives - The array of derivatives at the provided time.

addSamples

@JsMethod
public void addSamples(JulianDate[] times,
                                 T[] values)

Adds an array of samples

Parameters:

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

values - The array of values, where each value corresponds to the provided times index.

addSamples

@JsMethod
public void addSamples(JulianDate[] times,
                                 T[] values,
                                 T[] derivativeValues)

Adds an array of samples

Parameters:

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

values - The array of values, where each value corresponds to the provided times index.

derivativeValues - An array where each item is the array of derivatives at the equivalent time index.

addSamplesPackedArray

@JsMethod
public void addSamplesPackedArray(double[] packedSamples,
                                            JulianDate 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 and derivatives.

Parameters:

packedSamples - The array of packed samples.

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

removeSample

@JsMethod
public boolean removeSample(JulianDate time)

Removes a sample at the given time, if present.

Parameters:

time - The sample time.

Returns:

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

removeSamples

@JsMethod
public void removeSamples(TimeInterval time)

Removes all samples for the given time interval.

Parameters:

time - The time interval for which to remove all samples.

setInterpolationOptions

@JsMethod
public void setInterpolationOptions(SampledPropertyInterpolationOptions options)

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

Parameters:

options - Options