A description of the outline of a cylinder.
Name | Type | Description | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object |
Object with the following properties:
|
Throws:
-
DeveloperError : options.length must be greater than 0.
-
DeveloperError : options.topRadius must be greater than 0.
-
DeveloperError : options.bottomRadius must be greater than 0.
-
DeveloperError : bottomRadius and topRadius cannot both equal 0.
-
DeveloperError : options.slices must be greater than or equal to 3.
Example:
// create cylinder geometry
const cylinder = new Cesium.CylinderOutlineGeometry({
length: 200000,
topRadius: 80000,
bottomRadius: 200000,
});
const geometry = Cesium.CylinderOutlineGeometry.createGeometry(cylinder);
See:
Members
The number of elements used to pack the object into an array.
Methods
static Cesium.CylinderOutlineGeometry.createGeometry(cylinderGeometry) → Geometry|undefined
Computes the geometric representation of an outline of a cylinder, including its vertices, indices, and a bounding sphere.
Name | Type | Description |
---|---|---|
cylinderGeometry |
CylinderOutlineGeometry | A description of the cylinder outline. |
Returns:
The computed vertices and indices.
Stores the provided instance into the provided array.
Name | Type | Default | Description |
---|---|---|---|
value |
CylinderOutlineGeometry | The value to pack. | |
array |
Array.<Number> | The array to pack into. | |
startingIndex |
Number |
0
|
optional The index into the array at which to start packing the elements. |
Returns:
The array that was packed into
static Cesium.CylinderOutlineGeometry.unpack(array, startingIndex, result) → CylinderOutlineGeometry
Retrieves an instance from a packed array.
Name | Type | Default | Description |
---|---|---|---|
array |
Array.<Number> | The packed array. | |
startingIndex |
Number |
0
|
optional The starting index of the element to be unpacked. |
result |
CylinderOutlineGeometry | optional The object into which to store the result. |
Returns:
The modified result parameter or a new CylinderOutlineGeometry instance if one was not provided.