Inheritance diagram for wmm_pi:

Public Member Functions
	wmm_pi (void *ppimgr)

int	Init (void)
	Initialize the plugin and declare its capabilities.

bool	DeInit (void)
	Clean up plugin resources.

int	GetAPIVersionMajor ()
	Returns the major version number of the plugin API that this plugin supports.

int	GetAPIVersionMinor ()
	Returns the minor version number of the plugin API that this plugin supports.

int	GetPlugInVersionMajor ()
	Returns the major version number of the plugin itself.

int	GetPlugInVersionMinor ()
	Returns the minor version number of the plugin itself.

wxBitmap *	GetPlugInBitmap ()
	Get the plugin's icon bitmap.

wxString	GetCommonName ()
	Get the plugin's common (short) name.

wxString	GetShortDescription ()
	Get a brief description of the plugin.

wxString	GetLongDescription ()
	Get detailed plugin information.

void	SetCursorLatLon (double lat, double lon)
	Receives cursor lat/lon position updates.

void	SetPositionFix (PlugIn_Position_Fix &pfix)
	Updates plugin with current position fix data.

void	RenderOverlayBoth (pi_ocpnDC dc, PlugIn_ViewPort vp)

bool	RenderOverlay (wxDC &dc, PlugIn_ViewPort *vp)

bool	RenderGLOverlay (wxGLContext pcontext, PlugIn_ViewPort vp)
	Renders plugin overlay graphics in OpenGL mode.

void	RecomputePlot ()

int	GetToolbarToolCount (void)
	Returns the number of toolbar tools this plugin provides.

void	ShowPreferencesDialog (wxWindow *parent)
	Shows the plugin preferences dialog.

void	ShowPlotSettingsDialog (wxCommandEvent &event)

void	OnToolbarToolCallback (int id)
	Handles toolbar tool clicks.

void	SetColorScheme (PI_ColorScheme cs)
	Updates plugin color scheme.

void	SetPluginMessage (wxString &message_id, wxString &message_body)

void	SetShowPlot (bool showplot)

void	SetWmmDialogX (int x)

void	SetWmmDialogY (int x)

void	OnWmmDialogClose ()

void	ShowPlotSettings ()

Public Member Functions inherited from opencpn_plugin_18
	opencpn_plugin_18 (void *pmgr)

virtual void	SetPositionFixEx (PlugIn_Position_Fix_Ex &pfix)
	Updates plugin with extended position fix data.

virtual bool	RenderOverlay (wxMemoryDC pmdc, PlugIn_ViewPort vp)
	Render plugin overlay graphics using standard device context.

Public Member Functions inherited from opencpn_plugin
	opencpn_plugin (void *pmgr)

virtual void	SetDefaults (void)
	Sets plugin default options.

virtual int	GetToolboxPanelCount (void)
	Returns the number of preference pages this plugin provides.

virtual void	SetupToolboxPanel (int page_sel, wxNotebook *pnotebook)
	Creates a plugin preferences page.

virtual void	OnCloseToolboxPanel (int page_sel, int ok_apply_cancel)
	Handles preference page closure.

virtual void	SetCurrentViewPort (PlugIn_ViewPort &vp)
	Notifies plugin of viewport changes.

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)
	Handles parent window resize events.

virtual void	OnContextMenuItemCallback (int id)
	Handles context menu item selection.

virtual void	UpdateAuiStatus (void)
	Updates AUI manager status.

virtual wxArrayString	GetDynamicChartClassNameArray (void)
	Returns array of dynamically loaded chart class names.

Public Attributes
MAGtype_MagneticModel *	MagneticModels [1]

MAGtype_MagneticModel *	MagneticModel

MAGtype_MagneticModel *	TimedMagneticModel

MAGtype_Ellipsoid	Ellip

MAGtype_CoordSpherical	CoordSpherical

MAGtype_CoordGeodetic	CoordGeodetic

MAGtype_Date	UserDate

MAGtype_GeoMagneticElements	GeoMagneticElements

MAGtype_Geoid	Geoid

wxString	filename

wxWindow *	m_parent_window

WmmUIDialog *	m_pWmmDialog

pi_ocpnDC *	m_oDC

Detailed Description

Definition at line 97 of file wmm_pi.h.

Constructor & Destructor Documentation

◆ wmm_pi()

wmm_pi::wmm_pi ( void * ppimgr )

Definition at line 114 of file wmm_pi.cpp.

Member Function Documentation

◆ DeInit()

bool wmm_pi::DeInit ( void )

virtual

Clean up plugin resources.

This required method is called by OpenCPN during plugin unloading or program shutdown. It should release any resources allocated by the plugin.

