OpenRoadCode
Public API reference for OpenRoadCode
Loading...
Searching...
No Matches
frontends.tk.automotive.offroad_dashboard_panel.OffroadDashboardPanel Class Reference

Display trail-oriented navigation data through narrow UI contracts. More...

Inheritance diagram for frontends.tk.automotive.offroad_dashboard_panel.OffroadDashboardPanel:
ui.navigation.orientation_ui_if.OrientationUiIf ui.navigation.translation_ui_if.TranslationUiIf ui.navigation.position_ui_if.PositionUiIf ui.navigation.ground_track_ui_if.GroundTrackUiIf ui.system.status_ui_if.StatusUiIf

Public Member Functions

None set_theme (self, OffroadTheme theme)
 Apply a resolved off-road theme and redraw the dashboard.
 
None set_style_sheet (self, StyleSheet sheet)
 Apply the .automotive-offroad stylesheet rule.
 
None set_navigation_request_handler (self, NavigationRequestHandlerIf|None handler)
 Connect or clear navigation-control requests.
 
None set_heading (self, float|None heading_rad, HeadingReference reference=HeadingReference.TRUE_NORTH)
 Set displayed heading; the dashboard labels relative headings.
 
None set_pitch (self, float|None pitch_rad)
 Set displayed pitch.
 
None set_roll (self, float|None roll_rad)
 Set displayed roll.
 
None set_rate_of_climb (self, float|None rate_mps)
 Accept climb rate, which is not currently rendered.
 
None set_accel_x (self, float|None acceleration_x_mps2)
 Set fore/aft linear acceleration.
 
None set_accel_y (self, float|None acceleration_y_mps2)
 Set lateral linear acceleration.
 
None set_accel_z (self, float|None acceleration_z_mps2)
 Store vertical linear acceleration.
 
None set_accel_total (self, float|None acceleration_magnitude_mps2)
 Accept total acceleration, which is not currently rendered.
 
None set_position (self, PositionFix|None position_fix)
 Set position-derived altitude.
 
None set_satellites (self, Sequence[SatelliteInfo] satellites)
 Set the count of satellites used in the current fix.
 
None set_ground_speed (self, float|None speed_mps)
 Set speed over ground.
 
None set_course_over_ground (self, float|None course_rad)
 Set actual direction of travel over the ground.
 
None set_status (self, StatusValue status)
 Set the concise dashboard status line.
 

Protected Member Functions

None _draw_capsized_banner (self, float center_x, float center_y, float radius)
 Draw a deliberately dramatic inverted-vehicle warning.
 
None _draw_heading_card (self, float x, float y, float width, _DashboardState|None state)
 Draw relative heading and optional GPS course from above.
 
None _draw_pitch_card (self, float x, float y, float width, float|None value, float warning_deg)
 Draw a compact side-profile inclinometer with threshold bands.
 
None _draw_front_jeep (self, float center_x, float center_y, float radius, float roll_deg)
 Draw a recognizable front-view Jeep rotated by vehicle roll.
 
None _draw_pitch_scale (self, float center_x, float center_y, float radius, float pitch_deg)
 Draw a labeled vertical pitch ladder beside the Jeep.
 

Detailed Description

Display trail-oriented navigation data through narrow UI contracts.

Member Function Documentation

◆ set_accel_total()

None frontends.tk.automotive.offroad_dashboard_panel.OffroadDashboardPanel.set_accel_total (   self,
float | None  acceleration_magnitude_mps2 
)

Accept total acceleration, which is not currently rendered.

Parameters
acceleration_magnitude_mps2Acceleration magnitude, or None.

Reimplemented from ui.navigation.translation_ui_if.TranslationUiIf.

◆ set_accel_x()

None frontends.tk.automotive.offroad_dashboard_panel.OffroadDashboardPanel.set_accel_x (   self,
float | None  acceleration_x_mps2 
)

Set fore/aft linear acceleration.

Parameters
acceleration_x_mps2Acceleration in metres per second squared.

Reimplemented from ui.navigation.translation_ui_if.TranslationUiIf.

◆ set_accel_y()

None frontends.tk.automotive.offroad_dashboard_panel.OffroadDashboardPanel.set_accel_y (   self,
float | None  acceleration_y_mps2 
)

