feature-map/org.meshtastic.feature.map.tiles

Package-level declarations

Types

@Serializable

data class CustomTileProviderConfig(val id: String = Uuid.random().toString(), val name: String, val urlTemplate: String, val localUri: String? = null)

CustomTileProviderLoadResult

data class CustomTileProviderLoadResult(val providers: List<CustomTileProviderConfig>, val isSuccessful: Boolean)

CustomTileProviderRepository

interface CustomTileProviderRepository

CustomTileProviderRepositoryImpl

class CustomTileProviderRepositoryImpl(json: Json, dispatchers: CoroutineDispatchers, mapTileProviderPrefs: MapTileProviderPrefs) : CustomTileProviderRepository

CustomTileProviderSaveResult

enum CustomTileProviderSaveResult : Enum<CustomTileProviderSaveResult>

DemEncoding

enum DemEncoding : Enum<DemEncoding>

How a raster-DEM source packs elevation into its pixels.

MapTileCatalogue

object MapTileCatalogue

The tile sources the app offers, independent of which engine draws them.

RasterBasemapSource

data class RasterBasemapSource(val id: String, val label: String, val spec: RasterTileSpec)

A raster basemap: XYZ tiles that stand in for the base map itself.

RasterOverlaySource

data class RasterOverlaySource(val id: String, val label: StringResource, val spec: RasterTileSpec, val demEncoding: DemEncoding? = null)

A raster layer composited over whichever basemap is selected.

RasterTileSpec

data class RasterTileSpec(val tiles: List<String>, val tileSize: Int = DEFAULT_TILE_SIZE, val minZoom: Int = 0, val maxZoom: Int = DEFAULT_MAX_ZOOM, val attributionHtml: String? = null)

Tile-scheme description for one raster source.

Functions

attributionPlainText

fun String.attributionPlainText(): String

The attribution string as plain text.

isValidTileUrlTemplate

fun String.isValidTileUrlTemplate(requireHttps: Boolean): Boolean

Whether a tile URL template is one we are willing to request.

mapAttributionText

fun mapAttributionText(basemap: RasterTileSpec?, overlays: List<RasterTileSpec>): String

The credits owed for a basemap and whatever overlays are drawn over it, joined for a single line of text.

tileUrl

fun RasterTileSpec.tileUrl(x: Int, y: Int, zoom: Int): String?

Resolves the URL of a single tile from a RasterTileSpec.