ui.navigation.translation_ui_if.TranslationUiIf Class Reference

Display translational motion in the vehicle coordinate frame. More...

Inheritance diagram for ui.navigation.translation_ui_if.TranslationUiIf:

Public Member Functions
None	set_rate_of_climb (self, float|None rate_mps)
	Set the rate of climb.
None	set_accel_x (self, float|None acceleration_x_mps2)
	Set X-axis acceleration.
None	set_accel_y (self, float|None acceleration_y_mps2)
	Set Y-axis acceleration.
None	set_accel_z (self, float|None acceleration_z_mps2)
	Set Z-axis acceleration.
None	set_accel_total (self, float|None acceleration_magnitude_mps2)
	Set the total acceleration magnitude.

Detailed Description

Display translational motion in the vehicle coordinate frame.

The X axis points forward, Y points left, and Z points up. Acceleration is linear acceleration with gravity removed. The total is the Euclidean magnitude of that three-axis vector. Positive climb rate is upward. None means a measurement is unavailable.

Member Function Documentation

set_accel_total()

None ui.navigation.translation_ui_if.TranslationUiIf.set_accel_total	(		self,
		float | None	acceleration_magnitude_mps2
	)

Set the total acceleration magnitude.

Parameters

acceleration_magnitude_mps2

Metres per second squared, or None.

Reimplemented in frontends.tk.automotive.offroad_dashboard_panel.OffroadDashboardPanel, and ui.navigation.translation_ui_stub.TranslationUiStub.

set_accel_x()

None ui.navigation.translation_ui_if.TranslationUiIf.set_accel_x	(		self,
		float | None	acceleration_x_mps2
	)

Set X-axis acceleration.

Parameters

acceleration_x_mps2

Metres per second squared, or None.

Reimplemented in frontends.tk.automotive.offroad_dashboard_panel.OffroadDashboardPanel, and ui.navigation.translation_ui_stub.TranslationUiStub.

set_accel_y()

None ui.navigation.translation_ui_if.TranslationUiIf.set_accel_y	(		self,
		float | None	acceleration_y_mps2
	)

Set Y-axis acceleration.

Parameters

acceleration_y_mps2

Metres per second squared, or None.

Reimplemented in frontends.tk.automotive.offroad_dashboard_panel.OffroadDashboardPanel, and ui.navigation.translation_ui_stub.TranslationUiStub.

set_accel_z()

None ui.navigation.translation_ui_if.TranslationUiIf.set_accel_z	(		self,
		float | None	acceleration_z_mps2
	)

Set Z-axis acceleration.

Parameters

acceleration_z_mps2

Metres per second squared, or None.

Reimplemented in frontends.tk.automotive.offroad_dashboard_panel.OffroadDashboardPanel, and ui.navigation.translation_ui_stub.TranslationUiStub.

set_rate_of_climb()

None ui.navigation.translation_ui_if.TranslationUiIf.set_rate_of_climb	(		self,
		float | None	rate_mps
	)

Set the rate of climb.

Parameters

rate_mps

Metres per second, or None when unavailable.

Reimplemented in frontends.tk.automotive.offroad_dashboard_panel.OffroadDashboardPanel, and ui.navigation.translation_ui_stub.TranslationUiStub.

---

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

• ui/navigation/translation_ui_if.py