app/org.scottishtecharmy.soundscape.geoengine

Package-level declarations

Types

data class PositionedString(val text: String, val location: LngLatAlt? = null, val earcon: String? = null, val type: AudioType = AudioType.STANDARD, val heading: Double? = null)

ProtomapsGridState

class ProtomapsGridState : GridState

SoundscapeBackendGridState

class SoundscapeBackendGridState : GridState

StreetPreview

class StreetPreview

StreetPreviewChoice

data class StreetPreviewChoice(val heading: Double, val name: String, val route: List<LngLatAlt>)

StreetPreviewEnabled

enum StreetPreviewEnabled : Enum<StreetPreviewEnabled>

StreetPreviewState

data class StreetPreviewState(val enabled: StreetPreviewEnabled = StreetPreviewEnabled.OFF, val choices: List<StreetPreviewChoice> = emptyList())

TextForFeature

data class TextForFeature(val text: String = "", val generic: Boolean = false)

TreeId

enum TreeId : Enum<TreeId>

UserGeometry

class UserGeometry(val location: LngLatAlt = LngLatAlt(), var phoneHeading: Double? = null, val fovDistance: Double = 50.0, val inVehicle: Boolean = false, val inMotion: Boolean = false, val speed: Double = 0.0, headingMode: UserGeometry.HeadingMode = HeadingMode.CourseAuto, travelHeading: Double? = null, headHeading: Double? = null, inStreetPreview: Boolean = false)

UserGeometry contains all of the data relating to the location and motion of the user. It's aim is to reduces the number of arguments to many of the API calls and to concentrate some of the logic around heading choice.

Properties

GRID_SIZE

var GRID_SIZE: Int

PROTOMAPS_SERVER_BASE

const val PROTOMAPS_SERVER_BASE: String

The default tile server is the one out in the cloud where the tile JSON is at: https://server/protomaps.json

PROTOMAPS_SERVER_PATH

const val PROTOMAPS_SERVER_PATH: String

PROTOMAPS_SUFFIX

const val PROTOMAPS_SUFFIX: String

SOUNDSCAPE_TILE_BACKEND

const val SOUNDSCAPE_TILE_BACKEND: Boolean = false

The zoom level and grid size are constant. When using soundscape-backend these will be 16 and 3, but if we switch to using protobuf tiles they will be 15 and 2.

ZOOM_LEVEL

val ZOOM_LEVEL: Int

Functions

formatDistance

fun formatDistance(distance: Double, localizedContext: Context): String

We're going to round metric as documented for iOS: For metric units, we round all distances less than 1000 meters to the nearest 5 meters and all distances over 1000 meters to the nearest 50 meters.

getTextForFeature

fun getTextForFeature(localizedContext: Context, feature: Feature): TextForFeature

getNameForFeature returns text describing the feature for callouts. Usually it returns a name or if it doesn't have one then a localized description of the type of feature it is e.g. bike parking, or style. Some types of Feature have more info e.g. bus stops and railway stations

localReverseGeocode

fun localReverseGeocode(location: LngLatAlt, gridState: GridState, localizedContext: Context): LocationDescription?

reverseGeocode

fun reverseGeocode(userGeometry: UserGeometry, gridState: GridState, localizedContext: Context): PositionedString

Reverse geocodes a location into 1 of 4 possible states