Class: PolygonGeometry

PolygonGeometry

new PolygonGeometry(options)

A description of a polygon on the ellipsoid. The polygon is defined by a polygon hierarchy. Polygon geometry can be rendered with both Primitive and GroundPrimitive.
Parameters:
Name Type Description
options Object Object with the following properties:
Properties
Name Type Attributes Default Description
polygonHierarchy PolygonHierarchy A polygon hierarchy that can include holes.
height Number <optional>
 0.0 The distance in meters between the polygon and the ellipsoid surface.
extrudedHeight Number <optional>
 The distance in meters between the polygon's extruded face and the ellipsoid surface.
vertexFormat VertexFormat <optional>
 VertexFormat.DEFAULT The vertex attributes to be computed.
stRotation Number <optional>
 0.0 The rotation of the texture coordinates, in radians. A positive rotation is counter-clockwise.
ellipsoid Ellipsoid <optional>
 Ellipsoid.WGS84 The ellipsoid to be used as a reference.
granularity Number <optional>
 CesiumMath.RADIANS_PER_DEGREE The distance, in radians, between each latitude and longitude. Determines the number of positions in the buffer.
perPositionHeight Boolean <optional>
 false Use the height of options.positions for each position instead of using options.height to determine the height.
closeTop Boolean <optional>
 true When false, leaves off the top of an extruded polygon open.
closeBottom Boolean <optional>
 true When false, leaves off the bottom of an extruded polygon open.
Source:
See:
  • PolygonGeometry#createGeometry
  • PolygonGeometry#fromPositions
Example
// 1. create a polygon from points
var polygon = new Cesium.PolygonGeometry({
  polygonHierarchy : new Cesium.PolygonHierarchy(
    Cesium.Cartesian3.fromDegreesArray([
      -72.0, 40.0,
      -70.0, 35.0,
      -75.0, 30.0,
      -70.0, 30.0,
      -68.0, 40.0
    ])
  )
});
var geometry = Cesium.PolygonGeometry.createGeometry(polygon);

// 2. create a nested polygon with holes
var polygonWithHole = new Cesium.PolygonGeometry({
  polygonHierarchy : new Cesium.PolygonHierarchy(
    Cesium.Cartesian3.fromDegreesArray([
      -109.0, 30.0,
      -95.0, 30.0,
      -95.0, 40.0,
      -109.0, 40.0
    ]),
    [new Cesium.PolygonHierarchy(
      Cesium.Cartesian3.fromDegreesArray([
        -107.0, 31.0,
        -107.0, 39.0,
        -97.0, 39.0,
        -97.0, 31.0
      ]),
      [new Cesium.PolygonHierarchy(
        Cesium.Cartesian3.fromDegreesArray([
          -105.0, 33.0,
          -99.0, 33.0,
          -99.0, 37.0,
          -105.0, 37.0
        ]),
        [new Cesium.PolygonHierarchy(
          Cesium.Cartesian3.fromDegreesArray([
            -103.0, 34.0,
            -101.0, 34.0,
            -101.0, 36.0,
            -103.0, 36.0
          ])
        )]
      )]
    )]
  )
});
var geometry = Cesium.PolygonGeometry.createGeometry(polygonWithHole);

// 3. create extruded polygon
var extrudedPolygon = new Cesium.PolygonGeometry({
  polygonHierarchy : new Cesium.PolygonHierarchy(
    Cesium.Cartesian3.fromDegreesArray([
      -72.0, 40.0,
      -70.0, 35.0,
      -75.0, 30.0,
      -70.0, 30.0,
      -68.0, 40.0
    ])
  ),
  extrudedHeight: 300000
});
var geometry = Cesium.PolygonGeometry.createGeometry(extrudedPolygon);

Members

packedLength :Number

The number of elements used to pack the object into an array.
Type:
  • Number
Source:

Methods

(static) createGeometry(polygonGeometry) → {Geometry|undefined}

Computes the geometric representation of a polygon, including its vertices, indices, and a bounding sphere.
Parameters:
Name Type Description
polygonGeometry PolygonGeometry A description of the polygon.
Source:
Returns:
The computed vertices and indices.
Type
Geometry | undefined

(static) fromPositions(options) → {PolygonGeometry}

A description of a polygon from an array of positions. Polygon geometry can be rendered with both Primitive and GroundPrimitive.
Parameters:
Name Type Description
options Object Object with the following properties:
Properties
Name Type Attributes Default Description
positions Array.<Cartesian3> An array of positions that defined the corner points of the polygon.
height Number <optional>
 0.0 The height of the polygon.
extrudedHeight Number <optional>
 The height of the polygon extrusion.
vertexFormat VertexFormat <optional>
 VertexFormat.DEFAULT The vertex attributes to be computed.
stRotation Number <optional>
 0.0 The rotation of the texture coordiantes, in radians. A positive rotation is counter-clockwise.
ellipsoid Ellipsoid <optional>
 Ellipsoid.WGS84 The ellipsoid to be used as a reference.
granularity Number <optional>
 CesiumMath.RADIANS_PER_DEGREE The distance, in radians, between each latitude and longitude. Determines the number of positions in the buffer.
perPositionHeight Boolean <optional>
 false Use the height of options.positions for each position instead of using options.height to determine the height.
closeTop Boolean <optional>
 true When false, leaves off the top of an extruded polygon open.
closeBottom Boolean <optional>
 true When false, leaves off the bottom of an extruded polygon open.
Source:
See:
  • PolygonGeometry#createGeometry
Returns:
Type
PolygonGeometry
Example
// create a polygon from points
var polygon = Cesium.PolygonGeometry.fromPositions({
  positions : Cesium.Cartesian3.fromDegreesArray([
    -72.0, 40.0,
    -70.0, 35.0,
    -75.0, 30.0,
    -70.0, 30.0,
    -68.0, 40.0
  ])
});
var geometry = Cesium.PolygonGeometry.createGeometry(polygon);

(static) pack(value, array, startingIndexopt) → {Array.<Number>}

Stores the provided instance into the provided array.
Parameters:
Name Type Attributes Default Description
value PolygonGeometry The value to pack.
array Array.<Number> The array to pack into.
startingIndex Number <optional>
 0 The index into the array at which to start packing the elements.
Source:
Returns:
The array that was packed into
Type
Array.<Number>

(static) unpack(array, startingIndexopt, resultopt)

Retrieves an instance from a packed array.
Parameters:
Name Type Attributes Default Description
array Array.<Number> The packed array.
startingIndex Number <optional>
 0 The starting index of the element to be unpacked.
result PolygonGeometry <optional>
 The object into which to store the result.
Source: