EllipsoidGeometry - Cesium Documentation

# EllipsoidGeometry

#### new EllipsoidGeometry(options)

  A description of an ellipsoid centered at the origin.

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

  `options`

  Object

  optional Object with the following properties:

  Name | Type | Default | Description
  --- | --- | --- | ---
  `radii` | Cartesian3 | `Cartesian3(1.0, 1.0, 1.0)` | optional The radii of the ellipsoid in the x, y, and z directions.
  `stackPartitions` | Number | `64` | optional The number of times to partition the ellipsoid into stacks.
  `slicePartitions` | Number | `64` | optional The number of times to partition the ellipsoid into radial slices.
  `vertexFormat` | VertexFormat | `VertexFormat.DEFAULT` | optional The vertex attributes to be computed.

  ##### Throws:

  - DeveloperError : options.slicePartitions cannot be less than three.
  - DeveloperError : options.stackPartitions cannot be less than three.

  ##### Example:

      var ellipsoid = new Cesium.EllipsoidGeometry({
        vertexFormat : Cesium.VertexFormat.POSITION_ONLY,
        radii : new Cesium.Cartesian3(1000000.0, 500000.0, 500000.0)
      });
      var geometry = Cesium.EllipsoidGeometry.createGeometry(ellipsoid);

  ##### Demo:

  - Cesium Sandcastle Ellipsoid Demo

  ##### See:

  - EllipsoidGeometry#createGeometry
  Source: Core/EllipsoidGeometry.js, line 72

### Members

#### staticEllipsoidGeometry.packedLength :Number

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

### Methods

#### staticEllipsoidGeometry.createGeometry(ellipsoidGeometry) → Geometry

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

  Name | Type | Description
  --- | --- | ---
  `ellipsoidGeometry` | EllipsoidGeometry | A description of the ellipsoid.

  ##### Returns:

  The computed vertices and indices.
  Source: Core/EllipsoidGeometry.js, line 186

#### staticEllipsoidGeometry.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/EllipsoidGeometry.js, line 110

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

  Source: Core/EllipsoidGeometry.js, line 148