com.tomtom.sdk.maps:map-display/com.tomtom.sdk.map.display.route

Package-level declarations

Types

class Instruction(val routeOffset: Distance = Distance.ZERO, val length: Distance = DEFAULT_MANEUVER_LENGTH, val combineWithNext: Boolean = false)

Represents an instruction arrow on a route.

Route

class Route

A Route representation which can be added and displayed on the map.

RouteClickListener

fun interface RouteClickListener

Interface for notifying about the Route being clicked.

RouteController

interface RouteController

Controls Route-specific features on the map. Allows Route management and the user interactions with the Route.

RouteNotFoundException

class RouteNotFoundException : RuntimeException

Exception thrown when a Route with the given routeId cannot be found on the map.

RouteOptions

data class RouteOptions(val geometry: List<GeoPoint>, @ColorInt val color: Int = DEFAULT_COLOR, @FloatRange(from = 0.0) val outlineWidth: Double = DEFAULT_OUTLINE_WIDTH, val widths: List<WidthByZoom> = DEFAULT_WIDTHS, val visible: Boolean = true, val progress: Distance = Distance.ZERO, val instructions: List<Instruction> = emptyList(), val tag: String? = null, val departureMarkerVisible: Boolean = false, val destinationMarkerVisible: Boolean = false, val followable: Boolean = false, val routeOffset: List<Distance> = emptyList(), val sections: List<RouteSection> = emptyList(), val departureMarkerPinImage: Image? = null, val destinationMarkerPinImage: Image? = null)

Configures options for a Route representation which can be added and displayed on the map. See TomTomMap.addRoute(routeOptions: RouteOptions).

RouteSection

data class RouteSection(val type: RouteSectionType, val start: GeoPoint, val end: GeoPoint, val geometry: List<GeoPoint> = emptyList(), val routeOffset: Distance = Distance.ZERO)

Represent the Route section.

RouteSectionType

@JvmInline

value class RouteSectionType

The type of a RouteSectionType.