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

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

// Automatically generated - do not modify!

@file:Suppress(
    "NON_EXTERNAL_DECLARATION_IN_INAPPROPRIATE_FILE",
)

package cesium

/**
 * Describes a graphical point located at the position of the containing [Entity].
 * @see Online Documentation
 */
@JsName("\$cesium__PointGraphics")
external class PointGraphics {
    /**
     * 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 point.
     * @see Online Documentation
     */
    var show: Property?

    /**
     * Gets or sets the numeric Property specifying the size in pixels.
     * @see Online Documentation
     */
    var pixelSize: Property?

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

    /**
     * Gets or sets the Property specifying the [Color] of the point.
     * @see Online Documentation
     */
    var color: 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 the outline width in pixels.
     * @see Online Documentation
     */
    var outlineWidth: Property?

    /**
     * Gets or sets the [NearFarScalar] Property used to scale the point based on distance.
     * If undefined, a constant size is used.
     * @see Online Documentation
     */
    var scaleByDistance: Property?

    /**
     * Gets or sets [NearFarScalar] Property specifying the translucency of the point based on the distance from the camera.
     * A point's translucency will interpolate between the [NearFarScalar.nearValue] and
     * [NearFarScalar.farValue] while the camera distance falls within the lower and upper bounds
     * of the specified [NearFarScalar.near] and [NearFarScalar.far].
     * Outside of these ranges the points's translucency remains clamped to the nearest bound.
     * @see Online Documentation
     */
    var translucencyByDistance: Property?

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

    /**
     * Gets or sets the distance from the camera at which to disable the depth test to, for example, prevent clipping against terrain.
     * When set to zero, the depth test is always applied. When set to Number.POSITIVE_INFINITY, the depth test is never applied.
     * @see Online Documentation
     */
    var disableDepthTestDistance: 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: PointGraphics? = definedExternally): PointGraphics

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




© 2015 - 2024 Weber Informatics LLC | Privacy Policy