org.cesiumjs.cs.collections

Class PrimitiveCollection

java.lang.Object

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

org.cesiumjs.cs.collections.PrimitiveCollection

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

Author:

Serge Silaev aka iSergio

Field Summary

Fields

Modifier and Type	Field and Description
boolean	destroyPrimitives Determines if primitives in the collection are destroyed when they are removed by Collection.destroy() or Collection.remove(Object) or implicitly by PrimitiveCollection#removeAll.
boolean	show Determines if primitives in this collection will be shown.

Constructor Summary

Constructors

Constructor and Description
PrimitiveCollection() A collection of primitives.
PrimitiveCollection(PrimitiveCollectionOptions options) A collection of primitives.

Method Summary

Modifier and Type	Method and Description
void	lower(Primitive primitive) Lowers a primitive "down one" in the collection.
void	lowerToBottom(Primitive primitive) Lowers a primitive to the "bottom" of the collection.
void	raise(Primitive primitive) Raises a primitive "up one" in the collection.
void	raiseToTop(Primitive primitive) Raises a primitive to the "top" of 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

destroyPrimitives

@JsProperty
public boolean destroyPrimitives

Determines if primitives in the collection are destroyed when they are removed by Collection.destroy() or Collection.remove(Object) or implicitly by PrimitiveCollection#removeAll. Default: true

show

@JsProperty
public boolean show

Determines if primitives in this collection will be shown. Default: true

Constructor Detail

PrimitiveCollection

@JsConstructor
public PrimitiveCollection()

A collection of primitives. This is most often used with Scene.primitives(), but PrimitiveCollection is also a primitive itself so collections can be added to collections forming a hierarchy.

PrimitiveCollection

@JsConstructor
public PrimitiveCollection(PrimitiveCollectionOptions options)

A collection of primitives. This is most often used with Scene.primitives(), but PrimitiveCollection is also a primitive itself so collections can be added to collections forming a hierarchy.

Parameters:

options - Options.

Method Detail

lower

@JsMethod
public void lower(Primitive primitive)

Lowers a primitive "down one" in the collection. If all primitives in the collection are drawn on the globe surface, this visually moves the primitive down one.

Parameters:

primitive - The primitive to lower.

See Also:

lowerToBottom(org.cesiumjs.cs.scene.Primitive), raise(org.cesiumjs.cs.scene.Primitive), raiseToTop(org.cesiumjs.cs.scene.Primitive)

lowerToBottom

@JsMethod
public void lowerToBottom(Primitive primitive)

Lowers a primitive to the "bottom" of the collection. If all primitives in the collection are drawn on the globe surface, this visually moves the primitive to the bottom.

Parameters:

primitive - The primitive to lower to the bottom.

raise

@JsMethod
public void raise(Primitive primitive)

Raises a primitive "up one" in the collection. If all primitives in the collection are drawn on the globe surface, this visually moves the primitive up one.

Parameters:

primitive - The primitive to raise.

See Also:

raiseToTop(org.cesiumjs.cs.scene.Primitive), lower(org.cesiumjs.cs.scene.Primitive), lowerToBottom(org.cesiumjs.cs.scene.Primitive)

raiseToTop

@JsMethod
public void raiseToTop(Primitive primitive)

Raises a primitive to the "top" of the collection. If all primitives in the collection are drawn on the globe surface, this visually moves the primitive to the top.

Parameters:

primitive - The primitive to raise the top.

See Also:

raise(org.cesiumjs.cs.scene.Primitive), lower(org.cesiumjs.cs.scene.Primitive), lowerToBottom(org.cesiumjs.cs.scene.Primitive)