Returns: True if cleanup successful, False if error

Reimplemented from opencpn_plugin.

Definition at line 235 of file wmm_pi.cpp.

◆ GetAPIVersionMajor()

int wmm_pi::GetAPIVersionMajor ( )

virtual

Returns the major version number of the plugin API that this plugin supports.

This method must be implemented by all plugins to declare compatibility with a specific major version of the OpenCPN plugin API.

Returns: Integer value representing the major API version (e.g., 1)

Note: Major version changes indicate incompatible API changes; Current API major version is defined by API_VERSION_MAJOR

Reimplemented from opencpn_plugin.

Definition at line 269 of file wmm_pi.cpp.

◆ GetAPIVersionMinor()

int wmm_pi::GetAPIVersionMinor ( )

virtual

Returns the minor version number of the plugin API that this plugin supports.

This method must be implemented by all plugins to declare compatibility with a specific minor version of the OpenCPN plugin API.

Returns: Integer value representing the minor API version (e.g., 19)

Note: Minor version changes indicate backward-compatible API additions; Current API minor version is defined by API_VERSION_MINOR

Reimplemented from opencpn_plugin.

Definition at line 271 of file wmm_pi.cpp.

◆ GetCommonName()

wxString wmm_pi::GetCommonName ( )

virtual

Get the plugin's common (short) name.

This required method should return a short name used to identify the plugin in lists and menus.

Returns: wxString containing plugin name (e.g., "Dashboard")

Note: Should be valid and meaningful even before Init() is called; Used by the plugin manager GUI

Reimplemented from opencpn_plugin.

Definition at line 279 of file wmm_pi.cpp.

◆ GetLongDescription()

wxString wmm_pi::GetLongDescription ( )

virtual

Get detailed plugin information.

This required method should return a longer description including:

Detailed feature list
Version information
Author/copyright details

Returns: wxString containing detailed plugin information

Note: Should be valid before Init() is called; Used in plugin manager details view

Reimplemented from opencpn_plugin.

Definition at line 285 of file wmm_pi.cpp.

◆ GetPlugInBitmap()

wxBitmap * wmm_pi::GetPlugInBitmap ( )

virtual

Get the plugin's icon bitmap.

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

This method should return a wxBitmap containing the plugin's icon for display in the plugin manager and other UI elements.

Returns: Pointer to wxBitmap containing icon, NULL for default icon

Note: The bitmap should be square, typically 32x32 pixels; Ownership of the bitmap remains with the plugin; Icon should be visible on both light and dark backgrounds

#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 from opencpn_plugin.

Definition at line 277 of file wmm_pi.cpp.

◆ GetPlugInVersionMajor()

int wmm_pi::GetPlugInVersionMajor ( )

virtual

Returns the major version number of the plugin itself.

This method should return the plugin's own major version number, which is used by OpenCPN for plugin version management and display.

Returns: Integer value representing the plugin's major version

Note: Part of semantic version (major.minor.patch); Major version changes indicate incompatible API changes

Reimplemented from opencpn_plugin.

Definition at line 273 of file wmm_pi.cpp.

◆ GetPlugInVersionMinor()

int wmm_pi::GetPlugInVersionMinor ( )

virtual

Returns the minor version number of the plugin itself.

This method should return the plugin's own minor version number, which is used by OpenCPN for plugin version management and display.

Returns: Integer value representing the plugin's minor version

Note: Part of semantic version (major.minor.patch); Minor version changes indicate backward-compatible feature additions

Reimplemented from opencpn_plugin.

Definition at line 275 of file wmm_pi.cpp.

◆ GetShortDescription()

wxString wmm_pi::GetShortDescription ( )

virtual

Get a brief description of the plugin.

This required method should return a short description (1-2 sentences) explaining the plugin's basic functionality.

Returns: wxString containing brief description

Note: Should be valid before Init() is called; Used in plugin manager list view

Reimplemented from opencpn_plugin.

Definition at line 281 of file wmm_pi.cpp.

◆ GetToolbarToolCount()

int wmm_pi::GetToolbarToolCount ( void )

virtual

Returns the number of toolbar tools this plugin provides.

This method should return how many toolbar buttons/tools the plugin will add. Must be implemented if plugin sets INSTALLS_TOOLBAR_TOOL capability flag.

Returns: Number of toolbar items to be added

Note: Return 0 if no toolbar items; Each tool needs unique ID for callbacks; Called during plugin initialization

Reimplemented from opencpn_plugin.

Definition at line 297 of file wmm_pi.cpp.

◆ Init()

int wmm_pi::Init ( void )

virtual

Initialize the plugin and declare its capabilities.

This required method is called by OpenCPN during plugin loading. It should:

Set up any required plugin resources
Register capabilities by returning a bitwise OR of WANTS_ and INSTALLS_ flags

Returns

Integer capability flags indicating plugin features:

WANTS_OVERLAY_CALLBACK
WANTS_CURSOR_LATLON
WANTS_TOOLBAR_CALLBACK
etc. (see enum definitions)

Reimplemented from opencpn_plugin.

Definition at line 130 of file wmm_pi.cpp.

◆ OnToolbarToolCallback()

void wmm_pi::OnToolbarToolCallback ( int id )

virtual

Handles toolbar tool clicks.

Called when the user clicks a plugin's toolbar button. Must be implemented if plugin declares WANTS_TOOLBAR_CALLBACK capability.

Parameters

id	The tool ID assigned when tool was added via InsertPlugInTool()

Reimplemented from opencpn_plugin.

Definition at line 362 of file wmm_pi.cpp.

◆ RecomputePlot()

void wmm_pi::RecomputePlot ( )

Definition at line 453 of file wmm_pi.cpp.

◆ RenderGLOverlay()

bool wmm_pi::RenderGLOverlay	(	wxGLContext *	pcontext,
		PlugIn_ViewPort *	vp
	)

virtual

Renders plugin overlay graphics in OpenGL mode.

Called by OpenCPN during chart redraw to allow plugins to render custom visualizations in OpenGL mode. Both RenderOverlay() and RenderGLOverlay() use the same piDC device context abstraction for drawing, but RenderGLOverlay() provides direct access to the OpenGL context.

Plugins render in their load order within plugin array

Parameters

pcontext	OpenGL context for direct GL drawing commands
vp	Current viewport settings (scale, position, rotation)

Returns: True if overlay was rendered, false if no overlay

Note: Only called if plugin declares WANTS_OPENGL_OVERLAY_CALLBACK capability; Drawing should respect current viewport parameters; For OpenGL-specific rendering optimizations; Modern plugins should use RenderGLOverlayMultiCanvas() for priority control

Reimplemented from opencpn_plugin_18.

Definition at line 414 of file wmm_pi.cpp.

◆ RenderOverlay()

bool wmm_pi::RenderOverlay	(	wxDC &	dc,
		PlugIn_ViewPort *	vp
	)

virtual

Reimplemented from opencpn_plugin_18.

Definition at line 401 of file wmm_pi.cpp.

◆ RenderOverlayBoth()

void wmm_pi::RenderOverlayBoth	(	pi_ocpnDC *	dc,
		PlugIn_ViewPort *	vp
	)

Definition at line 393 of file wmm_pi.cpp.

◆ SetColorScheme()

void wmm_pi::SetColorScheme ( PI_ColorScheme cs )

virtual

Updates plugin color scheme.

Called when OpenCPN's color scheme changes between day, dusk and night modes. Plugins should update their UI colors to match the new scheme.

Parameters

cs	New color scheme to use: PI_GLOBAL_COLOR_SCHEME_DAY PI_GLOBAL_COLOR_SCHEME_DUSK PI_GLOBAL_COLOR_SCHEME_NIGHT

Reimplemented from opencpn_plugin.

Definition at line 299 of file wmm_pi.cpp.

◆ SetCursorLatLon()

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

virtual

Receives cursor lat/lon position updates.

This method is called when the cursor moves over the chart. Must be implemented if plugin sets WANTS_CURSOR_LATLON flag.

Parameters

lat	Cursor latitude in decimal degrees
lon	Cursor longitude in decimal degrees

Note: High frequency updates - keep processing quick; Only called when cursor over chart window

Reimplemented from opencpn_plugin.

Definition at line 470 of file wmm_pi.cpp.

◆ SetPluginMessage()

void wmm_pi::SetPluginMessage	(	wxString &	message_id,
		wxString &	message_body
	)

virtual

Reimplemented from opencpn_plugin_18.

Definition at line 668 of file wmm_pi.cpp.

◆ SetPositionFix()

void wmm_pi::SetPositionFix ( PlugIn_Position_Fix & pfix )

virtual

Updates plugin with current position fix data.

Called by OpenCPN when a new position fix is received. Plugins can use this to track vessel position, course and speed.

Parameters

pfix	Position fix data containing: Lat: Latitude in decimal degrees Lon: Longitude in decimal degrees Cog: Course over ground in degrees Sog: Speed over ground in knots Var: Magnetic variation in degrees FixTime: UTC timestamp of fix nSats: Number of satellites used in fix

Note: Only called if plugin declares WANTS_NMEA_EVENTS capability; For extended data including heading, use SetPositionFixEx()

