new Cesium.CoplanarPolygonOutlineGeometry(options)

A description of the outline of a polygon composed of arbitrary coplanar positions.
Name Type Description
options object Object with the following properties:
Name Type Description
polygonHierarchy PolygonHierarchy A polygon hierarchy that can include holes.
const polygonOutline = new Cesium.CoplanarPolygonOutlineGeometry({
  positions : Cesium.Cartesian3.fromDegreesArrayHeights([
     -90.0, 30.0, 0.0,
     -90.0, 30.0, 1000.0,
     -80.0, 30.0, 1000.0,
     -80.0, 30.0, 0.0
const geometry = Cesium.CoplanarPolygonOutlineGeometry.createGeometry(polygonOutline);


The number of elements used to pack the object into an array.


static Cesium.CoplanarPolygonOutlineGeometry.createGeometry(polygonGeometry)Geometry|undefined

Computes the geometric representation of an arbitrary coplanar polygon, including its vertices, indices, and a bounding sphere.
Name Type Description
polygonGeometry CoplanarPolygonOutlineGeometry A description of the polygon.
The computed vertices and indices.

static Cesium.CoplanarPolygonOutlineGeometry.fromPositions(options)CoplanarPolygonOutlineGeometry

A description of a coplanar polygon outline from an array of positions.
Name Type Description
options object Object with the following properties:
Name Type Description
positions Array.<Cartesian3> An array of positions that defined the corner points of the polygon.

static Cesium.CoplanarPolygonOutlineGeometry.pack(value, array, startingIndex)Array.<number>

Stores the provided instance into the provided array.
Name Type Default Description
value CoplanarPolygonOutlineGeometry 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.
The array that was packed into

static Cesium.CoplanarPolygonOutlineGeometry.unpack(array, startingIndex, result)CoplanarPolygonOutlineGeometry

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 CoplanarPolygonOutlineGeometry optional The object into which to store the result.
The modified result parameter or a new CoplanarPolygonOutlineGeometry instance if one was not provided.
Need help? The fastest way to get answers is from the community and team on the Cesium Forum.