app/org.scottishtecharmy.soundscape.geoengine

Package-level declarations

Types

open class GridState(val zoomLevel: Int = MAX_ZOOM_LEVEL, val gridSize: Int = GRID_SIZE, passedInTreeContext: CloseableCoroutineDispatcher? = null)

PositionedString

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

ProtomapsGridState

open class ProtomapsGridState(zoomLevel: Int = MAX_ZOOM_LEVEL, gridSize: Int = GRID_SIZE, passedInTreeContext: CloseableCoroutineDispatcher? = null) : GridState

StreetPreview

class StreetPreview

StreetPreviewChoice

data class StreetPreviewChoice(val heading: Double, val name: String, val way: Way)

StreetPreviewEnabled

enum StreetPreviewEnabled : Enum<StreetPreviewEnabled>

StreetPreviewState

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

TextForFeature

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

TreeId

enum TreeId : Enum<TreeId>

UserGeometry

class UserGeometry(val location: LngLatAlt = LngLatAlt(), var phoneHeading: Double? = null, var fovDistance: Double = 50.0, val speed: Double = 0.0, val mapMatchedWay: Way? = null, val mapMatchedLocation: PointAndDistanceAndHeading? = null, val currentBeacon: LngLatAlt? = null, val ruler: Ruler = CheapRuler(location.latitude), val timestampMilliseconds: Long = 0, headingMode: UserGeometry.HeadingMode = HeadingMode.CourseAuto, travelHeading: Double? = null, headHeading: Double? = null, val errorDistance: Double = 0.0, val errorHeading: Double = 0.0, val 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

const val GRID_SIZE: Int = 2

MANIFEST_NAME

const val MANIFEST_NAME: String

MAX_ZOOM_LEVEL

const val MAX_ZOOM_LEVEL: Int = 14

The zoom level and grid size were constant when using soundscape-backend at 16 and 3 respectively. With protobuf tiles the tile grid for walking around will be 15 and 2, but we can also have a lower zoom level to allow us to give better context when we're travelling by faster means of transport e.g. inter city train. The lower zoom levels mean that we can search for the nearest village or town instead of just the nearest street or road.

metric

var metric: Boolean

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.

MIN_MAX_ZOOM_LEVEL

const val MIN_MAX_ZOOM_LEVEL: Int = 14

PROTOMAPS_SERVER_PATH

const val PROTOMAPS_SERVER_PATH: String

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

PROTOMAPS_SUFFIX

const val PROTOMAPS_SUFFIX: String

Functions

describeReverseGeocode

fun describeReverseGeocode(userGeometry: UserGeometry, gridState: GridState, settlementGrid: GridState, localizedContext: Context?): PositionedString?

Reverse geocodes a location into 1 of 4 possible states

formatDistanceAndDirection

fun formatDistanceAndDirection(distance: Double, heading: Double?, localizedContext: Context?, userHeading: Double? = null, relativeTimeMode: String = "ClockFace"): String

getPhotonLanguage

fun getPhotonLanguage(sharedPreferences: SharedPreferences?): String?

getTextForFeature

fun getTextForFeature(localizedContext: Context?, feature: MvtFeature): 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

processTileFeatureCollection

fun processTileFeatureCollection(initialFeatureCollections: Array<FeatureCollection>, tileFeatureCollection: FeatureCollection)

tileFromNetworkResponse

fun tileFromNetworkResponse(response: Response<VectorTile.Tile>?): VectorTile.Tile?

The protomaps tile server responds with an HTTP 204 (No Content), and no body, for tiles that have no data at all, e.g. remote areas with no OSM features nearby. Note this is not the same as a tile that's entirely open sea, or one with a layer present but no features in it - those are still served normally with an HTTP 200. Retrofit special cases a 204/205 response and always returns a null body for it, even though the tile request itself succeeded, so that has to be turned back into an empty VectorTile here rather than being treated as a failed request that's worth retrying.

travellingReverseGeocode

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

treeIdToIndex

fun treeIdToIndex(id: TreeId): TreeId

updateMeasurementUnits

fun updateMeasurementUnits(sharedPreferences: SharedPreferences)