org.cesiumjs.cs.scene.options

Class ImageryLayerOptions

java.lang.Object

org.cesiumjs.cs.scene.options.ImageryLayerOptions

@JsType(isNative=true,
        namespace="<global>",
        name="Object")
public class ImageryLayerOptions
extends Object

Author:

Serge Silaev aka iSergio

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ImageryLayerOptions.ImagerySplitDirectionFunction

Field Summary

Fields

Modifier and Type	Field and Description
float	alpha The alpha blending value of this layer, from 0.0 to 1.0.
float	brightness The brightness of this layer. 1.0 uses the unmodified imagery color.
Color	colorToAlpha Color to be used as alpha.
double	colorToAlphaThreshold Threshold for color-to-alpha.
float	contrast The contrast of this layer. 1.0 uses the unmodified imagery color.
Rectangle	cutoutRectangle Cartographic rectangle for cutting out a portion of this ImageryLayer.
float	gamma The gamma correction to apply to this layer. 1.0 uses the unmodified imagery color.
float	hue The hue of this layer. 0.0 uses the unmodified imagery color.
Number	magnificationFilter The texture minification filter to apply to this layer.
double	maximumAnisotropy The maximum anisotropy level to use for texture filtering.
double	maximumTerrainLevel The maximum terrain level-of-detail at which to show this imagery layer, or undefined to show it at all levels.
Number	minificationFilter The texture minification filter to apply to this layer.
double	minimumTerrainLevel The minimum terrain level-of-detail at which to show this imagery layer, or undefined to show it at all levels.
Rectangle	rectangle The rectangle of the layer.
float	saturation The saturation of this layer. 1.0 uses the unmodified imagery color.
boolean	show True if the layer is shown; otherwise, false.
Number	splitDirection The ImagerySplitDirection split to apply to this layer.
ImageryLayerOptions.ImagerySplitDirectionFunction	splitDirectionFunction The function split to apply to this layer.

Constructor Summary

Constructors

Constructor and Description
ImageryLayerOptions()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

rectangle

@JsProperty
public Rectangle rectangle

The rectangle of the layer. This rectangle can limit the visible portion of the imagery provider. Default: imageryProvider.rectangle

alpha

@JsProperty
public float alpha

The alpha blending value of this layer, from 0.0 to 1.0. This can either be a simple number or a function with the signature function(frameState, layer, x, y, level). The function is passed the current frame state, this layer, and the x, y, and level coordinates of the imagery tile for which the alpha is required, and it is expected to return the alpha value to use for the tile. 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. This can either be a simple number or a function with the signature function(frameState, layer, x, y, level). The function is passed the current frame state, this layer, and the x, y, and level coordinates of the imagery tile for which the brightness is required, and it is expected to return the brightness value to use for the tile. The function is executed for every frame and for every tile, so it must be fast. Default: 1.0

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. This can either be a simple number or a function with the signature function(frameState, layer, x, y, level). The function is passed the current frame state, this layer, and the x, y, and level coordinates of the imagery tile for which the contrast is required, and it is expected to return the contrast value to use for the tile. The function is executed for every frame and for every tile, so it must be fast. Default: 1.0

hue

@JsProperty
public float hue

The hue of this layer. 0.0 uses the unmodified imagery color. This can either be a simple number or a function with the signature function(frameState, layer, x, y, level). The function is passed the current frame state, this layer, and the x, y, and level coordinates of the imagery tile for which the hue is required, and it is expected to return the contrast value to use for the tile. The function is executed for every frame and for every tile, so it must be fast. Default: 0.0

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. This can either be a simple number or a function with the signature function(frameState, layer, x, y, level). The function is passed the current frame state, this layer, and the x, y, and level coordinates of the imagery tile for which the saturation is required, and it is expected to return the contrast value to use for the tile. The function is executed for every frame and for every tile, so it must be fast. Default: 1.0

gamma

@JsProperty
public float gamma

The gamma correction to apply to this layer. 1.0 uses the unmodified imagery color. This can either be a simple number or a function with the signature function(frameState, layer, x, y, level). The function is passed the current frame state, this layer, and the x, y, and level coordinates of the imagery tile for which the gamma is required, and it is expected to return the gamma value to use for the tile. The function is executed for every frame and for every tile, so it must be fast. Default: 1.0

splitDirection

@JsProperty
public Number splitDirection

The ImagerySplitDirection split to apply to this layer. Default ImagerySplitDirection.NONE()

splitDirectionFunction

@JsProperty(name="splitDirection")
public ImageryLayerOptions.ImagerySplitDirectionFunction splitDirectionFunction

The function split to apply to this layer. Default ImagerySplitDirection.NONE()

minificationFilter

@JsProperty
public Number minificationFilter

The texture minification filter to apply to this layer. Possible values are TextureMinificationFilter.LINEAR and TextureMinificationFilter.NEAREST. Default: TextureMinificationFilter.LINEAR()

magnificationFilter

@JsProperty
public Number magnificationFilter

The texture minification filter to apply to this layer. Possible values are TextureMagnificationFilter.LINEAR and TextureMagnificationFilter.NEAREST. Default: TextureMagnificationFilter.LINEAR()

show

@JsProperty
public boolean show

True if the layer is shown; otherwise, false. Default: true

maximumAnisotropy

@JsProperty
public double maximumAnisotropy

The maximum anisotropy level to use for texture filtering. If this parameter is not specified, the maximum anisotropy supported by the WebGL stack will be used. Larger values make the imagery look better in horizon views.

minimumTerrainLevel

@JsProperty
public double minimumTerrainLevel

The minimum terrain level-of-detail at which to show this imagery layer, or undefined to show it at all levels. Level zero is the least-detailed level.

maximumTerrainLevel

@JsProperty
public double maximumTerrainLevel

The maximum terrain level-of-detail at which to show this imagery layer, or undefined to show it at all levels. Level zero is the least-detailed level.

cutoutRectangle

@JsProperty
public Rectangle cutoutRectangle

Cartographic rectangle for cutting out a portion of this ImageryLayer.

colorToAlpha

@JsProperty
public Color colorToAlpha

Color to be used as alpha.

colorToAlphaThreshold

@JsProperty
public double colorToAlphaThreshold

Threshold for color-to-alpha. Default: 0.004

Constructor Detail

ImageryLayerOptions

@JsConstructor
public ImageryLayerOptions()