opencpn_plugin Class Reference

Inheritance diagram for opencpn_plugin:

Public Member Functions
	opencpn_plugin (void *pmgr)
virtual int	Init (void)
virtual bool	DeInit (void)
virtual int	GetAPIVersionMajor ()
virtual int	GetAPIVersionMinor ()
virtual int	GetPlugInVersionMajor ()
virtual int	GetPlugInVersionMinor ()
virtual wxBitmap *	GetPlugInBitmap ()
	FIXME static wxBitmap* LoadSVG(const wxString filename, unsigned int width, unsigned int height) { if (!gFrame) return new wxBitmap(width, height); // We are headless.
virtual wxString	GetCommonName ()
virtual wxString	GetShortDescription ()
virtual wxString	GetLongDescription ()
virtual void	SetDefaults (void)
virtual int	GetToolbarToolCount (void)
virtual int	GetToolboxPanelCount (void)
virtual void	SetupToolboxPanel (int page_sel, wxNotebook *pnotebook)
virtual void	OnCloseToolboxPanel (int page_sel, int ok_apply_cancel)
virtual void	ShowPreferencesDialog (wxWindow *parent)
virtual bool	RenderOverlay (wxMemoryDC *pmdc, PlugIn_ViewPort *vp)
virtual void	SetCursorLatLon (double lat, double lon)
virtual void	SetCurrentViewPort (PlugIn_ViewPort &vp)
virtual void	SetPositionFix (PlugIn_Position_Fix &pfix)
virtual void	SetNMEASentence (wxString &sentence)
	Receive all NMEA 0183 sentences from OpenCPN.
virtual void	SetAISSentence (wxString &sentence)
	Receive all AIS sentences from OpenCPN.
virtual void	ProcessParentResize (int x, int y)
virtual void	SetColorScheme (PI_ColorScheme cs)
virtual void	OnToolbarToolCallback (int id)
virtual void	OnContextMenuItemCallback (int id)
virtual void	UpdateAuiStatus (void)
virtual wxArrayString	GetDynamicChartClassNameArray (void)

Detailed Description

Examples

/home/runner/work/main/main/opencpn/include/ocpn_plugin.h.

Definition at line 444 of file ocpn_plugin.h.

Constructor & Destructor Documentation

opencpn_plugin()

opencpn_plugin::opencpn_plugin ( void *  pmgr )

inline

Definition at line 446 of file ocpn_plugin.h.

~opencpn_plugin()

opencpn_plugin::~opencpn_plugin ( )

virtual

Definition at line 82 of file ocpn_plugin.cpp.

Member Function Documentation

DeInit()

bool opencpn_plugin::DeInit ( void  )

virtual

Definition at line 86 of file ocpn_plugin.cpp.

GetAPIVersionMajor()

int opencpn_plugin::GetAPIVersionMajor ( )

virtual

Definition at line 88 of file ocpn_plugin.cpp.

GetAPIVersionMinor()

int opencpn_plugin::GetAPIVersionMinor ( )

virtual

Definition at line 90 of file ocpn_plugin.cpp.

GetCommonName()

wxString opencpn_plugin::GetCommonName ( )

virtual

Definition at line 96 of file ocpn_plugin.cpp.

GetDynamicChartClassNameArray()

wxArrayString opencpn_plugin::GetDynamicChartClassNameArray ( void  )

virtual

Definition at line 143 of file ocpn_plugin.cpp.

GetLongDescription()

wxString opencpn_plugin::GetLongDescription ( )

virtual

Definition at line 102 of file ocpn_plugin.cpp.

GetPlugInBitmap()

wxBitmap * opencpn_plugin::GetPlugInBitmap ( )

virtual

FIXME static wxBitmap* LoadSVG(const wxString filename, unsigned int width, unsigned int height) { if (!gFrame) return new wxBitmap(width, height); // We are headless.

#ifdef ANDROID return loadAndroidSVG(filename, width, height); #elif defined(ocpnUSE_SVG) wxSVGDocument svgDoc; if (svgDoc.Load(filename)) return new wxBitmap(svgDoc.Render(width, height, NULL, true, true)); else return new wxBitmap(width, height); #else return new wxBitmap(width, height); #endif }

wxBitmap* opencpn_plugin::GetPlugInBitmap() { auto bitmap = PluginLoader::getInstance()->GetPluginDefaultIcon(); return const_cast<wxBitmap*>(bitmap); }

Reimplemented in chartdldr_pi, dashboard_pi, grib_pi, and wmm_pi.

Definition at line 76 of file ocpn_plugin.cpp.

GetPlugInVersionMajor()

int opencpn_plugin::GetPlugInVersionMajor ( )

virtual

Definition at line 92 of file ocpn_plugin.cpp.

GetPlugInVersionMinor()

int opencpn_plugin::GetPlugInVersionMinor ( )

virtual

Definition at line 94 of file ocpn_plugin.cpp.

GetShortDescription()

wxString opencpn_plugin::GetShortDescription ( )

virtual

Definition at line 98 of file ocpn_plugin.cpp.

GetToolbarToolCount()

int opencpn_plugin::GetToolbarToolCount ( void  )

virtual

Definition at line 113 of file ocpn_plugin.cpp.

GetToolboxPanelCount()

int opencpn_plugin::GetToolboxPanelCount ( void  )

virtual

Definition at line 115 of file ocpn_plugin.cpp.

Init()

int opencpn_plugin::Init ( void  )

virtual

Definition at line 84 of file ocpn_plugin.cpp.

OnCloseToolboxPanel()

void opencpn_plugin::OnCloseToolboxPanel ( int  page_sel, int  ok_apply_cancel  )

virtual

Definition at line 119 of file ocpn_plugin.cpp.

OnContextMenuItemCallback()

void opencpn_plugin::OnContextMenuItemCallback ( int  id )

virtual

Definition at line 125 of file ocpn_plugin.cpp.

OnToolbarToolCallback()

void opencpn_plugin::OnToolbarToolCallback ( int  id )

virtual

Definition at line 123 of file ocpn_plugin.cpp.

ProcessParentResize()

void opencpn_plugin::ProcessParentResize ( int  x, int  y  )

virtual

Definition at line 137 of file ocpn_plugin.cpp.

RenderOverlay()

bool opencpn_plugin::RenderOverlay ( wxMemoryDC *  pmdc, PlugIn_ViewPort *  vp  )

virtual

Definition at line 127 of file ocpn_plugin.cpp.

SetAISSentence()

void opencpn_plugin::SetAISSentence ( wxString &  sentence )

virtual

Receive all AIS sentences from OpenCPN.

Plugins can implement this method to receive all AIS sentences. They must set the WANTS_AIS_SENTENCES capability flag to receive updates.

Parameters

sentence

The AIS sentence in standard NMEA 0183 VDM/VDO format (e.g., "!AIVDM,1,1,,B,15MwkRUOidG?GElEa<iQk1JV06Jd,0*1D") These sentences contain binary encoded AIS messages that follow the ITU-R M.1371 standard.

Note

For handling NMEA/SignalK messages, a newer recommended message API is available: Plugin Message API Documentation

Definition at line 111 of file ocpn_plugin.cpp.

SetColorScheme()

void opencpn_plugin::SetColorScheme ( PI_ColorScheme  cs )

virtual

Definition at line 139 of file ocpn_plugin.cpp.

SetCurrentViewPort()

void opencpn_plugin::SetCurrentViewPort ( PlugIn_ViewPort &  vp )

virtual

Definition at line 133 of file ocpn_plugin.cpp.

SetCursorLatLon()

void opencpn_plugin::SetCursorLatLon ( double  lat, double  lon  )

virtual

Definition at line 131 of file ocpn_plugin.cpp.

SetDefaults()

void opencpn_plugin::SetDefaults ( void  )

virtual

Definition at line 135 of file ocpn_plugin.cpp.

SetNMEASentence()

void opencpn_plugin::SetNMEASentence ( wxString &  sentence )

virtual

Receive all NMEA 0183 sentences from OpenCPN.

Plugins can implement this method to receive all NMEA 0183 sentences. They must set the WANTS_NMEA_SENTENCES capability flag to receive updates.

Parameters

sentence

The NMEA 0183 sentence

Note

For handling NMEA/SignalK messages, a newer recommended message API is available: Plugin Message API Documentation

Reimplemented in dashboard_pi.

Definition at line 109 of file ocpn_plugin.cpp.

SetPositionFix()

void opencpn_plugin::SetPositionFix ( PlugIn_Position_Fix &  pfix )

virtual

Definition at line 107 of file ocpn_plugin.cpp.

SetupToolboxPanel()

void opencpn_plugin::SetupToolboxPanel ( int  page_sel, wxNotebook *  pnotebook  )

virtual

Definition at line 117 of file ocpn_plugin.cpp.

ShowPreferencesDialog()

void opencpn_plugin::ShowPreferencesDialog ( wxWindow *  parent )

virtual

Definition at line 121 of file ocpn_plugin.cpp.

UpdateAuiStatus()

void opencpn_plugin::UpdateAuiStatus ( void  )

virtual

Definition at line 141 of file ocpn_plugin.cpp.

---

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

• /home/runner/work/main/main/opencpn/include/ocpn_plugin.h
• /home/runner/work/main/main/opencpn/model/src/ocpn_plugin.cpp