Class: PolylineGeometry

PolylineGeometry

new PolylineGeometry(options)

A description of a polyline modeled as a line strip; the first two positions define a line segment, and each additional position defines a line segment from the previous position. The polyline is capable of displaying with a material.
Parameters:
Name Type Description
options Object Object with the following properties:
Properties
Name Type Attributes Default Description
positions Array.<Cartesian3> An array of Cartesian3 defining the positions in the polyline as a line strip.
width Number <optional>
 1.0 The width in pixels.
colors Array.<Color> <optional>
 An Array of Color defining the per vertex or per segment colors.
colorsPerVertex Boolean <optional>
 false A boolean that determines whether the colors will be flat across each segment of the line or interpolated across the vertices.
followSurface Boolean <optional>
 true A boolean that determines whether positions will be adjusted to the surface of the ellipsoid via a great arc.
granularity Number <optional>
 CesiumMath.RADIANS_PER_DEGREE The distance, in radians, between each latitude and longitude if options.followSurface=true. Determines the number of positions in the buffer.
vertexFormat VertexFormat <optional>
 VertexFormat.DEFAULT The vertex attributes to be computed.
ellipsoid Ellipsoid <optional>
 Ellipsoid.WGS84 The ellipsoid to be used as a reference.
Source:
See:
  • PolylineGeometry#createGeometry
Throws:
Example
// A polyline with two connected line segments
var polyline = new Cesium.PolylineGeometry({
  positions : Cesium.Cartesian3.fromDegreesArray([
    0.0, 0.0,
    5.0, 0.0,
    5.0, 5.0
  ]),
  width : 10.0
});
var geometry = Cesium.PolylineGeometry.createGeometry(polyline);

Members

packedLength :Number

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

Methods

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

Computes the geometric representation of a polyline, including its vertices, indices, and a bounding sphere.
Parameters:
Name Type Description
polylineGeometry PolylineGeometry A description of the polyline.
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 PolylineGeometry 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) → {PolylineGeometry}

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