CylinderGeometry - Cesium Documentation

# CylinderGeometry

#### new CylinderGeometry(options)

  A description of a cylinder.

  Name | Type | Description
  --- | --- | ---

  `options`

  Object

  Object with the following properties:

  Name | Type | Default | Description
  --- | --- | --- | ---
  `length` | Number |  | The length of the cylinder.
  `topRadius` | Number |  | The radius of the top of the cylinder.
  `bottomRadius` | Number |  | The radius of the bottom of the cylinder.
  `slices` | Number | `128` | optional The number of edges around perimeter of the cylinder.
  `vertexFormat` | VertexFormat | `VertexFormat.DEFAULT` | optional The vertex attributes to be computed.

  ##### 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 that 3.

  ##### Example:

      // create cylinder geometry
      var cylinder = new Cesium.CylinderGeometry({
          length: 200000,
          topRadius: 80000,
          bottomRadius: 200000,
      });
      var geometry = Cesium.CylinderGeometry.createGeometry(cylinder);

  ##### Demo:

  - Cesium Sandcastle Cylinder Demo

  ##### See:

  - CylinderGeometry.createGeometry
  Source: Core/CylinderGeometry.js, line 75

### Members

#### staticCylinderGeometry.packedLength :Number

  The number of elements used to pack the object into an array.
  Source: Core/CylinderGeometry.js, line 114

### Methods

#### staticCylinderGeometry.createGeometry(cylinderGeometry) → Geometry

  Computes the geometric representation of a cylinder, including its vertices, indices, and a bounding sphere.

  Name | Type | Description
  --- | --- | ---
  `cylinderGeometry` | CylinderGeometry | A description of the cylinder.

  ##### Returns:

  The computed vertices and indices.
  Source: Core/CylinderGeometry.js, line 201

#### staticCylinderGeometry.pack(value, array, startingIndex)

  Stores the provided instance into the provided array.

  Name | Type | Default | Description
  --- | --- | --- | ---
  `value` | Object |  | 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.

  Source: Core/CylinderGeometry.js, line 124

#### staticCylinderGeometry.unpack(array, startingIndex, result)

  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` | CylinderGeometry |  | optional The object into which to store the result.

  Source: Core/CylinderGeometry.js, line 161