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

/**
 * Describe an ellipsoid or sphere.  The center position and orientation are determined by the containing [Entity].
 * @see Online Documentation
 */
external class EllipsoidGraphics {
    /**
     * 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 ellipsoid.
     * @see Online Documentation
     */
    var show: Property?

    /**
     * Gets or sets the [Cartesian3] [Property] specifying the radii of the ellipsoid.
     * @see Online Documentation
     */
    var radii: Property?

    /**
     * Gets or sets the [Cartesian3] [Property] specifying the inner radii of the ellipsoid.
     * @see Online Documentation
     */
    var innerRadii: Property?

    /**
     * Gets or sets the Property specifying the minimum clock angle of the ellipsoid.
     * @see Online Documentation
     */
    var minimumClock: Property?

    /**
     * Gets or sets the Property specifying the maximum clock angle of the ellipsoid.
     * @see Online Documentation
     */
    var maximumClock: Property?

    /**
     * Gets or sets the Property specifying the minimum cone angle of the ellipsoid.
     * @see Online Documentation
     */
    var minimumCone: Property?

    /**
     * Gets or sets the Property specifying the maximum cone angle of the ellipsoid.
     * @see Online Documentation
     */
    var maximumCone: Property?

    /**
     * Gets or sets the Property specifying the [HeightReference].
     * @see Online Documentation
     */
    var heightReference: Property?

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

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

    /**
     * Gets or sets the Property specifying whether the ellipsoid 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?

    /**
     * Gets or sets the Property specifying the number of stacks.
     * @see Online Documentation
     */
    var stackPartitions: Property?

    /**
     * Gets or sets the Property specifying the number of radial slices per 360 degrees.
     * @see Online Documentation
     */
    var slicePartitions: Property?

    /**
     * Gets or sets the Property specifying the number of samples per outline ring, determining the granularity of the curvature.
     * @see Online Documentation
     */
    var subdivisions: Property?

    /**
     * Get or sets the enum Property specifying whether the ellipsoid
     * 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 ellipsoid 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: EllipsoidGraphics? = definedExternally): EllipsoidGraphics

    /**
     * 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: EllipsoidGraphics)
}

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