main.cesium.PositionProperty.kt Maven / Gradle / Ivy
// Automatically generated - do not modify!
package cesium
/**
* The interface for all [Property] objects that define a world
* location as a [Cartesian3] with an associated [ReferenceFrame].
* This type defines an interface and cannot be instantiated directly.
* @see Online Documentation
*/
@JsName("\$cesium__PositionProperty")
abstract external class PositionProperty {
/**
* 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
*/
abstract 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
*/
abstract val definitionChanged: Event
/**
* Gets the reference frame that the position is defined in.
* @see Online Documentation
*/
abstract var referenceFrame: ReferenceFrame
/**
* 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
*/
abstract fun getValue(
time: JulianDate,
result: Cartesian3? = definedExternally,
): Cartesian3
/**
* 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
*/
abstract fun getValueInReferenceFrame(
time: JulianDate,
referenceFrame: ReferenceFrame,
result: Cartesian3? = definedExternally,
): Cartesian3
}