OpenCPN Partial API docs
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
opencpn_plugin_119 Class Reference
Inheritance diagram for opencpn_plugin_119:
opencpn_plugin_118 opencpn_plugin_117 opencpn_plugin_116 opencpn_plugin_115 opencpn_plugin_114 opencpn_plugin_113 opencpn_plugin_112 opencpn_plugin_111 opencpn_plugin_110 opencpn_plugin_19 opencpn_plugin_18 opencpn_plugin

Public Member Functions

 opencpn_plugin_119 (void *pmgr)
 
virtual void PreShutdownHook ()
 Called just before OpenCPN begins shutdown sequence.
 
- Public Member Functions inherited from opencpn_plugin_118
 opencpn_plugin_118 (void *pmgr)
 
virtual bool RenderGLOverlayMultiCanvas (wxGLContext *pcontext, PlugIn_ViewPort *vp, int canvasIndex, int priority)
 Render plugin overlay over chart canvas in OpenGL mode.
 
bool RenderGLOverlayMultiCanvas (wxGLContext *pcontext, PlugIn_ViewPort *vp, int canvas_ix) override
 Renders plugin overlay graphics in OpenGL mode with canvas selection.
 
virtual bool RenderOverlayMultiCanvas (wxDC &dc, PlugIn_ViewPort *vp, int canvas_ix, int priority)
 Render plugin overlay over chart canvas in non-OpenGL mode.
 
bool RenderOverlayMultiCanvas (wxDC &dc, PlugIn_ViewPort *vp, int canvas_ix) override
 Renders plugin overlay graphics with canvas selection.
 
virtual bool RenderGLOverlayMultiCanvas (wxGLContext *pcontext, PlugIn_ViewPort *vp, int canvasIndex)
 Renders plugin overlay graphics in OpenGL mode with canvas selection.
 
virtual bool RenderOverlayMultiCanvas (wxDC &dc, PlugIn_ViewPort *vp, int canvasIndex)
 Renders plugin overlay graphics with canvas selection.
 
- Public Member Functions inherited from opencpn_plugin_117
 opencpn_plugin_117 (void *pmgr)
 
virtual int GetPlugInVersionPatch ()
 Forms a semantic version together with GetPlugInVersionMajor() and GetPlugInVersionMinor().
 
virtual int GetPlugInVersionPost ()
 Post-release version part, extends the semver spec.
 
virtual const char * GetPlugInVersionPre ()
 Pre-release tag version part, see GetPlugInVersionPatch()
 
virtual const char * GetPlugInVersionBuild ()
 Build version part see GetPlugInVersionPatch().
 
virtual void SetActiveLegInfo (Plugin_Active_Leg_Info &leg_info)
 
- 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 bool MouseEventHook (wxMouseEvent &event)
 Handles mouse events from chart window.
 
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 custom setup options.
 
- Public Member Functions inherited from opencpn_plugin_18
 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

Constructor & Destructor Documentation

◆ opencpn_plugin_119()

opencpn_plugin_119::opencpn_plugin_119 ( void *  pmgr)

Definition at line 294 of file ocpn_plugin.cpp.

Member Function Documentation

◆ PreShutdownHook()

void opencpn_plugin_119::PreShutdownHook ( )
virtual

Called just before OpenCPN begins shutdown sequence.

Provides plugins an opportunity to perform cleanup and save state before OpenCPN shutdown completes. This hook is called early in the shutdown process, before core subsystems are terminated.

Typical uses include:

  • Saving plugin configuration/state
  • Closing network connections
  • Releasing system resources
  • Stopping background threads
  • Terminating external processes
Note
Only called if plugin declares WANTS_PRESHUTDOWN_HOOK capability
Plugin should handle this quickly to avoid delaying shutdown
Core subsystems are still available during this call

Definition at line 296 of file ocpn_plugin.cpp.


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