CircleOutlineGeometry - Cesium Documentation

# CircleOutlineGeometry

#### new CircleOutlineGeometry(options)

  A description of the outline of a circle on the ellipsoid.

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

  `options`

  Object

  Object with the following properties:

  Name | Type | Default | Description
  --- | --- | --- | ---
  `center` | Cartesian3 |  | The circle's center point in the fixed frame.
  `radius` | Number |  | The radius in meters.
  `ellipsoid` | Ellipsoid | `Ellipsoid.WGS84` | optional The ellipsoid the circle will be on.
  `height` | Number | `0.0` | optional The height above the ellipsoid.
  `granularity` | Number | `0.02` | optional The angular distance between points on the circle in radians.
  `extrudedHeight` | Number | `0.0` | optional The height of the extrusion relative to the ellipsoid.
  `numberOfVerticalLines` | Number | `16` | optional Number of lines to draw between the top and bottom of an extruded circle.

  ##### Throws:

  - DeveloperError : radius must be greater than zero.
  - DeveloperError : granularity must be greater than zero.

  ##### Example:

      // Create a circle.
      var circle = new Cesium.CircleOutlineGeometry({
        center : Cesium.Cartesian3.fromDegrees(-75.59777, 40.03883),
        radius : 100000.0
      });
      var geometry = Cesium.CircleOutlineGeometry.createGeometry(circle);

  ##### Demo:

  - Cesium Sandcastle Circle Outline Demo

  ##### See:

  - CircleOutlineGeometry.createGeometry
  - Packable
  Source: Core/CircleOutlineGeometry.js, line 49

### Members

#### staticCircleOutlineGeometry.packedLength :Number

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

### Methods

#### staticCircleOutlineGeometry.createGeometry(circleGeometry) → Geometry

  Computes the geometric representation of an outline of a circle on an ellipsoid, including its vertices, indices, and a bounding sphere.

  Name | Type | Description
  --- | --- | ---
  `circleGeometry` | CircleOutlineGeometry | A description of the circle.

  ##### Returns:

  The computed vertices and indices.
  Source: Core/CircleOutlineGeometry.js, line 149

#### staticCircleOutlineGeometry.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/CircleOutlineGeometry.js, line 90

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

  Source: Core/CircleOutlineGeometry.js, line 123