navigation.navigation_route_request_handler.NavigationRouteRequestHandler Class Reference

Send semantic UI route requests to the navigation service. More...

Inheritance diagram for navigation.navigation_route_request_handler.NavigationRouteRequestHandler:

Public Member Functions
RouteResult|None	active_route (self)
	Return the most recently started route, or None after cancellation.
None	observe_route (self, Callable[[RouteResult|None], None] observer)
	Receive successful route starts and cancellation events.
None	request_start_route (self, GeoPoint destination, Sequence[GeoPoint] waypoints, TravelMode travel_mode)
	Request route calculation and guidance.
None	request_cancel_route (self)
	Request cancellation of active route guidance.
None	request_start_route_simulation (self, *float time_scale=60.0)
	Start simulated movement along the active route.
None	request_stop_route_simulation (self)
	Stop simulated route traversal and restore normal position input.
None	request_add_waypoint (self, GeoPoint waypoint)
	Request addition of an intermediate route location.
None	request_remove_waypoint (self, int waypoint_index)
	Request removal of a waypoint by its displayed index.
None	request_select_alternative (self, int alternative_index)
	Request selection of an alternative route.
None	request_recalculate_route (self)
	Request immediate route recalculation from current position.
None	request_travel_mode (self, TravelMode travel_mode)
	Request a new route costing mode.
None	request_voice_guidance_muted (self, bool muted)
	Request spoken route guidance mute state.

Detailed Description

Send semantic UI route requests to the navigation service.

Member Function Documentation

request_add_waypoint()

None navigation.navigation_route_request_handler.NavigationRouteRequestHandler.request_add_waypoint	(		self,
		GeoPoint	waypoint
	)

Request addition of an intermediate route location.

Parameters

waypoint

Geographic waypoint to add.

Reimplemented from ui.navigation.route_request_handler_if.RouteRequestHandlerIf.

request_remove_waypoint()

None navigation.navigation_route_request_handler.NavigationRouteRequestHandler.request_remove_waypoint	(		self,
		int	waypoint_index
	)

Request removal of a waypoint by its displayed index.

Parameters

waypoint_index

Zero-based waypoint index.

Reimplemented from ui.navigation.route_request_handler_if.RouteRequestHandlerIf.

request_select_alternative()

None navigation.navigation_route_request_handler.NavigationRouteRequestHandler.request_select_alternative	(		self,
		int	alternative_index
	)

Request selection of an alternative route.

Parameters

alternative_index

Zero-based alternative-route index.

Reimplemented from ui.navigation.route_request_handler_if.RouteRequestHandlerIf.

request_start_route()

None navigation.navigation_route_request_handler.NavigationRouteRequestHandler.request_start_route	(		self,
		GeoPoint	destination,
		Sequence[GeoPoint]	waypoints,
		TravelMode	travel_mode
	)

Request route calculation and guidance.

Parameters

destination	Requested final destination.
waypoints	Ordered intermediate route locations.
travel_mode	Requested route costing mode.

Reimplemented from ui.navigation.route_request_handler_if.RouteRequestHandlerIf.

request_start_route_simulation()

None navigation.navigation_route_request_handler.NavigationRouteRequestHandler.request_start_route_simulation	(		self,
		*float	time_scale = 60.0
	)

Start simulated movement along the active route.

Parameters

time_scale

Simulation speed multiplier relative to real time.

Reimplemented from ui.navigation.route_simulation_request_handler_if.RouteSimulationRequestHandlerIf.

request_travel_mode()

None navigation.navigation_route_request_handler.NavigationRouteRequestHandler.request_travel_mode	(		self,
		TravelMode	travel_mode
	)

Request a new route costing mode.

Parameters

travel_mode

Requested travel mode.

Reimplemented from ui.navigation.route_request_handler_if.RouteRequestHandlerIf.

request_voice_guidance_muted()

None navigation.navigation_route_request_handler.NavigationRouteRequestHandler.request_voice_guidance_muted	(		self,
		bool	muted
	)

Request spoken route guidance mute state.

Parameters

muted

True to mute spoken route guidance.

Reimplemented from ui.navigation.route_request_handler_if.RouteRequestHandlerIf.

---

The documentation for this class was generated from the following file:

• controllers/navigation/navigation_route_request_handler.py