Route

Collection of maneuvers and roadElements connecting two or more waypoints. Waypoints may be thought of as the input to a route calculation whereas maneuvers are the results of calculating a route.

Note: Parceled Route object is valid only if the original route object is also valid.

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
Link copied to clipboard

Returns the destination waypoint of the route

Link copied to clipboard

Route created from parcel may not be valid, if original route was already destroyed

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Returns basic route info.

Link copied to clipboard
Link copied to clipboard

Returns the starting waypoint of the route

Link copied to clipboard

Functions

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

Returns list of GeoPolylines representing route segments

Link copied to clipboard

Returns a list of {@link RouteElement} objects for current route object from start. The elements are generated asynchronously and returned via callback. The callback will be called on provided executor or on main thread if null. Note: This array doesn't change while navigating.

Link copied to clipboard
fun getRouteGeometry(withAltitude: Boolean, listener: GeometryListener, executor: Executor? = null)

Returns geometry with altitude of route. Geometry is generated asynchronously and callback is then called on provided executor with results.

Link copied to clipboard

Returns a list of {@link RouteWarning} warnings, which occurred during route calculation.

Link copied to clipboard

Retrieves list of countries route is passing by with regions, if available

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

Serialize the route to a JSON string. Brief serialization is to be used with {@link Router#computeRouteFromJSONString(String, RouteComputeListener, Executor)}. Only waypoints and routing options are saved, so route has to be computed again.

Link copied to clipboard

Serialize the route to a JSON string. Full serialization is to be used with {@link Route#deserializeFromFullJSON(String)}. All of route info is saved, so no computing is needed.

Link copied to clipboard
abstract fun writeToParcel(p0: Parcel, p1: Int)