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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cesium-kotlin
Kotlin/JS declarations for Cesium
The newest version!
// Automatically generated - do not modify!

@file:JsModule("cesium")

@file:Suppress(
    "NON_EXTERNAL_DECLARATION_IN_INAPPROPRIATE_FILE",
)

package cesium

/**
 * A [MaterialProperty] that maps to image [Material] uniforms.
 * @see Online Documentation
 */
external class ImageMaterialProperty : 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
     */
    override 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
     */
    override val definitionChanged: Event

    /**
     * Gets or sets the Property specifying Image, URL, Canvas, or Video to use.
     * @see Online Documentation
     */
    var image: Property?

    /**
     * Gets or sets the [Cartesian2] Property specifying the number of times the image repeats in each direction.
     * @see Online Documentation
     */
    var repeat: Property?

    /**
     * Gets or sets the Color Property specifying the desired color applied to the image.
     * @see Online Documentation
     */
    var color: Property?

    /**
     * Gets or sets the Boolean Property specifying whether the image has transparency
     * @see Online Documentation
     */
    var transparent: Property?

    /**
     * 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
     */
    override 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
     */
    override fun getValue(
        time: JulianDate,
        result: Any?,
    ): Any
}

inline fun ImageMaterialProperty(
    block: ImageMaterialProperty.() -> Unit,
): ImageMaterialProperty =
    ImageMaterialProperty().apply(block)