Inheritance diagram for DashboardInstrument_Dial:

Public Member Functions
	DashboardInstrument_Dial (wxWindow parent, wxWindowID id, wxString title, InstrumentProperties Properties, DASH_CAP cap_flag, int s_angle, int r_angle, int s_value, int e_value)

wxSize	GetSize (int orient, wxSize hint) override

void	SetData (DASH_CAP, double, wxString) override

void	SetOptionMarker (double step, DialMarkerOption option, int offset)

void	SetOptionLabel (double step, DialLabelOption option, wxArrayString labels=wxArrayString())

void	SetOptionMainValue (wxString format, DialPositionOption option)

void	SetOptionExtraValue (DASH_CAP cap, wxString format, DialPositionOption option)

Public Member Functions inherited from DashboardInstrument
	DashboardInstrument (wxWindow pparent, wxWindowID id, wxString title, DASH_CAP cap_flag, InstrumentProperties Properties=nullptr)

CapType	GetCapacity ()

void	OnEraseBackground (wxEraseEvent &WXUNUSED(evt))

void	OnPaint (wxPaintEvent &WXUNUSED(event))

void	SetDrawSoloInPane (bool value)

void	MouseEvent (wxMouseEvent &event)

void	OnLeftUp (wxMouseEvent &event)

void	SetCapFlag (DASH_CAP val)

bool	HasCapFlag (DASH_CAP val)

Protected Member Functions
void	Draw (wxGCDC *dc) override

virtual void	DrawFrame (wxGCDC *dc)

virtual void	DrawMarkers (wxGCDC *dc)

virtual void	DrawLabels (wxGCDC *dc)

virtual void	DrawBackground (wxGCDC *dc)

virtual void	DrawData (wxGCDC *dc, double value, wxString unit, wxString format, DialPositionOption position)

virtual void	DrawForeground (wxGCDC *dc)

Protected Member Functions inherited from DashboardInstrument
virtual void	InitDataTextHeight (const wxString &sampleText, int &sampleWidth)

virtual void	InitTitleSize ()

virtual void	InitTitleAndDataPosition (int drawHeight)

virtual int	GetFullHeight (int drawHeight)

virtual int	GetDataBottom (int clientHeight)

virtual void	SetDataFont (wxGCDC *dc)

Protected Attributes
int	m_cx

int	m_cy

int	m_radius

int	m_angle_start

int	m_angle_range

bool	m_gps_wd

double	m_main_value

DASH_CAP	m_main_value_cap

double	m_main_value_min

double	m_main_value_max

wxString	m_main_value_format

wxString	m_main_value_unit

DialPositionOption	m_main_value_option

double	m_extra_value

DASH_CAP	m_extra_value_cap

wxString	m_extra_value_format

wxString	m_extra_value_unit

DialPositionOption	m_extra_value_option

DialMarkerOption	m_marker_option

int	m_marker_offset

double	m_marker_step

double	m_label_step

DialLabelOption	m_label_option

wxArrayString	m_label_array

Protected Attributes inherited from DashboardInstrument
CapType	m_cap_flag

int	m_InstrumentSpacing

int	m_DataTextHeight

int	m_DataMargin

int	m_TitleWidth

int	m_TitleHeight

int	m_DataTop

int	m_TitleTop

bool	m_DataRightAlign

bool	m_TitleRightAlign

wxString	m_title

Additional Inherited Members
Public Attributes inherited from DashboardInstrument
int	instrumentTypeId

InstrumentProperties *	m_Properties

Detailed Description

Definition at line 78 of file dial.h.

Constructor & Destructor Documentation

◆ DashboardInstrument_Dial()

DashboardInstrument_Dial::DashboardInstrument_Dial	(	wxWindow *	parent,
		wxWindowID	id,
		wxString	title,
		InstrumentProperties *	Properties,
		DASH_CAP	cap_flag,
		int	s_angle,
		int	r_angle,
		int	s_value,
		int	e_value
	)

Definition at line 45 of file dial.cpp.

Member Function Documentation

◆ Draw()

void DashboardInstrument_Dial::Draw ( wxGCDC * dc )

overrideprotectedvirtual

Implements DashboardInstrument.

Definition at line 96 of file dial.cpp.

◆ DrawBackground()

void DashboardInstrument_Dial::DrawBackground ( wxGCDC * dc )

protectedvirtual

Definition at line 314 of file dial.cpp.

◆ DrawData()

void DashboardInstrument_Dial::DrawData	(	wxGCDC *	dc,
		double	value,
		wxString	unit,
		wxString	format,
		DialPositionOption	position
	)

protectedvirtual

Definition at line 319 of file dial.cpp.

◆ DrawForeground()

void DashboardInstrument_Dial::DrawForeground ( wxGCDC * dc )

protectedvirtual

Definition at line 447 of file dial.cpp.

◆ DrawFrame()

void DashboardInstrument_Dial::DrawFrame ( wxGCDC * dc )

protectedvirtual

Definition at line 136 of file dial.cpp.

◆ DrawLabels()

void DashboardInstrument_Dial::DrawLabels ( wxGCDC * dc )

protectedvirtual

Definition at line 252 of file dial.cpp.

◆ DrawMarkers()

void DashboardInstrument_Dial::DrawMarkers ( wxGCDC * dc )

protectedvirtual

Definition at line 200 of file dial.cpp.

◆ GetSize()

wxSize DashboardInstrument_Dial::GetSize	(	int	orient,
		wxSize	hint
	)

overridevirtual

Implements DashboardInstrument.

Definition at line 71 of file dial.cpp.

◆ SetData()

