main.cesium.PolylineVolumeGraphics.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

/**
 * Describes a polyline volume defined as a line strip and corresponding two dimensional shape which is extruded along it.
 * The resulting volume conforms to the curvature of the globe.
 * @see Online Documentation
 */
external class PolylineVolumeGraphics {
    /**
     * Gets the event that is raised whenever a property or sub-property is changed or modified.
     * @see Online Documentation
     */
    val definitionChanged: Event

    /**
     * Gets or sets the boolean Property specifying the visibility of the volume.
     * @see Online Documentation
     */
    var show: Property?

    /**
     * Gets or sets the Property specifying the array of [Cartesian3] positions which define the line strip.
     * @see Online Documentation
     */
    var positions: Property?

    /**
     * Gets or sets the Property specifying the array of [Cartesian2] positions which define the shape to be extruded.
     * @see Online Documentation
     */
    var shape: Property?

    /**
     * Gets or sets the [CornerType] Property specifying the style of the corners.
     * @see Online Documentation
     */
    var cornerType: Property?

    /**
     * Gets or sets the numeric Property specifying the angular distance between points on the volume.
     * @see Online Documentation
     */
    var granularity: Property?

    /**
     * Gets or sets the boolean Property specifying whether the volume is filled with the provided material.
     * @see Online Documentation
     */
    var fill: Property?

    /**
     * Gets or sets the Property specifying the material used to fill the volume.
     * @see Online Documentation
     */
    var material: MaterialProperty

    /**
     * Gets or sets the Property specifying whether the volume is outlined.
     * @see Online Documentation
     */
    var outline: Property?

    /**
     * Gets or sets the Property specifying the [Color] of the outline.
     * @see Online Documentation
     */
    var outlineColor: Property?

    /**
     * Gets or sets the numeric Property specifying the width of the outline.
     *
     * Note: This property will be ignored on all major browsers on Windows platforms. For details, see (@link https://github.com/CesiumGS/cesium/issues/40}.
     * @see Online Documentation
     */
    var outlineWidth: Property?

    /**
     * Get or sets the enum Property specifying whether the volume
     * casts or receives shadows from light sources.
     * @see Online Documentation
     */
    var shadows: Property?

    /**
     * Gets or sets the [DistanceDisplayCondition] Property specifying at what distance from the camera that this volume will be displayed.
     * @see Online Documentation
     */
    var distanceDisplayCondition: Property?

    /**
     * Duplicates this instance.
     * @param [result] The object onto which to store the result.
     * @return The modified result parameter or a new instance if one was not provided.
     * @see Online Documentation
     */
    fun clone(result: PolylineVolumeGraphics? = definedExternally): PolylineVolumeGraphics

    /**
     * Assigns each unassigned property on this object to the value
     * of the same property on the provided source object.
     * @param [source] The object to be merged into this object.
     * @see Online Documentation
     */
    fun merge(source: PolylineVolumeGraphics)
}

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