org.cesiumjs.cs.collections

Class BillboardCollection

java.lang.Object

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

org.cesiumjs.cs.collections.BillboardCollection

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

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 billboard in this collection from model to world coordinates.

Constructor Summary

Constructors

Constructor and Description
BillboardCollection() A renderable collection of billboards.
BillboardCollection(BillboardCollectionOptions options) A renderable collection of billboards.

Method Summary

Modifier and Type	Method and Description
Billboard	add(BillboardOptions billboard) Creates and adds a billboard with the specified initial properties to the collection.
static BillboardCollection	create(Scene scene) Create collection of Billboard with Scene option

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 billboard in this collection from model to world coordinates. When this is the identity matrix, the billboards 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()

See Also:

Transforms.eastNorthUpToFixedFrame(org.cesiumjs.cs.core.Cartesian3)

Constructor Detail

BillboardCollection

@JsConstructor
public BillboardCollection()

A renderable collection of billboards. Billboards are viewport-aligned images positioned in the 3D scene. Billboards are added and removed from the collection using add(org.cesiumjs.cs.scene.options.BillboardOptions) and Collection.remove(T). Billboards in a collection automatically share textures for images with the same identifier. Performance: For best performance, prefer a few collections, each with many billboards, to many collections with only a few billboards each. Organize collections so that billboards with the same update frequency are in the same collection, i.e., billboards that do not change should be in one collection; billboards that change every frame should be in another collection; and so on.

See Also:

add(org.cesiumjs.cs.scene.options.BillboardOptions), Collection.remove(T), Billboard, LabelCollection

BillboardCollection

@JsConstructor
public BillboardCollection(BillboardCollectionOptions options)

A renderable collection of billboards. Billboards are viewport-aligned images positioned in the 3D scene. Billboards are added and removed from the collection using add(org.cesiumjs.cs.scene.options.BillboardOptions) and Collection.remove(T). Billboards in a collection automatically share textures for images with the same identifier. Performance: For best performance, prefer a few collections, each with many billboards, to many collections with only a few billboards each. Organize collections so that billboards with the same update frequency are in the same collection, i.e., billboards that do not change should be in one collection; billboards that change every frame should be in another collection; and so on.

Parameters:

options - Options

See Also:

add(org.cesiumjs.cs.scene.options.BillboardOptions), Collection.remove(T), Billboard, LabelCollection

Method Detail

create

@JsOverlay
public static BillboardCollection create(Scene scene)

Create collection of Billboard with Scene option

Parameters:

scene - current Scene

Returns:

BillboardCollection

add

@JsMethod
public Billboard add(BillboardOptions billboard)

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

Parameters:

billboard - Options

Returns:

The billboard that was added to the collection.

See Also:

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