All Downloads are FREE. Search and download functionalities are using the official Maven repository.

main.cesium.PropertyArray.kt Maven / Gradle / Ivy

// Automatically generated - do not modify!

@file:JsModule("cesium")

package cesium

/**
 * A [Property] whose value is an array whose items are the computed value
 * of other property instances.
 * @see Online Documentation
 *
 * @constructor
 * @param [value] An array of Property instances.
 * @see Online Documentation
 */
external class PropertyArray(value: Array? = definedExternally) {
    /**
     * Gets a value indicating if this property is constant.  This property
     * is considered constant if all property items in the array are constant.
     * @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 or one of the properties in the array also changes.
     * @see Online Documentation
     */
    val definitionChanged: Event

    /**
     * Gets the value of the property.
     * @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, which is an array of values produced by evaluating each of the contained properties at the given time or a new instance if the result parameter was not supplied.
     * @see Online Documentation
     */
    fun getValue(
        time: JulianDate,
        result: Array? = definedExternally,
    ): Array

    /**
     * Sets the value of the property.
     * @param [value] An array of Property instances.
     * @see Online Documentation
     */
    fun setValue(value: Array)
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy