opencpn_plugin_18 Class Reference

Inheritance diagram for opencpn_plugin_18:

Public Member Functions
	opencpn_plugin_18 (void *pmgr)
virtual bool	RenderOverlay (wxDC &dc, PlugIn_ViewPort *vp)
virtual bool	RenderGLOverlay (wxGLContext *pcontext, PlugIn_ViewPort *vp)
	Renders plugin overlay graphics in OpenGL mode.
virtual void	SetPluginMessage (wxString &message_id, wxString &message_body)
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 int	Init (void)
	Initialize the plugin and declare its capabilities.
virtual bool	DeInit (void)
	Clean up plugin resources.
virtual int	GetAPIVersionMajor ()
	Returns the major version number of the plugin API that this plugin supports.
virtual int	GetAPIVersionMinor ()
	Returns the minor version number of the plugin API that this plugin supports.
virtual int	GetPlugInVersionMajor ()
	Returns the major version number of the plugin itself.
virtual int	GetPlugInVersionMinor ()
	Returns the minor version number of the plugin itself.
virtual wxBitmap *	GetPlugInBitmap ()
	Get the plugin's icon bitmap.
virtual wxString	GetCommonName ()
	Get the plugin's common (short) name.
virtual wxString	GetShortDescription ()
	Get a brief description of the plugin.
virtual wxString	GetLongDescription ()
	Get detailed plugin information.
virtual void	SetDefaults (void)
	Sets plugin default options.
virtual int	GetToolbarToolCount (void)
	Returns the number of toolbar tools this plugin provides.
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	ShowPreferencesDialog (wxWindow *parent)
	Shows the plugin preferences dialog.
virtual void	SetCursorLatLon (double lat, double lon)
	Receives cursor lat/lon position updates.
virtual void	SetCurrentViewPort (PlugIn_ViewPort &vp)
	Notifies plugin of viewport changes.
virtual void	SetPositionFix (PlugIn_Position_Fix &pfix)
	Updates plugin with current position fix data.
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	SetColorScheme (PI_ColorScheme cs)
	Updates plugin color scheme.
virtual void	OnToolbarToolCallback (int id)
	Handles toolbar tool clicks.
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.

Detailed Description

Examples

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

Definition at line 1665 of file ocpn_plugin.h.

Constructor & Destructor Documentation

opencpn_plugin_18()

opencpn_plugin_18::opencpn_plugin_18

(

void *

pmgr

)

Definition at line 178 of file ocpn_plugin.cpp.

~opencpn_plugin_18()

opencpn_plugin_18::~opencpn_plugin_18 ( void  )

virtual

Definition at line 180 of file ocpn_plugin.cpp.

Member Function Documentation

RenderGLOverlay()

bool opencpn_plugin_18::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 in grib_pi, and wmm_pi.

Definition at line 186 of file ocpn_plugin.cpp.

RenderOverlay() [1/2]

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

virtual

Definition at line 182 of file ocpn_plugin.cpp.

RenderOverlay() [2/2]

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

virtual

Render plugin overlay graphics using standard device context.

Called by OpenCPN during chart redraw to allow plugins to render custom visualization overlays on top of charts. Drawing is done through a device context abstraction (piDC) that handles both standard and OpenGL contexts.

Examples include:

• Weather routing course lines and markers
• GRIB weather data visualization
• Custom chart layers
• Route tracking and navigation data

Rendering order is determined by plugin load order in array for same priority level.

Parameters

dc	Reference to wxDC device context for drawing
vp	Pointer to current viewport settings (scale, position, rotation)

Returns

True if overlay was rendered, false if no overlay

Note

Only called if plugin declares WANTS_OVERLAY_CALLBACK capability

Drawing should respect current viewport parameters

Performance critical - keep drawing efficient

Companion to RenderGLOverlay() for OpenGL-specific rendering

Reimplemented from opencpn_plugin.

Definition at line 1452 of file ocpn_plugin.cpp.

SetPluginMessage()

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

virtual

Definition at line 191 of file ocpn_plugin.cpp.

SetPositionFixEx()

void opencpn_plugin_18::SetPositionFixEx ( PlugIn_Position_Fix_Ex &  pfix )

virtual

Updates plugin with extended position fix data.

Called by OpenCPN when a new position fix with heading data is received. Extends SetPositionFix() by adding true heading information.

Parameters

pfix	Extended position fix data containing: All basic position fix fields from SetPositionFix() Hdm: Magnetic heading in degrees Hdt: True heading in degrees

Note

Only called if plugin declares WANTS_NMEA_EVENTS capability

HDT/HDM sentences must be available for heading data

Reimplemented in dashboard_pi, and grib_pi.

Definition at line 194 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