main.cesium.EllipsoidGeometry.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 an ellipsoid centered at the origin.
* ```
* const ellipsoid = new EllipsoidGeometry({
* vertexFormat : VertexFormat.POSITION_ONLY,
* radii : new Cartesian3(1000000.0, 500000.0, 500000.0)
* });
* const geometry = EllipsoidGeometry.createGeometry(ellipsoid);
* ```
* @see Online Documentation
*/
external class EllipsoidGeometry(options: ConstructorOptions? = definedExternally) {
/**
* @property [radii] The radii of the ellipsoid in the x, y, and z directions.
* Default value - [Cartesian3(1.0, 1.0, 1.0)][Cartesian3]
* @property [innerRadii] The inner radii of the ellipsoid in the x, y, and z directions.
* Default value - `options.radii`
* @property [minimumClock] The minimum angle lying in the xy-plane measured from the positive x-axis and toward the positive y-axis.
* Default value - `0.0`
* @property [maximumClock] The maximum angle lying in the xy-plane measured from the positive x-axis and toward the positive y-axis.
* Default value - `2*PI`
* @property [minimumCone] The minimum angle measured from the positive z-axis and toward the negative z-axis.
* Default value - `0.0`
* @property [maximumCone] The maximum angle measured from the positive z-axis and toward the negative z-axis.
* Default value - `PI`
* @property [stackPartitions] The number of times to partition the ellipsoid into stacks.
* Default value - `64`
* @property [slicePartitions] The number of times to partition the ellipsoid into radial slices.
* Default value - `64`
* @property [vertexFormat] The vertex attributes to be computed.
* Default value - [VertexFormat.DEFAULT]
*/
interface ConstructorOptions {
var radii: Cartesian3?
var innerRadii: Cartesian3?
var minimumClock: Double?
var maximumClock: Double?
var minimumCone: Double?
var maximumCone: Double?
var stackPartitions: Int?
var slicePartitions: Int?
var vertexFormat: VertexFormat?
}
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: EllipsoidGeometry,
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 EllipsoidGeometry instance if one was not provided.
* @see Online Documentation
*/
override fun unpack(
array: Array,
startingIndex: Int?,
result: EllipsoidGeometry?,
): EllipsoidGeometry
/**
* Computes the geometric representation of an ellipsoid, including its vertices, indices, and a bounding sphere.
* @param [ellipsoidGeometry] A description of the ellipsoid.
* @return The computed vertices and indices.
* @see Online Documentation
*/
fun createGeometry(ellipsoidGeometry: EllipsoidGeometry): Geometry?
}
}
inline fun EllipsoidGeometry(
block: EllipsoidGeometry.ConstructorOptions.() -> Unit,
): EllipsoidGeometry {
val options: EllipsoidGeometry.ConstructorOptions = js("({})")
block(options)
return EllipsoidGeometry(options)
}