OpenRoadCode
Public API reference for OpenRoadCode
Loading...
Searching...
No Matches
ui.navigation.map_ui_if.MapUiIf Class Reference

Display map state and emit renderer-neutral map requests. More...

Inheritance diagram for ui.navigation.map_ui_if.MapUiIf:
frontends.common.map_renderer_ui.MapRendererUi ui.navigation.map_ui_stub.MapUiStub

Public Member Functions

None set_map_state (self, MapState|None state)
 Replace the displayed map state or clear unavailable state.
 
None set_map_request_handler (self, "MapRequestHandlerIf | None" handler)
 Connect or clear the handler for semantic map requests.
 

Detailed Description

Display map state and emit renderer-neutral map requests.

Member Function Documentation

◆ set_map_request_handler()

None ui.navigation.map_ui_if.MapUiIf.set_map_request_handler (   self,
"MapRequestHandlerIf | None"  handler 
)

Connect or clear the handler for semantic map requests.

Parameters
handlerRequest consumer, or None to disconnect it.

Reimplemented in frontends.common.map_renderer_ui.MapRendererUi, and ui.navigation.map_ui_stub.MapUiStub.

◆ set_map_state()

None ui.navigation.map_ui_if.MapUiIf.set_map_state (   self,
MapState | None  state 
)

Replace the displayed map state or clear unavailable state.

Parameters
stateComplete map snapshot, or None when unavailable.

Reimplemented in frontends.common.map_renderer_ui.MapRendererUi, and ui.navigation.map_ui_stub.MapUiStub.


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