main.cesium.RectangleOutlineGeometry.kt Maven / Gradle / Ivy
// Automatically generated - do not modify!
@file:JsModule("cesium")
@file:Suppress(
"NON_EXTERNAL_DECLARATION_IN_INAPPROPRIATE_FILE",
)
package cesium
/**
* A description of the outline of a a cartographic rectangle on an ellipsoid centered at the origin.
* ```
* const rectangle = new RectangleOutlineGeometry({
* ellipsoid : Ellipsoid.WGS84,
* rectangle : Rectangle.fromDegrees(-80.0, 39.0, -74.0, 42.0),
* height : 10000.0
* });
* const geometry = RectangleOutlineGeometry.createGeometry(rectangle);
* ```
* @see Online Documentation
*/
external class RectangleOutlineGeometry(options: ConstructorOptions) {
/**
* @property [rectangle] A cartographic rectangle with north, south, east and west properties in radians.
* @property [ellipsoid] The ellipsoid on which the rectangle lies.
* 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 rectangle and the ellipsoid surface.
* Default value - `0.0`
* @property [rotation] The rotation of the rectangle, in radians. A positive rotation is counter-clockwise.
* Default value - `0.0`
* @property [extrudedHeight] The distance in meters between the rectangle's extruded face and the ellipsoid surface.
*/
interface ConstructorOptions {
var rectangle: Rectangle
var ellipsoid: Ellipsoid?
var granularity: Double?
var height: Double?
var rotation: Double?
var extrudedHeight: Double?
}
companion object : Packable {
/**
* The number of elements used to pack the object into an array.
* @see Online Documentation
*/
override val packedLength: Int
/**
* 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
*/
override fun pack(
value: RectangleOutlineGeometry,
array: Array,
startingIndex: Int?,
): 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 Quaternion instance if one was not provided.
* @see Online Documentation
*/
override fun unpack(
array: Array,
startingIndex: Int?,
result: RectangleOutlineGeometry?,
): RectangleOutlineGeometry
/**
* Computes the geometric representation of an outline of a rectangle, including its vertices, indices, and a bounding sphere.
* @param [rectangleGeometry] A description of the rectangle outline.
* @return The computed vertices and indices.
* @see Online Documentation
*/
fun createGeometry(rectangleGeometry: RectangleOutlineGeometry): Geometry?
}
}
inline fun RectangleOutlineGeometry(
block: RectangleOutlineGeometry.ConstructorOptions.() -> Unit,
): RectangleOutlineGeometry {
val options: RectangleOutlineGeometry.ConstructorOptions = js("({})")
block(options)
return RectangleOutlineGeometry(options)
}