main.cesium.SphereOutlineGeometry.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 sphere.
* ```
* var sphere = new SphereOutlineGeometry({
* radius : 100.0,
* stackPartitions : 6,
* slicePartitions: 5
* });
* var geometry = SphereOutlineGeometry.createGeometry(sphere);
* ```
* @see Online Documentation
*/
@JsName("\$cesium__SphereOutlineGeometry")
external class SphereOutlineGeometry(options: ConstructorOptions? = definedExternally) {
/**
* @property [radius] The radius of the sphere.
* Default value - `1.0`
* @property [stackPartitions] The count of stacks for the sphere (1 greater than the number of parallel lines).
* Default value - `10`
* @property [slicePartitions] The count of slices for the sphere (Equal to the number of radial lines).
* Default value - `8`
* @property [subdivisions] The number of points per line, determining the granularity of the curvature .
* Default value - `200`
*/
interface ConstructorOptions {
var radius: Double?
var stackPartitions: Int?
var slicePartitions: Int?
var subdivisions: 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: SphereOutlineGeometry,
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 SphereOutlineGeometry instance if one was not provided.
* @see Online Documentation
*/
override fun unpack(
array: Array,
startingIndex: Int?,
result: SphereOutlineGeometry?,
): SphereOutlineGeometry
/**
* Computes the geometric representation of an outline of a sphere, including its vertices, indices, and a bounding sphere.
* @param [sphereGeometry] A description of the sphere outline.
* @return The computed vertices and indices.
* @see Online Documentation
*/
fun createGeometry(sphereGeometry: SphereOutlineGeometry): Geometry?
}
}