org.cesiumjs.cs.scene

Class ImageryLayer

java.lang.Object

org.cesiumjs.cs.scene.ImageryLayer

@JsType(isNative=true,
        namespace="Cesium",
        name="ImageryLayer")
public class ImageryLayer
extends Object

Author:

Serge Silaev aka iSergio

Field Summary

Fields

Modifier and Type	Field and Description
float	alpha The alpha blending value of this layer, with 0.0 representing fully transparent and 1.0 representing fully opaque.
float	brightness The brightness of this layer. 1.0 uses the unmodified imagery color.
Color	colorToAlpha Color value that should be set to transparent.
double	colorToAlphaThreshold Normalized (0-1) threshold for color-to-alpha.
float	contrast The contrast of this layer. 1.0 uses the unmodified imagery color.
Rectangle	cutoutRectangle Rectangle cutout in this layer of imagery.
static float	DEFAULT_BRIGHTNESS This value is used as the default brightness for the imagery layer if one is not provided during construction or by the imagery provider.
static float	DEFAULT_CONTRAST This value is used as the default contrast for the imagery layer if one is not provided during construction or by the imagery provider.
static float	DEFAULT_GAMMA This value is used as the default gamma for the imagery layer if one is not provided during construction or by the imagery provider.
static float	DEFAULT_HUE This value is used as the default hue for the imagery layer if one is not provided during construction or by the imagery provider.
static Number	DEFAULT_MAGNIFICATION_FILTER This value is used as the default texture magnification filter for the imagery layer if one is not provided during construction or by the imagery provider.
static Number	DEFAULT_MINIFICATION_FILTER This value is used as the default texture minification filter for the imagery layer if one is not provided during construction or by the imagery provider.
static float	DEFAULT_SATURATION This value is used as the default saturation for the imagery layer if one is not provided during construction or by the imagery provider.
static Number	DEFAULT_SPLIT This value is used as the default spliat for the imagery layer if one is not provided during construction or by the imagery provider.
float	gamma The gamma correction to apply to this layer. 1.0 uses the unmodified imagery color.
float	hue The hue of this layer in radians. 0.0 uses the unmodified imagery color.
Number	magnificationFilter The TextureMagnificationFilter to apply to this layer.
Number	minificationFilter The TextureMinificationFilter to apply to this layer.
float	saturation The saturation of this layer. 1.0 uses the unmodified imagery color.
boolean	show Determines if this layer is shown.
Number	splitDirection The ImagerySplitDirection to apply to this layer.

Constructor Summary

Constructors

Constructor and Description
ImageryLayer(ImageryProvider imageryProvider) An imagery layer that displays tiled imagery data from a single imagery provider on a Globe.
ImageryLayer(ImageryProvider imageryProvider, ImageryLayerOptions options) An imagery layer that displays tiled imagery data from a single imagery provider on a Globe.

Method Summary

Modifier and Type	Method and Description
void	destroy() Destroys the WebGL resources held by this object.
Promise<Rectangle,Void>	getViewableRectangle() Computes the intersection of this layer's rectangle with the imagery provider's availability rectangle, producing the overall bounds of imagery that can be produced by this layer.
ImageryProvider	imageryProvider() Gets the imagery provider for this layer.
boolean	isBaseLayer() Gets a value indicating whether this layer is the base layer in the ImageryLayerCollection.
boolean	isDestroyed() Returns true if this object was destroyed; otherwise, false.
Rectangle	rectangle() Gets the rectangle of this layer.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_BRIGHTNESS

@JsProperty
public static float DEFAULT_BRIGHTNESS

This value is used as the default brightness for the imagery layer if one is not provided during construction or by the imagery provider. This value does not modify the brightness of the imagery. Default: 1.0

DEFAULT_CONTRAST

@JsProperty
public static float DEFAULT_CONTRAST

This value is used as the default contrast for the imagery layer if one is not provided during construction or by the imagery provider. This value does not modify the contrast of the imagery. Default: 1.0

DEFAULT_GAMMA

@JsProperty
public static float DEFAULT_GAMMA

This value is used as the default gamma for the imagery layer if one is not provided during construction or by the imagery provider. This value does not modify the gamma of the imagery. Default: 1.0

DEFAULT_HUE

@JsProperty
public static float DEFAULT_HUE

This value is used as the default hue for the imagery layer if one is not provided during construction or by the imagery provider. This value does not modify the hue of the imagery. Default: 0.0

DEFAULT_MAGNIFICATION_FILTER

@JsProperty
public static Number DEFAULT_MAGNIFICATION_FILTER

This value is used as the default texture magnification filter for the imagery layer if one is not provided during construction or by the imagery provider. Default: TextureMagnificationFilter.LINEAR()

DEFAULT_MINIFICATION_FILTER

@JsProperty
public static Number DEFAULT_MINIFICATION_FILTER

This value is used as the default texture minification filter for the imagery layer if one is not provided during construction or by the imagery provider. Default: TextureMinificationFilter.LINEAR()

DEFAULT_SATURATION

@JsProperty
public static float DEFAULT_SATURATION

This value is used as the default saturation for the imagery layer if one is not provided during construction or by the imagery provider. This value does not modify the saturation of the imagery. Default: 1.0

