main.cesium.TimeIntervalCollectionPositionProperty.kt Maven / Gradle / Ivy
// Automatically generated - do not modify!
@file:Suppress(
"EXTERNAL_CLASS_CONSTRUCTOR_PROPERTY_PARAMETER",
)
package cesium
/**
* A [TimeIntervalCollectionProperty] which is also a [PositionProperty].
* @see Online Documentation
*
* @constructor
* @property [referenceFrame] The reference frame in which the position is defined.
* Default value - [ReferenceFrame.FIXED]
* @see Online Documentation
*/
@JsName("\$cesium__TimeIntervalCollectionPositionProperty")
external class TimeIntervalCollectionPositionProperty(var referenceFrame: ReferenceFrame = definedExternally) {
/**
* 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.
* @see Online Documentation
*/
val isConstant: Boolean
/**
* 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.
* @see Online Documentation
*/
val definitionChanged: Event
/**
* Gets the interval collection.
* @see Online Documentation
*/
var intervals: TimeIntervalCollection
/**
* Gets the value of the property at the provided time in the fixed frame.
* @param [time] The time for which to retrieve the value.
* @param [result] The object to store the value into, if omitted, a new instance is created and returned.
* @return The modified result parameter or a new instance if the result parameter was not supplied.
* @see Online Documentation
*/
fun getValue(
time: JulianDate,
result: Any? = definedExternally,
): Any
/**
* Gets the value of the property at the provided time and in the provided reference frame.
* @param [time] The time for which to retrieve the value.
* @param [referenceFrame] The desired referenceFrame of the result.
* @param [result] The object to store the value into, if omitted, a new instance is created and returned.
* @return The modified result parameter or a new instance if the result parameter was not supplied.
* @see Online Documentation
*/
fun getValueInReferenceFrame(
time: JulianDate,
referenceFrame: ReferenceFrame,
result: Cartesian3? = definedExternally,
): Cartesian3
}