ui.navigation.route_guidance_ui_if.RouteGuidanceUiIf Class Reference

Display active turn-by-turn route guidance. More...

Inheritance diagram for ui.navigation.route_guidance_ui_if.RouteGuidanceUiIf:

Public Member Functions
None	set_instruction (self, str|None instruction)
	Set the current maneuver instruction.
None	set_distance_to_maneuver (self, float|None distance_m)
	Set distance remaining until the current maneuver.
None	set_distance_remaining (self, float|None distance_m)
	Set total route distance remaining.
None	set_off_route (self, bool off_route)
	Set whether the vehicle is currently off route.
None	set_route_complete (self, bool complete)
	Set whether the destination has been reached.

Detailed Description

Display active turn-by-turn route guidance.

Member Function Documentation

set_distance_remaining()

None ui.navigation.route_guidance_ui_if.RouteGuidanceUiIf.set_distance_remaining	(		self,
		float | None	distance_m
	)

Set total route distance remaining.

Parameters

distance_m

Remaining route distance in meters, or None when unavailable.

Reimplemented in apps.carUi.screens.turn_by_turn_screen.TurnByTurnScreen, and ui.navigation.route_guidance_ui_stub.RouteGuidanceUiStub.

set_distance_to_maneuver()

None ui.navigation.route_guidance_ui_if.RouteGuidanceUiIf.set_distance_to_maneuver	(		self,
		float | None	distance_m
	)

Set distance remaining until the current maneuver.

Parameters

distance_m

Distance to the maneuver in meters, or None when unavailable.

Reimplemented in apps.carUi.screens.turn_by_turn_screen.TurnByTurnScreen, and ui.navigation.route_guidance_ui_stub.RouteGuidanceUiStub.

set_instruction()

None ui.navigation.route_guidance_ui_if.RouteGuidanceUiIf.set_instruction	(		self,
		str | None	instruction
	)

Set the current maneuver instruction.

Parameters

instruction

Human-readable maneuver instruction, or None when unavailable.

Reimplemented in apps.carUi.screens.turn_by_turn_screen.TurnByTurnScreen, and ui.navigation.route_guidance_ui_stub.RouteGuidanceUiStub.

set_off_route()

None ui.navigation.route_guidance_ui_if.RouteGuidanceUiIf.set_off_route	(		self,
		bool	off_route
	)

Set whether the vehicle is currently off route.

Parameters

off_route

True when the vehicle is considered off the active route.

Reimplemented in apps.carUi.screens.turn_by_turn_screen.TurnByTurnScreen, and ui.navigation.route_guidance_ui_stub.RouteGuidanceUiStub.

set_route_complete()

None ui.navigation.route_guidance_ui_if.RouteGuidanceUiIf.set_route_complete	(		self,
		bool	complete
	)

Set whether the destination has been reached.

Parameters

complete

True when route guidance has reached the destination.

Reimplemented in apps.carUi.screens.turn_by_turn_screen.TurnByTurnScreen, and ui.navigation.route_guidance_ui_stub.RouteGuidanceUiStub.

---

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

• ui/navigation/route_guidance_ui_if.py