agi.foundation.cesium

(agi.foundation.cesium-2024r3.jar)

Class ScalarCesiumProperty

java.lang.Object

agi.foundation.cesium.advanced.CesiumProperty<Double>

agi.foundation.cesium.ScalarCesiumProperty

public class ScalarCesiumProperty
extends CesiumProperty<Double>

A CesiumProperty that writes values by evaluating a given Scalar.

Constructor Summary

Constructors

Constructor and Description
ScalarCesiumProperty() Initializes a new instance.
ScalarCesiumProperty(Scalar scalar) Initializes a new instance with the provided Scalar.

Method Summary

Modifier and Type	Method and Description
Duration	getBackwardExtrapolationDuration() Gets the amount of time to extrapolate backward before the property becomes undefined.
CesiumExtrapolationType	getBackwardExtrapolationType() Gets the type of extrapolation to perform when a value is requested at a time before any available samples.
Duration	getForwardExtrapolationDuration() Gets the amount of time to extrapolate forward before the property becomes undefined.
CesiumExtrapolationType	getForwardExtrapolationType() Gets the type of extrapolation to perform when a value is requested at a time after any available samples.
CesiumInterpolationAlgorithm	getInterpolationAlgorithm() Gets the algorithm to use for interpolation.
Integer	getInterpolationDegree() Gets the degree of the polynomial to use for interpolation.
Scalar	getScalar() Gets the scalar.
void	setBackwardExtrapolationDuration(Duration value) Sets the amount of time to extrapolate backward before the property becomes undefined.
void	setBackwardExtrapolationType(CesiumExtrapolationType value) Sets the type of extrapolation to perform when a value is requested at a time before any available samples.
void	setForwardExtrapolationDuration(Duration value) Sets the amount of time to extrapolate forward before the property becomes undefined.
void	setForwardExtrapolationType(CesiumExtrapolationType value) Sets the type of extrapolation to perform when a value is requested at a time after any available samples.
void	setInterpolationAlgorithm(CesiumInterpolationAlgorithm value) Sets the algorithm to use for interpolation.
void	setInterpolationDegree(Integer value) Sets the degree of the polynomial to use for interpolation.
void	setScalar(Scalar value) Sets the scalar.
static ScalarCesiumProperty	toScalarCesiumProperty(Scalar value) Converts a Scalar to a ScalarCesiumProperty.

Methods inherited from class agi.foundation.cesium.advanced.CesiumProperty

createGenerators, toCesiumProperty, toCesiumProperty, toCesiumProperty

Methods inherited from class java.lang.Object

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

Constructor Detail

ScalarCesiumProperty

public ScalarCesiumProperty()

Initializes a new instance.

ScalarCesiumProperty

public ScalarCesiumProperty(Scalar scalar)

Initializes a new instance with the provided Scalar.

Parameters:

scalar - The scalar.

Method Detail

toScalarCesiumProperty

public static ScalarCesiumProperty toScalarCesiumProperty(Scalar value)

Converts a Scalar to a ScalarCesiumProperty.

Parameters:

value - The value to convert.

Returns:

A new ScalarCesiumProperty configured with the given Scalar, or null if value is null.

getScalar

public final Scalar getScalar()

Gets the scalar.

setScalar

public final void setScalar(Scalar value)

Sets the scalar.

getInterpolationAlgorithm

@Nullable
public final CesiumInterpolationAlgorithm getInterpolationAlgorithm()

Gets the algorithm to use for interpolation. null indicates that the value will not be specified in the CZML output.

setInterpolationAlgorithm

public final void setInterpolationAlgorithm(@Nullable
                                            CesiumInterpolationAlgorithm value)

Sets the algorithm to use for interpolation. null indicates that the value will not be specified in the CZML output.

getInterpolationDegree

@Nullable
public final Integer getInterpolationDegree()

Gets the degree of the polynomial to use for interpolation. null indicates that the value will not be specified in the CZML output.

setInterpolationDegree

public final void setInterpolationDegree(@Nullable
                                         Integer value)

Sets the degree of the polynomial to use for interpolation. null indicates that the value will not be specified in the CZML output.

getForwardExtrapolationType

@Nullable
public final CesiumExtrapolationType getForwardExtrapolationType()

Gets the type of extrapolation to perform when a value is requested at a time after any available samples. null indicates that the value will not be specified in the CZML output.

setForwardExtrapolationType

public final void setForwardExtrapolationType(@Nullable
                                              CesiumExtrapolationType value)

Sets the type of extrapolation to perform when a value is requested at a time after any available samples. null indicates that the value will not be specified in the CZML output.

getForwardExtrapolationDuration

@Nullable
public final Duration getForwardExtrapolationDuration()

Gets the amount of time to extrapolate forward before the property becomes undefined. A value of 0 will extrapolate forever. null indicates that the value will not be specified in the CZML output.

setForwardExtrapolationDuration

public final void setForwardExtrapolationDuration(@Nullable
                                                  Duration value)

Sets the amount of time to extrapolate forward before the property becomes undefined. A value of 0 will extrapolate forever. null indicates that the value will not be specified in the CZML output.

getBackwardExtrapolationType

@Nullable
public final CesiumExtrapolationType getBackwardExtrapolationType()

Gets the type of extrapolation to perform when a value is requested at a time before any available samples. null indicates that the value will not be specified in the CZML output.

setBackwardExtrapolationType

public final void setBackwardExtrapolationType(@Nullable
                                               CesiumExtrapolationType value)

Sets the type of extrapolation to perform when a value is requested at a time before any available samples. null indicates that the value will not be specified in the CZML output.

getBackwardExtrapolationDuration

@Nullable
public final Duration getBackwardExtrapolationDuration()

Gets the amount of time to extrapolate backward before the property becomes undefined. A value of 0 will extrapolate forever. null indicates that the value will not be specified in the CZML output.

setBackwardExtrapolationDuration

public final void setBackwardExtrapolationDuration(@Nullable
                                                   Duration value)

Sets the amount of time to extrapolate backward before the property becomes undefined. A value of 0 will extrapolate forever. null indicates that the value will not be specified in the CZML output.