Reimplemented from opencpn_plugin.

Definition at line 527 of file wmm_pi.cpp.

◆ SetShowPlot()

void wmm_pi::SetShowPlot ( bool showplot )

inline

Definition at line 133 of file wmm_pi.h.

◆ SetWmmDialogX()

void wmm_pi::SetWmmDialogX ( int x )

inline

Definition at line 136 of file wmm_pi.h.

◆ SetWmmDialogY()

void wmm_pi::SetWmmDialogY ( int x )

inline

Definition at line 137 of file wmm_pi.h.

◆ ShowPlotSettings()

void wmm_pi::ShowPlotSettings ( )

dialog->m_dpDate->SetValue(m_MapDate);

m_MapDate = dialog->m_dpDate->GetValue();

Definition at line 907 of file wmm_pi.cpp.

◆ ShowPreferencesDialog()

void wmm_pi::ShowPreferencesDialog ( wxWindow * parent )

virtual

Shows the plugin preferences dialog.

This method is called when the user requests the plugin preferences through the OpenCPN options dialog. Must be implemented if plugin sets WANTS_PREFERENCES flag.

Parameters

parent Parent window to use for dialog

Note: Different from toolbox panel preferences; Use for simple plugin-specific settings; Modal dialog recommended

Reimplemented from opencpn_plugin.

Definition at line 877 of file wmm_pi.cpp.

Member Data Documentation

◆ CoordGeodetic

MAGtype_CoordGeodetic wmm_pi::CoordGeodetic

Definition at line 147 of file wmm_pi.h.

◆ CoordSpherical

MAGtype_CoordSpherical wmm_pi::CoordSpherical

Definition at line 146 of file wmm_pi.h.

◆ Ellip

MAGtype_Ellipsoid wmm_pi::Ellip

Definition at line 145 of file wmm_pi.h.

◆ filename

wxString wmm_pi::filename

Definition at line 151 of file wmm_pi.h.

◆ Geoid

MAGtype_Geoid wmm_pi::Geoid

Definition at line 150 of file wmm_pi.h.

◆ GeoMagneticElements

MAGtype_GeoMagneticElements wmm_pi::GeoMagneticElements

Definition at line 149 of file wmm_pi.h.

◆ m_oDC

pi_ocpnDC* wmm_pi::m_oDC

Definition at line 156 of file wmm_pi.h.

◆ m_parent_window

wxWindow* wmm_pi::m_parent_window

Definition at line 153 of file wmm_pi.h.

◆ m_pWmmDialog

WmmUIDialog* wmm_pi::m_pWmmDialog

Definition at line 154 of file wmm_pi.h.

◆ MagneticModel

MAGtype_MagneticModel* wmm_pi::MagneticModel

Definition at line 144 of file wmm_pi.h.

◆ MagneticModels

MAGtype_MagneticModel* wmm_pi::MagneticModels[1]

Definition at line 143 of file wmm_pi.h.

◆ TimedMagneticModel

MAGtype_MagneticModel * wmm_pi::TimedMagneticModel

Definition at line 144 of file wmm_pi.h.

◆ UserDate

MAGtype_Date wmm_pi::UserDate

Definition at line 148 of file wmm_pi.h.

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

/home/runner/work/main/main/opencpn/plugins/wmm_pi/src/wmm_pi.h
/home/runner/work/main/main/opencpn/plugins/wmm_pi/src/wmm_pi.cpp

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ wmm_pi()

Member Function Documentation

◆ DeInit()

◆ GetAPIVersionMajor()

◆ GetAPIVersionMinor()

◆ GetCommonName()

◆ GetLongDescription()

◆ GetPlugInBitmap()

◆ GetPlugInVersionMajor()

◆ GetPlugInVersionMinor()

◆ GetShortDescription()

◆ GetToolbarToolCount()

◆ Init()

◆ OnToolbarToolCallback()

◆ RecomputePlot()

◆ RenderGLOverlay()

◆ RenderOverlay()

◆ RenderOverlayBoth()

◆ SetColorScheme()

◆ SetCursorLatLon()

◆ SetPluginMessage()

◆ SetPositionFix()

◆ SetShowPlot()

◆ SetWmmDialogX()

◆ SetWmmDialogY()

◆ ShowPlotSettings()

◆ ShowPreferencesDialog()

Member Data Documentation

◆ CoordGeodetic

◆ CoordSpherical

◆ Ellip

◆ filename

◆ Geoid

◆ GeoMagneticElements

◆ m_oDC

◆ m_parent_window

◆ m_pWmmDialog

◆ MagneticModel

◆ MagneticModels

◆ TimedMagneticModel

◆ UserDate