CorridorOutlineGeometry - Cesium Documentation

# CorridorOutlineGeometry

#### new CorridorOutlineGeometry(options)

  A description of a corridor outline.

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

  `options`

  Object

  Object with the following properties:

  Name | Type | Default | Description
  --- | --- | --- | ---
  `positions` | Array.<Cartesian3> |  | An array of positions that define the center of the corridor outline.
  `width` | Number |  | The distance between the edges of the corridor outline.
  `ellipsoid` | Ellipsoid | `Ellipsoid.WGS84` | optional The ellipsoid to be used as a reference.
  `granularity` | Number | `CesiumMath.RADIANS_PER_DEGREE` | optional The distance, in radians, between each latitude and longitude. Determines the number of positions in the buffer.
  `height` | Number | `0` | optional The distance between the ellipsoid surface and the positions.
  `extrudedHeight` | Number |  | optional The distance between the ellipsoid surface and the extrusion.
  `cornerType` | CornerType | `CornerType.ROUNDED` | optional Determines the style of the corners.

  ##### Example:

      var corridor = new Cesium.CorridorOutlineGeometry({
        positions : Cesium.Cartesian3.fromDegreesArray([-72.0, 40.0, -70.0, 35.0]),
        width : 100000
      });

  ##### Demo:

  - Cesium Sandcastle Corridor Outline Demo

  ##### See:

  - CorridorOutlineGeometry.createGeometry
  Source: Core/CorridorOutlineGeometry.js, line 328

### Members

#### packedLength :Number

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

### Methods

#### staticCorridorOutlineGeometry.createGeometry(corridorOutlineGeometry) → Geometry|undefined

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

  Name | Type | Description
  --- | --- | ---
  `corridorOutlineGeometry` | CorridorOutlineGeometry | A description of the corridor.

  ##### Returns:

  The computed vertices and indices.
  Source: Core/CorridorOutlineGeometry.js, line 466

#### staticCorridorOutlineGeometry.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/CorridorOutlineGeometry.js, line 366

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

  Source: Core/CorridorOutlineGeometry.js, line 414