main.cesium.ConstantProperty.kt Maven / Gradle / Ivy
// Automatically generated - do not modify!
@file:JsModule("cesium")
package cesium
/**
* A [Property] whose value does not change with respect to simulation time.
* @see Online Documentation
*
* @constructor
* @param [value] The property value.
* @see Online Documentation
*/
external class ConstantProperty(value: Any? = definedExternally) {
/**
* Gets a value indicating if this property is constant.
* This property always returns `true`.
* @see Online Documentation
*/
val isConstant: Boolean
/**
* Gets the event that is raised whenever the definition of this property changes.
* The definition is changed whenever setValue is called with data different
* than the current value.
* @see Online Documentation
*/
val definitionChanged: Event
/**
* Gets the value of the property.
* @param [time] The time for which to retrieve the value. This parameter is unused since the value does not change with respect to time.
* @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? = definedExternally,
result: Any? = definedExternally,
): Any
/**
* Sets the value of the property.
* @param [value] The property value.
* @see Online Documentation
*/
fun setValue(value: Any)
/**
* Gets this property's value.
* @return This property's value.
* @see Online Documentation
*/
fun valueOf(): Any
}