WorldWind Kotlin/earth.worldwind.layer.cache/UrlTemplateImageTileSource

UrlTemplateImageTileSource

class UrlTemplateImageTileSource(val urlTemplate: String, headers: Map<String, String> = emptyMap(), connectTimeoutMs: Long = 5.seconds.inWholeMilliseconds, requestTimeoutMs: Long = 30.seconds.inWholeMilliseconds, clientConfig: HttpClientConfig<*>.() -> Unit = {}) : HttpTileSource

TileSource for slippy-map raster servers — image tiles addressed by (z, x, y) via a URL template, the same pattern every major XYZ-tile provider uses (Google, OSM, MapServer cgi-bin, Stamen, …). Supports the common template tokens {z}, {x}, {y}, {lang}, {rand=a,b,c}, {i} (the WorldWind dialect — see UrlTemplate).

Constructors

constructor(urlTemplate: String, headers: Map<String, String> = emptyMap(), connectTimeoutMs: Long = 5.seconds.inWholeMilliseconds, requestTimeoutMs: Long = 30.seconds.inWholeMilliseconds, clientConfig: HttpClientConfig<*>.() -> Unit = {})

Properties

headers

val headers: Map<String, String>

urlTemplate

val urlTemplate: String

Functions

open override fun close()

Release any resources held by the source (HTTP client, etc.). Idempotent default no-op.

fetchTile

open suspend override fun fetchTile(z: Int, x: Int, y: Int, previousEtag: String? = null, previousLastModified: String? = null): TileBlob?

launchBulkRetrieval

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

Download every tile that intersects sector across every level whose resolution falls in resolution — typically used by "save a region for offline use" flows. Returns the launched Job so the caller can cancel mid-download.

tryReadCachedTile

open suspend fun tryReadCachedTile(z: Int, x: Int, y: Int): TileBlob?

Cache-only fast-path read for (z, x, y). Default returns null — a plain network source has no cache to consult. Cache-backed sources override to read their store without going through the network-fetch concurrency budget.