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

Go to download
// Automatically generated - do not modify!

@file:JsModule("cesium")

package cesium

/**
 * The interface for all [Property] objects that represent [Material] uniforms.
 * This type defines an interface and cannot be instantiated directly.
 * @see Online Documentation
 */
abstract external class MaterialProperty {
    /**
     * 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 [Material] type at the provided time.
     * @param [time] The time for which to retrieve the type.
     * @return The type of material.
     * @see Online Documentation
     */
    abstract fun getType(time: JulianDate): String

    /**
     * Gets the value of the property at the provided time.
     * @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: Any? = definedExternally,
    ): Any
}