main.cesium.EllipseOutlineGeometry.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 an ellipse on an ellipsoid.
* ```
* var ellipse = new EllipseOutlineGeometry({
* center : Cartesian3.fromDegrees(-75.59777, 40.03883),
* semiMajorAxis : 500000.0,
* semiMinorAxis : 300000.0,
* rotation : Math.toRadians(60.0)
* });
* var geometry = EllipseOutlineGeometry.createGeometry(ellipse);
* ```
* @see Online Documentation
*/
@JsName("\$cesium__EllipseOutlineGeometry")
external class EllipseOutlineGeometry(options: ConstructorOptions) {
/**
* @property [center] The ellipse's center point in the fixed frame.
* @property [semiMajorAxis] The length of the ellipse's semi-major axis in meters.
* @property [semiMinorAxis] The length of the ellipse's semi-minor axis in meters.
* @property [ellipsoid] The ellipsoid the ellipse will be on.
* Default value - [Ellipsoid.WGS84]
* @property [height] The distance in meters between the ellipse and the ellipsoid surface.
* Default value - `0.0`
* @property [extrudedHeight] The distance in meters between the ellipse's extruded face and the ellipsoid surface.
* @property [rotation] The angle from north (counter-clockwise) in radians.
* Default value - `0.0`
* @property [granularity] The angular distance between points on the ellipse in radians.
* Default value - `0.02`
* @property [numberOfVerticalLines] Number of lines to draw between the top and bottom surface of an extruded ellipse.
* Default value - `16`
*/
interface ConstructorOptions {
var center: Cartesian3
var semiMajorAxis: Double
var semiMinorAxis: Double
var ellipsoid: Ellipsoid?
var height: Double?
var extrudedHeight: Double?
var rotation: Double?
var granularity: Double?
var numberOfVerticalLines: Int?
}
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: EllipseOutlineGeometry,
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 EllipseOutlineGeometry instance if one was not provided.
* @see Online Documentation
*/
override fun unpack(
array: Array,
startingIndex: Int?,
result: EllipseOutlineGeometry?,
): EllipseOutlineGeometry
/**
* Computes the geometric representation of an outline of an ellipse on an ellipsoid, including its vertices, indices, and a bounding sphere.
* @param [ellipseGeometry] A description of the ellipse.
* @return The computed vertices and indices.
* @see Online Documentation
*/
fun createGeometry(ellipseGeometry: EllipseOutlineGeometry): Geometry?
}
}