void DashboardInstrument_Dial::SetData	(	DASH_CAP	st,
		double	data,
		wxString	unit
	)

overridevirtual

Implements DashboardInstrument.

Definition at line 84 of file dial.cpp.

◆ SetOptionExtraValue()

void DashboardInstrument_Dial::SetOptionExtraValue	(	DASH_CAP	cap,
		wxString	format,
		DialPositionOption	option
	)

inline

Definition at line 103 of file dial.h.

◆ SetOptionLabel()

void DashboardInstrument_Dial::SetOptionLabel	(	double	step,
		DialLabelOption	option,
		wxArrayString	labels = `wxArrayString()`
	)

inline

Definition at line 93 of file dial.h.

◆ SetOptionMainValue()

void DashboardInstrument_Dial::SetOptionMainValue	(	wxString	format,
		DialPositionOption	option
	)

inline

Definition at line 99 of file dial.h.

◆ SetOptionMarker()

void DashboardInstrument_Dial::SetOptionMarker	(	double	step,
		DialMarkerOption	option,
		int	offset
	)

inline

Definition at line 88 of file dial.h.

Member Data Documentation

◆ m_angle_range

int DashboardInstrument_Dial::m_angle_range

protected

Definition at line 114 of file dial.h.

◆ m_angle_start

int DashboardInstrument_Dial::m_angle_start

protected

Definition at line 114 of file dial.h.

◆ m_cx

int DashboardInstrument_Dial::m_cx

protected

Definition at line 113 of file dial.h.

◆ m_cy

int DashboardInstrument_Dial::m_cy

protected

Definition at line 113 of file dial.h.

◆ m_extra_value

double DashboardInstrument_Dial::m_extra_value

protected

Definition at line 122 of file dial.h.

◆ m_extra_value_cap

DASH_CAP DashboardInstrument_Dial::m_extra_value_cap

protected

Definition at line 123 of file dial.h.

◆ m_extra_value_format

wxString DashboardInstrument_Dial::m_extra_value_format

protected

Definition at line 124 of file dial.h.

◆ m_extra_value_option

DialPositionOption DashboardInstrument_Dial::m_extra_value_option

protected

Definition at line 126 of file dial.h.

◆ m_extra_value_unit

wxString DashboardInstrument_Dial::m_extra_value_unit

protected

Definition at line 125 of file dial.h.

◆ m_gps_wd

bool DashboardInstrument_Dial::m_gps_wd

protected

Definition at line 115 of file dial.h.

◆ m_label_array

wxArrayString DashboardInstrument_Dial::m_label_array

protected

Definition at line 131 of file dial.h.

◆ m_label_option

DialLabelOption DashboardInstrument_Dial::m_label_option

protected

Definition at line 130 of file dial.h.

◆ m_label_step

double DashboardInstrument_Dial::m_label_step

protected

Definition at line 129 of file dial.h.

◆ m_main_value

double DashboardInstrument_Dial::m_main_value

protected

Definition at line 116 of file dial.h.

◆ m_main_value_cap

DASH_CAP DashboardInstrument_Dial::m_main_value_cap

protected

Definition at line 117 of file dial.h.

◆ m_main_value_format

wxString DashboardInstrument_Dial::m_main_value_format

protected

Definition at line 119 of file dial.h.

◆ m_main_value_max

double DashboardInstrument_Dial::m_main_value_max

protected

Definition at line 118 of file dial.h.

◆ m_main_value_min

double DashboardInstrument_Dial::m_main_value_min

protected

Definition at line 118 of file dial.h.

◆ m_main_value_option

DialPositionOption DashboardInstrument_Dial::m_main_value_option

protected

Definition at line 121 of file dial.h.

◆ m_main_value_unit

wxString DashboardInstrument_Dial::m_main_value_unit

protected

Definition at line 120 of file dial.h.

◆ m_marker_offset

int DashboardInstrument_Dial::m_marker_offset

protected

Definition at line 128 of file dial.h.

◆ m_marker_option

DialMarkerOption DashboardInstrument_Dial::m_marker_option

protected

Definition at line 127 of file dial.h.

◆ m_marker_step

double DashboardInstrument_Dial::m_marker_step

protected

Definition at line 129 of file dial.h.

◆ m_radius

int DashboardInstrument_Dial::m_radius

protected

Definition at line 113 of file dial.h.

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

/home/runner/work/main/main/opencpn/plugins/dashboard_pi/src/dial.h
/home/runner/work/main/main/opencpn/plugins/dashboard_pi/src/dial.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DashboardInstrument_Dial()

Member Function Documentation

◆ Draw()

◆ DrawBackground()

◆ DrawData()

◆ DrawForeground()

◆ DrawFrame()

◆ DrawLabels()

◆ DrawMarkers()

◆ GetSize()

◆ SetData()

◆ SetOptionExtraValue()

◆ SetOptionLabel()

◆ SetOptionMainValue()

◆ SetOptionMarker()

Member Data Documentation

◆ m_angle_range

◆ m_angle_start

◆ m_cx

◆ m_cy

◆ m_extra_value

◆ m_extra_value_cap

◆ m_extra_value_format

◆ m_extra_value_option

◆ m_extra_value_unit

◆ m_gps_wd

◆ m_label_array

◆ m_label_option

◆ m_label_step

◆ m_main_value

◆ m_main_value_cap

◆ m_main_value_format

◆ m_main_value_max

◆ m_main_value_min

◆ m_main_value_option

◆ m_main_value_unit

◆ m_marker_offset

◆ m_marker_option

◆ m_marker_step

◆ m_radius