BufferPolyline

View bound to the underlying buffer data of a BufferPolylineCollection.

BufferPolyline instances are flyweights: a single BufferPolyline instance can be temporarily bound to any conceptual "polyline" in a BufferPolylineCollection, allowing very large collections to be iterated and updated with a minimal memory footprint.

Represented as two (2) or more positions.

new Cesium.BufferPolyline()
engine/Source/Scene/BufferPolyline.js 28

Experimental

This feature is not final and is subject to change without Cesium's standard deprecation policy.

See:

Extends

Members

featureId : number
engine/Source/Scene/BufferPrimitive.js 145

Feature ID associated with the primitive; not required to be unique.
Inherited From:

show : boolean
engine/Source/Scene/BufferPrimitive.js 157

Whether primitive is shown.
Inherited From:

readonly vertexCount : number
engine/Source/Scene/BufferPolyline.js 108

Count of positions (vertices) in this polyline, number of VEC3 elements.

width : number
engine/Source/Scene/BufferPolyline.js 180

Width of polyline, 0–255px.

Methods

static Cesium.BufferPolyline.clone(polyline, result) → BufferPolyline
engine/Source/Scene/BufferPolyline.js 80

Copies data from source polyline to result. If the result polyline is not new (the last polyline in the collection) then source and result polylines must have the same vertex counts.
Name Type Description
polyline BufferPolyline
result BufferPolyline
Returns:

getColor(result) → Color
engine/Source/Scene/BufferPrimitive.js 201

Returns the color of primitive.
Name Type Description
result Color
Returns:
Inherited From:

getPositions(result)
engine/Source/Scene/BufferPolyline.js 121

Returns an array view of this polyline's vertex positions. If 'result' argument is given, vertex positions are written to that array and returned. Otherwise, returns an ArrayView on collection memory — changes to this array will not trigger render updates, which requires `.setPositions()`.
Name Type Description
result TypedArray optional return {TypedArray}

setColor(color)
engine/Source/Scene/BufferPrimitive.js 212

Updates the color of primitive.
Name Type Description
color Color
Inherited From:

setPositions(positions)
engine/Source/Scene/BufferPolyline.js 148

Name Type Description
positions TypedArray

toJSON() → Object
engine/Source/Scene/BufferPolyline.js 199

Returns a JSON-serializable object representing the polyline. This encoding is not memory-efficient, and should generally be used for debugging and testing.
Returns:
JSON-serializable object.
Inherited From:
Need help? The fastest way to get answers is from the community and team on the Cesium Forum.
CtrlK
packages/engine
packages/widgets