kotlin-cesium-engine/cesium.engine/ImageryLayer

ImageryLayer

external class ImageryLayer(val imageryProvider: ImageryProvider = definedExternally, options: ImageryLayer.ConstructorOptions? = definedExternally)(source)

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

// Add an OpenStreetMaps layer
const imageryLayer = new ImageryLayer(new OpenStreetMapImageryProvider({
  url: "https://tile.openstreetmap.org/"
}));
scene.imageryLayers.add(imageryLayer);

// Add Cesium ion's default world imagery layer
const imageryLayer = ImageryLayer.fromWorldImagery();
scene.imageryLayers.add(imageryLayer);

// Add a new transparent layer from Cesium ion
const imageryLayer = ImageryLayer.fromProviderAsync(IonImageryProvider.fromAssetId(3812));
imageryLayer.alpha = 0.5;
scene.imageryLayers.add(imageryLayer);

Parameters

options

An object describing initialization options

Constructors

ImageryLayer

constructor(imageryProvider: ImageryProvider = definedExternally, options: ImageryLayer.ConstructorOptions? = definedExternally)

Types

Companion

object Companion

ConstructorOptions

sealed interface ConstructorOptions

Initialization options for the ImageryLayer constructor.

Properties

alpha

var alpha: Double

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

brightness

var brightness: Double

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.

colorToAlpha

var colorToAlpha: Color

Color value that should be set to transparent.

colorToAlphaThreshold

var colorToAlphaThreshold: Double

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

contrast

var contrast: Double

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.

cutoutRectangle

var cutoutRectangle: Rectangle

Rectangle cutout in this layer of imagery.

dayAlpha

var dayAlpha: Double

The alpha blending value of this layer on the day side of the globe, with 0.0 representing fully transparent and 1.0 representing fully opaque. This only takes effect when Globe.enableLighting is true.

gamma

var gamma: Double

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

hue

var hue: Double

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

imageryProvider

val imageryProvider: ImageryProvider

The imagery provider to use.

magnificationFilter

var magnificationFilter: TextureMagnificationFilter

The TextureMagnificationFilter to apply to this layer. Possible values are TextureMagnificationFilter.LINEAR (the default) and TextureMagnificationFilter.NEAREST.

minificationFilter

var minificationFilter: TextureMinificationFilter

The TextureMinificationFilter to apply to this layer. Possible values are TextureMinificationFilter.LINEAR (the default) and TextureMinificationFilter.NEAREST.

nightAlpha

var nightAlpha: Double

The alpha blending value of this layer on the night side of the globe, with 0.0 representing fully transparent and 1.0 representing fully opaque. This only takes effect when Globe.enableLighting is true.

ready

val ready: Boolean

Returns true when the terrain provider has been successfully created. Otherwise, returns false.

readyEvent

val readyEvent: Event<ImageryLayerReadyEventCallback>

Gets an event that is raised when the imagery provider has been successfully created. Event listeners are passed the created instance of ImageryProvider.

rectangle

val 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.

saturation

var saturation: Double

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.

show

var show: Boolean

Determines if this layer is shown.

splitDirection

var splitDirection: SplitDirection

The SplitDirection to apply to this layer.

Functions

destroy

fun 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.

getImageryRectangle

fun getImageryRectangle(): Rectangle

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.

isBaseLayer

fun isBaseLayer(): Boolean

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.

isDestroyed

fun isDestroyed(): Boolean

Returns true if this object was destroyed; otherwise, false.

ImageryLayer

Parameters

See also

Constructors

Types

Properties

Functions