PolylineCollection

new Cesium.PolylineCollection(options)
Scene/PolylineCollection.js 159

A renderable collection of polylines.


Example polylines


Polylines are added and removed from the collection using PolylineCollection#add and PolylineCollection#remove.
Performance:

For best performance, prefer a few collections, each with many polylines, to many collections with only a few polylines each. Organize collections so that polylines with the same update frequency are in the same collection, i.e., polylines that do not change should be in one collection; polylines that change every frame should be in another collection; and so on.

Name Type Description
options Object optional Object with the following properties:
Name Type Default Description
modelMatrix Matrix4 Matrix4.IDENTITY optional The 4x4 transformation matrix that transforms each polyline from model to world coordinates.
debugShowBoundingVolume Boolean false optional For debugging only. Determines if this primitive's commands' bounding spheres are shown.
Example:
// Create a polyline collection with two polylines
var polylines = new Cesium.PolylineCollection();
polylines.add({
  positions : Cesium.Cartesian3.fromDegreesArray([
    -75.10, 39.57,
    -77.02, 38.53,
    -80.50, 35.14,
    -80.12, 25.46]),
  width : 2
});

polylines.add({
  positions : Cesium.Cartesian3.fromDegreesArray([
    -73.10, 37.57,
    -75.02, 36.53,
    -78.50, 33.14,
    -78.12, 23.46]),
  width : 4
});
See:

Members

debugShowBoundingVolume : Boolean
Scene/PolylineCollection.js 184

This property is for debugging only; it is not for production use nor is it optimized.

Draws the bounding sphere for each draw command in the primitive.

Default Value: false

length : Number
Scene/PolylineCollection.js 231

Returns the number of polylines in this collection. This is commonly used with PolylineCollection#get to iterate over all the polylines in the collection.

modelMatrix : Matrix4
Scene/PolylineCollection.js 171

The 4x4 transformation matrix that transforms each polyline in this collection from model to world coordinates. When this is the identity matrix, the polylines are drawn in world coordinates, i.e., Earth's WGS84 coordinates. Local reference frames can be used by providing a different transformation matrix, like that returned by Transforms.eastNorthUpToFixedFrame.
Default Value: Matrix4.IDENTITY

Methods

add(options) → Polyline
Scene/PolylineCollection.js 267

Creates and adds a polyline with the specified initial properties to the collection. The added polyline is returned so it can be modified or removed from the collection later.
Performance:

After calling add, PolylineCollection#update is called and the collection's vertex buffer is rewritten - an O(n) operation that also incurs CPU to GPU overhead. For best performance, add as many polylines as possible before calling update.

Name Type Description
options Object optional A template describing the polyline's properties as shown in Example 1.
Returns:
The polyline that was added to the collection.
Throws:
  • DeveloperError : This object was destroyed, i.e., destroy() was called.
Example:
// Example 1:  Add a polyline, specifying all the default values.
var p = polylines.add({
  show : true,
  positions : ellipsoid.cartographicArrayToCartesianArray([
           Cesium.Cartographic.fromDegrees(-75.10, 39.57),
           Cesium.Cartographic.fromDegrees(-77.02, 38.53)]),
  width : 1
});
See:

contains(polyline) → Boolean
Scene/PolylineCollection.js 359

Determines if this collection contains the specified polyline.
Name Type Description
polyline Polyline The polyline to check for.
Returns:
true if this collection contains the polyline, false otherwise.
See:

destroy()
Scene/PolylineCollection.js 761

Destroys the WebGL resources held by this object. Destroying an object allows for deterministic release of WebGL resources, instead of relying on the garbage collector to destroy this object.

Once an object is destroyed, it should not be used; calling any function other than isDestroyed will result in a DeveloperError exception. Therefore, assign the return value (undefined) to the object as done in the example.
Throws:
  • DeveloperError : This object was destroyed, i.e., destroy() was called.
Example:
polylines = polylines && polylines.destroy();
See:

get(index) → Polyline
Scene/PolylineCollection.js 389

Returns the polyline in the collection at the specified index. Indices are zero-based and increase as polylines are added. Removing a polyline shifts all polylines after it to the left, changing their indices. This function is commonly used with PolylineCollection#length to iterate over all the polylines in the collection.
Performance:

If polylines were removed from the collection and PolylineCollection#update was not called, an implicit O(n) operation is performed.

Name Type Description
index Number The zero-based index of the polyline.
Returns:
The polyline at the specified index.
Throws:
  • DeveloperError : This object was destroyed, i.e., destroy() was called.
Example:
// Toggle the show property of every polyline in the collection
var len = polylines.length;
for (var i = 0; i < len; ++i) {
  var p = polylines.get(i);
  p.show = !p.show;
}
See:

isDestroyed() → Boolean
Scene/PolylineCollection.js 741

Returns true if this object was destroyed; otherwise, false.

If this object was destroyed, it should not be used; calling any function other than isDestroyed will result in a DeveloperError exception.
Returns:
true if this object was destroyed; otherwise, false.
See:

remove(polyline) → Boolean
Scene/PolylineCollection.js 300

Removes a polyline from the collection.
Performance:

After calling remove, PolylineCollection#update is called and the collection's vertex buffer is rewritten - an O(n) operation that also incurs CPU to GPU overhead. For best performance, remove as many polylines as possible before calling update. If you intend to temporarily hide a polyline, it is usually more efficient to call Polyline#show instead of removing and re-adding the polyline.

Name Type Description
polyline Polyline The polyline to remove.
Returns:
true if the polyline was removed; false if the polyline was not found in the collection.
Throws:
  • DeveloperError : This object was destroyed, i.e., destroy() was called.
Example:
var p = polylines.add(...);
polylines.remove(p);  // Returns true
See:

removeAll()
Scene/PolylineCollection.js 341

Removes all polylines from the collection.
Performance:

O(n). It is more efficient to remove all the polylines from a collection and then add new ones than to create a new collection entirely.

Throws:
  • DeveloperError : This object was destroyed, i.e., destroy() was called.
Example:
polylines.add(...);
polylines.add(...);
polylines.removeAll();
See:

update()
Scene/PolylineCollection.js 445

Called when Viewer or CesiumWidget render the scene to get the draw commands needed to render this primitive.

Do not call this function directly. This is documented just to list the exceptions that may be propagated when the scene is rendered:

Throws:
  • RuntimeError : Vertex texture fetch support is required to render primitives with per-instance attributes. The maximum number of vertex texture image units must be greater than zero.