A description of the outline of a polygon on the ellipsoid. The polygon is defined by a polygon hierarchy.
Name | Type | Description | ||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object |
Object with the following properties:
|
- PolygonOutlineGeometry#createGeometry
- PolygonOutlineGeometry#fromPositions
Example:
// 1. create a polygon outline from points
const polygon = new Cesium.PolygonOutlineGeometry({
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
])
)
});
const geometry = Cesium.PolygonOutlineGeometry.createGeometry(polygon);
// 2. create a nested polygon with holes outline
const polygonWithHole = new Cesium.PolygonOutlineGeometry({
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
])
)]
)]
)]
)
});
const geometry = Cesium.PolygonOutlineGeometry.createGeometry(polygonWithHole);
// 3. create extruded polygon outline
const extrudedPolygon = new Cesium.PolygonOutlineGeometry({
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
});
const geometry = Cesium.PolygonOutlineGeometry.createGeometry(extrudedPolygon);
See:
Members
The number of elements used to pack the object into an array.
Methods
static Cesium.PolygonOutlineGeometry.createGeometry(polygonGeometry) → Geometry|undefined
Computes the geometric representation of a polygon outline, including its vertices, indices, and a bounding sphere.
Name | Type | Description |
---|---|---|
polygonGeometry |
PolygonOutlineGeometry | A description of the polygon outline. |
Returns:
The computed vertices and indices.
static Cesium.PolygonOutlineGeometry.fromPositions(options) → PolygonOutlineGeometry
A description of a polygon outline from an array of positions.
Name | Type | Description | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object |
Object with the following properties:
|
Returns:
- PolygonOutlineGeometry#createGeometry
Example:
// create a polygon from points
const polygon = Cesium.PolygonOutlineGeometry.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
])
});
const geometry = Cesium.PolygonOutlineGeometry.createGeometry(polygon);
See:
Stores the provided instance into the provided array.
Name | Type | Default | Description |
---|---|---|---|
value |
PolygonOutlineGeometry | 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. |
Returns:
The array that was packed into
static Cesium.PolygonOutlineGeometry.unpack(array, startingIndex, result) → PolygonOutlineGeometry
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 |
PolygonOutlineGeometry | optional The object into which to store the result. |
Returns:
The modified result parameter or a new PolygonOutlineGeometry instance if one was not provided.