Inheritance diagram for opencpn_plugin_112:

Public Member Functions
	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

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

Definition at line 1745 of file ocpn_plugin.h.

Constructor & Destructor Documentation

◆ opencpn_plugin_112()

opencpn_plugin_112::opencpn_plugin_112 ( void * pmgr )

Definition at line 216 of file ocpn_plugin.cpp.

◆ ~opencpn_plugin_112()

opencpn_plugin_112::~opencpn_plugin_112 ( void )

virtual

Definition at line 218 of file ocpn_plugin.cpp.

Member Function Documentation

◆ MouseEventHook()

bool opencpn_plugin_112::MouseEventHook ( wxMouseEvent & event )

virtual

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 in grib_pi.

Definition at line 220 of file ocpn_plugin.cpp.

◆ SendVectorChartObjectInfo()

void opencpn_plugin_112::SendVectorChartObjectInfo	(	wxString &	chart,
		wxString &	feature,
		wxString &	objname,
		double	lat,
		double	lon,
		double	scale,
		int	nativescale
	)

virtual

Receives vector chart object information.

Called when user clicks vector chart features. Provides details about the selected chart object.

Parameters

chart	Chart identifier
feature	Feature type
objname	Object name/identifier
lat	Object latitude
lon	Object longitude
scale	Display scale when clicked
nativescale	Chart's native scale

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

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ opencpn_plugin_112()

◆ ~opencpn_plugin_112()

Member Function Documentation

◆ MouseEventHook()

◆ SendVectorChartObjectInfo()