RoutePath

class RoutePath(engine: RoutePath, metadataRepository: MetadataRepository)

Wrapper class for a route path generated by the native engine.

This class provides access to route metadata, such as path segments, alerts, and distance/time estimates, and converts native structures into Kotlin-friendly representations.

Constructors

Link copied to clipboard
constructor(engine: RoutePath, metadataRepository: MetadataRepository)

Properties

Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard

Returns the set of alert identifiers associated with the route.

Link copied to clipboard
fun getClosestPathPoint(loc: MercatorZone): MercatorZone?

Finds the closest path point on the route path to the provided location.

Link copied to clipboard
fun getCoreEngine(): RoutePath
Link copied to clipboard
fun getCpp(): RoutePath
Link copied to clipboard

Returns the total distance and estimated travel time for the route.

Link copied to clipboard
fun getEngine(): RoutePath
Link copied to clipboard

Returns the last instruction of the route path, if available.

Link copied to clipboard
fun getLastPoint(): MercatorZone?

Returns the last point of the route path, if available.

Link copied to clipboard

Returns the last segment of the route path, if available.

Link copied to clipboard

Return the propertyId of the route path

Link copied to clipboard

Returns the routing error, if any, associated with the route computation.

Link copied to clipboard

Returns the list of segments that make up the route path.

Link copied to clipboard

Returns the first instruction of the route path, if available.

Link copied to clipboard
fun getStartPoint(): MercatorZone?

Returns the first point of the route path, if available.

Link copied to clipboard

Returns the first segment of the route path, if available.

Link copied to clipboard

Indicates whether the route is considered accessible (e.g., wheelchair accessible).

Link copied to clipboard

Indicates whether the route is from the user's current location.

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