Set lateral linear acceleration.

Parameters
acceleration_y_mps2Acceleration in metres per second squared.

Reimplemented from ui.navigation.translation_ui_if.TranslationUiIf.

◆ set_accel_z()

None frontends.tk.automotive.offroad_dashboard_panel.OffroadDashboardPanel.set_accel_z (   self,
float | None  acceleration_z_mps2 
)

Store vertical linear acceleration.

Parameters
acceleration_z_mps2Acceleration in metres per second squared.

Reimplemented from ui.navigation.translation_ui_if.TranslationUiIf.

◆ set_course_over_ground()

None frontends.tk.automotive.offroad_dashboard_panel.OffroadDashboardPanel.set_course_over_ground (   self,
float | None  course_rad 
)

Set actual direction of travel over the ground.

Parameters
course_radClockwise radians from true north, or None.

Reimplemented from ui.navigation.ground_track_ui_if.GroundTrackUiIf.

◆ set_ground_speed()

None frontends.tk.automotive.offroad_dashboard_panel.OffroadDashboardPanel.set_ground_speed (   self,
float | None  speed_mps 
)

Set speed over ground.

Parameters
speed_mpsSpeed in metres per second, or None.

Reimplemented from ui.navigation.ground_track_ui_if.GroundTrackUiIf.

◆ set_heading()

None frontends.tk.automotive.offroad_dashboard_panel.OffroadDashboardPanel.set_heading (   self,
float | None  heading_rad,
HeadingReference   reference = HeadingReference.TRUE_NORTH 
)

Set displayed heading; the dashboard labels relative headings.

Parameters
heading_radHeading in radians, or None when unavailable.
referenceSupplied north reference.

Reimplemented from ui.navigation.orientation_ui_if.OrientationUiIf.

◆ set_navigation_request_handler()

None frontends.tk.automotive.offroad_dashboard_panel.OffroadDashboardPanel.set_navigation_request_handler (   self,
NavigationRequestHandlerIf | None  handler 
)

Connect or clear navigation-control requests.

Parameters
handlerRequest consumer, or None to disable the controls.

◆ set_pitch()

None frontends.tk.automotive.offroad_dashboard_panel.OffroadDashboardPanel.set_pitch (   self,
float | None  pitch_rad 
)

Set displayed pitch.

Parameters
pitch_radPitch in radians, or None.

Reimplemented from ui.navigation.orientation_ui_if.OrientationUiIf.

◆ set_position()

None frontends.tk.automotive.offroad_dashboard_panel.OffroadDashboardPanel.set_position (   self,
PositionFix | None  position_fix 
)

Set position-derived altitude.

Parameters
position_fixPosition fix, or None when unavailable.

Reimplemented from ui.navigation.position_ui_if.PositionUiIf.

◆ set_rate_of_climb()

None frontends.tk.automotive.offroad_dashboard_panel.OffroadDashboardPanel.set_rate_of_climb (   self,
float | None  rate_mps 
)

Accept climb rate, which is not currently rendered.

Parameters
rate_mpsClimb rate in metres per second, or None.

Reimplemented from ui.navigation.translation_ui_if.TranslationUiIf.

◆ set_roll()

None frontends.tk.automotive.offroad_dashboard_panel.OffroadDashboardPanel.set_roll (   self,
float | None  roll_rad 
)

Set displayed roll.

Parameters
roll_radRoll in radians, or None.

Reimplemented from ui.navigation.orientation_ui_if.OrientationUiIf.

◆ set_satellites()

None frontends.tk.automotive.offroad_dashboard_panel.OffroadDashboardPanel.set_satellites (   self,
Sequence[SatelliteInfo]  satellites 
)

Set the count of satellites used in the current fix.

Parameters
satellitesComplete satellite snapshot.

Reimplemented from ui.navigation.position_ui_if.PositionUiIf.

◆ set_status()

None frontends.tk.automotive.offroad_dashboard_panel.OffroadDashboardPanel.set_status (   self,
StatusValue  status 
)

Set the concise dashboard status line.

Parameters
statusStructured status, text, or None.

Reimplemented from ui.system.status_ui_if.StatusUiIf.


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