WorldWind Kotlin/earth.worldwind.layer.mercator/WebMercatorImageLayer

WebMercatorImageLayer

class WebMercatorImageLayer(val serviceAddress: String, val imageFormat: String = "image/png", val isTransparent: Boolean = false, name: String? = null, tiledSurfaceImage: MercatorTiledSurfaceImage? = null) : MercatorTiledImageLayer, WebImageLayer

Constructors

constructor(serviceAddress: String, imageFormat: String = "image/png", isTransparent: Boolean = false, name: String? = null, tiledSurfaceImage: MercatorTiledSurfaceImage? = null)

Types

Companion

object Companion

Properties

cachedSourceInfo

val TiledImageLayer.cachedSourceInfo: CachedSourceInfo?

Cache identity of this layer's tile source, or null when the layer isn't wired through a cache (network-only). Walks the layer's tile factory chain, looking for a CachedSourceInfoProvider — typically a CachedTileSource that wraps an IDB / gpkg / filesystem TileStore.

count

val count: Int

displayName

open override var displayName: String?

imageFormat

open override val imageFormat: String

Expected output image format

isDynamic

open override var isDynamic: Boolean

isEnabled

open override var isEnabled: Boolean

isPickEnabled

open override var isPickEnabled: Boolean

isTransparent

open override val isTransparent: Boolean

Is layer a transparent overlay

layerName

open val layerName: String?

The technical name of the desired layer

maxActiveAltitude

open override var maxActiveAltitude: Double

minActiveAltitude

open override var minActiveAltitude: Double

opacity

open override var opacity: Float

serviceAddress

open override val serviceAddress: String

The service address

serviceMetadata

open val serviceMetadata: String?

Descriptive information about service capabilities

serviceType

open override val serviceType: String

Type of the service

tiledSurfaceImage

var tiledSurfaceImage: TiledSurfaceImage?

type

val type: String?

Functions

addAllRenderables

fun addAllRenderables(layer: RenderableLayer)

fun addAllRenderables(iterable: Iterable<Renderable>)

addRenderable

fun addRenderable(renderable: Renderable)

fun addRenderable(index: Int, renderable: Renderable)

clearRenderables

fun clearRenderables()

clone

open override fun clone(): WebMercatorImageLayer

contentEntry

fun TiledImageLayer.contentEntry(contentManager: ContentManager? = null): ContentEntry?

One-stop accessor for "this image layer's content view." Lookup order:

getRenderable

fun getRenderable(index: Int): Renderable

getRenderablesByDisplayName

fun getRenderablesByDisplayName(name: String): List<Renderable>

getUserProperty

open override fun getUserProperty(key: Any): Any?

hasUserProperty

open override fun hasUserProperty(key: Any): Boolean

indexOfRenderable

fun indexOfRenderable(renderable: Renderable): Int

indexOfRenderableNamed

fun indexOfRenderableNamed(name: String): Int

indexOfRenderableWithProperty

fun indexOfRenderableWithProperty(key: Any, value: Any): Int

isEmpty

fun isEmpty(): Boolean

isWithinActiveAltitudes

open override fun isWithinActiveAltitudes(rc: RenderContext): Boolean

iterator

open operator override fun iterator(): MutableIterator<Renderable>

launchBulkRetrieval

fun TiledImageLayer.launchBulkRetrieval(sector: Sector, resolution: ClosedRange<Angle>, scope: CoroutineScope = GlobalScope, maxRetries: Int = 3, retryTimeoutShort: Duration = 5.seconds, retryTimeoutLong: Duration = 15.seconds, overrideCache: Boolean = false, onProgress: (downloaded: Long, skipped: Long, total: Long) -> Unit? = null): Job?

Download every tile within sector across the resolution range into the layer's underlying TileStore (when the layer was constructed with a CachedTileSource). Returns the launched Job for cancellation; returns null when the layer's tile factory isn't backed by a TileSourceFactoryAdapter (i.e. no source-based wiring, so bulk-via-source is impossible).

putUserProperty

open override fun putUserProperty(key: Any, value: Any): Any?

removeAllRenderables

fun removeAllRenderables(renderables: Iterable<Renderable>): Boolean

removeRenderable

fun removeRenderable(renderable: Renderable): Boolean

fun removeRenderable(index: Int): Renderable

removeUserProperty

open override fun removeUserProperty(key: Any): Any?

render

open override fun render(rc: RenderContext)

setOfflineOnly

fun TiledImageLayer.setOfflineOnly(offlineOnly: Boolean = true)

Toggle the cache-only flag on a cache-attached layer or coverage.

setRenderable

fun setRenderable(index: Int, renderable: Renderable): Renderable