Class: PolylineVolumeGeometry

PolylineVolumeGeometry

new PolylineVolumeGeometry(options)

A description of a polyline with a volume (a 2D shape extruded along a polyline).
Parameters:
Name Type Description
options Object Object with the following properties:
Properties
Name Type Attributes Default Description
polylinePositions Array.<Cartesian3> An array of Cartesain3 positions that define the center of the polyline volume.
shapePositions Array.<Cartesian2> An array of Cartesian2 positions that define the shape to be extruded along the polyline
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.
vertexFormat VertexFormat <optional>
VertexFormat.DEFAULT The vertex attributes to be computed.
cornerType CornerType <optional>
CornerType.ROUNDED Determines the style of the corners.
Source:
See:
  • PolylineVolumeGeometry#createGeometry
Example
function computeCircle(radius) {
  var positions = [];
  for (var i = 0; i < 360; i++) {
    var radians = Cesium.Math.toRadians(i);
    positions.push(new Cesium.Cartesian2(radius * Math.cos(radians), radius * Math.sin(radians)));
  }
  return positions;
}

var volume = new Cesium.PolylineVolumeGeometry({
  vertexFormat : Cesium.VertexFormat.POSITION_ONLY,
  polylinePositions : Cesium.Cartesian3.fromDegreesArray([
    -72.0, 40.0,
    -70.0, 35.0
  ]),
  shapePositions : computeCircle(100000.0)
});

Members

packedLength :Number

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

Methods

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

Computes the geometric representation of a polyline with a volume, including its vertices, indices, and a bounding sphere.
Parameters:
Name Type Description
polylineVolumeGeometry PolylineVolumeGeometry A description of the polyline volume.
Source:
Returns:
The computed vertices and indices.
Type
Geometry | undefined

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

Stores the provided instance into the provided array.
Parameters:
Name Type Attributes Default Description
value PolylineVolumeGeometry 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) → {PolylineVolumeGeometry}

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 PolylineVolumeGeometry <optional>
The object into which to store the result.
Source:
Returns:
The modified result parameter or a new PolylineVolumeGeometry instance if one was not provided.
Type
PolylineVolumeGeometry