org.cesiumjs.cs.collections

Class LabelCollection

java.lang.Object

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

org.cesiumjs.cs.collections.LabelCollection

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

Author:

Serge Silaev aka iSergio

Field Summary

Fields

Modifier and Type	Field and Description
Number	blendOption The billboard blending option.
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 label in this collection from model to world coordinates.

Constructor Summary

Constructors

Constructor and Description
LabelCollection()
LabelCollection(LabelCollectionOptions options)

Method Summary

Modifier and Type	Method and Description
Label	add(LabelOptions options) Creates and adds a label 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

blendOption

@JsProperty
public Number blendOption

The billboard blending option. The default is used for rendering both opaque and translucent billboards. However, if either all of the billboards are completely opaque or all are completely translucent, setting the technique to BillboardRenderTechnique.OPAQUE or BillboardRenderTechnique.TRANSLUCENT can improve performance by up to 2x. Default: BlendOption.OPAQUE_AND_TRANSLUCENT()

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 label in this collection from model to world coordinates. When this is the identity matrix, the labels 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: Matrix4.IDENTITY()

Constructor Detail

LabelCollection

@JsConstructor
public LabelCollection()

LabelCollection

@JsConstructor
public LabelCollection(LabelCollectionOptions options)

Method Detail

add

@JsMethod
public Label add(LabelOptions options)

Creates and adds a label with the specified initial properties to the collection. The added label is returned so it can be modified or removed from the collection later. Calling add is expected constant time. However, the collection's vertex buffer is rewritten; this operations is O(n) and also incurs CPU to GPU overhead. For best performance, add as many billboards as possible before calling update.

Parameters:

options - A template describing the label's properties.

Returns:

The label that was added to the collection.

See Also:

Collection.remove(T), Collection.removeAll()