ui.navigation.orientation_ui_if.OrientationUiIf Class Reference

Display vehicle attitude in a right-handed vehicle coordinate frame. More...

Inheritance diagram for ui.navigation.orientation_ui_if.OrientationUiIf:

Public Member Functions
None	set_heading (self, float|None heading_rad, HeadingReference reference=HeadingReference.TRUE_NORTH)
	Set heading in radians and identify its north reference.
None	set_pitch (self, float|None pitch_rad)
	Set pitch in radians, positive nose-up.
None	set_roll (self, float|None roll_rad)
	Set roll using the vehicle-frame right-hand rule.

Detailed Description

Display vehicle attitude in a right-handed vehicle coordinate frame.

The X axis points forward, Y points left, and Z points up. Roll is rotation about X and pitch is rotation about Y, following the right-hand rule. Heading is a bearing in [0, 2*pi) increasing clockwise from the selected true-north, magnetic-north, or user-defined relative reference. Heading is the navigation form of yaw, so a separate yaw setter is intentionally not exposed.

None means the corresponding measurement is unavailable.

Member Function Documentation

set_heading()

None ui.navigation.orientation_ui_if.OrientationUiIf.set_heading	(		self,
		float | None	heading_rad,
		HeadingReference	reference = HeadingReference.TRUE_NORTH
	)

Set heading in radians and identify its north reference.

Parameters

heading_rad	Heading in radians, or None when unavailable.
reference	North reference used by the supplied heading.

Reimplemented in frontends.tk.automotive.offroad_dashboard_panel.OffroadDashboardPanel, and ui.navigation.orientation_ui_stub.OrientationUiStub.

set_pitch()

None ui.navigation.orientation_ui_if.OrientationUiIf.set_pitch	(		self,
		float | None	pitch_rad
	)

Set pitch in radians, positive nose-up.

Parameters

pitch_rad

Pitch in radians, or None when unavailable.

Reimplemented in frontends.tk.automotive.offroad_dashboard_panel.OffroadDashboardPanel, and ui.navigation.orientation_ui_stub.OrientationUiStub.

set_roll()

None ui.navigation.orientation_ui_if.OrientationUiIf.set_roll	(		self,
		float | None	roll_rad
	)

Set roll using the vehicle-frame right-hand rule.

Parameters

roll_rad

Roll in radians, or None when unavailable.

Reimplemented in frontends.tk.automotive.offroad_dashboard_panel.OffroadDashboardPanel, and ui.navigation.orientation_ui_stub.OrientationUiStub.

---

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

• ui/navigation/orientation_ui_if.py