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

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

// Automatically generated - do not modify!

@file:Suppress(
    "NON_EXTERNAL_DECLARATION_IN_INAPPROPRIATE_FILE",
)

package cesium

/**
 * Describes a frustum at the given the origin and orientation.
 * @see Online Documentation
 */
@JsName("\$cesium__FrustumGeometry")
external class FrustumGeometry(options: ConstructorOptions) {
    /**
     * @property [frustum] The frustum.
     * @property [origin] The origin of the frustum.
     * @property [orientation] The orientation of the frustum.
     * @property [vertexFormat] The vertex attributes to be computed.
     *   Default value - [VertexFormat.DEFAULT]
     */
    interface ConstructorOptions {
        var frustum: dynamic
        var origin: Cartesian3
        var orientation: Quaternion
        var vertexFormat: VertexFormat?
    }

    /**
     * The number of elements used to pack the object into an array.
     * @see Online Documentation
     */
    val packedLength: Int

    companion object {
        /**
         * Stores the provided instance into the provided array.
         * @param [value] The value to pack.
         * @param [array] The array to pack into.
         * @param [startingIndex] The index into the array at which to start packing the elements.
         *   Default value - `0`
         * @return The array that was packed into
         * @see Online Documentation
         */
        fun pack(
            value: FrustumGeometry,
            array: Array,
            startingIndex: Int? = definedExternally,
        ): Array

        /**
         * Retrieves an instance from a packed array.
         * @param [array] The packed array.
         * @param [startingIndex] The starting index of the element to be unpacked.
         *   Default value - `0`
         * @param [result] The object into which to store the result.
         * @see Online Documentation
         */
        fun unpack(
            array: Array,
            startingIndex: Int? = definedExternally,
            result: FrustumGeometry? = definedExternally,
        )

        /**
         * Computes the geometric representation of a frustum, including its vertices, indices, and a bounding sphere.
         * @param [frustumGeometry] A description of the frustum.
         * @return The computed vertices and indices.
         * @see Online Documentation
         */
        fun createGeometry(frustumGeometry: FrustumGeometry): Geometry?
    }
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy