Inheritance diagram for GribPi:

Public Member Functions
	GribPi (void *ppimgr)

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

bool	DeInit () override
	Clean up plugin resources.

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

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

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

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

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

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

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

wxString	GetLongDescription () override
	Get detailed plugin information.

bool	MouseEventHook (wxMouseEvent &event) override
	Handles mouse events from chart window.

bool	RenderOverlay (wxDC &dc, PlugIn_ViewPort *vp) override

bool	RenderOverlayMultiCanvas (wxDC &dc, PlugIn_ViewPort *vp, int canvasIndex) override
	Renders plugin overlay graphics in standard DC mode for multi-canvas support.

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

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

void	SetPluginMessage (wxString &message_id, wxString &message_body) override

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

bool	RenderGLOverlayMultiCanvas (wxGLContext pcontext, PlugIn_ViewPort vp, int canvasIndex) override
	Renders plugin overlay graphics in OpenGL mode for multi-canvas support.

void	SendTimelineMessage (wxDateTime time)

void	SetDefaults () override
	Sets plugin default options.

int	GetToolBarToolCount ()

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

void	OnToolbarToolCallback (int id) override
	Handles toolbar tool clicks.

bool	QualifyCtrlBarPosition (wxPoint position, wxSize size)

void	MoveDialog (wxDialog *dialog, wxPoint position)

void	SetPositionFixEx (PlugIn_Position_Fix_Ex &pfix) override
	Updates plugin with extended position fix data at regular intervals.

void	SetCtrlBarXY (wxPoint p)

void	SetCursorDataXY (wxPoint p)

void	SetCtrlBarSizeXY (wxSize p)

void	SetColorScheme (PI_ColorScheme cs) override
	Updates plugin color scheme.

void	SetDialogFont (wxWindow window, wxFont font=OCPNGetFont(_("Dialog")))

void	SetCurrentViewPort (PlugIn_ViewPort &vp) override
	Callback invoked by OpenCPN core whenever the current ViewPort changes or through periodic updates.

PlugIn_ViewPort &	GetCurrentViewPort ()

void	OnGribCtrlBarClose ()

wxPoint	GetCtrlBarXY ()

wxPoint	GetCursorDataXY ()

int	GetStartOptions () const

bool	GetCopyFirstCumRec () const
	Returns true if cumulative parameters like precipitation and cloud cover should initialize their start values from the first record.

bool	GetCopyMissWaveRec () const
	Returns true if wave data should be propagated across time periods where wave records are missing.

GRIBOverlayFactory *	GetGRIBOverlayFactory () const

void	UpdatePrefs (GribPreferencesDialog *Pref)

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

virtual void	PrepareContextMenu (int canvasIndex)
	Prepares plugin context menu items.

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

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

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

virtual bool	KeyboardEventHook (wxKeyEvent &event)
	Handles keyboard events from main window.

virtual void	OnToolbarToolDownCallback (int id)
	Handles toolbar button press.

virtual void	OnToolbarToolUpCallback (int id)
	Handles toolbar button release.

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

virtual void	SendVectorChartObjectInfo (wxString &chart, wxString &feature, wxString &objname, double lat, double lon, double scale, int nativescale)
	Receives vector chart object information.

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

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

virtual void	LateInit (void)

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

virtual void	OnSetupOptions (void)
	Allows plugin to add pages to global Options dialog.

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

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	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	SetPositionFix (PlugIn_Position_Fix &pfix)
	Updates plugin with current position fix data at regular intervals.

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	UpdateAuiStatus (void)
	Updates AUI manager status.

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

Public Attributes
GRIBOverlayFactory *	m_pGRIBOverlayFactory

int	m_MenuItem

bool	m_DialogStyleChanged

wxSize	m_coreToolbarSize

wxPoint	m_coreToolbarPosn

bool	m_bZoomToCenterAtInit

wxString	m_local_sources_catalog

double	m_boat_lat

double	m_boat_lon

double	m_boat_cog

double	m_boat_sog

time_t	m_boat_time

Detailed Description

Definition at line 88 of file grib_pi.h.

Constructor & Destructor Documentation

◆ GribPi()

GribPi::GribPi ( void * ppimgr )

Definition at line 76 of file grib_pi.cpp.

◆ ~GribPi()

GribPi::~GribPi ( )

override

Definition at line 96 of file grib_pi.cpp.

Member Function Documentation

◆ DeInit()

bool GribPi::DeInit ( void )

overridevirtual

Clean up plugin resources.

Called by OpenCPN when plugin is disabled. Shall release any resources allocated by the plugin. Good place to persist plugin configuration.

Returns: True if cleanup successful, False if error

Reimplemented from opencpn_plugin.

Definition at line 177 of file grib_pi.cpp.

◆ GetAPIVersionMajor()

int GribPi::GetAPIVersionMajor ( )

overridevirtual

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 193 of file grib_pi.cpp.

◆ GetAPIVersionMinor()

int GribPi::GetAPIVersionMinor ( )

overridevirtual

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 195 of file grib_pi.cpp.

◆ GetCommonName()

wxString GribPi::GetCommonName ( )

overridevirtual

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 203 of file grib_pi.cpp.

◆ GetCopyFirstCumRec()

bool GribPi::GetCopyFirstCumRec ( ) const

inline

Returns true if cumulative parameters like precipitation and cloud cover should initialize their start values from the first record.

This avoids artificial zero values at the beginning of the time series.

Definition at line 152 of file grib_pi.h.

◆ GetCopyMissWaveRec()

bool GribPi::GetCopyMissWaveRec ( ) const

inline

Returns true if wave data should be propagated across time periods where wave records are missing.

This ensures continuity of wave visualization even when data points are sparse.

Definition at line 160 of file grib_pi.h.

◆ GetCtrlBarXY()

wxPoint GribPi::GetCtrlBarXY ( )

inline

Definition at line 143 of file grib_pi.h.

◆ GetCurrentViewPort()

PlugIn_ViewPort & GribPi::GetCurrentViewPort ( )

inline

Definition at line 139 of file grib_pi.h.

◆ GetCursorDataXY()

wxPoint GribPi::GetCursorDataXY ( )

inline

Definition at line 144 of file grib_pi.h.

◆ GetGRIBOverlayFactory()

GRIBOverlayFactory * GribPi::GetGRIBOverlayFactory ( ) const

inline

Definition at line 163 of file grib_pi.h.

◆ GetLongDescription()

wxString GribPi::GetLongDescription ( )

overridevirtual

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 207 of file grib_pi.cpp.

◆ GetPlugInBitmap()

wxBitmap * GribPi::GetPlugInBitmap ( )

overridevirtual

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 201 of file grib_pi.cpp.

◆ GetPlugInVersionMajor()

int GribPi::GetPlugInVersionMajor ( )

overridevirtual

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 197 of file grib_pi.cpp.

◆ GetPlugInVersionMinor()

int GribPi::GetPlugInVersionMinor ( )

overridevirtual

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 199 of file grib_pi.cpp.

◆ GetShortDescription()

wxString GribPi::GetShortDescription ( )

overridevirtual

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 205 of file grib_pi.cpp.

◆ GetStartOptions()

int GribPi::GetStartOptions ( ) const

inline

Definition at line 145 of file grib_pi.h.

◆ GetToolBarToolCount()

int GribPi::GetToolBarToolCount ( )

Definition at line 228 of file grib_pi.cpp.

◆ Init()

int GribPi::Init ( void )

overridevirtual

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 102 of file grib_pi.cpp.

◆ MouseEventHook()

bool GribPi::MouseEventHook ( wxMouseEvent & event )

overridevirtual

Handles mouse events from chart window.

Called for mouse events in the chart display area. Must be implemented if plugin declares WANTS_MOUSE_EVENTS capability.

Parameters

event The mouse event

Returns: True if event was handled, false to pass to OpenCPN

Reimplemented from opencpn_plugin_112.

Definition at line 230 of file grib_pi.cpp.

◆ MoveDialog()

void GribPi::MoveDialog	(	wxDialog *	dialog,
		wxPoint	position
	)

Definition at line 404 of file grib_pi.cpp.

◆ OnContextMenuItemCallback()

void GribPi::OnContextMenuItemCallback ( int id )

overridevirtual

Handles context menu item selection.

Called when user selects a plugin's context menu item. Must be implemented if plugin adds items via AddCanvasContextMenuItem().

Parameters

id	The menu item ID assigned when item was added

Reimplemented from opencpn_plugin.

Definition at line 626 of file grib_pi.cpp.

◆ OnGribCtrlBarClose()

void GribPi::OnGribCtrlBarClose ( )

Definition at line 531 of file grib_pi.cpp.

◆ OnToolbarToolCallback()

void GribPi::OnToolbarToolCallback ( int id )

overridevirtual

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 426 of file grib_pi.cpp.

◆ QualifyCtrlBarPosition()

bool GribPi::QualifyCtrlBarPosition	(	wxPoint	position,
		wxSize	size
	)

Definition at line 371 of file grib_pi.cpp.

◆ RenderGLOverlay()

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

overridevirtual

Renders plugin overlay graphics in OpenGL mode for single canvas.

Legacy method for OpenGL overlay rendering that predates multi-canvas and priority support. This method renders overlays at OVERLAY_LEGACY priority level (0) on the primary canvas only.

Both RenderOverlay() and RenderGLOverlay() use the same piDC device context abstraction for drawing, but RenderGLOverlay() provides direct access to the OpenGL context for advanced OpenGL operations.

Plugins render in their load order within the plugin array for overlays at the same priority level.

Parameters

pcontext	OpenGL context for direct GL drawing commands and piDC operations
vp	Current viewport settings including 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; Renders only on primary canvas (index 0); Renders at OVERLAY_LEGACY priority level automatically

Deprecated:: Use RenderGLOverlayMultiCanvas() for multi-canvas and priority support

See also: RenderGLOverlayMultiCanvas() for modern multi-canvas priority-aware rendering; RenderOverlay() for standard DC rendering; OVERLAY_LEGACY

Since: API v1.7

Reimplemented from opencpn_plugin_18.

Definition at line 579 of file grib_pi.cpp.

◆ RenderGLOverlayMultiCanvas()

bool GribPi::RenderGLOverlayMultiCanvas	(	wxGLContext *	pcontext,
		PlugIn_ViewPort *	vp,
		int	canvasIndex
	)

overridevirtual

Renders plugin overlay graphics in OpenGL mode for multi-canvas support.

Legacy version of RenderGLOverlayMultiCanvas without priority control. This method is called for backward compatibility with plugins that haven't upgraded to the priority-aware API. The overlay is rendered at OVERLAY_LEGACY priority level (0), appearing behind ships and other high-priority elements.

Parameters

pcontext	OpenGL context for drawing operations
vp	Current viewport parameters including position, scale, rotation
canvasIndex	Index of the target canvas (0-based)

Returns: True if overlay was rendered, False otherwise

Note: Only called if plugin declares WANTS_OPENGL_OVERLAY_CALLBACK capability; Modern plugins should use the priority-aware version instead; Renders at OVERLAY_LEGACY priority level automatically; Drawing should respect current viewport parameters; For new plugins, prefer RenderGLOverlayMultiCanvas() with priority parameter

Deprecated:: Use RenderGLOverlayMultiCanvas(wxGLContext*, PlugIn_ViewPort*, int, int) for priority control

See also: RenderGLOverlayMultiCanvas() with priority parameter; RenderGLOverlay() for single-canvas legacy rendering; OVERLAY_LEGACY

Since: API v1.16

Reimplemented from opencpn_plugin_116.

Definition at line 611 of file grib_pi.cpp.

◆ RenderOverlay()

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

overridevirtual

Reimplemented from opencpn_plugin_18.

Definition at line 556 of file grib_pi.cpp.

◆ RenderOverlayMultiCanvas()

bool GribPi::RenderOverlayMultiCanvas	(	wxDC &	dc,
		PlugIn_ViewPort *	vp,
		int	canvasIndex
	)

overridevirtual

Renders plugin overlay graphics in standard DC mode for multi-canvas support.

Legacy version of RenderOverlayMultiCanvas without priority control. This method is called for backward compatibility with plugins that haven't upgraded to the priority-aware API. The overlay is rendered at OVERLAY_LEGACY priority level (0), appearing behind ships and other high-priority elements.

Parameters

dc	Device context for drawing operations
vp	Current viewport parameters including position, scale, rotation
canvasIndex	Index of the target canvas (0-based)

Returns: True if overlay was rendered, False otherwise

Note: Only called if plugin declares WANTS_OVERLAY_CALLBACK capability; Modern plugins should use the priority-aware version instead; Renders at OVERLAY_LEGACY priority level automatically; Use GetCanvasPixLL() to convert lat/lon coordinates to screen pixels; For new plugins, prefer RenderOverlayMultiCanvas() with priority parameter

Deprecated:: Use RenderOverlayMultiCanvas(wxDC&, PlugIn_ViewPort*, int, int) for priority control

See also: RenderOverlayMultiCanvas() with priority parameter; RenderOverlay() for single-canvas legacy rendering; OVERLAY_LEGACY

Since: API v1.16

Reimplemented from opencpn_plugin_116.

Definition at line 616 of file grib_pi.cpp.

◆ SendTimelineMessage()

void GribPi::SendTimelineMessage ( wxDateTime time )

Definition at line 842 of file grib_pi.cpp.

◆ SetColorScheme()

void GribPi::SetColorScheme ( PI_ColorScheme cs )

overridevirtual

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_RGB: Unmodified RGB colors PI_GLOBAL_COLOR_SCHEME_DAY: Optimized for bright conditions PI_GLOBAL_COLOR_SCHEME_DUSK: Optimized for low light PI_GLOBAL_COLOR_SCHEME_NIGHT: Optimized for dark conditions

Note: Follow the patterns documented in the PI_ColorScheme enum.

Reimplemented from opencpn_plugin.

Definition at line 832 of file grib_pi.cpp.

◆ SetCtrlBarSizeXY()

void GribPi::SetCtrlBarSizeXY ( wxSize p )

inline

Definition at line 129 of file grib_pi.h.

◆ SetCtrlBarXY()

void GribPi::SetCtrlBarXY ( wxPoint p )

inline

Definition at line 127 of file grib_pi.h.

◆ SetCurrentViewPort()

void GribPi::SetCurrentViewPort ( PlugIn_ViewPort & vp )

inlineoverridevirtual

Callback invoked by OpenCPN core whenever the current ViewPort changes or through periodic updates.

In multi-canvas configurations, each canvas triggers a viewport update.

Reimplemented from opencpn_plugin.

Definition at line 138 of file grib_pi.h.

◆ SetCursorDataXY()

void GribPi::SetCursorDataXY ( wxPoint p )

inline

Definition at line 128 of file grib_pi.h.

◆ SetCursorLatLon()

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

overridevirtual

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 621 of file grib_pi.cpp.

◆ SetDefaults()

void GribPi::SetDefaults ( void )

overridevirtual

Sets plugin default options.

This method is called when a plugin is enabled via the user preferences dialog. It provides an opportunity to set up any default options and behaviors.

Note: Optional override - implement if plugin has configurable options; Called before plugin is activated in GUI; Good place to load saved settings from config file

Reimplemented from opencpn_plugin.

Definition at line 226 of file grib_pi.cpp.

◆ SetDialogFont()

void GribPi::SetDialogFont	(	wxWindow *	window,
		wxFont *	font = `OCPNGetFont(_("Dialog"))`
	)

Definition at line 631 of file grib_pi.cpp.

◆ SetPluginMessage()

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

overridevirtual

Reimplemented from opencpn_plugin_18.

Definition at line 644 of file grib_pi.cpp.

◆ SetPositionFixEx()

void GribPi::SetPositionFixEx ( PlugIn_Position_Fix_Ex & pfix )

overridevirtual

Updates plugin with extended position fix data at regular intervals.

Called by OpenCPN approximately once per second (1 Hz), regardless of how frequently new position data is actually received from GPS/NMEA sources. This provides plugins with a steady, predictable update rate for navigation calculations and display updates.

Extends SetPositionFix() by adding magnetic and true heading information when available from HDM/HDT NMEA sentences.

Parameters

pfix	Extended position fix data containing: All basic position fix fields from SetPositionFix() Hdm: Magnetic heading in degrees (0-360°, NaN if unavailable) Hdt: True heading in degrees (0-360°, NaN if unavailable)

