Summary: Methods | [Expand All]
public static interface

MapApi.Wayfinding

com.mapsted.map.MapApi.Wayfinding
Known Indirect Subclasses

Class Overview

Access Wayfinding, Routing, turn-by-turn Navigation related information and functionalities

Summary

Public Methods
abstract void clearAllRoutes()
Clears RouteResponse objects
abstract void clearBuildingRoutes(int buildingId)
Clears route data on all floors for the provided building id
abstract void clearPropertyRoutes(int propertyId)
Clear routes on property layer
abstract RouteNode getCurNavigationInstruction()
Get current navigation instruction.
abstract void requestRouting(RouteRequest request, RoutingRequestCallback callback)
Request a route
abstract void startNavigation(Route route, RoutingStatusCallback routingStatusCallback)
This function will start navigation process.
abstract void stopNavigation()
This function will stop navigation process.
abstract void switchRoute(Route route)
Change path drawing to a different route.
abstract void switchRouteSegment(RouteSegment routeSegment)
Change path drawing to another route segment within the same route If you want to change to another route segment, use switchRoute(Route)} instead.

Public Methods

public abstract void clearAllRoutes ()

Clears RouteResponse objects

public abstract void clearBuildingRoutes (int buildingId)

Clears route data on all floors for the provided building id

Parameters
buildingId Building id for which the routes are supposed to be cleared

public abstract void clearPropertyRoutes (int propertyId)

Clear routes on property layer

Parameters
propertyId the route's PropertyId to clear

public abstract RouteNode getCurNavigationInstruction ()

Get current navigation instruction.

Call this function to get the latest navigation instruction. This function need to be called inside navigation mode. Assume startNavigation(Route, RoutingStatusCallback) is already called.

Returns
  • A routing instruction contains a double value indicates the map rotation angle, and a set of route information.

public abstract void requestRouting (RouteRequest request, RoutingRequestCallback callback)

Request a route

Parameters
request route request with options
callback Callback when successful or failed

public abstract void startNavigation (Route route, RoutingStatusCallback routingStatusCallback)

This function will start navigation process. It will clear previous routes, tilt focus map, handle paths drawn on the map. Then call positioning library to start navigation process.

Parameters
route the desired route
routingStatusCallback callback for status updates
See Also

public abstract void stopNavigation ()

This function will stop navigation process. It will call positioning library to stop navigation process.

See Also

public abstract void switchRoute (Route route)

Change path drawing to a different route. If you want to change route segment only and keep the same route, use switchRouteSegment(RouteSegment) instead.

Parameters
route The route you want to switch to
See Also

public abstract void switchRouteSegment (RouteSegment routeSegment)

Change path drawing to another route segment within the same route If you want to change to another route segment, use switchRoute(Route)} instead.

Parameters
routeSegment The route segment you want to switch.
See Also