AreaAlongRoute

class AreaAlongRoute(val corridorWidth: Distance = DEFAULT_CORRIDOR_WIDTH)

Defines an area along a route for prefetching.

Constructors

Link copied to clipboard
constructor(corridorWidth: Distance, corridorMinLength: Distance)

Important: This is a Public Preview API. It may be changed or removed at any time. Defines an area along a route for prefetching.

constructor(corridorWidth: Distance = DEFAULT_CORRIDOR_WIDTH)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

Important: This is a Public Preview API. It may be changed or removed at any time.

Link copied to clipboard

The width of the route corridor (must be at least MIN_CORRIDOR_WIDTH). This is the distance between the edges of the corridor. The 'corridor' is defined as the sum of the areas to the left and to the right of the central route polyline. corridorWidth measures its total width. Another way to think about this is to say that the corridor consists of all places within corridorWidth / 2 of the central route polyline, in all directions equally. Also corridorMinLength determinate the minimum corridor length to prefetch, ensuring it's downloaded and available even in case of later connectivity loss. Eg. on 200km route, we will prefetch at least the first corridorMinLength. Updating route current position will effectively move the 'sliding window'. The larger the area, the more robust the system is to temporary unavailability of the map data source, but at a greater memory and bandwidth cost.

Functions

Link copied to clipboard
open operator override fun equals(other: Any?): Boolean

Checks if this AreaAlongRoute object is equal to another object.

Link copied to clipboard
open override fun hashCode(): Int

Generates a hash code for this AreaAlongRoute object.

Link copied to clipboard
open override fun toString(): String

Returns a string representation of the object.