CylinderOutlineGeometry - Cesium Documentation

# CylinderOutlineGeometry

#### new CylinderOutlineGeometry(options)

  A description of the outline 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.
  `numberOfVerticalLines` | Number | `16` | optional Number of lines to draw between the top and bottom surfaces of the cylinder.

  ##### 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.CylinderOutlineGeometry({
          length: 200000,
          topRadius: 80000,
          bottomRadius: 200000,
      });
      var geometry = Cesium.CylinderOutlineGeometry.createGeometry(cylinder);

  ##### Demo:

  - Cesium Sandcastle Cylinder Outline Demo

  ##### See:

  - CylinderOutlineGeometry.createGeometry
  Source: Core/CylinderOutlineGeometry.js, line 66

### Members

#### staticCylinderOutlineGeometry.packedLength :Number

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

### Methods

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

  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.
  Source: Core/CylinderOutlineGeometry.js, line 188

#### staticCylinderOutlineGeometry.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/CylinderOutlineGeometry.js, line 115

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

  Source: Core/CylinderOutlineGeometry.js, line 149