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

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

// Automatically generated - do not modify!

@file:JsModule("cesium")

@file:Suppress(
    "NON_EXTERNAL_DECLARATION_IN_INAPPROPRIATE_FILE",
)

package cesium

/**
 * A [MaterialProperty] that maps to polyline dash [Material] uniforms.
 * @see Online Documentation
 */
external class PolylineDashMaterialProperty : 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 the [Color] of the line.
     * @see Online Documentation
     */
    var color: Property?

    /**
     * Gets or sets the Property specifying the [Color] of the gaps in the line.
     * @see Online Documentation
     */
    var gapColor: Property?

    /**
     * Gets or sets the numeric Property specifying the length of a dash cycle
     * @see Online Documentation
     */
    var dashLength: Property?

    /**
     * Gets or sets the numeric Property specifying a dash pattern
     * @see Online Documentation
     */
    var dashPattern: 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 PolylineDashMaterialProperty(
    block: PolylineDashMaterialProperty.() -> Unit,
): PolylineDashMaterialProperty =
    PolylineDashMaterialProperty().apply(block)




© 2015 - 2024 Weber Informatics LLC | Privacy Policy