org.cesiumjs.cs.collections

Class ImageryLayerCollection

java.lang.Object

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

org.cesiumjs.cs.collections.ImageryLayerCollection

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

Author:

Serge Silaev aka iSergio

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ImageryLayerCollection.Listener

Field Summary

Fields

Modifier and Type	Field and Description
Event	layerAdded An event that is raised when a layer is added to the collection.
Event	layerMoved An event that is raised when a layer changes position in the collection.
Event	layerRemoved An event that is raised when a layer is removed from the collection.
Event	layerShownOrHidden An event that is raised when a layer is shown or hidden by setting the ImageryLayer#show property.

Constructor Summary

Constructors

Constructor and Description
ImageryLayerCollection() An ordered collection of imagery layers.

Method Summary

Modifier and Type	Method and Description
void	add(ImageryLayer layer, int index) Adds a layer to the collection.
ImageryLayer	addImageryProvider(ImageryProvider imageryProvider) Creates a new layer using the given ImageryProvider and adds it to the collection.
ImageryLayer	addImageryProvider(ImageryProvider imageryProvider, int index) Creates a new layer using the given ImageryProvider and adds it to the collection.
int	indexOf(ImageryLayer layer) Determines the index of a given layer in the collection.
void	lower(ImageryLayer layer) Lowers a layer down one position in the collection.
void	lowerToBottom(ImageryLayer layer) Lowers a layer to the bottom of the collection.
Promise<ImageryLayerFeatureInfo[],Void>	pickImageryLayerFeatures(Ray ray, Scene scene) Asynchronously determines the imagery layer features that are intersected by a pick ray.
void	raise(ImageryLayer layer) Raises a layer up one position in the collection.
void	raiseToTop(ImageryLayer layer) Raises a layer to the top of the collection.
boolean	remove(ImageryLayer layer, boolean destroy) Removes a layer from this collection, if present.
void	removeAll(boolean destroy) Removes all layers from this 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

layerAdded

@JsProperty
public Event layerAdded

An event that is raised when a layer is added to the collection. Event handlers are passed the layer that was added and the index at which it was added. Default: Event()

layerMoved

@JsProperty
public Event layerMoved

An event that is raised when a layer changes position in the collection. Event handlers are passed the layer that was moved, its new index after the move, and its old index prior to the move. Default: Event()

layerRemoved

@JsProperty
public Event layerRemoved

An event that is raised when a layer is removed from the collection. Event handlers are passed the layer that was removed and the index from which it was removed. Default: Event()

layerShownOrHidden

@JsProperty
public Event layerShownOrHidden

An event that is raised when a layer is shown or hidden by setting the ImageryLayer#show property. Event handlers are passed a reference to this layer, the index of the layer in the collection, and a flag that is true if the layer is now shown or false if it is now hidden. Default: Event()

Constructor Detail

ImageryLayerCollection

@JsConstructor
public ImageryLayerCollection()

An ordered collection of imagery layers.

Method Detail

add

@JsMethod
public void add(ImageryLayer layer,
                          int index)

Adds a layer to the collection.

Parameters:

layer - the layer to add.

index - the index to add the layer at. If omitted, the layer will added on top of all existing layers.

addImageryProvider

@JsMethod
public ImageryLayer addImageryProvider(ImageryProvider imageryProvider)

Creates a new layer using the given ImageryProvider and adds it to the collection.

Parameters:

imageryProvider - the imagery provider to create a new layer for.

Returns:

The newly created layer.

addImageryProvider

@JsMethod
public ImageryLayer addImageryProvider(ImageryProvider imageryProvider,
                                                 int index)

Creates a new layer using the given ImageryProvider and adds it to the collection.

Parameters:

imageryProvider - the imagery provider to create a new layer for.

index - the index to add the layer at. If omitted, the layer will added on top of all existing layers.

Returns:

The newly created layer.

indexOf

@JsMethod
public int indexOf(ImageryLayer layer)

Determines the index of a given layer in the collection.

Parameters:

layer - The layer to find the index of.

Returns:

The index of the layer in the collection, or -1 if the layer does not exist in the collection.

lower

@JsMethod
public void lower(ImageryLayer layer)

Lowers a layer down one position in the collection.

Parameters:

layer - the layer to move.

lowerToBottom

@JsMethod
public void lowerToBottom(ImageryLayer layer)

Lowers a layer to the bottom of the collection.

Parameters:

layer - the layer to move.

pickImageryLayerFeatures

@JsMethod
public Promise<ImageryLayerFeatureInfo[],Void> pickImageryLayerFeatures(Ray ray,
                                                                                  Scene scene)

Asynchronously determines the imagery layer features that are intersected by a pick ray. The intersected imagery layer features are found by invoking ImageryProvider#pickFeatures for each imagery layer tile intersected by the pick ray. To compute a pick ray from a location on the screen, use Camera.getPickRay.

Parameters:

ray - The ray to test for intersection.

scene - The scene.

Returns:

A promise that resolves to an array of features intersected by the pick ray. If it can be quickly determined that no features are intersected (for example, because no active imagery providers support ImageryProvider#pickFeatures or because the pick ray does not intersect the surface), this function will return undefined.

raise

@JsMethod
public void raise(ImageryLayer layer)

Raises a layer up one position in the collection.

Parameters:

layer - the layer to move.

raiseToTop

@JsMethod
public void raiseToTop(ImageryLayer layer)

Raises a layer to the top of the collection.

Parameters:

layer - the layer to move.

remove

@JsMethod
public boolean remove(ImageryLayer layer,
                                boolean destroy)

Removes a layer from this collection, if present.

Parameters:

layer - The layer to remove.

destroy - whether to destroy the layers in addition to removing them. Default: true

Returns:

true if the layer was in the collection and was removed, false if the layer was not in the collection.

removeAll

@JsMethod
public void removeAll(boolean destroy)

Removes all layers from this collection.

Parameters:

destroy - whether to destroy the layers in addition to removing them. Default: true