main.cesium.CorridorOutlineGeometry.kt Maven / Gradle / Ivy
// Automatically generated - do not modify!
@file:Suppress(
"NON_EXTERNAL_DECLARATION_IN_INAPPROPRIATE_FILE",
)
package cesium
/**
* A description of a corridor outline.
* ```
* var corridor = new CorridorOutlineGeometry({
* positions : Cartesian3.fromDegreesArray([-72.0, 40.0, -70.0, 35.0]),
* width : 100000
* });
* ```
* @see Online Documentation
*/
@JsName("\$cesium__CorridorOutlineGeometry")
external class CorridorOutlineGeometry(options: ConstructorOptions) {
/**
* @property [positions] An array of positions that define the center of the corridor outline.
* @property [width] The distance between the edges of the corridor outline.
* @property [ellipsoid] The ellipsoid to be used as a reference.
* Default value - [Ellipsoid.WGS84]
* @property [granularity] The distance, in radians, between each latitude and longitude. Determines the number of positions in the buffer.
* Default value - [Math.RADIANS_PER_DEGREE]
* @property [height] The distance in meters between the positions and the ellipsoid surface.
* Default value - `0`
* @property [extrudedHeight] The distance in meters between the extruded face and the ellipsoid surface.
* @property [cornerType] Determines the style of the corners.
* Default value - [CornerType.ROUNDED]
*/
interface ConstructorOptions {
var positions: Array
var width: Double
var ellipsoid: Ellipsoid?
var granularity: Double?
var height: Double?
var extrudedHeight: Double?
var cornerType: CornerType?
}
/**
* 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: CorridorOutlineGeometry,
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.
* @return The modified result parameter or a new CorridorOutlineGeometry instance if one was not provided.
* @see Online Documentation
*/
fun unpack(
array: Array,
startingIndex: Int? = definedExternally,
result: CorridorOutlineGeometry? = definedExternally,
): CorridorOutlineGeometry
/**
* Computes the geometric representation of a corridor, including its vertices, indices, and a bounding sphere.
* @param [corridorOutlineGeometry] A description of the corridor.
* @return The computed vertices and indices.
* @see Online Documentation
*/
fun createGeometry(corridorOutlineGeometry: CorridorOutlineGeometry): Geometry?
}
}