EllipseGeometry - Cesium Documentation

# EllipseGeometry

#### new EllipseGeometry(options)

  A description of an ellipse on an ellipsoid.

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

  `options`

  Object

  Object with the following properties:

  Name | Type | Default | Description
  --- | --- | --- | ---
  `center` | Cartesian3 |  | The ellipse's center point in the fixed frame.
  `semiMajorAxis` | Number |  | The length of the ellipse's semi-major axis in meters.
  `semiMinorAxis` | Number |  | The length of the ellipse's semi-minor axis in meters.
  `ellipsoid` | Ellipsoid | `Ellipsoid.WGS84` | optional The ellipsoid the ellipse will be on.
  `height` | Number | `0.0` | optional The height above the ellipsoid.
  `extrudedHeight` | Number |  | optional The height of the extrusion.
  `rotation` | Number | `0.0` | optional The angle of rotation counter-clockwise from north.
  `stRotation` | Number | `0.0` | optional The rotation of the texture coordinates counter-clockwise from north.
  `granularity` | Number | `CesiumMath.RADIANS_PER_DEGREE` | optional The angular distance between points on the ellipse in radians.
  `vertexFormat` | VertexFormat | `VertexFormat.DEFAULT` | optional The vertex attributes to be computed.

  ##### Throws:

  - DeveloperError : semiMajorAxis and semiMinorAxis must be greater than zero.
  - DeveloperError : semiMajorAxis must be larger than the semiMinorAxis.
  - DeveloperError : granularity must be greater than zero.

  ##### Example:

      // Create an ellipse.
      var ellipse = new Cesium.EllipseGeometry({
        center : Cesium.Cartesian3.fromDegrees(-75.59777, 40.03883),
        semiMajorAxis : 500000.0,
        semiMinorAxis : 300000.0,
        rotation : Cesium.Math.toRadians(60.0)
      });
      var geometry = Cesium.EllipseGeometry.createGeometry(ellipse);

  ##### See:

  - EllipseGeometry.createGeometry
  Source: Core/EllipseGeometry.js, line 624

### Members

#### staticEllipseGeometry.packedLength :Number

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

### Methods

#### staticEllipseGeometry.createGeometry(ellipseGeometry) → Geometry

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

  Name | Type | Description
  --- | --- | ---
  `ellipseGeometry` | EllipseGeometry | A description of the ellipse.

  ##### Returns:

  The computed vertices and indices.
  Source: Core/EllipseGeometry.js, line 799

#### staticEllipseGeometry.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/EllipseGeometry.js, line 686

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

  Source: Core/EllipseGeometry.js, line 740