DEFAULT_SPLIT

@JsProperty
public static Number DEFAULT_SPLIT

This value is used as the default spliat for the imagery layer if one is not provided during construction or by the imagery provider. Default: ImagerySplitDirection.NONE()

alpha

@JsProperty
public float alpha

The alpha blending value of this layer, with 0.0 representing fully transparent and 1.0 representing fully opaque. Default: 1.0

brightness

@JsProperty
public float brightness

The brightness of this layer. 1.0 uses the unmodified imagery color. Less than 1.0 makes the imagery darker while greater than 1.0 makes it brighter. Default: DEFAULT_BRIGHTNESS

colorToAlpha

@JsProperty
public Color colorToAlpha

Color value that should be set to transparent.

colorToAlphaThreshold

@JsProperty
public double colorToAlphaThreshold

Normalized (0-1) threshold for color-to-alpha.

contrast

@JsProperty
public float contrast

The contrast of this layer. 1.0 uses the unmodified imagery color. Less than 1.0 reduces the contrast while greater than 1.0 increases it. Default: DEFAULT_CONTRAST

cutoutRectangle

@JsProperty
public Rectangle cutoutRectangle

Rectangle cutout in this layer of imagery.

gamma

@JsProperty
public float gamma

The gamma correction to apply to this layer. 1.0 uses the unmodified imagery color. Default: DEFAULT_GAMMA

hue

@JsProperty
public float hue

The hue of this layer in radians. 0.0 uses the unmodified imagery color. Default: DEFAULT_HUE

magnificationFilter

@JsProperty
public Number magnificationFilter

The TextureMagnificationFilter to apply to this layer. Possible values are TextureMagnificationFilter.LINEAR() (the default) and TextureMagnificationFilter.NEAREST(). To take effect, this property must be set immediately after adding the imagery layer. Once a texture is loaded it won't be possible to change the texture filter used. Default: DEFAULT_MAGNIFICATION_FILTER

minificationFilter

@JsProperty
public Number minificationFilter

The TextureMinificationFilter to apply to this layer. Possible values are TextureMinificationFilter.LINEAR() (the default) and TextureMinificationFilter.NEAREST(). To take effect, this property must be set immediately after adding the imagery layer. Once a texture is loaded it won't be possible to change the texture filter used. Default: DEFAULT_MINIFICATION_FILTER

saturation

@JsProperty
public float saturation

The saturation of this layer. 1.0 uses the unmodified imagery color. Less than 1.0 reduces the saturation while greater than 1.0 increases it. Default: DEFAULT_SATURATION

show

@JsProperty
public boolean show

Determines if this layer is shown. Default: true

splitDirection

@JsProperty
public Number splitDirection

The ImagerySplitDirection to apply to this layer. Default: {ImageryLayer#DEFAULT_SPLIT}.

Constructor Detail

ImageryLayer

@JsConstructor
public ImageryLayer(ImageryProvider imageryProvider)

An imagery layer that displays tiled imagery data from a single imagery provider on a Globe.

Parameters:

imageryProvider - The imagery provider to use.

ImageryLayer

@JsConstructor
public ImageryLayer(ImageryProvider imageryProvider,
                                   ImageryLayerOptions options)

An imagery layer that displays tiled imagery data from a single imagery provider on a Globe.

Parameters:

imageryProvider - The imagery provider to use.

options - Options.

Method Detail

imageryProvider

@JsProperty(name="imageryProvider")
public ImageryProvider imageryProvider()

Gets the imagery provider for this layer.

rectangle

@JsProperty(name="rectangle")
public Rectangle rectangle()

Gets the rectangle of this layer. If this rectangle is smaller than the rectangle of the ImageryProvider, only a portion of the imagery provider is shown.

destroy

@JsMethod
public void destroy()

Destroys the WebGL resources held by this object. Destroying an object allows for deterministic release of WebGL resources, instead of relying on the garbage collector to destroy this object. Once an object is destroyed, it should not be used; calling any function other than isDestroyed will result in a DeveloperError exception. Therefore, assign the return value (undefined) to the object as done in the example.

See Also:

isDestroyed()

getViewableRectangle

@JsMethod
public Promise<Rectangle,Void> getViewableRectangle()

Computes the intersection of this layer's rectangle with the imagery provider's availability rectangle, producing the overall bounds of imagery that can be produced by this layer.

Returns:

A promise to a rectangle which defines the overall bounds of imagery that can be produced by this layer.

isBaseLayer

@JsMethod
public boolean isBaseLayer()

Gets a value indicating whether this layer is the base layer in the ImageryLayerCollection. The base layer is the one that underlies all others. It is special in that it is treated as if it has global rectangle, even if it actually does not, by stretching the texels at the edges over the entire globe.

Returns:

true if this is the base layer; otherwise, false.

isDestroyed

@JsMethod
public boolean isDestroyed()

Returns true if this object was destroyed; otherwise, false. If this object was destroyed, it should not be used; calling any function other than isDestroyed will result in a DeveloperError exception.

Returns:

True if this object was destroyed; otherwise, false.

See Also:

destroy()