OpenCPN Partial API docs
Loading...
Searching...
No Matches
DashboardInstrument_Dial Class Reference
Inheritance diagram for DashboardInstrument_Dial:
DashboardInstrument DashboardInstrument_AppTrueWindAngle DashboardInstrument_Compass DashboardInstrument_RudderAngle DashboardInstrument_Speedometer DashboardInstrument_TrueWindAngle DashboardInstrument_Wind DashboardInstrument_WindCompass

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)
 
void SetData (DASH_CAP, double, wxString)
 
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=NULL)
 
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

virtual void Draw (wxGCDC *dc)
 
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_AngleStart
 
int m_AngleRange
 
bool m_gpsWD
 
double m_MainValue
 
DASH_CAP m_MainValueCap
 
double m_MainValueMin
 
double m_MainValueMax
 
wxString m_MainValueFormat
 
wxString m_MainValueUnit
 
DialPositionOption m_MainValueOption
 
double m_ExtraValue
 
DASH_CAP m_ExtraValueCap
 
wxString m_ExtraValueFormat
 
wxString m_ExtraValueUnit
 
DialPositionOption m_ExtraValueOption
 
DialMarkerOption m_MarkerOption
 
int m_MarkerOffset
 
double m_MarkerStep
 
double m_LabelStep
 
DialLabelOption m_LabelOption
 
wxArrayString m_LabelArray
 
- 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
 
InstrumentPropertiesm_Properties
 

Detailed Description

Definition at line 84 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 51 of file dial.cpp.

◆ ~DashboardInstrument_Dial()

DashboardInstrument_Dial::~DashboardInstrument_Dial ( void  )
inline

Definition at line 90 of file dial.h.

Member Function Documentation

◆ Draw()

void DashboardInstrument_Dial::Draw ( wxGCDC *  dc)
protectedvirtual

Implements DashboardInstrument.

Definition at line 102 of file dial.cpp.

◆ DrawBackground()

void DashboardInstrument_Dial::DrawBackground ( wxGCDC *  dc)
protectedvirtual

Definition at line 319 of file dial.cpp.

◆ DrawData()

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

Definition at line 324 of file dial.cpp.

◆ DrawForeground()

void DashboardInstrument_Dial::DrawForeground ( wxGCDC *  dc)
protectedvirtual

Definition at line 453 of file dial.cpp.

◆ DrawFrame()

void DashboardInstrument_Dial::DrawFrame ( wxGCDC *  dc)
protectedvirtual

Definition at line 142 of file dial.cpp.

◆ DrawLabels()

void DashboardInstrument_Dial::DrawLabels ( wxGCDC *  dc)
protectedvirtual

Definition at line 257 of file dial.cpp.

◆ DrawMarkers()

void DashboardInstrument_Dial::DrawMarkers ( wxGCDC *  dc)
protectedvirtual

Definition at line 206 of file dial.cpp.

◆ GetSize()

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

Implements DashboardInstrument.

Definition at line 77 of file dial.cpp.

◆ SetData()

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

Implements DashboardInstrument.

Definition at line 90 of file dial.cpp.

◆ SetOptionExtraValue()

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

Definition at line 109 of file dial.h.

◆ SetOptionLabel()

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

Definition at line 99 of file dial.h.

◆ SetOptionMainValue()

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

Definition at line 105 of file dial.h.

◆ SetOptionMarker()

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

Definition at line 94 of file dial.h.

Member Data Documentation

◆ m_AngleRange

int DashboardInstrument_Dial::m_AngleRange
protected

Definition at line 120 of file dial.h.

◆ m_AngleStart

int DashboardInstrument_Dial::m_AngleStart
protected

Definition at line 120 of file dial.h.

◆ m_cx

int DashboardInstrument_Dial::m_cx
protected

Definition at line 119 of file dial.h.

◆ m_cy

int DashboardInstrument_Dial::m_cy
protected

Definition at line 119 of file dial.h.

◆ m_ExtraValue

double DashboardInstrument_Dial::m_ExtraValue
protected

Definition at line 128 of file dial.h.

◆ m_ExtraValueCap

DASH_CAP DashboardInstrument_Dial::m_ExtraValueCap
protected

Definition at line 129 of file dial.h.

◆ m_ExtraValueFormat

wxString DashboardInstrument_Dial::m_ExtraValueFormat
protected

Definition at line 130 of file dial.h.

◆ m_ExtraValueOption

DialPositionOption DashboardInstrument_Dial::m_ExtraValueOption
protected

Definition at line 132 of file dial.h.

◆ m_ExtraValueUnit

wxString DashboardInstrument_Dial::m_ExtraValueUnit
protected

Definition at line 131 of file dial.h.

◆ m_gpsWD

bool DashboardInstrument_Dial::m_gpsWD
protected

Definition at line 121 of file dial.h.

◆ m_LabelArray

wxArrayString DashboardInstrument_Dial::m_LabelArray
protected

Definition at line 137 of file dial.h.

◆ m_LabelOption

DialLabelOption DashboardInstrument_Dial::m_LabelOption
protected

Definition at line 136 of file dial.h.

◆ m_LabelStep

double DashboardInstrument_Dial::m_LabelStep
protected

Definition at line 135 of file dial.h.

◆ m_MainValue

double DashboardInstrument_Dial::m_MainValue
protected

Definition at line 122 of file dial.h.

◆ m_MainValueCap

DASH_CAP DashboardInstrument_Dial::m_MainValueCap
protected

Definition at line 123 of file dial.h.

◆ m_MainValueFormat

wxString DashboardInstrument_Dial::m_MainValueFormat
protected

Definition at line 125 of file dial.h.

◆ m_MainValueMax

double DashboardInstrument_Dial::m_MainValueMax
protected

Definition at line 124 of file dial.h.

◆ m_MainValueMin

double DashboardInstrument_Dial::m_MainValueMin
protected

Definition at line 124 of file dial.h.

◆ m_MainValueOption

DialPositionOption DashboardInstrument_Dial::m_MainValueOption
protected

Definition at line 127 of file dial.h.

◆ m_MainValueUnit

wxString DashboardInstrument_Dial::m_MainValueUnit
protected

Definition at line 126 of file dial.h.

◆ m_MarkerOffset

int DashboardInstrument_Dial::m_MarkerOffset
protected

Definition at line 134 of file dial.h.

◆ m_MarkerOption

DialMarkerOption DashboardInstrument_Dial::m_MarkerOption
protected

Definition at line 133 of file dial.h.

◆ m_MarkerStep

double DashboardInstrument_Dial::m_MarkerStep
protected

Definition at line 135 of file dial.h.

◆ m_radius

int DashboardInstrument_Dial::m_radius
protected

Definition at line 119 of file dial.h.


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