main.cesium.CoplanarPolygonOutlineGeometry.kt Maven / Gradle / Ivy
// Automatically generated - do not modify!
@file:Suppress(
"NON_EXTERNAL_DECLARATION_IN_INAPPROPRIATE_FILE",
)
package cesium
/**
* A description of the outline of a polygon composed of arbitrary coplanar positions.
* ```
* var polygonOutline = new CoplanarPolygonOutlineGeometry({
* positions : Cartesian3.fromDegreesArrayHeights([
* -90.0, 30.0, 0.0,
* -90.0, 30.0, 1000.0,
* -80.0, 30.0, 1000.0,
* -80.0, 30.0, 0.0
* ])
* });
* var geometry = CoplanarPolygonOutlineGeometry.createGeometry(polygonOutline);
* ```
* @see Online Documentation
*/
@JsName("\$cesium__CoplanarPolygonOutlineGeometry")
external class CoplanarPolygonOutlineGeometry(options: ConstructorOptions) {
/**
* @property [polygonHierarchy] A polygon hierarchy that can include holes.
*/
interface ConstructorOptions {
var polygonHierarchy: PolygonHierarchy
}
/**
* The number of elements used to pack the object into an array.
* @see Online Documentation
*/
val packedLength: Int
companion object {
/**
* A description of a coplanar polygon outline from an array of positions.
* @see Online Documentation
*/
fun fromPositions(options: FromPositionsOptions): CoplanarPolygonOutlineGeometry
/**
* @property [positions] An array of positions that defined the corner points of the polygon.
*/
interface FromPositionsOptions {
var positions: Array
}
/**
* 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: CoplanarPolygonOutlineGeometry,
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 CoplanarPolygonOutlineGeometry instance if one was not provided.
* @see Online Documentation
*/
fun unpack(
array: Array,
startingIndex: Int? = definedExternally,
result: CoplanarPolygonOutlineGeometry? = definedExternally,
): CoplanarPolygonOutlineGeometry
/**
* Computes the geometric representation of an arbitrary coplanar polygon, including its vertices, indices, and a bounding sphere.
* @param [polygonGeometry] A description of the polygon.
* @return The computed vertices and indices.
* @see Online Documentation
*/
fun createGeometry(polygonGeometry: CoplanarPolygonOutlineGeometry): Geometry?
}
}