Note: Only called if plugin declares WANTS_NMEA_EVENTS capability

See also: SetPositionFix() for basic position data without heading

Reimplemented from opencpn_plugin_18.

Definition at line 867 of file grib_pi.cpp.

◆ ShowPreferencesDialog()

void GribPi::ShowPreferencesDialog ( wxWindow * parent )

overridevirtual

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 236 of file grib_pi.cpp.

◆ UpdatePrefs()

void GribPi::UpdatePrefs ( GribPreferencesDialog * Pref )

Definition at line 299 of file grib_pi.cpp.

Member Data Documentation

◆ m_boat_cog

double GribPi::m_boat_cog

Definition at line 177 of file grib_pi.h.

◆ m_boat_lat

double GribPi::m_boat_lat

Definition at line 176 of file grib_pi.h.

◆ m_boat_lon

double GribPi::m_boat_lon

Definition at line 176 of file grib_pi.h.

◆ m_boat_sog

double GribPi::m_boat_sog

Definition at line 177 of file grib_pi.h.

◆ m_boat_time

time_t GribPi::m_boat_time

Definition at line 178 of file grib_pi.h.

◆ m_bZoomToCenterAtInit

bool GribPi::m_bZoomToCenterAtInit

Definition at line 174 of file grib_pi.h.

◆ m_coreToolbarPosn

wxPoint GribPi::m_coreToolbarPosn

Definition at line 173 of file grib_pi.h.

◆ m_coreToolbarSize

wxSize GribPi::m_coreToolbarSize

Definition at line 172 of file grib_pi.h.

◆ m_DialogStyleChanged

bool GribPi::m_DialogStyleChanged

Definition at line 170 of file grib_pi.h.

◆ m_local_sources_catalog

wxString GribPi::m_local_sources_catalog

Definition at line 175 of file grib_pi.h.

◆ m_MenuItem

int GribPi::m_MenuItem

Definition at line 169 of file grib_pi.h.

◆ m_pGRIBOverlayFactory

GRIBOverlayFactory* GribPi::m_pGRIBOverlayFactory

Definition at line 162 of file grib_pi.h.

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

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

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ GribPi()

◆ ~GribPi()

Member Function Documentation

◆ DeInit()

◆ GetAPIVersionMajor()

◆ GetAPIVersionMinor()

◆ GetCommonName()

◆ GetCopyFirstCumRec()

◆ GetCopyMissWaveRec()

◆ GetCtrlBarXY()

◆ GetCurrentViewPort()

◆ GetCursorDataXY()

◆ GetGRIBOverlayFactory()

◆ GetLongDescription()

◆ GetPlugInBitmap()

◆ GetPlugInVersionMajor()

◆ GetPlugInVersionMinor()

◆ GetShortDescription()

◆ GetStartOptions()

◆ GetToolBarToolCount()

◆ Init()

◆ MouseEventHook()

◆ MoveDialog()

◆ OnContextMenuItemCallback()

◆ OnGribCtrlBarClose()

◆ OnToolbarToolCallback()

◆ QualifyCtrlBarPosition()

◆ RenderGLOverlay()

◆ RenderGLOverlayMultiCanvas()

◆ RenderOverlay()

◆ RenderOverlayMultiCanvas()

◆ SendTimelineMessage()

◆ SetColorScheme()

◆ SetCtrlBarSizeXY()

◆ SetCtrlBarXY()

◆ SetCurrentViewPort()

◆ SetCursorDataXY()

◆ SetCursorLatLon()

◆ SetDefaults()

◆ SetDialogFont()

◆ SetPluginMessage()

◆ SetPositionFixEx()

◆ ShowPreferencesDialog()

◆ UpdatePrefs()

Member Data Documentation

◆ m_boat_cog

◆ m_boat_lat

◆ m_boat_lon

◆ m_boat_sog

◆ m_boat_time

◆ m_bZoomToCenterAtInit

◆ m_coreToolbarPosn

◆ m_coreToolbarSize

◆ m_DialogStyleChanged

◆ m_local_sources_catalog

◆ m_MenuItem

◆ m_pGRIBOverlayFactory