org.cesiumjs.cs.collections

Class PolylineCollection

java.lang.Object

org.cesiumjs.cs.collections.Collection<Polyline>

org.cesiumjs.cs.collections.PolylineCollection

@JsType(isNative=true,
        namespace="Cesium",
        name="PolylineCollection")
public class PolylineCollection
extends Collection<Polyline>

Author:

Serge Silaev aka iSergio

Field Summary

Fields

Modifier and Type	Field and Description
boolean	debugShowBoundingVolume This property is for debugging only; it is not for production use nor is it optimized.
Matrix4	modelMatrix The 4x4 transformation matrix that transforms each polyline in this collection from model to world coordinates.

Constructor Summary

Constructors

Constructor and Description
PolylineCollection() A renderable collection of polylines.
PolylineCollection(PolylineCollectionOptions options) A renderable collection of polylines.

Method Summary

Modifier and Type	Method and Description
Polyline	add(PolylineOptions polylineOptions) Creates and adds a polyline with the specified initial properties to the collection.

Methods inherited from class org.cesiumjs.cs.collections.Collection

add, add, contains, destroy, get, isDestroyed, length, remove, remove, removeAll, update

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

debugShowBoundingVolume

@JsProperty
public boolean debugShowBoundingVolume

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: false

modelMatrix

@JsProperty
public Matrix4 modelMatrix

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(org.cesiumjs.cs.core.Cartesian3). Default: Matrix4.IDENTITY()

Constructor Detail

PolylineCollection

@JsConstructor
public PolylineCollection()

A renderable collection of polylines. Polylines are added and removed from the collection using add(org.cesiumjs.cs.scene.options.PolylineOptions) and Collection.remove(T). 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.

PolylineCollection

@JsConstructor
public PolylineCollection(PolylineCollectionOptions options)

A renderable collection of polylines. Polylines are added and removed from the collection using add(org.cesiumjs.cs.scene.options.PolylineOptions) and Collection.remove(T). 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.

Parameters:

options - PolylineCollectionOptions

Method Detail

add

@JsMethod
public Polyline add(PolylineOptions polylineOptions)

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, Collection.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.

Parameters:

polylineOptions - PolylineOptions

Returns:

The polyline that was added to the collection.