Citymapper SDK/com.citymapper.sdk.core.geo

Package com.citymapper.sdk.core.geo

Types

data class Coords(latitude: Double, longitude: Double)

data class CoordsBounds(latNorth: Double, lonEast: Double, latSouth: Double, lonWest: Double)

A geographical area representing a latitude/longitude aligned rectangle.

value class Distance(value: Double) : Comparable<Distance>

enum DistanceUnit : Enum<DistanceUnit>

data class Location(latitude: Double, longitude: Double, horizontalAccuracy: Distance, verticalAccuracy: Distance?, altitude: Distance?, speedMetersPerSecond: Float?, speedAccuracyMetersPerSecond: Float?, bearingDegrees: Float?, bearingAccuracyDegrees: Float?, date: Date)

typealias Path = List<Coords>

typealias PathGeometry = List<Coords>

Functions

fun Location.asCoords(): Coords

fun Coords.bearingTo(other: Coords): Double

coordinateAtOffset

fun Coords.coordinateAtOffset(distance: Distance, bearing: Double): Coords

fun Coords.distanceTo(other: Coords): Distance

fractionalIndexBackwards

tailrec fun PathGeometry.fractionalIndexBackwards(fromIndex: Float, distance: Distance): Float

fun PathGeometry.fractionalIndexBackwards(fromIndex: Int, distance: Distance): Float

fractionalIndexForwards

tailrec fun PathGeometry.fractionalIndexForwards(fromIndex: Float, distance: Distance): Float

fun PathGeometry.fractionalIndexForwards(fromIndex: Int, distance: Distance): Float

getBearingAfterPoint

fun PathGeometry.getBearingAfterPoint(pathIndex: Int): Float

getBearingBeforePoint

fun PathGeometry.getBearingBeforePoint(pathIndex: Int): Float

getDistanceBetween

fun PathGeometry.getDistanceBetween(startIndex: Int, endIndex: Int): Distance

fun PathGeometry.getPathBetween(fractionalStartIndex: Float, fractionalEndIndex: Float): List<Coords>

getPointAtFractionalIndex

fun PathGeometry.getPointAtFractionalIndex(fractionalIndex: Float): Coords

isEffectivelyEqualTo

fun Coords.isEffectivelyEqualTo(other: Coords): Boolean

https://xkcd.com/2170/

nearestPointOnLine

fun Coords.nearestPointOnLine(from: Coords, to: Coords): Pair<Coords, Double>

fun Double.toDistance(distanceUnit: DistanceUnit): Distance

Properties

val Location.accuracy: Distance

val Double.feet: Distance

val Float.feet: Distance

val Int.feet: Distance

val Long.feet: Distance

val Double.meters: Distance

val Float.meters: Distance

val Int.meters: Distance

val Long.meters: Distance

val Double.miles: Distance

val Float.miles: Distance

val Int.miles: Distance

val Long.miles: Distance

val PathGeometry.totalDistance: Distance

val Double.yards: Distance

val Float.yards: Distance

val Int.yards: Distance

val Long.yards: Distance