OpenCPN Partial API docs
Loading...
Searching...
No Matches
opencpn_plugin_118 Class Reference
Inheritance diagram for 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_118 (void *pmgr)
 
virtual bool RenderGLOverlayMultiCanvas (wxGLContext *pcontext, PlugIn_ViewPort *vp, int canvasIndex, int priority=-1)
 Render plugin overlay over chart canvas in OpenGL mode. More...
 
virtual bool RenderOverlayMultiCanvas (wxDC &dc, PlugIn_ViewPort *vp, int canvasIndex, int priority=-1)
 Render plugin overlay over chart canvas in non-OpenGL mode. More...
 
- Public Member Functions inherited from opencpn_plugin_117
 opencpn_plugin_117 (void *pmgr)
 
virtual int GetPlugInVersionPatch ()
 
virtual int GetPlugInVersionPost ()
 Post-release version part, extends the semver spec. More...
 
virtual const char * GetPlugInVersionPre ()
 Pre-release tag version part, see GetPlugInVersionPatch() More...
 
virtual const char * GetPlugInVersionBuild ()
 Build version part see GetPlugInVersionPatch(). More...
 
virtual void SetActiveLegInfo (Plugin_Active_Leg_Info &leg_info)
 
- Public Member Functions inherited from opencpn_plugin_116
 opencpn_plugin_116 (void *pmgr)
 
virtual bool RenderGLOverlayMultiCanvas (wxGLContext *pcontext, PlugIn_ViewPort *vp, int canvasIndex)
 
virtual bool RenderOverlayMultiCanvas (wxDC &dc, PlugIn_ViewPort *vp, int canvasIndex)
 
virtual void PrepareContextMenu (int canvasIndex)
 
- 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)
 
virtual void OnToolbarToolDownCallback (int id)
 
virtual void OnToolbarToolUpCallback (int id)
 
- Public Member Functions inherited from opencpn_plugin_112
 opencpn_plugin_112 (void *pmgr)
 
virtual bool MouseEventHook (wxMouseEvent &event)
 
virtual void SendVectorChartObjectInfo (wxString &chart, wxString &feature, wxString &objname, double lat, double lon, double scale, int nativescale)
 
- 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)
 
- 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)
 
virtual void SetPluginMessage (wxString &message_id, wxString &message_body)
 
virtual void SetPositionFixEx (PlugIn_Position_Fix_Ex &pfix)
 
- Public Member Functions inherited from opencpn_plugin
 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. More...
 
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)
 
virtual void SetAISSentence (wxString &sentence)
 
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

Definition at line 580 of file ocpn_plugin.h.

Constructor & Destructor Documentation

◆ opencpn_plugin_118()

opencpn_plugin_118::opencpn_plugin_118 ( void *  pmgr)

Definition at line 280 of file ocpn_plugin.cpp.

Member Function Documentation

◆ RenderGLOverlayMultiCanvas()

bool opencpn_plugin_118::RenderGLOverlayMultiCanvas ( wxGLContext *  pcontext,
PlugIn_ViewPort vp,
int  canvasIndex,
int  priority = -1 
)
virtual

Render plugin overlay over chart canvas in OpenGL mode.

Parameters
pcontextPointer to the OpenGL context
vpPointer to the Viewport
canvasIndexIndex of the chart canvas, 0 for the first canvas
priorityPriority, plugins only upgrading from older API versions should draw only when priority is OVERLAY_LEGACY (0)
Returns
true if overlay was rendered, false otherwise

Definition at line 282 of file ocpn_plugin.cpp.

◆ RenderOverlayMultiCanvas()

bool opencpn_plugin_118::RenderOverlayMultiCanvas ( wxDC &  dc,
PlugIn_ViewPort vp,
int  canvasIndex,
int  priority = -1 
)
virtual

Render plugin overlay over chart canvas in non-OpenGL mode.

Parameters
dcReference to the "device context"
vpPointer to the Viewport
canvasIndexIndex of the chart canvas, 0 for the first canvas
priorityPriority, plugins only upgrading from older API versions should draw only when priority is OVERLAY_LEGACY (0)
Returns
true if overlay was rendered, false otherwise

Definition at line 289 of file ocpn_plugin.cpp.


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