mapsglmaps/com.xweather.mapsgl.sources

Package-level declarations

Types

BitmapPackage

class BitmapPackage(val bitmap: Bitmap, val texNum: Int, val id: String)

This is used for the early demo, will not be used in the final product

DataPool

class DataPool

DatasetType

typealias DatasetType = EncodedDataset

DataSource

interface DataSource : EventSource

DataType

typealias DataType = EncodedTimeSeriesData

EncodedGridVectorTileSource

class EncodedGridVectorTileSource(val id: String, encodedSource: XweatherEncodedTileSource, gridSpacing: Double, iconEncodedColorScale: ColorScaleOptions? = null, iconEncodedScalarMax: Double? = null, val timelineMeldInvalidatesMapboxTiles: Boolean = true, instancedQuadMonochromeWhite: Boolean = false) : VectorTileSource

Sidecar vector source for gridded/symbol layers backed by XweatherEncodedTileSource.

EncodedSourceDescriptor

typealias EncodedSourceDescriptor = com.xweather.mapsgl.sources.source.spec.EncodedSourceDescriptor

EncodedTileSource

open class EncodedTileSource(val id: String, var authenticator: XweatherAuthenticator? = null) : TileSource<DataType>

EncodedTileSource.kt

GeoJSONSource

class GeoJSONSource(val id: String) : TileSource<VectorData>

Runtime GeoJSON data source for map layers that consume geographic features (points, lines, polygons).

GeoJSONSourceDescriptor

typealias GeoJSONSourceDescriptor = com.xweather.mapsgl.sources.source.spec.GeoJSONSourceDescriptor

ImageSourceDescriptor

typealias ImageSourceDescriptor = com.xweather.mapsgl.sources.source.spec.ImageSourceDescriptor

ImageTileSource

class ImageTileSource(val id: String, typeString: String, val authenticator: XweatherAuthenticator?) : TileSource<TileData>

ImageTileSource.kt

MetadataType

typealias MetadataType = SourceMetadataSchema

PaddingManager

class PaddingManager(val size: Int, val padding: Int, val tileCache: TileCache<DataType>, val id: String)

RasterTileApiEvent

open class RasterTileApiEvent

This will be merged with DataSourceEvents

RequestOptions

data class RequestOptions(val dataSetId: String, val dataMin: Double, val dataMax: Double, val outputMin: Double, val outputMax: Double, val outputNoDataValue: Double? = null, val validTimes: MutableList<Date>? = null)

RequestTileSuccess

open class RequestTileSuccess<DataType : TileData>

SourceDescriptor

typealias SourceDescriptor = com.xweather.mapsgl.sources.source.spec.SourceDescriptor

Public entry types for configuring tile/geo sources passed to com.xweather.mapsgl.map.MapController.addSource.

SourceMetadata

class SourceMetadata<DataType : SourceMetadataSchema>(data: DataType, url: URL?) : EventSource

SourceMetadata.kt

SourceMetadataSchema

open class SourceMetadataSchema

TileDataParser

interface TileDataParser

An interface for a structure responsible for parsing and decoding tile data into a specific format required for rendering.

TileSource

abstract class TileSource<DataType : TileData> : DataSource

TileSource.kt

TileType

typealias TileType = Tile<DataType>

VectorData

class VectorData(val validTime: Date, val features: MutableList<Feature>) : TileData

VectorSourceDescriptor

typealias VectorSourceDescriptor = com.xweather.mapsgl.sources.source.spec.VectorSourceDescriptor

VectorTileSource

open class VectorTileSource(val id: String, var authenticator: XweatherAuthenticator? = null) : TileSource<VectorData>

Runtime vector tile source created by com.xweather.mapsgl.map.MapController.addSource when using com.xweather.mapsgl.sources.source.spec.VectorSourceDescriptor. Obtain via com.xweather.mapsgl.map.MapController.getSource and cast to this type to change TileSource.tileURL, TileSource.minZoom / TileSource.maxZoom, or refresh tiles.

VisibleGeoBounds

data class VisibleGeoBounds(val west: Double, val south: Double, val east: Double, val north: Double)

Geographic rectangle in degrees (WGS84), same convention as Mapbox camera bounds.

XweatherEncodedSourceDescriptor

typealias XweatherEncodedSourceDescriptor = com.xweather.mapsgl.sources.source.spec.XweatherEncodedSourceDescriptor

XweatherEncodedTileSource

class XweatherEncodedTileSource(var id: String, var authenticator: XweatherAuthenticator?) : EncodedTileSource

XweatherEncodedTileSource.kt

XweatherVectorLayerMetadata

data class XweatherVectorLayerMetadata(var layers: List<XweatherVectorLayerMetadata.Layer>, var validTimes: List<Date>)

Properties

isReady

val TileSource<DataType>.isReady: Boolean

maxZoom

val TileSource<DataType>.maxZoom: Float

minZoom

val TileSource<DataType>.minZoom: Float

needsMetadata

val TileSource<DataType>.needsMetadata: Boolean

outstandingReq

var outstandingReq: Int

TAG

const val TAG: String

tiles

val TileSource<DataType>.tiles: TileCache<DataType>

tileSize

val TileSource<DataType>.tileSize: TileSize

type

val DataSource.type: DataSourceKind

Functions

calculateSignedArea

fun calculateSignedArea(polygon: List<Point>): Double

contains

fun <DataType : TileData> TileSource<DataType>.contains(coord: TileCoord): Boolean

getLatLonBoundsOfTile

fun getLatLonBoundsOfTile(tile: TileCoord): LatLonBounds

Calculates the geographic latitude/longitude bounding box for a given tile.

getTileBounds

fun getTileBounds(tile: TileCoord): List<Point>

init

fun <DataType : TileData> TileSource<DataType>.init(id: String, authenticator: Authenticator<MediaSession.Token>?)

isClockwise

fun List<Point>.isClockwise(): Boolean

isCounterClockwise

fun List<Point>.isCounterClockwise(): Boolean

Checks if a polygon's vertices are in counter-clockwise (CCW) order. Assumes longitude as x and latitude as y. Conventionally, a positive signed area from the shoelace formula indicates CCW.

nestedDictionary

fun nestedDictionary(flat: Map<String, Any>): Map<String, Any>

reversedIfClockwise

fun List<Point>.reversedIfClockwise(): List<Point>

Reverses the list if its winding order is clockwise. Useful for ensuring a polygon ring is counter-clockwise (e.g., GeoJSON outer rings).

reversedIfCounterClockwise

fun List<Point>.reversedIfCounterClockwise(): List<Point>

Reverses the list if its winding order is counter-clockwise. Useful for ensuring a polygon ring is clockwise (e.g., GeoJSON inner rings/holes).

shouldRequestTile

fun <DataType : TileData> TileSource<DataType>.shouldRequestTile(tile: TileType, reload: Boolean): Boolean