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