ocpn_plugin.h File Reference

PlugIn Object Definition/API. More...

#include <wx/xml/xml.h>
#include <wx/dcmemory.h>
#include <wx/dialog.h>
#include <wx/event.h>
#include <wx/menuitem.h>
#include <wx/gdicmn.h>
#include <memory>
#include <vector>
#include <unordered_map>

Go to the source code of this file.

Classes
class	PlugIn_ViewPort
	Contains view parameters and status information for a chart display viewport. More...
class	PlugIn_Position_Fix
	Basic position fix information. More...
class	PlugIn_Position_Fix_Ex
	Extended position fix information. More...
class	Plugin_Active_Leg_Info
	Information about the currently active route leg. More...
class	PlugIn_AIS_Target
	AIS target information accessible to plugins. More...
struct	_ExtentPI
	Geographic extent structure defining a bounding box. More...
class	PlugInChartBase
	Base class for implementing custom chart types in OpenCPN plugins. More...
class	opencpn_plugin
	Base class for OpenCPN plugins. More...
class	opencpn_plugin_16
class	opencpn_plugin_17
class	opencpn_plugin_18
class	opencpn_plugin_19
class	opencpn_plugin_110
class	opencpn_plugin_111
class	opencpn_plugin_112
class	opencpn_plugin_113
class	opencpn_plugin_114
class	opencpn_plugin_115
class	opencpn_plugin_116
class	opencpn_plugin_117
class	opencpn_plugin_118
class	opencpn_plugin_119
class	Plugin_Hyperlink
	Class representing a hyperlink associated with a waypoint or route. More...
class	PlugIn_Waypoint
	Plugin waypoint class providing core waypoint/mark functionality. More...
class	PlugIn_Route
	Plugin route class for managing ordered waypoint collections. More...
class	PlugIn_Track
	Plugin track class for managing recorded track data. More...
struct	DateTimeFormatOptions
	Configuration options for date and time formatting. More...
class	PlugInChartBaseGL
	OpenGL-optimized chart base class for plugin chart types. More...
class	PlugInChartBaseGLPlus2
	Extended OpenGL-optimized chart base class with additional querying capabilities. More...
class	PlugInChartBaseExtended
	Extended chart base class with separated text rendering. More...
class	PlugInChartBaseExtendedPlus2
class	PI_line_segment_element
	Represents a line segment element for efficient vector chart rendering. More...
class	PI_S57Obj
	Class representing an S-57 chart object. More...
class	OCPN_downloadEvent
class	PlugIn_Waypoint_Ex
	Extended waypoint class with additional navigation features. More...
class	PlugIn_Route_Ex
	Extended route class for managing complex route features. More...
class	ObservedEvt
	Custom event class for OpenCPN's notification system. More...
struct	NMEA2000Id
	Identifier for NMEA 2000 message types. More...
struct	NMEA0183Id
	Identifier for NMEA 0183 sentence types. More...
struct	SignalkId
	Identifier for Signal K paths. More...
struct	NavDataId
	Navigation data message identifier. More...
struct	PluginNavdata
	Basic navigation data structure. More...
struct	PluginMsgId
	Facade for NavAddrPluginMsg. More...

Macros
#define	DECL_EXP
#define	DECL_IMP
#define	API_VERSION_MAJOR   1
#define	API_VERSION_MINOR   19
#define	WANTS_OVERLAY_CALLBACK   0x00000001
	Receive callbacks to render custom overlay graphics on the chart.
#define	WANTS_CURSOR_LATLON   0x00000002
	Receive updates when cursor moves over chart.
#define	WANTS_TOOLBAR_CALLBACK   0x00000004
	Receive notification when user left-clicks plugin's toolbar buttons.
#define	INSTALLS_TOOLBAR_TOOL   0x00000008
	Plugin will add one or more toolbar buttons.
#define	WANTS_CONFIG   0x00000010
	Plugin requires persistent configuration storage.
#define	INSTALLS_TOOLBOX_PAGE   0x00000020
	Plugin will add pages to the toolbox/settings dialog.
#define	INSTALLS_CONTEXTMENU_ITEMS   0x00000040
	Plugin will add items to chart context menu.
#define	WANTS_NMEA_SENTENCES   0x00000080
	Receive raw NMEA 0183 sentences from all active ports.
#define	WANTS_NMEA_EVENTS   0x00000100
	Receive decoded NMEA events with parsed data.
#define	WANTS_AIS_SENTENCES   0x00000200
	Receive AIS target information and updates.
#define	USES_AUI_MANAGER   0x00000400
	Plugin uses wxAuiManager for window management.
#define	WANTS_PREFERENCES   0x00000800
	Plugin will add page(s) to global preferences dialog.
#define	INSTALLS_PLUGIN_CHART   0x00001000
	Plugin provides new chart type for standard (non-GL) view.
#define	WANTS_ONPAINT_VIEWPORT   0x00002000
	Receive callbacks during chart viewport painting.
#define	WANTS_PLUGIN_MESSAGING   0x00004000
	Enable message passing between plugins.
#define	WANTS_OPENGL_OVERLAY_CALLBACK   0x00008000
#define	WANTS_DYNAMIC_OPENGL_OVERLAY_CALLBACK   0x00010000
#define	WANTS_LATE_INIT   0x00020000
	Delay full plugin initialization until system is ready.
#define	INSTALLS_PLUGIN_CHART_GL   0x00040000
	Plugin provides new chart type for OpenGL view.
#define	WANTS_MOUSE_EVENTS   0x00080000
	Receive mouse events (clicks, movement, etc).
#define	WANTS_VECTOR_CHART_OBJECT_INFO   0x00100000
	Receive information about vector chart objects.
#define	WANTS_KEYBOARD_EVENTS   0x00200000
	Receive keyboard events from main window.
#define	WANTS_PRESHUTDOWN_HOOK   0x00400000
	Receive notification just before OpenCPN shutdown.
#define	OVERLAY_LEGACY   0
#define	OVERLAY_OVER_SHIPS   64
#define	OVERLAY_OVER_EMBOSS   96
#define	OVERLAY_OVER_UI   128
#define	PI_FULL_INIT   0
	Full chart initialization including all data needed for rendering and all operations.
#define	PI_HEADER_ONLY   1
	Initialize only the chart header/metadata for chart database operations (faster, used for chart database building).
#define	PI_THUMB_ONLY   2
	Initialize only what's needed to generate a thumbnail image.
#define	PLIB_CAPS_LINE_VBO   1
	API 1.11 adds access to S52 Presentation library Types.
#define	PLIB_CAPS_LINE_BUFFER   1 << 1
	Support for line vertex buffers Enables batched line rendering using vertex buffers.
#define	PLIB_CAPS_SINGLEGEO_BUFFER   1 << 2
	Support for single geometry buffers Allows combining multiple geometries into a single buffer.
#define	PLIB_CAPS_OBJSEGLIST   1 << 3
	Support for object segment lists Enables breaking complex geometries into optimized segments.
#define	PLIB_CAPS_OBJCATMUTATE   1 << 4
	Support for object category mutation Allows dynamic changes to object display categories.
#define	ONLINE_CHECK_RETRY    30
#define	OBSERVABLE_EVT_H

Typedefs
typedef enum ChartTypeEnumPI	_ChartTypeEnumPI
	Enumeration of chart types.
typedef enum ChartFamilyEnumPI	_ChartFamilyEnumPI
	Enumeration of chart families (broad categories).
typedef enum ChartDepthUnitTypePI	_ChartDepthUnitTypePI
	Enumeration of depth unit types used in charts.
typedef enum OcpnProjTypePI	_OcpnProjTypePI
	Enumeration of chart projection types.
typedef struct _ExtentPI	ExtentPI
	Geographic extent structure defining a bounding box.
typedef opencpn_plugin *	create_t(void *)
typedef void	destroy_t(opencpn_plugin *)
typedef enum OptionsParentPI	_OptionsParentPI
	Enum defining parent pages in OpenCPN options dialog where plugins can add panels.
typedef enum _PI_LUPname	PI_LUPname
	Name identifiers for S57 lookup table sets.
typedef enum _PI_DisCat	PI_DisCat
	Display categories for S52 chart features.
typedef enum _PI_DisPrio	PI_DisPrio
	Display priority levels for S52 chart objects.
typedef enum PI_InitReturn	_PI_InitReturn
	Return values for plugin initialization.
typedef enum _OCPN_DLStatus	OCPN_DLStatus
	Status codes for HTTP file download operations.
typedef enum _OCPN_DLCondition	OCPN_DLCondition
	Event types for HTTP file download operations.
typedef enum _OBJECT_LAYER_REQ	OBJECT_LAYER_REQ
	Filter options for object queries.
typedef std::string	DriverHandle
	Plugin API supporting direct access to comm drivers for output purposes.
typedef enum CommDriverResult	_CommDriverResult
	Error return values
typedef enum _PI_NavMode	PI_NavMode
	Navigation mode options for chart display orientation.

Enumerations
enum	PI_ColorScheme {   PI_GLOBAL_COLOR_SCHEME_RGB , PI_GLOBAL_COLOR_SCHEME_DAY , PI_GLOBAL_COLOR_SCHEME_DUSK , PI_GLOBAL_COLOR_SCHEME_NIGHT ,   PI_N_COLOR_SCHEMES }
	Enumeration of color schemes. More...
enum	plugin_ais_alarm_type { PI_AIS_NO_ALARM = 0 , PI_AIS_ALARM_SET , PI_AIS_ALARM_ACKNOWLEDGED }
	Enumeration of AIS alarm states. More...
enum	ChartTypeEnumPI {   PI_CHART_TYPE_UNKNOWN = 0 , PI_CHART_TYPE_DUMMY , PI_CHART_TYPE_DONTCARE , PI_CHART_TYPE_KAP ,   PI_CHART_TYPE_GEO , PI_CHART_TYPE_S57 , PI_CHART_TYPE_CM93 , PI_CHART_TYPE_CM93COMP ,   PI_CHART_TYPE_PLUGIN }
	Enumeration of chart types. More...
enum	ChartFamilyEnumPI { PI_CHART_FAMILY_UNKNOWN = 0 , PI_CHART_FAMILY_RASTER , PI_CHART_FAMILY_VECTOR , PI_CHART_FAMILY_DONTCARE }
	Enumeration of chart families (broad categories). More...
enum	ChartDepthUnitTypePI { PI_DEPTH_UNIT_UNKNOWN , PI_DEPTH_UNIT_FEET , PI_DEPTH_UNIT_METERS , PI_DEPTH_UNIT_FATHOMS }
	Enumeration of depth unit types used in charts. More...
enum	OcpnProjTypePI {   PI_PROJECTION_UNKNOWN , PI_PROJECTION_MERCATOR , PI_PROJECTION_TRANSVERSE_MERCATOR , PI_PROJECTION_POLYCONIC ,   PI_PROJECTION_ORTHOGRAPHIC , PI_PROJECTION_POLAR , PI_PROJECTION_STEREOGRAPHIC , PI_PROJECTION_GNOMONIC ,   PI_PROJECTION_EQUIRECTANGULAR }
	Enumeration of chart projection types. More...
enum	OptionsParentPI {   PI_OPTIONS_PARENT_DISPLAY , PI_OPTIONS_PARENT_CONNECTIONS , PI_OPTIONS_PARENT_CHARTS , PI_OPTIONS_PARENT_SHIPS ,   PI_OPTIONS_PARENT_UI , PI_OPTIONS_PARENT_PLUGINS }
	Enum defining parent pages in OpenCPN options dialog where plugins can add panels. More...
enum	_PI_LUPname {   PI_SIMPLIFIED = 'L' , PI_PAPER_CHART , PI_LINES = 'S' , PI_PLAIN_BOUNDARIES = 'N' ,   PI_SYMBOLIZED_BOUNDARIES = 'O' , PI_LUPNAME_NUM = 5 }
	Name identifiers for S57 lookup table sets. More...
enum	_PI_DisCat {   PI_DISPLAYBASE = 'D' , PI_STANDARD = 'S' , PI_OTHER = 'O' , PI_MARINERS_STANDARD = 'M' ,   PI_MARINERS_OTHER , PI_DISP_CAT_NUM }
	Display categories for S52 chart features. More...
enum	_PI_DisPrio {   PI_PRIO_NODATA = '0' , PI_PRIO_GROUP1 = '1' , PI_PRIO_AREA_1 = '2' , PI_PRIO_AREA_2 = '3' ,   PI_PRIO_SYMB_POINT = '4' , PI_PRIO_SYMB_LINE = '5' , PI_PRIO_SYMB_AREA = '6' , PI_PRIO_ROUTEING = '7' ,   PI_PRIO_HAZARDS = '8' , PI_PRIO_MARINERS = '9' , PI_PRIO_NUM = 10 }
	Display priority levels for S52 chart objects. More...
enum	PI_InitReturn { PI_INIT_OK = 0 , PI_INIT_FAIL_RETRY , PI_INIT_FAIL_REMOVE , PI_INIT_FAIL_NOERROR }
	Return values for plugin initialization. More...
enum	_OCPN_DLStatus {   OCPN_DL_UNKNOWN = -1 , OCPN_DL_NO_ERROR = 0 , OCPN_DL_FAILED = 1 , OCPN_DL_ABORTED = 2 ,   OCPN_DL_USER_TIMEOUT = 4 , OCPN_DL_STARTED = 8 }
	Status codes for HTTP file download operations. More...
enum	_OCPN_DLCondition { OCPN_DL_EVENT_TYPE_UNKNOWN = -1 , OCPN_DL_EVENT_TYPE_START = 80 , OCPN_DL_EVENT_TYPE_PROGRESS = 81 , OCPN_DL_EVENT_TYPE_END = 82 }
	Event types for HTTP file download operations. More...
enum	OCPN_DLDialogStyle {   OCPN_DLDS_ELAPSED_TIME = 0x0001 , OCPN_DLDS_ESTIMATED_TIME , OCPN_DLDS_REMAINING_TIME = 0x0004 , OCPN_DLDS_SPEED = 0x0008 ,   OCPN_DLDS_SIZE = 0x0010 , OCPN_DLDS_URL , OCPN_DLDS_CONN_SETTINGS_AUTH , OCPN_DLDS_CONN_SETTINGS_PORT = 0x0080 ,   OCPN_DLDS_CONN_SETTINGS_PROXY , OCPN_DLDS_CONN_SETTINGS_ALL , OCPN_DLDS_SHOW_ALL , OCPN_DLDS_CAN_ABORT = 0x0200 ,   OCPN_DLDS_CAN_START = 0x0400 , OCPN_DLDS_CAN_PAUSE = 0x0800 , OCPN_DLDS_AUTO_CLOSE , OCPN_DLDS_DEFAULT_STYLE }
enum	SDDMFORMAT { DEGREES_DECIMAL_MINUTES = 0 , DECIMAL_DEGREES , DEGREES_MINUTES_SECONDS , END_SDDMFORMATS }
	Coordinate format options for lat/lon display. More...
enum	_OBJECT_LAYER_REQ { OBJECTS_ALL = 0 , OBJECTS_NO_LAYERS , OBJECTS_ONLY_LAYERS }
	Filter options for object queries. More...
enum	CommDriverResult {   RESULT_COMM_NO_ERROR = 0 , RESULT_COMM_INVALID_HANDLE , RESULT_COMM_INVALID_PARMS , RESULT_COMM_TX_ERROR ,   RESULT_COMM_REGISTER_GATEWAY_ERROR , RESULT_COMM_REGISTER_PGN_ERROR }
	Error return values More...
enum	_PI_NavMode { PI_NORTH_UP_MODE = 0 , PI_COURSE_UP_MODE , PI_HEAD_UP_MODE }
	Navigation mode options for chart display orientation. More...

Functions
	WX_DEFINE_ARRAY_PTR (PlugIn_AIS_Target *, ArrayOfPlugIn_AIS_Targets)
	WX_DECLARE_LIST (Plugin_Hyperlink, Plugin_HyperlinkList)
	WX_DECLARE_LIST (PlugIn_Waypoint, Plugin_WaypointList)
DECL_EXP int	InsertPlugInTool (wxString label, wxBitmap *bitmap, wxBitmap *bmpRollover, wxItemKind kind, wxString shortHelp, wxString longHelp, wxObject *clientData, int position, int tool_sel, opencpn_plugin *pplugin)
	Adds a tool to OpenCPN's toolbar.
DECL_EXP void	RemovePlugInTool (int tool_id)
	Removes a tool from OpenCPN's toolbar.
DECL_EXP void	SetToolbarToolViz (int item, bool viz)
	Temporarily changes toolbar tool visibility.
DECL_EXP void	SetToolbarItemState (int item, bool toggle)
	Sets toolbar item toggle state.
DECL_EXP void	SetToolbarToolBitmaps (int item, wxBitmap *bitmap, wxBitmap *bmpRollover)
	Updates toolbar tool bitmaps.
DECL_EXP int	InsertPlugInToolSVG (wxString label, wxString SVGfile, wxString SVGfileRollover, wxString SVGfileToggled, wxItemKind kind, wxString shortHelp, wxString longHelp, wxObject *clientData, int position, int tool_sel, opencpn_plugin *pplugin)
	Adds a tool using SVG graphics.
DECL_EXP void	SetToolbarToolBitmapsSVG (int item, wxString SVGfile, wxString SVGfileRollover, wxString SVGfileToggled)
	Updates SVG graphics for toolbar tool.
DECL_EXP int	AddCanvasContextMenuItem (wxMenuItem *pitem, opencpn_plugin *pplugin)
	Adds item to chart canvas context menu.
DECL_EXP void	RemoveCanvasContextMenuItem (int item)
	Removes a context menu item completely.
DECL_EXP void	SetCanvasContextMenuItemViz (int item, bool viz)
	Temporarily changes context menu item visibility.
DECL_EXP void	SetCanvasContextMenuItemGrey (int item, bool grey)
	Sets menu item enabled/disabled state.
DECL_EXP wxFileConfig *	GetOCPNConfigObject (void)
	Gets OpenCPN's configuration object.
DECL_EXP void	RequestRefresh (wxWindow *)
	Requests window refresh.
DECL_EXP bool	GetGlobalColor (wxString colorName, wxColour *pcolour)
	Gets a global color value.
DECL_EXP void	GetCanvasPixLL (PlugIn_ViewPort *vp, wxPoint *pp, double lat, double lon)
	Converts lat/lon to canvas physical pixel coordinates.
DECL_EXP void	GetCanvasLLPix (PlugIn_ViewPort *vp, wxPoint p, double *plat, double *plon)
	Converts canvas physical pixel coordinates to lat/lon.
DECL_EXP wxWindow *	GetOCPNCanvasWindow ()
	Gets OpenCPN's main canvas window.
DECL_EXP wxFont *	OCPNGetFont (wxString TextElement, int default_size=0)
	Gets a font for UI elements.
DECL_EXP wxString *	GetpSharedDataLocation ()
	Gets shared application data location.
DECL_EXP ArrayOfPlugIn_AIS_Targets *	GetAISTargetArray (void)
	Gets array of AIS targets.
DECL_EXP wxAuiManager *	GetFrameAuiManager (void)
	Gets main frame AUI manager.
DECL_EXP bool	AddLocaleCatalog (wxString catalog)
	Adds a locale catalog for translations.
DECL_EXP void	PushNMEABuffer (wxString str)
	Pushes NMEA sentence to the system.
DECL_EXP wxXmlDocument	GetChartDatabaseEntryXML (int dbIndex, bool b_getGeom)
	Gets chart database entry as XML.
DECL_EXP bool	UpdateChartDBInplace (wxArrayString dir_array, bool b_force_update, bool b_ProgressDialog)
	Updates chart database in place.
DECL_EXP wxArrayString	GetChartDBDirArrayString ()
	Gets chart database directory list.
DECL_EXP void	SendPluginMessage (wxString message_id, wxString message_body)
	Sends message to other plugins.
DECL_EXP void	DimeWindow (wxWindow *)
	Applies system color scheme to window.
DECL_EXP void	JumpToPosition (double lat, double lon, double scale)
	Centers chart display on specified position at given scale.
DECL_EXP void	PositionBearingDistanceMercator_Plugin (double lat, double lon, double brg, double dist, double *dlat, double *dlon)
	Calculates destination point given start point, bearing and distance.
DECL_EXP void	DistanceBearingMercator_Plugin (double lat0, double lon0, double lat1, double lon1, double *brg, double *dist)
	Calculates bearing and distance between two points.
DECL_EXP double	DistGreatCircle_Plugin (double slat, double slon, double dlat, double dlon)
	Calculates great circle distance between two points.
DECL_EXP void	toTM_Plugin (float lat, float lon, float lat0, float lon0, double *x, double *y)
	Converts geographic coordinates to Transverse Mercator projection.
DECL_EXP void	fromTM_Plugin (double x, double y, double lat0, double lon0, double *lat, double *lon)
	Converts Transverse Mercator coordinates to geographic.
DECL_EXP void	toSM_Plugin (double lat, double lon, double lat0, double lon0, double *x, double *y)
	Converts geographic coordinates to Simple Mercator projection.
DECL_EXP void	fromSM_Plugin (double x, double y, double lat0, double lon0, double *lat, double *lon)
	Converts Simple Mercator coordinates to geographic.
DECL_EXP void	toSM_ECC_Plugin (double lat, double lon, double lat0, double lon0, double *x, double *y)
	Converts geographic coordinates to Elliptical Simple Mercator projection.
DECL_EXP void	fromSM_ECC_Plugin (double x, double y, double lat0, double lon0, double *lat, double *lon)
	Converts Elliptical Simple Mercator coordinates to geographic.
DECL_EXP bool	DecodeSingleVDOMessage (const wxString &str, PlugIn_Position_Fix_Ex *pos, wxString *acc)
	Decodes a single VDO (Own Ship AIS) message.
DECL_EXP int	GetChartbarHeight (void)
	Gets height of chart bar in pixels.
DECL_EXP bool	GetActiveRoutepointGPX (char *buffer, unsigned int buffer_length)
	Gets GPX representation of active route waypoint.
DECL_EXP wxScrolledWindow *	AddOptionsPage (OptionsParentPI parent, wxString title)
	Adds a new preferences page to OpenCPN options dialog.
DECL_EXP bool	DeleteOptionsPage (wxScrolledWindow *page)
	Removes a previously added options page.
DECL_EXP double	toUsrDistance_Plugin (double nm_distance, int unit=-1)
	Converts nautical miles to user's preferred distance unit.
DECL_EXP double	fromUsrDistance_Plugin (double usr_distance, int unit=-1)
	Converts from user's preferred distance unit to nautical miles.
DECL_EXP double	toUsrSpeed_Plugin (double kts_speed, int unit=-1)
	Converts knots to user's preferred speed unit.
DECL_EXP double	fromUsrSpeed_Plugin (double usr_speed, int unit=-1)
	Converts from user's preferred speed unit to knots.
DECL_EXP double	toUsrTemp_Plugin (double cel_temp, int unit=-1)
	Converts Celsius to user's preferred temperature unit.
DECL_EXP double	fromUsrTemp_Plugin (double usr_temp, int unit=-1)
	Converts from user's preferred temperature unit to Celsius.
DECL_EXP wxString	getUsrDistanceUnit_Plugin (int unit=-1)
	Gets display string for user's preferred distance unit.
DECL_EXP wxString	getUsrSpeedUnit_Plugin (int unit=-1)
	Gets display string for user's preferred speed unit.
DECL_EXP wxString	getUsrTempUnit_Plugin (int unit=-1)
	Gets display string for user's preferred temperature unit.
DECL_EXP wxString	toUsrDateTimeFormat_Plugin (const wxDateTime date_time, const DateTimeFormatOptions &options=DateTimeFormatOptions())
	Format a wxDateTime to a localized string representation, conforming to the global date/time format and timezone settings.
DECL_EXP wxString	GetNewGUID ()
	Generates a new globally unique identifier (GUID).
DECL_EXP bool	PlugIn_GSHHS_CrossesLand (double lat1, double lon1, double lat2, double lon2)
	Checks if a great circle route crosses land.
DECL_EXP void	PlugInPlaySound (wxString &sound_file)
	Plays a sound file asynchronously.
DECL_EXP wxBitmap *	FindSystemWaypointIcon (wxString &icon_name)
	Finds built-in system waypoint icon.
DECL_EXP bool	AddCustomWaypointIcon (wxBitmap *pimage, wxString key, wxString description)
	Adds a custom waypoint icon.
DECL_EXP bool	AddSingleWaypoint (PlugIn_Waypoint *pwaypoint, bool b_permanent=true)
	Adds a single waypoint.
DECL_EXP bool	DeleteSingleWaypoint (wxString &GUID)
	Deletes a single waypoint.
DECL_EXP bool	UpdateSingleWaypoint (PlugIn_Waypoint *pwaypoint)
	Updates a single waypoint.
DECL_EXP bool	AddPlugInRoute (PlugIn_Route *proute, bool b_permanent=true)
	Adds a new route.
DECL_EXP bool	DeletePlugInRoute (wxString &GUID)
	Deletes a route.
DECL_EXP bool	UpdatePlugInRoute (PlugIn_Route *proute)
	Updates an existing route.
DECL_EXP bool	AddPlugInTrack (PlugIn_Track *ptrack, bool b_permanent=true)
	Adds a new track.
DECL_EXP bool	DeletePlugInTrack (wxString &GUID)
	Deletes a track.
DECL_EXP bool	UpdatePlugInTrack (PlugIn_Track *ptrack)
	Updates an existing track.
wxColour DECL_EXP	GetBaseGlobalColor (wxString colorName)
	Gets a global system color.
int DECL_EXP	OCPNMessageBox_PlugIn (wxWindow *parent, const wxString &message, const wxString &caption=_T("Message"), int style=wxOK, int x=-1, int y=-1)
	Shows a message box dialog.
DECL_EXP wxString	toSDMM_PlugIn (int NEflag, double a, bool hi_precision=true)
	Formats latitude/longitude in degrees and decimal minutes.
DECL_EXP wxString *	GetpPrivateApplicationDataLocation ()
	Gets private application data directory.
DECL_EXP wxString	GetOCPN_ExePath (void)
	Gets OpenCPN executable path.
DECL_EXP wxString *	GetpPlugInLocation ()
	Gets plugins directory location.
DECL_EXP wxString	GetPlugInPath (opencpn_plugin *pplugin)
	Gets the installation path for a specific plugin.
DECL_EXP int	AddChartToDBInPlace (wxString &full_path, bool b_RefreshCanvas)
	Adds a chart to the database without full rebuild.
DECL_EXP int	RemoveChartFromDBInPlace (wxString &full_path)
	Removes a chart from database without full rebuild.
DECL_EXP wxString	GetLocaleCanonicalName ()
	Gets system locale canonical name.
	WX_DECLARE_LIST (PI_S57Obj, ListOfPI_S57Obj)
wxString DECL_EXP	PI_GetPLIBColorScheme ()
	Gets current color scheme used by S52 PLIB.
int DECL_EXP	PI_GetPLIBDepthUnitInt ()
	Gets configured depth unit for S52 display.
int DECL_EXP	PI_GetPLIBSymbolStyle ()
	Gets configured S52 symbol style.
int DECL_EXP	PI_GetPLIBBoundaryStyle ()
	Gets configured S52 boundary style.
int DECL_EXP	PI_GetPLIBStateHash ()
	Gets hash value representing current PLIB state.
double DECL_EXP	PI_GetPLIBMarinerSafetyContour ()
	Gets configured safety contour depth.
bool DECL_EXP	PI_GetObjectRenderBox (PI_S57Obj *pObj, double *lat_min, double *lat_max, double *lon_min, double *lon_max)
	Gets geographic bounding box of S57 object.
void DECL_EXP	PI_UpdateContext (PI_S57Obj *pObj)
	Updates rendering context for S57 object.
bool DECL_EXP	PI_PLIBObjectRenderCheck (PI_S57Obj *pObj, PlugIn_ViewPort *vp)
	Checks if object should be rendered.
PI_LUPname DECL_EXP	PI_GetObjectLUPName (PI_S57Obj *pObj)
	Gets Look-Up Table (LUP) name for object.
PI_DisPrio DECL_EXP	PI_GetObjectDisplayPriority (PI_S57Obj *pObj)
	Gets display priority for object.
PI_DisCat DECL_EXP	PI_GetObjectDisplayCategory (PI_S57Obj *pObj)
	Gets display category for object.
void DECL_EXP	PI_PLIBSetLineFeaturePriority (PI_S57Obj *pObj, int prio)
	Sets rendering priority for line feature.
void DECL_EXP	PI_PLIBPrepareForNewRender (void)
	Prepares PLIB for new rendering pass.
void DECL_EXP	PI_PLIBFreeContext (void *pContext)
	Frees S52 PLIB context.
void DECL_EXP	PI_PLIBSetRenderCaps (unsigned int flags)
	Sets rendering capability flags.
bool DECL_EXP	PI_PLIBSetContext (PI_S57Obj *pObj)
	Sets S52 PLIB rendering context for an object.
int DECL_EXP	PI_PLIBRenderObjectToDC (wxDC *pdc, PI_S57Obj *pObj, PlugIn_ViewPort *vp)
	Renders an S57 object using standard device context.
int DECL_EXP	PI_PLIBRenderAreaToDC (wxDC *pdc, PI_S57Obj *pObj, PlugIn_ViewPort *vp, wxRect rect, unsigned char *pixbuf)
	Renders an S57 area object using standard device context.
int DECL_EXP	PI_PLIBRenderAreaToGL (const wxGLContext &glcc, PI_S57Obj *pObj, PlugIn_ViewPort *vp, wxRect &render_rect)
	Renders an S57 area object using OpenGL.
int DECL_EXP	PI_PLIBRenderObjectToGL (const wxGLContext &glcc, PI_S57Obj *pObj, PlugIn_ViewPort *vp, wxRect &render_rect)
	Renders any S57 object using OpenGL.
DECL_EXP bool	PlugInHasNormalizedViewPort (PlugIn_ViewPort *vp)
	Checks if viewport has been normalized.
DECL_EXP void	PlugInMultMatrixViewport (PlugIn_ViewPort *vp, float lat=0, float lon=0)
	Applies viewport transformation matrix.
DECL_EXP void	PlugInNormalizeViewport (PlugIn_ViewPort *vp, float lat=0, float lon=0)
	Normalizes viewport parameters.
DECL_EXP void	GetDoubleCanvasPixLL (PlugIn_ViewPort *vp, wxPoint2DDouble *pp, double lat, double lon)
	Converts lat/lon to canvas pixels with double precision.
DECL_EXP double	fromDMM_Plugin (wxString sdms)
	Converts degrees/decimal minutes string to decimal degrees.
DECL_EXP void	SetCanvasRotation (double rotation)
	Sets chart display rotation angle.
DECL_EXP void	SetCanvasProjection (int projection)
	Sets chart projection type.
DECL_EXP bool	GetSingleWaypoint (wxString GUID, PlugIn_Waypoint *pwaypoint)
	Gets waypoint data by GUID.
DECL_EXP bool	CheckEdgePan_PlugIn (int x, int y, bool dragging, int margin, int delta)
	Checks if chart should pan when cursor near edge.
DECL_EXP wxBitmap	GetIcon_PlugIn (const wxString &name)
	Gets icon bitmap by name.
DECL_EXP void	SetCursor_PlugIn (wxCursor *pPlugin_Cursor=NULL)
	Sets mouse cursor.
DECL_EXP wxFont *	GetOCPNScaledFont_PlugIn (wxString TextElement, int default_size=0)
DECL_EXP wxFont	GetOCPNGUIScaledFont_PlugIn (wxString item)
	Gets a uniquely scaled font copy for responsive UI elements.
DECL_EXP double	GetOCPNGUIToolScaleFactor_PlugIn (int GUIScaledFactor)
	Gets GUI scaling factor for a specific scaling level.
DECL_EXP double	GetOCPNGUIToolScaleFactor_PlugIn ()
	Gets current global GUI scaling factor.
DECL_EXP float	GetOCPNChartScaleFactor_Plugin ()
	Gets chart rendering scale factor.
DECL_EXP wxColour	GetFontColour_PlugIn (wxString TextElement)
	Gets color configured for a UI text element.
DECL_EXP double	GetCanvasTilt ()
	Gets current canvas tilt angle.
DECL_EXP void	SetCanvasTilt (double tilt)
	Gets current canvas tilt angle.
DECL_EXP bool	PlugInPlaySoundEx (wxString &sound_file, int deviceIndex=-1)
	Start playing a sound file asynchronously.
DECL_EXP void	AddChartDirectory (wxString &path)
	Adds a chart directory to OpenCPN's chart database.
DECL_EXP void	ForceChartDBUpdate ()
	Forces an update of the chart database.
DECL_EXP void	ForceChartDBRebuild ()
	Forces complete rebuild of chart database.
DECL_EXP wxString	GetWritableDocumentsDir (void)
	Returns the platform-specific default documents directory.
DECL_EXP wxDialog *	GetActiveOptionsDialog ()
	Gets pointer to active options dialog.
DECL_EXP wxArrayString	GetWaypointGUIDArray (void)
	Gets array of all waypoint/marks GUIDs.
DECL_EXP wxArrayString	GetIconNameArray (void)
	Gets array of available waypoint icons.
DECL_EXP bool	AddPersistentFontKey (wxString TextElement)
	Registers a new font configuration element.
DECL_EXP wxString	GetActiveStyleName ()
	Gets name of currently active style sheet.
DECL_EXP wxBitmap	GetBitmapFromSVGFile (wxString filename, unsigned int width, unsigned int height)
	Creates bitmap from SVG file.
DECL_EXP bool	IsTouchInterface_PlugIn (void)
	Checks if touch interface mode is enabled.
DECL_EXP int	PlatformDirSelectorDialog (wxWindow *parent, wxString *file_spec, wxString Title, wxString initDir)
	Shows platform-optimized directory selector dialog.
DECL_EXP int	PlatformFileSelectorDialog (wxWindow *parent, wxString *file_spec, wxString Title, wxString initDir, wxString suggestedName, wxString wildcard)
	Shows platform-optimized file selector dialog.
DECL_EXP _OCPN_DLStatus	OCPN_downloadFile (const wxString &url, const wxString &outputFile, const wxString &title, const wxString &message, const wxBitmap &bitmap, wxWindow *parent, long style, int timeout_secs)
	Synchronously downloads a file with progress dialog.
DECL_EXP _OCPN_DLStatus	OCPN_downloadFileBackground (const wxString &url, const wxString &outputFile, wxEvtHandler *handler, long *handle)
	Asynchronously downloads a file in the background.
DECL_EXP void	OCPN_cancelDownloadFileBackground (long handle)
	Cancels a background download.
DECL_EXP _OCPN_DLStatus	OCPN_postDataHttp (const wxString &url, const wxString &parameters, wxString &result, int timeout_secs)
	Performs HTTP POST request.
DECL_EXP bool	OCPN_isOnline ()
	Checks internet connectivity.
bool	LaunchDefaultBrowser_Plugin (wxString url)
DECL_EXP void	PlugInAISDrawGL (wxGLCanvas *glcanvas, const PlugIn_ViewPort &vp)
	Renders AIS targets on a secondary OpenGL canvas.
DECL_EXP bool	PlugInSetFontColor (const wxString TextElement, const wxColour color)
	Sets text color for a UI element.
DECL_EXP double	PlugInGetDisplaySizeMM ()
	Gets physical display size in millimeters.
DECL_EXP wxFont *	FindOrCreateFont_PlugIn (int point_size, wxFontFamily family, wxFontStyle style, wxFontWeight weight, bool underline=false, const wxString &facename=wxEmptyString, wxFontEncoding encoding=wxFONTENCODING_DEFAULT)
	Creates or finds a font in the font cache.
DECL_EXP int	PlugInGetMinAvailableGshhgQuality ()
	Gets minimum available GSHHS coastline data quality.
DECL_EXP int	PlugInGetMaxAvailableGshhgQuality ()
	Gets maximum available GSHHS coastline data quality.
DECL_EXP void	PlugInHandleAutopilotRoute (bool enable)
	Controls autopilot route handling.
DECL_EXP wxString	GetPluginDataDir (const char *plugin_name)
	Return the plugin data directory for a given directory name.
DECL_EXP bool	ShuttingDown (void)
	Checks if OpenCPN is in shutdown process.
DECL_EXP wxWindow *	PluginGetFocusCanvas ()
	Gets the currently focused chart canvas.
DECL_EXP wxWindow *	PluginGetOverlayRenderCanvas ()
	Gets the canvas currently designated for overlay rendering.
DECL_EXP void	CanvasJumpToPosition (wxWindow *canvas, double lat, double lon, double scale)
	Centers specified canvas on given position at given scale.
DECL_EXP int	AddCanvasMenuItem (wxMenuItem *pitem, opencpn_plugin *pplugin, const char *name="")
	Adds item to canvas context menu.
DECL_EXP void	RemoveCanvasMenuItem (int item, const char *name="")
	Removes a context menu item completely.
DECL_EXP void	SetCanvasMenuItemViz (int item, bool viz, const char *name="")
	Temporarily changes context menu item visibility.
DECL_EXP void	SetCanvasMenuItemGrey (int item, bool grey, const char *name="")
	Sets menu item enabled/disabled state.
DECL_EXP wxString	GetSelectedWaypointGUID_Plugin ()
	Gets GUID of currently selected waypoint.
DECL_EXP wxString	GetSelectedRouteGUID_Plugin ()
	Gets GUID of currently selected route.
DECL_EXP wxString	GetSelectedTrackGUID_Plugin ()
	Gets GUID of currently selected track.
DECL_EXP std::unique_ptr< PlugIn_Waypoint >	GetWaypoint_Plugin (const wxString &)
	Gets waypoint details by GUID.
DECL_EXP std::unique_ptr< PlugIn_Route >	GetRoute_Plugin (const wxString &)
	Gets route details by GUID.
DECL_EXP std::unique_ptr< PlugIn_Track >	GetTrack_Plugin (const wxString &)
	Gets track details by GUID.
DECL_EXP wxWindow *	GetCanvasUnderMouse ()
	Gets canvas window under mouse cursor.
DECL_EXP int	GetCanvasIndexUnderMouse ()
	Gets index of chart canvas under mouse cursor.
DECL_EXP wxWindow *	GetCanvasByIndex (int canvasIndex)
	Gets chart canvas window by index.
DECL_EXP int	GetCanvasCount ()
	Gets total number of chart canvases.
DECL_EXP bool	CheckMUIEdgePan_PlugIn (int x, int y, bool dragging, int margin, int delta, int canvasIndex)
	Checks if chart should pan when cursor near edge.
DECL_EXP void	SetMUICursor_PlugIn (wxCursor *pCursor, int canvasIndex)
	Sets mouse cursor for specific canvas.
DECL_EXP wxRect	GetMasterToolbarRect ()
	Gets bounding rectangle of master toolbar.
DECL_EXP int	GetLatLonFormat (void)
	Gets currently selected latitude/longitude display format.
DECL_EXP void	ZeroXTE ()
	Resets cross track error to zero.
	WX_DECLARE_LIST (PlugIn_Waypoint_Ex, Plugin_WaypointExList)
DECL_EXP wxArrayString	GetRouteGUIDArray (void)
	Gets array of route GUIDs.
DECL_EXP wxArrayString	GetTrackGUIDArray (void)
	Gets array of track GUIDs.
DECL_EXP bool	GetSingleWaypointEx (wxString GUID, PlugIn_Waypoint_Ex *pwaypoint)
	Gets extended waypoint data by GUID.
DECL_EXP bool	AddSingleWaypointEx (PlugIn_Waypoint_Ex *pwaypoint, bool b_permanent=true)
	Adds a waypoint with extended properties.
DECL_EXP bool	UpdateSingleWaypointEx (PlugIn_Waypoint_Ex *pwaypoint)
	Updates an existing extended waypoint.
DECL_EXP bool	AddPlugInRouteEx (PlugIn_Route_Ex *proute, bool b_permanent=true)
	Adds a route with extended features.
DECL_EXP bool	UpdatePlugInRouteEx (PlugIn_Route_Ex *proute)
	Updates an existing extended route.
DECL_EXP std::unique_ptr< PlugIn_Waypoint_Ex >	GetWaypointEx_Plugin (const wxString &)
	Gets extended waypoint by GUID.
DECL_EXP std::unique_ptr< PlugIn_Route_Ex >	GetRouteEx_Plugin (const wxString &)
	Gets extended route by GUID.
DECL_EXP wxString	GetActiveWaypointGUID (void)
	Gets GUID of currently active waypoint.
DECL_EXP wxString	GetActiveRouteGUID (void)
	Gets GUID of currently active route.
DECL_EXP double	OCPN_GetDisplayContentScaleFactor ()
	Gets content scaling factor for current display.
DECL_EXP double	OCPN_GetWinDIPScaleFactor ()
	Gets Windows-specific DPI scaling factor.
DECL_EXP std::vector< std::string >	GetPriorityMaps ()
	Gets list of configured priority mapping schemes.
DECL_EXP std::vector< std::string >	GetActivePriorityIdentifiers ()
	Gets list of active priority identifiers.
DECL_EXP int	GetGlobalWatchdogTimoutSeconds ()
	Gets global watchdog timeout value.
DECL_EXP wxArrayString	GetRouteGUIDArray (OBJECT_LAYER_REQ req)
	Gets array of route GUIDs with layer filtering.
DECL_EXP wxArrayString	GetTrackGUIDArray (OBJECT_LAYER_REQ req)
	Gets array of track GUIDs with layer filtering.
DECL_EXP wxArrayString	GetWaypointGUIDArray (OBJECT_LAYER_REQ req)
	Gets array of waypoint/track GUIDs with layer filtering.
	wxDECLARE_EVENT (obsNOTIFY, ObservedEvt)
DECL_EXP std::shared_ptr< ObservableListener >	GetListener (NMEA2000Id id, wxEventType ev, wxEvtHandler *handler)
	Gets listener for NMEA 2000 messages.
DECL_EXP std::shared_ptr< ObservableListener >	GetListener (NMEA0183Id id, wxEventType ev, wxEvtHandler *handler)
	Gets listener for NMEA 0183 messages.
DECL_EXP std::shared_ptr< ObservableListener >	GetListener (SignalkId id, wxEventType ev, wxEvtHandler *handler)
	Gets listener for Signal K updates.
DECL_EXP std::vector< uint8_t >	GetN2000Payload (NMEA2000Id id, ObservedEvt ev)
	Return N2K payload for a received n2000 message of type id in ev.
DECL_EXP std::shared_ptr< void >	GetSignalkPayload (ObservedEvt ev)
	Get SignalK status payload after receiving a message.
DECL_EXP std::string	GetN2000Source (NMEA2000Id id, ObservedEvt ev)
	Return source identifier (iface) of a received n2000 message of type id in ev.
DECL_EXP std::string	GetN0183Payload (NMEA0183Id id, ObservedEvt ev)
	Return payload in a received n0183 message of type id in ev.
DECL_EXP std::shared_ptr< ObservableListener >	GetListener (NavDataId id, wxEventType ev, wxEvtHandler *handler)
	Gets listener for navigation data updates.
DECL_EXP PluginNavdata	GetEventNavdata (ObservedEvt ev)
	Return BasicNavDataMsg decoded data available in ev.
DECL_EXP std::vector< DriverHandle >	GetActiveDrivers ()
	Query OCPN core for a list of active drivers
DECL_EXP const std::unordered_map< std::string, std::string >	GetAttributes (DriverHandle handle)
	Query a specific driver for attributes.
DECL_EXP CommDriverResult	WriteCommDriver (DriverHandle handle, const std::shared_ptr< std::vector< uint8_t > > &payload)
	Send a non-NMEA2000 message.
DECL_EXP CommDriverResult	WriteCommDriverN2K (DriverHandle handle, int PGN, int destinationCANAddress, int priority, const std::shared_ptr< std::vector< uint8_t > > &payload)
	Send a PGN message to an NMEA2000 address.
DECL_EXP CommDriverResult	RegisterTXPGNs (DriverHandle handle, std::vector< int > &pgn_list)
	Register PGNs that this application intends to transmit for some NMEA 2000 adapters like Actisense NGT-1.
DECL_EXP std::shared_ptr< ObservableListener >	GetListener (PluginMsgId id, wxEventType ev, wxEvtHandler *handler)
	Return listener for plugin messages, internal or received on the REST interface.
DECL_EXP std::string	GetPluginMsgPayload (PluginMsgId id, ObservedEvt ev)
	Retrieve the string in a plugin message, internal or received on the REST insterface.
DECL_EXP void	ExitOCPN ()
	Exits OpenCPN application.
DECL_EXP void	RequestWindowRefresh (wxWindow *win, bool eraseBackground)
	Requests window refresh.
DECL_EXP bool	GetFullScreen ()
	Gets full screen state.
DECL_EXP void	SetFullScreen (bool full_screen_on)
	Sets full screen mode.
DECL_EXP void	EnableTouchMode (bool enable)
	Enables/disables touch interface mode.
DECL_EXP bool	GetTouchMode ()
	Gets touch interface mode state.
DECL_EXP void	SetGlobalColor (std::string table, std::string name, wxColor color)
	Sets a color in the global color scheme.
DECL_EXP wxColor	GetGlobalColorD (std::string map_name, std::string name)
	Gets a color from the global color scheme.
DECL_EXP void	EnableStatusBar (bool enable)
	Shows/hides the status bar.
DECL_EXP void	EnableMenu (bool enable)
	Shows/hides the main menu bar.
DECL_EXP bool	GetEnableStatusBar ()
	Gets status bar visibility state.
DECL_EXP bool	GetEnableMenu ()
	Gets menu bar visibility state.
DECL_EXP void	SetNavigationMode (PI_NavMode mode, int CanvasIndex)
	Sets the navigation mode for a specific chart canvas.
DECL_EXP PI_NavMode	GetNavigationMode (int CanvasIndex)
	Gets current navigation mode for a canvas.
DECL_EXP void	EnableLookaheadMode (bool enable, int CanvasIndex)
	Enables/disables look-ahead mode for a canvas.
DECL_EXP bool	GetEnableLookaheadMode (int CanvasIndex)
	Gets look-ahead mode state for a canvas.
DECL_EXP void	EnableMUIBar (bool enable, int CanvasIndex)
	Controls visibility of MUI (Mobile/Touch User Interface) bar.
DECL_EXP void	EnableCompassGPSIcon (bool enable, int CanvasIndex)
	Controls visibility of compass/GPS status icon.
DECL_EXP void	EnableChartBar (bool enable, int CanvasIndex)
	Controls visibility of chart info bar.
DECL_EXP bool	GetEnableMUIBar (int CanvasIndex)
	Gets MUI bar visibility state.
DECL_EXP bool	GetEnableCompassGPSIcon (int CanvasIndex)
	Gets compass icon visibility state.
DECL_EXP bool	GetEnableChartBar (int CanvasIndex)
	Gets chart bar visibility state.
DECL_EXP void	EnableCanvasFocusBar (bool enable, int CanvasIndex)
	Controls visibility of canvas focus indicator.
DECL_EXP bool	GetEnableCanvasFocusBar (int CanvasIndex)
	Gets focus indicator visibility state.
DECL_EXP void	EnableLatLonGrid (bool enable, int CanvasIndex)
	Controls latitude/longitude grid display.
DECL_EXP void	EnableChartOutlines (bool enable, int CanvasIndex)
	Controls chart outline display.
DECL_EXP void	EnableDepthUnitDisplay (bool enable, int CanvasIndex)
	Controls depth unit display.
DECL_EXP void	EnableAisTargetDisplay (bool enable, int CanvasIndex)
	Controls AIS target display.
DECL_EXP void	EnableTideStationsDisplay (bool enable, int CanvasIndex)
	Controls tide station icon display.
DECL_EXP void	EnableCurrentStationsDisplay (bool enable, int CanvasIndex)
	Controls current station icon display.
DECL_EXP void	EnableENCTextDisplay (bool enable, int CanvasIndex)
	Controls ENC text label display.
DECL_EXP void	EnableENCDepthSoundingsDisplay (bool enable, int CanvasIndex)
	Controls ENC depth sounding display.
DECL_EXP void	EnableBuoyLightLabelsDisplay (bool enable, int CanvasIndex)
	Controls buoy/light name label display.
DECL_EXP void	EnableLightsDisplay (bool enable, int CanvasIndex)
	Controls light icon display.
DECL_EXP void	EnableLightDescriptionsDisplay (bool enable, int CanvasIndex)
	Controls light description text display.
DECL_EXP void	SetENCDisplayCategory (PI_DisCat cat, int CanvasIndex)
	Sets ENC (Electronic Navigation Chart) feature display category.
DECL_EXP bool	GetEnableLatLonGrid (int CanvasIndex)
	Gets latitude/longitude grid visibility state.
DECL_EXP bool	GetEnableChartOutlines (int CanvasIndex)
	Gets chart outline visibility state.
DECL_EXP bool	GetEnableDepthUnitDisplay (int CanvasIndex)
	Gets depth unit display state.
DECL_EXP bool	GetEnableAisTargetDisplay (int CanvasIndex)
	Gets AIS target display state.
DECL_EXP bool	GetEnableTideStationsDisplay (int CanvasIndex)
	Gets tide station icon visibility.
DECL_EXP bool	GetEnableCurrentStationsDisplay (int CanvasIndex)
	Gets current station icon visibility.
DECL_EXP bool	GetEnableENCTextDisplay (int CanvasIndex)
	Gets ENC text label visibility.
DECL_EXP bool	GetEnableENCDepthSoundingsDisplay (int CanvasIndex)
	Gets ENC depth sounding visibility.
DECL_EXP bool	GetEnableBuoyLightLabelsDisplay (int CanvasIndex)
	Gets buoy/light label visibility.
DECL_EXP bool	GetEnableLightsDisplay (int CanvasIndex)
	Gets light icon visibility.
DECL_EXP bool	GetEnableLightDescriptionsDisplay (int CanvasIndex)
	Gets light description text visibility.
DECL_EXP PI_DisCat	GetENCDisplayCategory (int CanvasIndex)
	Gets current ENC display category.
DECL_EXP void	PluginSetFollowMode (int CanvasIndex, bool enable_follow)
	Set follow mode for a specific canvas.
DECL_EXP bool	PluginGetFollowMode (int CanvasIndex)
	Get the current follow mode status for a specific canvas.
DECL_EXP void	SetTrackingMode (bool enable)
	Enable or disable tracking mode.
DECL_EXP bool	GetTrackingMode ()
	Get the current tracking mode status.
DECL_EXP void	SetAppColorScheme (PI_ColorScheme cs)
	Set the application color scheme.
DECL_EXP PI_ColorScheme	GetAppColorScheme ()
	Get the current application color scheme.
DECL_EXP void	EnableSplitScreenLayout (bool enable=true)
	Enable or disable the split-screen layout.
DECL_EXP void	PluginZoomCanvas (int CanvasIndex, double factor)
	Zoom a specific chart canvas by the given factor.
DECL_EXP bool	GetEnableMainToolbar ()
	Check if the main toolbar is enabled.
DECL_EXP void	SetEnableMainToolbar (bool enable)
	Show or hide the main toolbar.
DECL_EXP void	ShowGlobalSettingsDialog ()
	Display the global settings dialog.
DECL_EXP void	PluginCenterOwnship (int CanvasIndex)
	Center the chart view on the own ship position for a specific canvas.
DECL_EXP bool	GetEnableTenHertzUpdate ()
	Check if 10 Hz update rate is enabled.
DECL_EXP void	EnableTenHertzUpdate (bool enable)
	Enable or disable 10 Hz update rate.
DECL_EXP void	ConfigFlushAndReload ()
	Flush configuration changes to disk and reload settings.

Variables
DECL_EXP wxEventType	wxEVT_DOWNLOAD_EVENT

Detailed Description

PlugIn Object Definition/API.

Definition in file ocpn_plugin.h.

Macro Definition Documentation

API_VERSION_MAJOR

#define API_VERSION_MAJOR   1

Definition at line 67 of file ocpn_plugin.h.

API_VERSION_MINOR

#define API_VERSION_MINOR   19

Definition at line 68 of file ocpn_plugin.h.

DECL_EXP

#define DECL_EXP

Definition at line 36 of file ocpn_plugin.h.

DECL_IMP

#define DECL_IMP

Definition at line 43 of file ocpn_plugin.h.

INSTALLS_CONTEXTMENU_ITEMS

#define INSTALLS_CONTEXTMENU_ITEMS   0x00000040

Plugin will add items to chart context menu.

Enables extending the right-click menu with custom actions.

Definition at line 115 of file ocpn_plugin.h.

INSTALLS_PLUGIN_CHART

#define INSTALLS_PLUGIN_CHART   0x00001000

Plugin provides new chart type for standard (non-GL) view.

Used by plugins that implement custom chart formats.

Definition at line 134 of file ocpn_plugin.h.

INSTALLS_PLUGIN_CHART_GL

#define INSTALLS_PLUGIN_CHART_GL   0x00040000

Plugin provides new chart type for OpenGL view.

Used by plugins that implement custom chart formats with OpenGL support.

Definition at line 148 of file ocpn_plugin.h.

INSTALLS_TOOLBAR_TOOL

#define INSTALLS_TOOLBAR_TOOL   0x00000008

Plugin will add one or more toolbar buttons.

Enables plugin to extend OpenCPN toolbar with custom functionality.

Definition at line 106 of file ocpn_plugin.h.

INSTALLS_TOOLBOX_PAGE

#define INSTALLS_TOOLBOX_PAGE   0x00000020

Plugin will add pages to the toolbox/settings dialog.

Allows plugin to provide custom configuration UI in OpenCPN settings.

Definition at line 112 of file ocpn_plugin.h.

OBSERVABLE_EVT_H

#define OBSERVABLE_EVT_H

Definition at line 5335 of file ocpn_plugin.h.

ONLINE_CHECK_RETRY

#define ONLINE_CHECK_RETRY    30

Definition at line 4413 of file ocpn_plugin.h.

OVERLAY_LEGACY

#define OVERLAY_LEGACY   0

Definition at line 167 of file ocpn_plugin.h.

OVERLAY_OVER_EMBOSS

#define OVERLAY_OVER_EMBOSS   96

Definition at line 169 of file ocpn_plugin.h.

OVERLAY_OVER_SHIPS

#define OVERLAY_OVER_SHIPS   64

Definition at line 168 of file ocpn_plugin.h.

OVERLAY_OVER_UI

#define OVERLAY_OVER_UI   128

Definition at line 170 of file ocpn_plugin.h.

PI_FULL_INIT

#define PI_FULL_INIT   0

Full chart initialization including all data needed for rendering and all operations.

Definition at line 425 of file ocpn_plugin.h.

PI_HEADER_ONLY

#define PI_HEADER_ONLY   1

Initialize only the chart header/metadata for chart database operations (faster, used for chart database building).

Definition at line 428 of file ocpn_plugin.h.

PI_THUMB_ONLY

#define PI_THUMB_ONLY   2

Initialize only what's needed to generate a thumbnail image.

Definition at line 430 of file ocpn_plugin.h.

PLIB_CAPS_LINE_BUFFER

#define PLIB_CAPS_LINE_BUFFER   1 << 1

Support for line vertex buffers Enables batched line rendering using vertex buffers.

Optimizes performance by reducing draw calls.

Definition at line 3188 of file ocpn_plugin.h.

PLIB_CAPS_LINE_VBO

#define PLIB_CAPS_LINE_VBO   1

API 1.11 adds access to S52 Presentation library Types.

OpenGL and vector rendering capability flags for S52 PLIB.

These flags define various capabilities and optimizations available for rendering vector charts and S52 features. They are used by plugins to indicate what rendering features they support. Support for OpenGL Vertex Buffer Objects (VBO) Enables hardware-accelerated rendering of vector lines using modern OpenGL VBOs. More efficient than immediate mode rendering.

Definition at line 3184 of file ocpn_plugin.h.

PLIB_CAPS_OBJCATMUTATE

#define PLIB_CAPS_OBJCATMUTATE   1 << 4

Support for object category mutation Allows dynamic changes to object display categories.

Required for runtime S52 display category changes.

Definition at line 3200 of file ocpn_plugin.h.

PLIB_CAPS_OBJSEGLIST

#define PLIB_CAPS_OBJSEGLIST   1 << 3

Support for object segment lists Enables breaking complex geometries into optimized segments.

Improves culling and rendering of large objects.

Definition at line 3196 of file ocpn_plugin.h.

PLIB_CAPS_SINGLEGEO_BUFFER

#define PLIB_CAPS_SINGLEGEO_BUFFER   1 << 2

Support for single geometry buffers Allows combining multiple geometries into a single buffer.

Reduces memory usage and draw calls.

Definition at line 3192 of file ocpn_plugin.h.

USES_AUI_MANAGER

#define USES_AUI_MANAGER   0x00000400

Plugin uses wxAuiManager for window management.

Needed for plugins that create dockable windows or panels.

Definition at line 128 of file ocpn_plugin.h.

WANTS_AIS_SENTENCES

#define WANTS_AIS_SENTENCES   0x00000200

Receive AIS target information and updates.

Required for plugins that monitor or process vessel traffic data.

Definition at line 125 of file ocpn_plugin.h.

WANTS_CONFIG

#define WANTS_CONFIG   0x00000010

Plugin requires persistent configuration storage.

Enables access to the config file for saving and loading settings.

Definition at line 109 of file ocpn_plugin.h.

WANTS_CURSOR_LATLON

#define WANTS_CURSOR_LATLON   0x00000002

Receive updates when cursor moves over chart.

Enables plugins to show information about chart features at cursor position.

Definition at line 90 of file ocpn_plugin.h.

WANTS_DYNAMIC_OPENGL_OVERLAY_CALLBACK

#define WANTS_DYNAMIC_OPENGL_OVERLAY_CALLBACK   0x00010000

Definition at line 142 of file ocpn_plugin.h.

WANTS_KEYBOARD_EVENTS

#define WANTS_KEYBOARD_EVENTS   0x00200000

Receive keyboard events from main window.

Enables plugins to implement keyboard shortcuts or commands.

Definition at line 157 of file ocpn_plugin.h.

WANTS_LATE_INIT

#define WANTS_LATE_INIT   0x00020000

Delay full plugin initialization until system is ready.

Useful for plugins that need complete system initialization.

Definition at line 145 of file ocpn_plugin.h.

WANTS_MOUSE_EVENTS

#define WANTS_MOUSE_EVENTS   0x00080000

Receive mouse events (clicks, movement, etc).

Enables plugins to respond to user mouse interaction.

Definition at line 151 of file ocpn_plugin.h.

WANTS_NMEA_EVENTS

#define WANTS_NMEA_EVENTS   0x00000100

Receive decoded NMEA events with parsed data.

Provides easy access to specific navigation data without parsing raw sentences.

Definition at line 122 of file ocpn_plugin.h.

WANTS_NMEA_SENTENCES

#define WANTS_NMEA_SENTENCES   0x00000080

Receive raw NMEA 0183 sentences from all active ports.

Used for plugins that need to process navigation data directly.

Definition at line 118 of file ocpn_plugin.h.

WANTS_ONPAINT_VIEWPORT

#define WANTS_ONPAINT_VIEWPORT   0x00002000

Receive callbacks during chart viewport painting.

Enables custom drawing in standard (non-GL) chart display.

Definition at line 137 of file ocpn_plugin.h.

WANTS_OPENGL_OVERLAY_CALLBACK

#define WANTS_OPENGL_OVERLAY_CALLBACK   0x00008000

Definition at line 141 of file ocpn_plugin.h.

WANTS_OVERLAY_CALLBACK

#define WANTS_OVERLAY_CALLBACK   0x00000001

Receive callbacks to render custom overlay graphics on the chart.

Used for drawing additional navigation data, markers, or custom visualizations.

Definition at line 86 of file ocpn_plugin.h.

WANTS_PLUGIN_MESSAGING

#define WANTS_PLUGIN_MESSAGING   0x00004000

Enable message passing between plugins.

Required for plugins that need to communicate with other plugins.

Definition at line 140 of file ocpn_plugin.h.

WANTS_PREFERENCES

#define WANTS_PREFERENCES   0x00000800

Plugin will add page(s) to global preferences dialog.

Allows plugin to integrate configuration UI with main preferences.

Definition at line 131 of file ocpn_plugin.h.

WANTS_PRESHUTDOWN_HOOK

#define WANTS_PRESHUTDOWN_HOOK   0x00400000

Receive notification just before OpenCPN shutdown.

Allows plugins to clean up resources and save state.

Definition at line 160 of file ocpn_plugin.h.

WANTS_TOOLBAR_CALLBACK

#define WANTS_TOOLBAR_CALLBACK   0x00000004

Receive notification when user left-clicks plugin's toolbar buttons.

Required for plugins that need to respond to their toolbar button actions. opencpn_plugin::OnToolbarToolCallback() will be called with the button ID when user left-clicks a toolbar button.

See also

opencpn_plugin::OnToolbarToolCallback

Definition at line 100 of file ocpn_plugin.h.

WANTS_VECTOR_CHART_OBJECT_INFO

#define WANTS_VECTOR_CHART_OBJECT_INFO   0x00100000

Receive information about vector chart objects.

Enables access to S57 chart feature data and attributes.

Definition at line 154 of file ocpn_plugin.h.

Typedef Documentation

_CommDriverResult

typedef enum CommDriverResult _CommDriverResult

Error return values

Result codes for communication driver operations.

These values indicate the result status of operations performed on communication drivers like sending messages or registering parameters.

Examples

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

_OptionsParentPI

typedef enum OptionsParentPI _OptionsParentPI

Enum defining parent pages in OpenCPN options dialog where plugins can add panels.

When adding plugin preference panels using AddOptionsPage(), the plugin must specify which main section should contain the new panel.

Examples

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

_PI_InitReturn

typedef enum PI_InitReturn _PI_InitReturn

Return values for plugin initialization.

These values are returned by opencpn_plugin::Init() to indicate the result of plugin initialization and guide OpenCPN's handling of initialization failures.

Examples

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

create_t

typedef opencpn_plugin * create_t(void *)

Definition at line 1602 of file ocpn_plugin.h.

destroy_t

typedef void destroy_t(opencpn_plugin *)

Definition at line 1603 of file ocpn_plugin.h.

DriverHandle

typedef std::string DriverHandle

Plugin API supporting direct access to comm drivers for output purposes.

Definition of OCPN DriverHandle

Examples

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

Definition at line 5595 of file ocpn_plugin.h.

OBJECT_LAYER_REQ

typedef enum _OBJECT_LAYER_REQ OBJECT_LAYER_REQ

Filter options for object queries.

Controls whether layer objects are included when querying routes, tracks and waypoints.

Examples

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

OCPN_DLCondition

typedef enum _OCPN_DLCondition OCPN_DLCondition

Event types for HTTP file download operations.

These values identify different stages of the download process when receiving download progress events.

Examples

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

OCPN_DLStatus

typedef enum _OCPN_DLStatus OCPN_DLStatus

Status codes for HTTP file download operations.

These values indicate the final result or current state of file download operations initiated through the plugin download API.

Examples

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

PI_DisCat

typedef enum _PI_DisCat PI_DisCat

Display categories for S52 chart features.

These categories control the visibility of chart features according to IHO S-52 presentation library specifications. Features can be assigned to different categories to allow selective display based on importance and use case.

The categories form a hierarchy:

• Display Base: Critical navigation features that must always be visible
• Standard: Additional features needed for basic safe navigation
• Other: Extra features for detailed navigation and reference
• Mariner's Standard: User-selected standard features
• Mariner's Other: Additional user-selected features

Examples

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

PI_DisPrio

typedef enum _PI_DisPrio PI_DisPrio

Display priority levels for S52 chart objects.

These values define the drawing order for different types of chart features according to IHO S-52 presentation library specifications. Higher priority objects are drawn on top of lower priority objects.

The priorities form a hierarchy from base fill patterns through to user navigation objects:

• Basic area fills (priority 0)
• Land/sea areas (priorities 1-3)
• Fixed/floating aids (priorities 4-6)
• Routes and navigation features (priorities 7-8)
• User data and vessel symbols (priority 9)

Examples

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

PI_LUPname

typedef enum _PI_LUPname PI_LUPname

Name identifiers for S57 lookup table sets.

These values represent the fifth letter in S52 lookup table names, defining which drawing rules to use for different chart feature types:

• Points (simplified or paper chart symbols)
• Lines
• Areas (plain or symbolized boundaries)

Examples

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

PI_NavMode

typedef enum _PI_NavMode PI_NavMode

Navigation mode options for chart display orientation.

These values define how the chart display is oriented relative to north, course, or heading. Different modes are useful for different navigation scenarios.

Examples

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

Enumeration Type Documentation

_OBJECT_LAYER_REQ

enum _OBJECT_LAYER_REQ

Filter options for object queries.

Controls whether layer objects are included when querying routes, tracks and waypoints.

Enumerator
OBJECTS_ALL	Return all objects including those in layers.
OBJECTS_NO_LAYERS	Exclude objects that are in layers.
OBJECTS_ONLY_LAYERS	Return only objects that are in layers.

Definition at line 5266 of file ocpn_plugin.h.

_OCPN_DLCondition

enum _OCPN_DLCondition

Event types for HTTP file download operations.

These values identify different stages of the download process when receiving download progress events.

Enumerator
OCPN_DL_EVENT_TYPE_UNKNOWN	Unknown event type.
OCPN_DL_EVENT_TYPE_START	Download is starting.
OCPN_DL_EVENT_TYPE_PROGRESS	Download progress update.
OCPN_DL_EVENT_TYPE_END	Download has completed.

Definition at line 4360 of file ocpn_plugin.h.

_OCPN_DLStatus

enum _OCPN_DLStatus

Status codes for HTTP file download operations.

These values indicate the final result or current state of file download operations initiated through the plugin download API.

Enumerator
OCPN_DL_UNKNOWN	Unknown or uninitialized status.
OCPN_DL_NO_ERROR	Download completed successfully.
OCPN_DL_FAILED	Download failed (general error)
OCPN_DL_ABORTED	Download was cancelled by user.
OCPN_DL_USER_TIMEOUT	Download timed out waiting for user action.
OCPN_DL_STARTED	Download has begun but not yet complete.

Definition at line 4345 of file ocpn_plugin.h.

_PI_DisCat

enum _PI_DisCat

Display categories for S52 chart features.

These categories control the visibility of chart features according to IHO S-52 presentation library specifications. Features can be assigned to different categories to allow selective display based on importance and use case.

The categories form a hierarchy:

• Display Base: Critical navigation features that must always be visible
• Standard: Additional features needed for basic safe navigation
• Other: Extra features for detailed navigation and reference
• Mariner's Standard: User-selected standard features
• Mariner's Other: Additional user-selected features

Enumerator
PI_DISPLAYBASE	Display Base - features that must always be shown.
PI_STANDARD	Standard - default features for safe navigation.
PI_OTHER	Other - additional features for detailed navigation.
PI_MARINERS_STANDARD	Mariner specified standard features.
PI_MARINERS_OTHER	Additional mariner specified features.
PI_DISP_CAT_NUM	Number of categories (for array sizing)

Definition at line 3497 of file ocpn_plugin.h.

_PI_DisPrio

enum _PI_DisPrio

Display priority levels for S52 chart objects.

These values define the drawing order for different types of chart features according to IHO S-52 presentation library specifications. Higher priority objects are drawn on top of lower priority objects.

The priorities form a hierarchy from base fill patterns through to user navigation objects:

• Basic area fills (priority 0)
• Land/sea areas (priorities 1-3)
• Fixed/floating aids (priorities 4-6)
• Routes and navigation features (priorities 7-8)
• User data and vessel symbols (priority 9)

Enumerator
PI_PRIO_NODATA	No data fill area pattern (lowest priority)
PI_PRIO_GROUP1	S57 group 1 filled areas (land, etc)
PI_PRIO_AREA_1	Superimposed areas.
PI_PRIO_AREA_2	Superimposed areas including water features.
PI_PRIO_SYMB_POINT	Point symbols including land features.
PI_PRIO_SYMB_LINE	Line symbols including restricted areas.
PI_PRIO_SYMB_AREA	Area symbols including traffic areas.
PI_PRIO_ROUTEING	Routeing lines (TSS, recommended tracks)
PI_PRIO_HAZARDS	Hazards, buoys, beacons.
PI_PRIO_MARINERS	VRM, EBL, own ship (highest priority)
PI_PRIO_NUM	Number of priority levels.

Definition at line 3521 of file ocpn_plugin.h.

_PI_LUPname

enum _PI_LUPname

Name identifiers for S57 lookup table sets.

These values represent the fifth letter in S52 lookup table names, defining which drawing rules to use for different chart feature types:

• Points (simplified or paper chart symbols)
• Lines
• Areas (plain or symbolized boundaries)

Enumerator
PI_SIMPLIFIED	Point objects using simplified symbols.
PI_PAPER_CHART	Point objects using traditional paper chart symbols.
PI_LINES	Line objects (e.g., depth contours, coastlines)
PI_PLAIN_BOUNDARIES	Area objects with simple boundaries.
PI_SYMBOLIZED_BOUNDARIES	Area objects with symbolized boundaries.
PI_LUPNAME_NUM	Total number of lookup table types.

Definition at line 3472 of file ocpn_plugin.h.

_PI_NavMode

enum _PI_NavMode

Navigation mode options for chart display orientation.

These values define how the chart display is oriented relative to north, course, or heading. Different modes are useful for different navigation scenarios.

Enumerator
PI_NORTH_UP_MODE	North Up Mode - True north is always at the top of the display. Most natural for general navigation and voyage planning. Static display orientation Easy chart reading and bearing plotting Traditional paper chart orientation
PI_COURSE_UP_MODE	Course Up Mode - Current course over ground at the top. Useful for route following and collision avoidance. Display rotates to match vessel course Forward direction always at top Helps visualize vessel's path
PI_HEAD_UP_MODE	Head Up Mode - Current vessel heading at the top. Best for close quarters maneuvering and docking. Display rotates to match vessel heading Shows view as seen from vessel Matches visual references

Definition at line 5713 of file ocpn_plugin.h.

ChartDepthUnitTypePI

enum ChartDepthUnitTypePI

Enumeration of depth unit types used in charts.

Enumerator
PI_DEPTH_UNIT_UNKNOWN	Depth unit is unknown or not specified.
PI_DEPTH_UNIT_FEET	Depths shown in feet.
PI_DEPTH_UNIT_METERS	Depths shown in meters.
PI_DEPTH_UNIT_FATHOMS	Depths shown in fathoms.

Definition at line 382 of file ocpn_plugin.h.

ChartFamilyEnumPI

enum ChartFamilyEnumPI

Enumeration of chart families (broad categories).

Enumerator
PI_CHART_FAMILY_UNKNOWN	Chart family is unknown.
PI_CHART_FAMILY_RASTER	Raster chart formats (KAP, GEO, etc.)
PI_CHART_FAMILY_VECTOR	Vector chart formats (S-57, CM93, etc.)
PI_CHART_FAMILY_DONTCARE	Chart family is not important for the operation.

Definition at line 372 of file ocpn_plugin.h.

ChartTypeEnumPI

enum ChartTypeEnumPI

Enumeration of chart types.

Enumerator
PI_CHART_TYPE_UNKNOWN	Chart type is unknown or undefined.
PI_CHART_TYPE_DUMMY	Dummy chart used when no actual chart is available.
PI_CHART_TYPE_DONTCARE	Chart type is not important for the operation.
PI_CHART_TYPE_KAP	BSB/KAP raster chart format.
PI_CHART_TYPE_GEO	GEO raster chart format.
PI_CHART_TYPE_S57	S-57 vector chart format.
PI_CHART_TYPE_CM93	CM93 vector chart format.
PI_CHART_TYPE_CM93COMP	CM93 Composite vector chart format.
PI_CHART_TYPE_PLUGIN	Chart type provided by a plugin.

Definition at line 357 of file ocpn_plugin.h.

CommDriverResult

enum CommDriverResult

Error return values

Result codes for communication driver operations.

These values indicate the result status of operations performed on communication drivers like sending messages or registering parameters.

Enumerator
RESULT_COMM_NO_ERROR	Operation completed successfully.
RESULT_COMM_INVALID_HANDLE	Invalid or unknown driver handle specified.
RESULT_COMM_INVALID_PARMS	Invalid parameters provided to operation.
RESULT_COMM_TX_ERROR	Error occurred during transmission.
RESULT_COMM_REGISTER_GATEWAY_ERROR	Failed to register with gateway device.
RESULT_COMM_REGISTER_PGN_ERROR	Failed to register PGN parameters.

Definition at line 5605 of file ocpn_plugin.h.

OCPN_DLDialogStyle

enum OCPN_DLDialogStyle

Enumerator
OCPN_DLDS_ELAPSED_TIME	The dialog shows the elapsed time.
OCPN_DLDS_ESTIMATED_TIME	The dialog shows the estimated total time.
OCPN_DLDS_REMAINING_TIME	The dialog shows the remaining time.
OCPN_DLDS_SPEED	The dialog shows the transfer speed.
OCPN_DLDS_SIZE	The dialog shows the size of the resource to download/upload.
OCPN_DLDS_URL	The dialog shows the URL involved in the transfer.
OCPN_DLDS_CONN_SETTINGS_AUTH	The dialog allows the user to change the authentication settings.
OCPN_DLDS_CONN_SETTINGS_PORT	The dialog allows the user to change the port for the transfer.
OCPN_DLDS_CONN_SETTINGS_PROXY	The dialog allows the user to change the proxy settings.
OCPN_DLDS_CAN_ABORT	The transfer can be aborted by the user.
OCPN_DLDS_CAN_START	The transfer won't start automatically. The user needs to start it.
OCPN_DLDS_CAN_PAUSE	The transfer can be paused.
OCPN_DLDS_AUTO_CLOSE	The dialog auto closes when transfer is complete.

Definition at line 4369 of file ocpn_plugin.h.

OcpnProjTypePI

enum OcpnProjTypePI

Enumeration of chart projection types.

Enumerator
PI_PROJECTION_UNKNOWN	Projection type is unknown or undefined.
PI_PROJECTION_MERCATOR	Mercator projection, standard for navigation charts.
PI_PROJECTION_TRANSVERSE_MERCATOR	Transverse Mercator projection, used for some coastal charts.
PI_PROJECTION_POLYCONIC	Polyconic projection, sometimes used for inland charts.
PI_PROJECTION_ORTHOGRAPHIC	Orthographic projection, showing Earth as viewed from space.
PI_PROJECTION_POLAR	Polar projection, used for polar regions.
PI_PROJECTION_STEREOGRAPHIC	Stereographic projection, used for polar and specialty charts.
PI_PROJECTION_GNOMONIC	Gnomonic projection, in which great circles appear as straight lines.
PI_PROJECTION_EQUIRECTANGULAR	Equirectangular/Plate Carrée projection, simple lat/lon grid.

Definition at line 392 of file ocpn_plugin.h.

OptionsParentPI

enum OptionsParentPI

Enum defining parent pages in OpenCPN options dialog where plugins can add panels.

When adding plugin preference panels using AddOptionsPage(), the plugin must specify which main section should contain the new panel.

Enumerator
PI_OPTIONS_PARENT_DISPLAY	Display settings section. For options affecting chart display, colors, etc.
PI_OPTIONS_PARENT_CONNECTIONS	Connections section. For options affecting data connections, ports, etc.
PI_OPTIONS_PARENT_CHARTS	Charts section. For options affecting chart loading, display, etc.
PI_OPTIONS_PARENT_SHIPS	Ships section. For options affecting vessel display, AIS, etc.
PI_OPTIONS_PARENT_UI	User Interface section. For options affecting toolbars, interface, etc.
PI_OPTIONS_PARENT_PLUGINS	Plugins section. For plugin-specific settings and configuration.

Definition at line 2633 of file ocpn_plugin.h.

PI_ColorScheme

enum PI_ColorScheme

Enumeration of color schemes.

Enumerator
PI_GLOBAL_COLOR_SCHEME_RGB	RGB color scheme, unmodified colors.
PI_GLOBAL_COLOR_SCHEME_DAY	Day color scheme, optimized for bright ambient light.
PI_GLOBAL_COLOR_SCHEME_DUSK	Dusk color scheme, optimized for low ambient light.
PI_GLOBAL_COLOR_SCHEME_NIGHT	Night color scheme, optimized for dark conditions with minimal impact on night vision.
PI_N_COLOR_SCHEMES	Number of color schemes, used for bounds checking.

Definition at line 178 of file ocpn_plugin.h.

PI_InitReturn

enum PI_InitReturn

Return values for plugin initialization.

These values are returned by opencpn_plugin::Init() to indicate the result of plugin initialization and guide OpenCPN's handling of initialization failures.

Enumerator
PI_INIT_OK	Initialization successful.
PI_INIT_FAIL_RETRY	Init failed, retry suggested.
PI_INIT_FAIL_REMOVE	Init failed, suggest remove from further use.
PI_INIT_FAIL_NOERROR	Init failed, request no explicit error message.

Definition at line 3542 of file ocpn_plugin.h.

plugin_ais_alarm_type

enum plugin_ais_alarm_type

Enumeration of AIS alarm states.

Enumerator
PI_AIS_NO_ALARM	No alarm condition exists.
PI_AIS_ALARM_SET	Alarm has been set but not acknowledged.
PI_AIS_ALARM_ACKNOWLEDGED	Alarm has been acknowledged by the user.

Definition at line 318 of file ocpn_plugin.h.

SDDMFORMAT

enum SDDMFORMAT

Coordinate format options for lat/lon display.

These values define the different formats available for displaying geographic coordinates in the UI.

Enumerator
DEGREES_DECIMAL_MINUTES	Format like "50° 12.345' N".
DECIMAL_DEGREES	Format like "50.12345° N".
DEGREES_MINUTES_SECONDS	Format like "50° 12' 34.5" N".
END_SDDMFORMATS	Number of available formats.

Definition at line 4917 of file ocpn_plugin.h.

Function Documentation

AddCanvasContextMenuItem()

DECL_EXP int AddCanvasContextMenuItem	(	wxMenuItem *	pitem,
		opencpn_plugin *	pplugin
	)

Adds item to chart canvas context menu.

This method adds a menu item to the right-click context menu.

Parameters

pitem	Menu item to add
pplugin	Pointer to plugin instance

Returns

Item ID for later reference

Definition at line 210 of file ocpn_plugin_gui.cpp.

AddCanvasMenuItem()

DECL_EXP int AddCanvasMenuItem	(	wxMenuItem *	pitem,
		opencpn_plugin *	pplugin,
		const char *	name = ""
	)

Adds item to canvas context menu.

Parameters

pitem	Menu item to add
pplugin	Pointer to plugin instance
name	Optional canvas name for multi-canvas configs

Returns

Menu item ID for later reference

Note

IDs should be stored to later remove/modify items

Empty name targets default/primary canvas

Definition at line 190 of file ocpn_plugin_gui.cpp.

AddChartDirectory()

DECL_EXP void AddChartDirectory ( wxString &  path )

extern

Adds a chart directory to OpenCPN's chart database.

Registers a new directory containing charts for OpenCPN to scan and include in its database.

Parameters

path	Full path to directory containing charts

Note

Directory is not scanned immediately

Call ForceChartDBUpdate() to scan new directory

Path should use platform-appropriate separators

Definition at line 1433 of file ocpn_plugin_gui.cpp.

AddChartToDBInPlace()

DECL_EXP int AddChartToDBInPlace	(	wxString &	full_path,
		bool	b_RefreshCanvas
	)

Adds a chart to the database without full rebuild.

Adds a single chart to OpenCPN's database and optionally refreshes display.

Parameters

full_path	Full path to chart file
b_RefreshCanvas	True to refresh display after adding

Returns

Database index of added chart, -1 if failed

Definition at line 482 of file ocpn_plugin_gui.cpp.

AddCustomWaypointIcon()

DECL_EXP bool AddCustomWaypointIcon ( wxBitmap *  pimage, wxString  key, wxString  description  )

extern

Adds a custom waypoint icon.

Registers a new custom waypoint icon for use in OpenCPN.

Parameters

pimage	Bitmap image for the icon
key	Unique identifier for the icon
description	User-friendly description

Returns

True if successfully added

Definition at line 812 of file ocpn_plugin_gui.cpp.

AddLocaleCatalog()

DECL_EXP bool AddLocaleCatalog

(

wxString

catalog

)

Adds a locale catalog for translations.

Adds a plugin's translation catalog to OpenCPN's locale system.

Parameters

catalog

Path to translation catalog file

Returns

True if catalog was loaded successfully

Definition at line 415 of file ocpn_plugin_gui.cpp.

AddOptionsPage()

DECL_EXP wxScrolledWindow * AddOptionsPage ( OptionsParentPI  parent, wxString  title  )

extern

Adds a new preferences page to OpenCPN options dialog.

Creates a new panel in the specified section of the options dialog. Plugin should populate the returned wxScrolledWindow with preference controls.

Parameters

parent	Parent section to add page to (see OptionsParentPI enum)
title	Title shown for the new page

Returns

Pointer to wxScrolledWindow to populate with controls, NULL if error

Note

Plugin must handle saving/loading settings when page closes

Use standard wxWidgets controls for consistent look

Definition at line 548 of file ocpn_plugin_gui.cpp.

AddPersistentFontKey()

DECL_EXP bool AddPersistentFontKey ( wxString  TextElement )

extern

Registers a new font configuration element.

Allows plugins to define custom UI elements needing font configuration, beyond the standard elements defined in OCPNGetFont().

Parameters

TextElement

New UI element identifier to register

Returns

True if element was registered, false if already exists

See also

OCPNGetFont()

Definition at line 327 of file ocpn_plugin_gui.cpp.

AddPlugInRoute()

DECL_EXP bool AddPlugInRoute ( PlugIn_Route *  proute, bool  b_permanent = true  )

extern

Adds a new route.

Creates a new route and adds it to OpenCPN's route management system.

Parameters

proute	Route to add
b_permanent	True to save persistently, false for temporary

Returns

True if successfully added

Definition at line 1132 of file ocpn_plugin_gui.cpp.

AddPlugInRouteEx()

DECL_EXP bool AddPlugInRouteEx ( PlugIn_Route_Ex *  proute, bool  b_permanent = true  )

extern

Adds a route with extended features.

Creates a new route supporting advanced properties like descriptions.

Parameters

proute	Extended route data to add
b_permanent	True to save persistently, false for temporary

Returns

True if successfully added

Definition at line 2097 of file ocpn_plugin_gui.cpp.

AddPlugInTrack()

DECL_EXP bool AddPlugInTrack ( PlugIn_Track *  ptrack, bool  b_permanent = true  )

extern

Adds a new track.

Creates a new track and adds it to OpenCPN's track manager.

Parameters

ptrack	Track to add
b_permanent	True to save persistently, false for temporary

Returns

True if successfully added

Definition at line 1218 of file ocpn_plugin_gui.cpp.

AddSingleWaypoint()

DECL_EXP bool AddSingleWaypoint ( PlugIn_Waypoint *  pwaypoint, bool  b_permanent = true  )

extern

Adds a single waypoint.

Creates a new waypoint and adds it to OpenCPN's waypoint management system.

Parameters

pwaypoint	Waypoint to add
b_permanent	True to save persistently, false for temporary

Returns

True if successfully added

Definition at line 840 of file ocpn_plugin_gui.cpp.

AddSingleWaypointEx()

DECL_EXP bool AddSingleWaypointEx ( PlugIn_Waypoint_Ex *  pwaypoint, bool  b_permanent = true  )

extern

Adds a waypoint with extended properties.

Creates a new waypoint supporting advanced features like range rings.

Parameters

pwaypoint	Extended waypoint data to add
b_permanent	True to save persistently, false for temporary

Returns

True if successfully added

Definition at line 1992 of file ocpn_plugin_gui.cpp.

CanvasJumpToPosition()

DECL_EXP void CanvasJumpToPosition	(	wxWindow *	canvas,
		double	lat,
		double	lon,
		double	scale
	)

Centers specified canvas on given position at given scale.

Parameters

canvas	Canvas window to adjust view for
lat	Target latitude in decimal degrees
lon	Target longitude in decimal degrees
scale	Display scale factor (larger = more zoomed in)

Definition at line 1642 of file ocpn_plugin_gui.cpp.

CheckEdgePan_PlugIn()

DECL_EXP bool CheckEdgePan_PlugIn ( int  x, int  y, bool  dragging, int  margin, int  delta  )

extern

Checks if chart should pan when cursor near edge.

Tests if automatic chart panning should occur based on cursor position.

Parameters

x	Cursor X coordinate
y	Cursor Y coordinate
dragging	True if mouse is being dragged
margin	Edge margin width in pixels
delta	Pan amount in pixels

Returns

True if panning should occur

Definition at line 1419 of file ocpn_plugin_gui.cpp.

CheckMUIEdgePan_PlugIn()

DECL_EXP bool CheckMUIEdgePan_PlugIn ( int  x, int  y, bool  dragging, int  margin, int  delta, int  canvasIndex  )

extern

Checks if chart should pan when cursor near edge.

Tests if automatic chart panning should occur based on cursor position for a specific canvas.

Parameters

x	Cursor X coordinate in canvas space
y	Cursor Y coordinate in canvas space
dragging	True if mouse is being dragged
margin	Edge margin width in pixels
delta	Pan amount in pixels
canvasIndex	Index of canvas to check

Returns

True if panning should occur

Definition at line 1684 of file ocpn_plugin_gui.cpp.

ConfigFlushAndReload()

DECL_EXP void ConfigFlushAndReload ( )

extern

Flush configuration changes to disk and reload settings.

Forces immediate saving of any pending configuration changes and reloads all settings.

Definition at line 2740 of file ocpn_plugin_gui.cpp.

DecodeSingleVDOMessage()

DECL_EXP bool DecodeSingleVDOMessage	(	const wxString &	str,
		PlugIn_Position_Fix_Ex *	pos,
		wxString *	acc
	)

Decodes a single VDO (Own Ship AIS) message.

Parses a VDO sentence and extracts position and accuracy information.

Parameters

str	The raw VDO sentence
pos	Will receive decoded position data
acc	Will receive accuracy information

Returns

True if successfully decoded

Definition at line 586 of file ocpn_plugin_gui.cpp.

DeleteOptionsPage()

DECL_EXP bool DeleteOptionsPage ( wxScrolledWindow *  page )

extern

Removes a previously added options page.

Parameters

page	Pointer to page previously returned by AddOptionsPage()

Returns

True if page was successfully removed

Definition at line 581 of file ocpn_plugin_gui.cpp.

DeletePlugInRoute()

DECL_EXP bool DeletePlugInRoute ( wxString &  GUID )

extern

Deletes a route.

Removes route identified by GUID from OpenCPN.

Parameters

GUID	Unique identifier of route to delete

Returns

True if successfully deleted

Definition at line 1189 of file ocpn_plugin_gui.cpp.

DeletePlugInTrack()

DECL_EXP bool DeletePlugInTrack ( wxString &  GUID )

extern

Deletes a track.

Removes track identified by GUID from OpenCPN.

Parameters

GUID	Unique identifier of track to delete

Returns

True if successfully deleted

Definition at line 1260 of file ocpn_plugin_gui.cpp.

DeleteSingleWaypoint()

DECL_EXP bool DeleteSingleWaypoint ( wxString &  GUID )

extern

Deletes a single waypoint.

Removes waypoint identified by GUID from OpenCPN.

Parameters

GUID	Unique identifier of waypoint to delete

Returns

True if successfully deleted

Definition at line 887 of file ocpn_plugin_gui.cpp.

DimeWindow()

DECL_EXP void DimeWindow

(

wxWindow *

win

)

Applies system color scheme to window.

Adjusts window colors to match OpenCPN's color scheme.

Parameters

window

Window to adjust colors for

Definition at line 408 of file ocpn_plugin_gui.cpp.

DistanceBearingMercator_Plugin()

DECL_EXP void DistanceBearingMercator_Plugin	(	double	lat0,
		double	lon0,
		double	lat1,
		double	lon1,
		double *	brg,
		double *	dist
	)

Calculates bearing and distance between two points.

Uses Mercator projection math.

Parameters

lat0	Start latitude in decimal degrees
lon0	Start longitude in decimal degrees
lat1	End latitude in decimal degrees
lon1	End longitude in decimal degrees
brg	Bearing in degrees true (output)
dist	Distance in nautical miles (output)

Definition at line 662 of file ocpn_plugin_gui.cpp.

DistGreatCircle_Plugin()

DECL_EXP double DistGreatCircle_Plugin	(	double	slat,
		double	slon,
		double	dlat,
		double	dlon
	)

Calculates great circle distance between two points.

Parameters

slat	Start latitude in decimal degrees
slon	Start longitude in decimal degrees
dlat	End latitude in decimal degrees
dlon	End longitude in decimal degrees

Returns

Distance in nautical miles

Definition at line 667 of file ocpn_plugin_gui.cpp.

EnableAisTargetDisplay()

DECL_EXP void EnableAisTargetDisplay ( bool  enable, int  CanvasIndex  )

extern

Controls AIS target display.

Parameters

enable	True to show AIS targets
CanvasIndex	Index of target canvas

Definition at line 2417 of file ocpn_plugin_gui.cpp.

EnableBuoyLightLabelsDisplay()

DECL_EXP void EnableBuoyLightLabelsDisplay ( bool  enable, int  CanvasIndex  )

extern

Controls buoy/light name label display.

Parameters

enable	True to show buoy/light names
CanvasIndex	Index of target canvas

Definition at line 2452 of file ocpn_plugin_gui.cpp.

EnableCanvasFocusBar()

DECL_EXP void EnableCanvasFocusBar ( bool  enable, int  CanvasIndex  )

extern

Controls visibility of canvas focus indicator.

Shows which canvas currently has input focus.

Parameters

enable	True to show focus indicator
CanvasIndex	Index of target canvas

Definition at line 2722 of file ocpn_plugin_gui.cpp.

EnableChartBar()

DECL_EXP void EnableChartBar ( bool  enable, int  CanvasIndex  )

extern

Controls visibility of chart info bar.

Parameters

enable	True to show chart bar
CanvasIndex	Index of target canvas

Definition at line 2347 of file ocpn_plugin_gui.cpp.

EnableChartOutlines()

DECL_EXP void EnableChartOutlines ( bool  enable, int  CanvasIndex  )

extern

Controls chart outline display.

Parameters

enable	True to show available chart boundaries
CanvasIndex	Index of target canvas

Definition at line 2403 of file ocpn_plugin_gui.cpp.

EnableCompassGPSIcon()

DECL_EXP void EnableCompassGPSIcon ( bool  enable, int  CanvasIndex  )

extern

Controls visibility of compass/GPS status icon.

Parameters

enable	True to show compass icon
CanvasIndex	Index of target canvas

Definition at line 2321 of file ocpn_plugin_gui.cpp.

EnableCurrentStationsDisplay()

DECL_EXP void EnableCurrentStationsDisplay ( bool  enable, int  CanvasIndex  )

extern

Controls current station icon display.

Parameters

enable	True to show current station markers
CanvasIndex	Index of target canvas

Definition at line 2431 of file ocpn_plugin_gui.cpp.

EnableDepthUnitDisplay()

DECL_EXP void EnableDepthUnitDisplay ( bool  enable, int  CanvasIndex  )

extern

Controls depth unit display.

Parameters

enable	True to show depth unit indicators
CanvasIndex	Index of target canvas

Definition at line 2410 of file ocpn_plugin_gui.cpp.

EnableENCDepthSoundingsDisplay()

DECL_EXP void EnableENCDepthSoundingsDisplay ( bool  enable, int  CanvasIndex  )

extern

Controls ENC depth sounding display.

Parameters

enable	True to show depth soundings
CanvasIndex	Index of target canvas

Definition at line 2445 of file ocpn_plugin_gui.cpp.

EnableENCTextDisplay()

DECL_EXP void EnableENCTextDisplay ( bool  enable, int  CanvasIndex  )

extern

Controls ENC text label display.

Parameters

enable	True to show ENC feature text labels
CanvasIndex	Index of target canvas

Definition at line 2438 of file ocpn_plugin_gui.cpp.

EnableLatLonGrid()

DECL_EXP void EnableLatLonGrid ( bool  enable, int  CanvasIndex  )

extern

Controls latitude/longitude grid display.

Parameters

enable	True to show lat/lon grid lines
CanvasIndex	Index of target canvas

Definition at line 2396 of file ocpn_plugin_gui.cpp.

EnableLightDescriptionsDisplay()

DECL_EXP void EnableLightDescriptionsDisplay ( bool  enable, int  CanvasIndex  )

extern

Controls light description text display.

Parameters

enable	True to show light descriptions
CanvasIndex	Index of target canvas

Definition at line 2466 of file ocpn_plugin_gui.cpp.

EnableLightsDisplay()

DECL_EXP void EnableLightsDisplay ( bool  enable, int  CanvasIndex  )

extern

Controls light icon display.

Parameters

enable	True to show light icons
CanvasIndex	Index of target canvas

Definition at line 2459 of file ocpn_plugin_gui.cpp.

EnableLookaheadMode()

DECL_EXP void EnableLookaheadMode ( bool  enable, int  CanvasIndex  )

extern

Enables/disables look-ahead mode for a canvas.

Look-ahead mode shifts chart view ahead of vessel position.

Parameters

enable	True to enable look-ahead
CanvasIndex	Index of target canvas

Definition at line 2617 of file ocpn_plugin_gui.cpp.

EnableMenu()

DECL_EXP void EnableMenu ( bool  enable )

extern

Shows/hides the main menu bar.

Parameters

enable

True to show menu bar, false to hide

Definition at line 2365 of file ocpn_plugin_gui.cpp.

EnableMUIBar()

DECL_EXP void EnableMUIBar ( bool  enable, int  CanvasIndex  )

extern

Controls visibility of MUI (Mobile/Touch User Interface) bar.

Parameters

enable	True to show MUI bar
CanvasIndex	Index of target canvas

Definition at line 2300 of file ocpn_plugin_gui.cpp.

EnableSplitScreenLayout()

DECL_EXP void EnableSplitScreenLayout ( bool  enable = true )

extern

Enable or disable the split-screen layout.

Controls whether OpenCPN uses multiple chart canvases in a split-screen configuration.

Parameters

enable

True to enable split-screen layout, false for single canvas mode.

Definition at line 2652 of file ocpn_plugin_gui.cpp.

EnableStatusBar()

DECL_EXP void EnableStatusBar ( bool  enable )

extern

Shows/hides the status bar.

Parameters

enable

True to show status bar, false to hide

Definition at line 2340 of file ocpn_plugin_gui.cpp.

EnableTenHertzUpdate()

DECL_EXP void EnableTenHertzUpdate ( bool  enable )

extern

Enable or disable 10 Hz update rate.

Controls the frequency of position updates and screen redraws.

Parameters

enable

True to enable 10 Hz updates, false for standard update rate.

Definition at line 2738 of file ocpn_plugin_gui.cpp.

EnableTideStationsDisplay()

DECL_EXP void EnableTideStationsDisplay ( bool  enable, int  CanvasIndex  )

extern

Controls tide station icon display.

Parameters

enable	True to show tide station markers
CanvasIndex	Index of target canvas

Definition at line 2424 of file ocpn_plugin_gui.cpp.

EnableTouchMode()

DECL_EXP void EnableTouchMode ( bool  enable )

extern

Enables/disables touch interface mode.

Parameters

enable

True to enable touch optimized interface

Definition at line 2613 of file ocpn_plugin_gui.cpp.

ExitOCPN()

DECL_EXP void ExitOCPN ( )

extern

Exits OpenCPN application.

Triggers a clean shutdown of OpenCPN.

Definition at line 2287 of file ocpn_plugin_gui.cpp.

FindOrCreateFont_PlugIn()

DECL_EXP wxFont * FindOrCreateFont_PlugIn ( int  point_size, wxFontFamily  family, wxFontStyle  style, wxFontWeight  weight, bool  underline = false, const wxString &  facename = wxEmptyString, wxFontEncoding  encoding = wxFONTENCODING_DEFAULT  )

extern

Creates or finds a font in the font cache.

Parameters

point_size	Font size in points
family	Font family (wxFONTFAMILY_SWISS etc)
style	Style flags (wxFONTSTYLE_NORMAL etc)
weight	Weight flags (wxFONTWEIGHT_NORMAL etc)
underline	True for underlined font
facename	Font face name, empty for default
encoding	Font encoding, wxFONTENCODING_DEFAULT for default

Returns

Pointer to cached wxFont, do not delete

Definition at line 1516 of file ocpn_plugin_gui.cpp.

FindSystemWaypointIcon()

DECL_EXP wxBitmap * FindSystemWaypointIcon ( wxString &  icon_name )

extern

Finds built-in system waypoint icon.

Retrieves standard waypoint icon bitmap by name from OpenCPN's icon set.

Parameters

icon_name

Name/identifier of icon to find

Returns

Pointer to wxBitmap of icon, NULL if not found

Examples

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

ForceChartDBRebuild()

DECL_EXP void ForceChartDBRebuild ( )

extern

Forces complete rebuild of chart database.

Triggers OpenCPN to do a full rebuild of its chart database by rescanning all configured chart directories from scratch.

Note

More thorough but slower than ForceChartDBUpdate()

Removes all existing chart entries first

Required after major chart organization changes

May take several minutes for large chart sets

Definition at line 1446 of file ocpn_plugin_gui.cpp.

ForceChartDBUpdate()

DECL_EXP void ForceChartDBUpdate ( )

extern

Forces an update of the chart database.

Triggers OpenCPN to scan configured chart directories for new or removed charts and update the database accordingly.

Note

More efficient than full rebuild

Only detects changes since last update

May take several seconds for large chart sets

Definition at line 1439 of file ocpn_plugin_gui.cpp.

fromDMM_Plugin()

DECL_EXP double fromDMM_Plugin ( wxString  sdms )

extern

Converts degrees/decimal minutes string to decimal degrees.

Parses position strings in DDMMss format like "4930.000N".

Parameters

sdms	Position string in degrees/decimal minutes format

Returns

Position in decimal degrees, or 0.0 if invalid format

Definition at line 1382 of file ocpn_plugin_gui.cpp.

fromSM_ECC_Plugin()

DECL_EXP void fromSM_ECC_Plugin	(	double	x,
		double	y,
		double	lat0,
		double	lon0,
		double *	lat,
		double *	lon
	)

Converts Elliptical Simple Mercator coordinates to geographic.

Parameters

x	Easting coordinate
y	Northing coordinate
lat0	Reference latitude
lon0	Central meridian
lat	Latitude in decimal degrees (output)
lon	Longitude in decimal degrees (output)

Definition at line 697 of file ocpn_plugin_gui.cpp.

fromSM_Plugin()

DECL_EXP void fromSM_Plugin	(	double	x,
		double	y,
		double	lat0,
		double	lon0,
		double *	lat,
		double *	lon
	)

Converts Simple Mercator coordinates to geographic.

Parameters

x	Easting coordinate
y	Northing coordinate
lat0	Reference latitude
lon0	Central meridian
lat	Latitude in decimal degrees (output)
lon	Longitude in decimal degrees (output)

Definition at line 687 of file ocpn_plugin_gui.cpp.

fromTM_Plugin()

DECL_EXP void fromTM_Plugin	(	double	x,
		double	y,
		double	lat0,
		double	lon0,
		double *	lat,
		double *	lon
	)

Converts Transverse Mercator coordinates to geographic.

Parameters

x	Easting coordinate
y	Northing coordinate
lat0	Reference latitude
lon0	Central meridian
lat	Latitude in decimal degrees (output)
lon	Longitude in decimal degrees (output)

Definition at line 677 of file ocpn_plugin_gui.cpp.

fromUsrDistance_Plugin()

DECL_EXP double fromUsrDistance_Plugin	(	double	usr_distance,
		int	unit = -1
	)

Converts from user's preferred distance unit to nautical miles.

Parameters

usr_distance	Distance value in user's unit
unit	Override unit choice (-1 for user preference): 0=nm, 1=km, 2=mi, 3=fathoms

Returns

Distance in nautical miles

Definition at line 706 of file ocpn_plugin_gui.cpp.

fromUsrSpeed_Plugin()

DECL_EXP double fromUsrSpeed_Plugin	(	double	usr_speed,
		int	unit = -1
	)

Converts from user's preferred speed unit to knots.

Parameters

usr_speed	Speed value in user's unit
unit	Override unit choice (-1 for user preference): 0=knots, 1=km/h, 2=mph, 3=m/s

Returns

Speed in knots

Definition at line 718 of file ocpn_plugin_gui.cpp.

fromUsrTemp_Plugin()

DECL_EXP double fromUsrTemp_Plugin	(	double	usr_temp,
		int	unit = -1
	)

Converts from user's preferred temperature unit to Celsius.

Parameters

usr_temp	Temperature in user's unit
unit	Override unit choice (-1 for user preference): 0=Celsius, 1=Fahrenheit

Returns

Temperature in Celsius

Definition at line 730 of file ocpn_plugin_gui.cpp.

GetActiveDrivers()

DECL_EXP std::vector< DriverHandle > GetActiveDrivers ( )

extern

Query OCPN core for a list of active drivers

Query OCPN core for a list of active drivers

Definition at line 131 of file plugin_api.cpp.

GetActiveOptionsDialog()

DECL_EXP wxDialog * GetActiveOptionsDialog ( )

extern

Gets pointer to active options dialog.

Returns

Pointer to active wxDialog, NULL if no dialog shown

Definition at line 1452 of file ocpn_plugin_gui.cpp.

GetActivePriorityIdentifiers()

DECL_EXP std::vector< std::string > GetActivePriorityIdentifiers ( )

extern

Gets list of active priority identifiers.

Returns list of currently active data source priority identifiers.

Returns

Vector of active priority identifiers

Definition at line 2244 of file ocpn_plugin_gui.cpp.

GetActiveRouteGUID()

DECL_EXP wxString GetActiveRouteGUID ( void  )

extern

Gets GUID of currently active route.

Returns

GUID string, empty if no active route

Definition at line 2226 of file ocpn_plugin_gui.cpp.

GetActiveRoutepointGPX()

DECL_EXP bool GetActiveRoutepointGPX	(	char *	buffer,
		unsigned int	buffer_length
	)

Gets GPX representation of active route waypoint.

Retrieves an XML/GPX format description of the currently active route waypoint. The buffer will contain a GPX formatted waypoint like:

<?xml version="1.0"?> <wpt lat="50.123456" lon="-4.123456"> <name>Waypoint Name</name> <sym>triangle</sym> <type>WPT</type> <time>2024-03-12T10:30:00Z</time> <extensions> <opencpn:guid>12345678-1234-1234-1234-123456789012</opencpn:guid> <opencpn:viz>1</opencpn:viz> <opencpn:viz_name>0</opencpn:viz_name> </extensions> </wpt>

Parameters

buffer	Pre-allocated char buffer to receive GPX data
buffer_length	Size of provided buffer in bytes

Returns

True if waypoint data was written to buffer, false if

• No active waypoint exists
• Buffer is too small
• Other error occurred

Note

Buffer must be pre-allocated and large enough for GPX data

Recommended minimum buffer size is 4096 bytes

XML is formatted with newlines and indentation for readability

Definition at line 648 of file ocpn_plugin_gui.cpp.

GetActiveStyleName()

DECL_EXP wxString GetActiveStyleName ( )

extern

Gets name of currently active style sheet.

Returns the name of the currently selected S52 presentation library style. Style sheets control the overall appearance of vector chart features.

Returns

Name of active style sheet

Note

Style sheets are user-selectable

Affects S52 vector chart display only

Definition at line 331 of file ocpn_plugin_gui.cpp.

GetActiveWaypointGUID()

DECL_EXP wxString GetActiveWaypointGUID ( void  )

extern

Gets GUID of currently active waypoint.

Returns

GUID string, empty if no active waypoint

Definition at line 2217 of file ocpn_plugin_gui.cpp.

GetAISTargetArray()

DECL_EXP ArrayOfPlugIn_AIS_Targets * GetAISTargetArray

(

void

)

Gets array of AIS targets.

Returns array of all currently tracked AIS targets.

Returns

Pointer to array of PlugIn_AIS_Target pointers

Note

Array contents owned by core - do not delete targets

Definition at line 370 of file ocpn_plugin_gui.cpp.

GetAppColorScheme()

DECL_EXP PI_ColorScheme GetAppColorScheme ( )

extern

Get the current application color scheme.

Returns

Current color scheme (DAY, DUSK, or NIGHT).

Definition at line 2644 of file ocpn_plugin_gui.cpp.

GetAttributes()

DECL_EXP const std::unordered_map< std::string, std::string > GetAttributes ( DriverHandle  handle )

extern

Query a specific driver for attributes.

Driver attributes are available from OCPN core as a hash map of tag->attribute pairs. There is a defined set of common tags guaranteed for every driver. Both tags and attributes are defined as std::string. Here is the list of common tag-attribute pairs.

Tag Attribute definition

---

"protocol" Comm bus device protocol, such as "NMEA0183", "NMEA2000"

Definition at line 142 of file plugin_api.cpp.

GetBaseGlobalColor()

wxColour DECL_EXP GetBaseGlobalColor

(

wxString

colorName

)

Gets a global system color.

Retrieves a base color value from OpenCPN's color management system.

Parameters

colorName

Name of the color to retrieve

Returns

wxColour containing the color value

Definition at line 4262 of file pluginmanager.cpp.

GetBitmapFromSVGFile()

DECL_EXP wxBitmap GetBitmapFromSVGFile ( wxString  filename, unsigned int  width, unsigned int  height  )

extern

Creates bitmap from SVG file.

Renders an SVG file to a bitmap at the specified dimensions. Useful for creating resolution-independent toolbar icons and other graphics.

Parameters

filename	Full path to SVG file
width	Desired bitmap width in pixels
height	Desired bitmap height in pixels

Returns

wxBitmap containing rendered SVG, invalid bitmap if error

Note

SVG is scaled to fit requested dimensions

Aspect ratio is preserved unless width/height force different ratio

Returns invalid bitmap if file not found or invalid SVG

Definition at line 338 of file ocpn_plugin_gui.cpp.

GetCanvasByIndex()

DECL_EXP wxWindow * GetCanvasByIndex ( int  canvasIndex )

extern

Gets chart canvas window by index.

Retrieves pointer to a specific canvas window by its index number in multi-canvas configurations.

Parameters

canvasIndex

Index of canvas to get (0-based)

Returns

Pointer to canvas window, NULL if invalid index

Note

Index 0 is always the main/primary canvas

Valid indices are 0 to GetCanvasCount()-1

Definition at line 1673 of file ocpn_plugin_gui.cpp.

GetCanvasCount()

DECL_EXP int GetCanvasCount ( )

extern

Gets total number of chart canvases.

Returns the number of active chart canvas windows.

Returns

Number of canvases (always >= 1)

Note

Minimum is 1 for main canvas

Maximum depends on available screen space

Definition at line 1709 of file ocpn_plugin_gui.cpp.

GetCanvasIndexUnderMouse()

DECL_EXP int GetCanvasIndexUnderMouse ( )

extern

Gets index of chart canvas under mouse cursor.

Returns the index of the canvas window that the mouse cursor is currently positioned over in multi-canvas configurations. Note that having the mouse over a canvas does not automatically give that canvas focus - it merely indicates mouse position.

Returns

Canvas index (0-based), -1 if mouse not over any canvas

Note

This returns mouse position only - does not affect canvas focus

See also

GetFocusCanvas() To determine which canvas has input focus

GetCanvasCount() To get total number of canvases

Definition at line 1652 of file ocpn_plugin_gui.cpp.

GetCanvasLLPix()

DECL_EXP void GetCanvasLLPix	(	PlugIn_ViewPort *	vp,
		wxPoint	p,
		double *	plat,
		double *	plon
	)

Converts canvas physical pixel coordinates to lat/lon.

Transforms screen physical pixels to geographic coordinates for the given viewport.

Parameters

vp	Current viewport
p	Physical pixel coordinates
plat	Will receive latitude in decimal degrees
plon	Will receive longitude in decimal degrees

Definition at line 280 of file ocpn_plugin_gui.cpp.

GetCanvasPixLL()

DECL_EXP void GetCanvasPixLL	(	PlugIn_ViewPort *	vp,
		wxPoint *	pp,
		double	lat,
		double	lon
	)

Converts lat/lon to canvas physical pixel coordinates.

Transforms geographic coordinates to screen physical pixels for the given viewport.

Parameters

vp	Current viewport
pp	Will receive physical pixel coordinates
lat	Latitude in decimal degrees
lon	Longitude in decimal degrees

Definition at line 247 of file ocpn_plugin_gui.cpp.

GetCanvasTilt()

DECL_EXP double GetCanvasTilt ( )

extern

Gets current canvas tilt angle.

Returns the tilt angle of the chart display canvas in degrees. Tilt provides a 3D perspective view of the chart.

Returns

Tilt angle in degrees (0-90) 0 = Normal top-down view 90 = Horizontal view

Definition at line 1388 of file ocpn_plugin_gui.cpp.

GetCanvasUnderMouse()

DECL_EXP wxWindow * GetCanvasUnderMouse ( )

extern

Gets canvas window under mouse cursor.

Returns

Pointer to canvas window, NULL if mouse not over any canvas

Definition at line 1650 of file ocpn_plugin_gui.cpp.

GetChartbarHeight()

DECL_EXP int GetChartbarHeight

(

void

)

Gets height of chart bar in pixels.

Returns

Height of chart bar widget

Definition at line 612 of file ocpn_plugin_gui.cpp.

GetChartDatabaseEntryXML()

DECL_EXP wxXmlDocument GetChartDatabaseEntryXML ( int  dbIndex, bool  b_getGeom  )

extern

Gets chart database entry as XML.

Retrieves XML representation of chart database entry.

Parameters

dbIndex	Index of chart in database
b_getGeom	True to include chart geometry info

Returns

wxXmlDocument containing chart data

Definition at line 454 of file ocpn_plugin_gui.cpp.

GetChartDBDirArrayString()

DECL_EXP wxArrayString GetChartDBDirArrayString ( )

extern

Gets chart database directory list.

Returns array of chart directories in database.

Returns

Array of directory paths as strings

Definition at line 478 of file ocpn_plugin_gui.cpp.

GetDoubleCanvasPixLL()

DECL_EXP void GetDoubleCanvasPixLL	(	PlugIn_ViewPort *	vp,
		wxPoint2DDouble *	pp,
		double	lat,
		double	lon
	)

Converts lat/lon to canvas pixels with double precision.

High-precision version of GetCanvasPixLL() for accurate positioning. Transforms geographic coordinates to canvas pixel coordinates.

Parameters

vp	Current viewport settings
pp	Will receive pixel coordinates as doubles
lat	Latitude in decimal degrees
lon	Longitude in decimal degrees

Definition at line 264 of file ocpn_plugin_gui.cpp.

GetEnableAisTargetDisplay()

DECL_EXP bool GetEnableAisTargetDisplay ( int  CanvasIndex )

extern

Gets AIS target display state.

Parameters

CanvasIndex

Index of canvas to query

Returns

True if AIS targets are visible

Definition at line 2549 of file ocpn_plugin_gui.cpp.

GetEnableBuoyLightLabelsDisplay()

DECL_EXP bool GetEnableBuoyLightLabelsDisplay ( int  CanvasIndex )

extern

Gets buoy/light label visibility.

Parameters

CanvasIndex

Index of canvas to query

Returns

True if buoy/light name labels are shown

Definition at line 2589 of file ocpn_plugin_gui.cpp.

GetEnableCanvasFocusBar()

DECL_EXP bool GetEnableCanvasFocusBar ( int  CanvasIndex )

extern

Gets focus indicator visibility state.

Parameters

CanvasIndex

Index of canvas to query

Returns

True if focus indicator is visible

Definition at line 2728 of file ocpn_plugin_gui.cpp.

GetEnableChartBar()

DECL_EXP bool GetEnableChartBar ( int  CanvasIndex )

extern

Gets chart bar visibility state.

Parameters

CanvasIndex

Index of canvas to query

Returns

True if chart bar is visible

Definition at line 2362 of file ocpn_plugin_gui.cpp.

GetEnableChartOutlines()

DECL_EXP bool GetEnableChartOutlines ( int  CanvasIndex )

extern

Gets chart outline visibility state.

Parameters

CanvasIndex

Index of canvas to query

Returns

True if chart boundaries are visible

Definition at line 2533 of file ocpn_plugin_gui.cpp.

GetEnableCompassGPSIcon()

DECL_EXP bool GetEnableCompassGPSIcon ( int  CanvasIndex )

extern

Gets compass icon visibility state.

Parameters

CanvasIndex

Index of canvas to query

Returns

True if compass icon is visible

Definition at line 2328 of file ocpn_plugin_gui.cpp.

GetEnableCurrentStationsDisplay()

DECL_EXP bool GetEnableCurrentStationsDisplay ( int  CanvasIndex )

extern

Gets current station icon visibility.

Parameters

CanvasIndex

Index of canvas to query

Returns

True if current station markers are shown

Definition at line 2565 of file ocpn_plugin_gui.cpp.

GetEnableDepthUnitDisplay()

DECL_EXP bool GetEnableDepthUnitDisplay ( int  CanvasIndex )

extern

Gets depth unit display state.

Parameters

CanvasIndex

Index of canvas to query

Returns

True if depth unit indicators are shown

Definition at line 2541 of file ocpn_plugin_gui.cpp.

GetEnableENCDepthSoundingsDisplay()

DECL_EXP bool GetEnableENCDepthSoundingsDisplay ( int  CanvasIndex )

extern

Gets ENC depth sounding visibility.

Parameters

CanvasIndex

Index of canvas to query

Returns

True if depth soundings are shown

Definition at line 2581 of file ocpn_plugin_gui.cpp.

GetEnableENCTextDisplay()

DECL_EXP bool GetEnableENCTextDisplay ( int  CanvasIndex )

extern

Gets ENC text label visibility.

Parameters

CanvasIndex

Index of canvas to query

Returns

True if ENC feature text labels are shown

Definition at line 2573 of file ocpn_plugin_gui.cpp.

GetEnableLatLonGrid()

DECL_EXP bool GetEnableLatLonGrid ( int  CanvasIndex )

extern

Gets latitude/longitude grid visibility state.

Parameters

CanvasIndex

Index of canvas to query

Returns

True if lat/lon grid lines are visible

Definition at line 2525 of file ocpn_plugin_gui.cpp.

GetEnableLightDescriptionsDisplay()

DECL_EXP bool GetEnableLightDescriptionsDisplay ( int  CanvasIndex )

extern

Gets light description text visibility.

Parameters

CanvasIndex

Index of canvas to query

Returns

True if light descriptions are shown

Examples

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

GetEnableLightsDisplay()

DECL_EXP bool GetEnableLightsDisplay ( int  CanvasIndex )

extern

Gets light icon visibility.

Parameters

CanvasIndex

Index of canvas to query

Returns

True if light icons are shown

Definition at line 2597 of file ocpn_plugin_gui.cpp.

GetEnableLookaheadMode()

DECL_EXP bool GetEnableLookaheadMode ( int  CanvasIndex )

extern

Gets look-ahead mode state for a canvas.

Parameters

CanvasIndex

Index of canvas to query

Returns

True if look-ahead mode enabled

Definition at line 2624 of file ocpn_plugin_gui.cpp.

GetEnableMainToolbar()

DECL_EXP bool GetEnableMainToolbar ( )

extern

Check if the main toolbar is enabled.

Returns

True if the main toolbar is currently visible, false otherwise.

Definition at line 2681 of file ocpn_plugin_gui.cpp.

GetEnableMenu()

DECL_EXP bool GetEnableMenu ( )

extern

Gets menu bar visibility state.

Returns

True if menu bar is enabled/visible

Definition at line 2381 of file ocpn_plugin_gui.cpp.

GetEnableMUIBar()

DECL_EXP bool GetEnableMUIBar ( int  CanvasIndex )

extern

Gets MUI bar visibility state.

Parameters

CanvasIndex

Index of canvas to query

Returns

True if MUI bar is visible

Definition at line 2319 of file ocpn_plugin_gui.cpp.

GetEnableStatusBar()

DECL_EXP bool GetEnableStatusBar ( )

extern

Gets status bar visibility state.

Returns

True if status bar is enabled/visible

Definition at line 2345 of file ocpn_plugin_gui.cpp.

GetEnableTenHertzUpdate()

DECL_EXP bool GetEnableTenHertzUpdate ( )

extern

Check if 10 Hz update rate is enabled.

When enabled, position updates and screen redraws occur at approximately 10 times per second.

Returns

True if 10 Hz update is enabled, false otherwise.

Definition at line 2736 of file ocpn_plugin_gui.cpp.

GetEnableTideStationsDisplay()

DECL_EXP bool GetEnableTideStationsDisplay ( int  CanvasIndex )

extern

Gets tide station icon visibility.

Parameters

CanvasIndex

Index of canvas to query

Returns

True if tide station markers are shown

Definition at line 2557 of file ocpn_plugin_gui.cpp.

GetENCDisplayCategory()

DECL_EXP PI_DisCat GetENCDisplayCategory ( int  CanvasIndex )

extern

Gets current ENC display category.

Parameters

CanvasIndex

Index of canvas to query

Returns

Current display category:

• PI_DISPLAYBASE: Base features only
• PI_STANDARD: Standard features
• PI_OTHER: All features etc.

Definition at line 2497 of file ocpn_plugin_gui.cpp.

GetEventNavdata()

DECL_EXP PluginNavdata GetEventNavdata ( ObservedEvt  ev )

extern

Return BasicNavDataMsg decoded data available in ev.

Definition at line 115 of file plugin_api.cpp.

GetFontColour_PlugIn()

DECL_EXP wxColour GetFontColour_PlugIn ( wxString  TextElement )

extern

Gets color configured for a UI text element.

Parameters

TextElement

UI element ID like "AISTargetAlert"

Returns

Color configured for element, defaults to system window text color

See also

OCPNGetFont() for supported TextElement values

Definition at line 362 of file ocpn_plugin_gui.cpp.

GetFrameAuiManager()

DECL_EXP wxAuiManager * GetFrameAuiManager

(

void

)

Gets main frame AUI manager.

Provides access to wxAuiManager controlling OpenCPN's main frame layout. Used by plugins that need to add/manage dockable windows.

Returns

Pointer to main frame wxAuiManager

Note

Only available if plugin declares USES_AUI_MANAGER capability

Definition at line 392 of file ocpn_plugin_gui.cpp.

GetFullScreen()

DECL_EXP bool GetFullScreen ( )

extern

Gets full screen state.

Returns

True if application is in full screen mode

Definition at line 2289 of file ocpn_plugin_gui.cpp.

GetGlobalColor()

DECL_EXP bool GetGlobalColor	(	wxString	colorName,
		wxColour *	pcolour
	)

Gets a global color value.

Retrieves color values from OpenCPN's color scheme system.

Parameters

colorName	Name of the color to retrieve
pcolour	Pointer to wxColour to receive the color value

Returns

True if color was found, false if not

Definition at line 296 of file ocpn_plugin_gui.cpp.

GetGlobalColorD()

DECL_EXP wxColor GetGlobalColorD ( std::string  map_name, std::string  name  )

extern

Gets a color from the global color scheme.

Parameters

map_name	Color scheme name ("DAY", "DUSK", "NIGHT")
name	Color identifier within scheme

Returns

Color value, or wxNullColour if not found

Definition at line 2387 of file ocpn_plugin_gui.cpp.

GetGlobalWatchdogTimoutSeconds()

DECL_EXP int GetGlobalWatchdogTimoutSeconds ( )

extern

Gets global watchdog timeout value.

Returns timeout in seconds used by system watchdog monitoring.

Returns

Timeout value in seconds

Gets global watchdog timeout value.

Definition at line 2236 of file ocpn_plugin_gui.cpp.

GetIcon_PlugIn()

DECL_EXP wxBitmap GetIcon_PlugIn ( const wxString &  name )

extern

Gets icon bitmap by name.

Retrieves standard OpenCPN toolbar icon bitmap by name.

Parameters

name	Name/identifier of icon to get

Returns

Bitmap containing the icon

Definition at line 1424 of file ocpn_plugin_gui.cpp.

GetIconNameArray()

DECL_EXP wxArrayString GetIconNameArray ( void  )

extern

Gets array of available waypoint icons.

Returns

Array of icon names that can be used for waypoints

Definition at line 1122 of file ocpn_plugin_gui.cpp.

GetLatLonFormat()

DECL_EXP int GetLatLonFormat ( void  )

extern

Gets currently selected latitude/longitude display format.

Returns the coordinate format currently configured in OpenCPN settings.

Returns

Format enum value (see SDDMFORMAT)

Definition at line 1715 of file ocpn_plugin_gui.cpp.

GetListener() [1/5]

DECL_EXP std::shared_ptr< ObservableListener > GetListener ( NavDataId  id, wxEventType  ev, wxEvtHandler *  handler  )

extern

Gets listener for navigation data updates.

Creates a listener to receive basic navigation data updates including position, course, speed etc.

Parameters

id	NavDataId identifying message type to listen for
ev	Event type to generate on updates
handler	Event handler to receive updates

Returns

Shared pointer to listener object

Definition at line 105 of file plugin_api.cpp.

GetListener() [2/5]

DECL_EXP std::shared_ptr< ObservableListener > GetListener ( NMEA0183Id  id, wxEventType  ev, wxEvtHandler *  handler  )

extern

Gets listener for NMEA 0183 messages.

Creates a listener to receive NMEA 0183 messages of a specific type.

Parameters

id	Sentence identifier to listen for
ev	Event type to generate on message receipt
handler	Event handler to receive messages

Returns

Shared pointer to listener object

Definition at line 95 of file plugin_api.cpp.

GetListener() [3/5]

DECL_EXP std::shared_ptr< ObservableListener > GetListener ( NMEA2000Id  id, wxEventType  ev, wxEvtHandler *  handler  )

extern

Gets listener for NMEA 2000 messages.

Creates a listener to receive NMEA 2000 messages of a specific type.

Parameters

id	PGN identifier for message type to listen for
ev	Event type to generate on message receipt
handler	Event handler to receive messages

Returns

Shared pointer to listener object

Definition at line 90 of file plugin_api.cpp.

GetListener() [4/5]

DECL_EXP std::shared_ptr< ObservableListener > GetListener ( PluginMsgId  id, wxEventType  ev, wxEvtHandler *  handler  )

extern

Return listener for plugin messages, internal or received on the REST interface.

Definition at line 110 of file plugin_api.cpp.

GetListener() [5/5]

DECL_EXP std::shared_ptr< ObservableListener > GetListener ( SignalkId  id, wxEventType  ev, wxEvtHandler *  handler  )

extern

Gets listener for Signal K updates.

Creates a listener to receive Signal K updates for a specific path.

Parameters

id	Signal K path to listen for
ev	Event type to generate on updates
handler	Event handler to receive updates

Returns

Shared pointer to listener object

Definition at line 100 of file plugin_api.cpp.

GetLocaleCanonicalName()

DECL_EXP wxString GetLocaleCanonicalName ( )

extern

Gets system locale canonical name.

Returns the canonical name of current system locale (e.g. "en_US"). Used for localization and translations.

Returns

wxString containing locale canonical name

Definition at line 428 of file ocpn_plugin_gui.cpp.

GetMasterToolbarRect()

DECL_EXP wxRect GetMasterToolbarRect ( )

extern

Gets bounding rectangle of master toolbar.

Returns the screen coordinates and size of OpenCPN's main toolbar. Useful for positioning plugin UI elements relative to the toolbar.

Returns

wxRect containing toolbar position and dimensions

Definition at line 1717 of file ocpn_plugin_gui.cpp.

GetN0183Payload()

DECL_EXP std::string GetN0183Payload ( NMEA0183Id  id, ObservedEvt  ev  )

extern

Return payload in a received n0183 message of type id in ev.

Definition at line 55 of file plugin_api.cpp.

GetN2000Payload()

DECL_EXP std::vector< uint8_t > GetN2000Payload ( NMEA2000Id  id, ObservedEvt  ev  )

extern

Return N2K payload for a received n2000 message of type id in ev.

The vector returned is described in the following example

 [147,19,                     // Header bytes, unused
  3,                          // N2K priority
  16,240,1,                   // example pgn 126992 encoded little endian
  255,                        // N2K destination address
  1,                          // N2K origin address
  255,255,255,255,            // timestamp, unused
  8,                          // count of following NMEA2000 data
  13,240,207,76,208,3,94,40,  // NMEA2000 data
  85                          // CRC byte, unused,not included in count
 ];

Definition at line 45 of file plugin_api.cpp.

GetN2000Source()

DECL_EXP std::string GetN2000Source ( NMEA2000Id  id, ObservedEvt  ev  )

extern

Return source identifier (iface) of a received n2000 message of type id in ev.

Definition at line 50 of file plugin_api.cpp.

GetNavigationMode()

DECL_EXP PI_NavMode GetNavigationMode ( int  CanvasIndex )

extern

Gets current navigation mode for a canvas.

Parameters

CanvasIndex

Index of canvas to query

Returns

Current navigation mode

Definition at line 2517 of file ocpn_plugin_gui.cpp.

GetNewGUID()

DECL_EXP wxString GetNewGUID ( )

extern

Generates a new globally unique identifier (GUID).

Creates a unique string identifier suitable for waypoints, routes, etc. Format is RFC 4122 compliant UUID string.

Returns

wxString containing new GUID

Note

Returns format like "6ba7b810-9dad-11d1-80b4-00c04fd430c8"

Thread-safe and collision resistant

Definition at line 810 of file ocpn_plugin_gui.cpp.

GetOCPN_ExePath()

DECL_EXP wxString GetOCPN_ExePath ( void  )

extern

Gets OpenCPN executable path.

Returns full path to OpenCPN executable file.

Returns

wxString containing executable path

Definition at line 4271 of file pluginmanager.cpp.

GetOCPNCanvasWindow()

DECL_EXP wxWindow * GetOCPNCanvasWindow

(

)

Gets OpenCPN's main canvas window.

Provides access to the main chart display window.

Returns

Pointer to main canvas window

Definition at line 234 of file ocpn_plugin_gui.cpp.

GetOCPNChartScaleFactor_Plugin()

DECL_EXP float GetOCPNChartScaleFactor_Plugin ( )

extern

Gets chart rendering scale factor.

Returns the scaling factor used for chart display. This may differ from the GUI scaling factor to optimize chart rendering and readability.

Returns

Chart display scaling multiplier:

• 1.0 = Native chart resolution
• 2.0 = Double resolution
• etc.

Note

Used for high DPI displays

Affects chart text, symbols and features

Definition at line 319 of file ocpn_plugin_gui.cpp.

GetOCPNConfigObject()

DECL_EXP wxFileConfig * GetOCPNConfigObject

(

void

)

Gets OpenCPN's configuration object.

Provides access to OpenCPN's wxFileConfig object for reading/writing settings.

Returns

Pointer to global config object

Note

Do not delete the returned pointer

Definition at line 226 of file ocpn_plugin_gui.cpp.

GetOCPNGUIScaledFont_PlugIn()

DECL_EXP wxFont GetOCPNGUIScaledFont_PlugIn ( wxString  item )

extern

Gets a uniquely scaled font copy for responsive UI elements.

Like GetOCPNScaledFont_PlugIn() but scales font size more aggressively based on OpenCPN's responsive/touchscreen mode settings. Used by GUI tools and windows that need larger fonts for touch usability. Always ensures minimum 3mm physical size regardless of configured point size.

Parameters

item	UI element name to get font for

Returns

Scaled wxFont object

See also

OCPNGetFont() for supported TextElement values

GetOCPNScaledFont_PlugIn()

Definition at line 323 of file ocpn_plugin_gui.cpp.

GetOCPNGUIToolScaleFactor_PlugIn() [1/2]

DECL_EXP double GetOCPNGUIToolScaleFactor_PlugIn ( )

extern

Gets current global GUI scaling factor.

Returns the display scaling factor currently in use for the OpenCPN GUI. Used to scale plugin UI elements to match core application.

Returns

Current GUI scaling multiplier:

• 1.0 = Normal/100% scaling
• 2.0 = Double size/200% scaling
• etc.

Note

Reflects user's selected GUI scale setting

Takes system DPI into account

Definition at line 315 of file ocpn_plugin_gui.cpp.

GetOCPNGUIToolScaleFactor_PlugIn() [2/2]

DECL_EXP double GetOCPNGUIToolScaleFactor_PlugIn ( int  GUIScaledFactor )

extern

Gets GUI scaling factor for a specific scaling level.

Returns the display scaling factor to use for GUI elements at a given scaling level. Used to scale toolbar icons and other UI elements.

Parameters

GUIScaledFactor

Base scaling factor level (typically 0-5)

Returns

Scaling multiplier to apply to base sizes:

• 1.0 = Normal/100% scaling
• 2.0 = Double size/200% scaling
• etc.

Note

Used for consistent UI scaling across platforms

Takes system DPI into account

Definition at line 311 of file ocpn_plugin_gui.cpp.

GetOCPNScaledFont_PlugIn()

DECL_EXP wxFont * GetOCPNScaledFont_PlugIn ( wxString  TextElement, int  default_size = 0  )

extern

Definition at line 307 of file ocpn_plugin_gui.cpp.

GetPluginDataDir()

DECL_EXP wxString GetPluginDataDir ( const char *  plugin_name )

extern

Return the plugin data directory for a given directory name.

On Linux, the returned data path is an existing directory ending in "opencpn/plugins/<plugin_name>" where the last part is the plugin_name argument. The prefix part is one of the directories listed in the environment variable XDG_DATA_DIRS, by default ~/.local/share:/usr/local/share:/usr/share.

On other platforms, the returned value is GetSharedDataDir() + "/opencpn/plugins/" + plugin_name (with native path separators) if that path exists.

Return "" if no existing directory is found.

Definition at line 269 of file base_platform.cpp.

GetPluginMsgPayload()

DECL_EXP std::string GetPluginMsgPayload ( PluginMsgId  id, ObservedEvt  ev  )

extern

Retrieve the string in a plugin message, internal or received on the REST insterface.

Definition at line 60 of file plugin_api.cpp.

GetPlugInPath()

DECL_EXP wxString GetPlugInPath ( opencpn_plugin *  pplugin )

extern

Gets the installation path for a specific plugin.

Returns the full directory path where the specified plugin is installed.

Parameters

pplugin

Pointer to plugin instance

Returns

wxString containing plugin's installation path

Definition at line 4279 of file pluginmanager.cpp.

GetpPlugInLocation()

DECL_EXP wxString * GetpPlugInLocation

(

)

Gets plugins directory location.

Returns path to directory containing installed plugins.

Returns

Pointer to wxString containing plugins path

Note

Do not delete the returned pointer

Definition at line 4273 of file pluginmanager.cpp.

GetpPrivateApplicationDataLocation()

DECL_EXP wxString * GetpPrivateApplicationDataLocation

(

)

Gets private application data directory.

Returns path to OpenCPN's private data directory for storing settings.

Returns

Pointer to wxString containing data path

Note

Do not delete the returned pointer

Path includes trailing separator

Definition at line 255 of file plugin_api.cpp.

GetPriorityMaps()

DECL_EXP std::vector< std::string > GetPriorityMaps ( )

extern

Gets list of configured priority mapping schemes.

Returns list of available data source priority mapping configurations.

Returns

Vector of priority map names

Gets list of configured priority mapping schemes.

Definition at line 2239 of file ocpn_plugin_gui.cpp.

GetpSharedDataLocation()

DECL_EXP wxString * GetpSharedDataLocation

(

)

Gets shared application data location.

Returns path to OpenCPN's shared data directory containing resources like:

• Chart catalog files
• S57 overlay files
• World map data

Returns

Pointer to wxString containing shared data path

Note

Do not delete the returned pointer

Path includes trailing separator

Definition at line 366 of file ocpn_plugin_gui.cpp.

GetRoute_Plugin()

DECL_EXP std::unique_ptr< PlugIn_Route > GetRoute_Plugin ( const wxString &  GUID )

extern

Gets route details by GUID.

Parameters

guid	GUID of route to get

Returns

Unique pointer to route data, NULL if not found

Definition at line 1575 of file ocpn_plugin_gui.cpp.

GetRouteEx_Plugin()

DECL_EXP std::unique_ptr< PlugIn_Route_Ex > GetRouteEx_Plugin ( const wxString &  GUID )

extern

Gets extended route by GUID.

Returns smart pointer to route with extended properties.

Parameters

guid	GUID of route to get

Returns

Unique pointer to route data, NULL if not found

Definition at line 2184 of file ocpn_plugin_gui.cpp.

GetRouteGUIDArray() [1/2]

DECL_EXP wxArrayString GetRouteGUIDArray ( OBJECT_LAYER_REQ  req )

extern

Gets array of route GUIDs with layer filtering.

Returns list of globally unique identifiers for routes, filtered by layer requirements.

Parameters

req	Filter option: OBJECTS_ALL: Return all routes regardless of layer membership OBJECTS_NO_LAYERS: Only return routes that are not in any layer OBJECTS_ONLY_LAYERS: Only return routes that are part of layers

Returns

Array of matching route GUID strings

Note

Layers are collections of navigation objects that can be toggled as a unit

Routes may exist independently or as part of one or more layers

Definition at line 1078 of file ocpn_plugin_gui.cpp.

GetRouteGUIDArray() [2/2]

DECL_EXP wxArrayString GetRouteGUIDArray ( void  )

extern

Gets array of route GUIDs.

Returns list of globally unique identifiers for all routes.

Returns

Array of route GUID strings

Definition at line 1029 of file ocpn_plugin_gui.cpp.

GetSelectedRouteGUID_Plugin()

DECL_EXP wxString GetSelectedRouteGUID_Plugin ( )

extern

Gets GUID of currently selected route.

Returns

GUID string, empty if no route selected

Definition at line 1553 of file ocpn_plugin_gui.cpp.

GetSelectedTrackGUID_Plugin()

DECL_EXP wxString GetSelectedTrackGUID_Plugin ( )

extern

Gets GUID of currently selected track.

Returns

GUID string, empty if no track selected

Definition at line 1561 of file ocpn_plugin_gui.cpp.

GetSelectedWaypointGUID_Plugin()

DECL_EXP wxString GetSelectedWaypointGUID_Plugin ( )

extern

Gets GUID of currently selected waypoint.

Returns

GUID string, empty if no waypoint selected

Definition at line 1545 of file ocpn_plugin_gui.cpp.

GetSignalkPayload()

DECL_EXP std::shared_ptr< void > GetSignalkPayload ( ObservedEvt  ev )

extern

Get SignalK status payload after receiving a message.

Returns

pointer to a wxJSONValue map object. Typical usage:

auto ptr = GetSignalkPayload(ev);
const auto msg = *std::static_pointer_cast<const wxJSONValue>(payload);

The map contains the following entries:

• "Data": the parsed json message
• "ErrorCount": int, the number of parsing errors
• "WarningCount": int, the number of parsing warnings
• "Errors": list of strings, error messages.
• "Warnings": list of strings, warning messages..
• "Context": string, message context
• "ContextSelf": string, own ship context.

Definition at line 65 of file plugin_api.cpp.

GetSingleWaypoint()

DECL_EXP bool GetSingleWaypoint ( wxString  GUID, PlugIn_Waypoint *  pwaypoint  )

extern

Gets waypoint data by GUID.

Retrieves details for a specific waypoint.

Parameters

GUID	Unique identifier of waypoint to get
pwaypoint	Pointer to receive waypoint data

Returns

True if waypoint was found and data copied

Definition at line 1003 of file ocpn_plugin_gui.cpp.

GetSingleWaypointEx()

DECL_EXP bool GetSingleWaypointEx ( wxString  GUID, PlugIn_Waypoint_Ex *  pwaypoint  )

extern

Gets extended waypoint data by GUID.

Retrieves full waypoint details including extended properties.

Parameters

GUID	Unique identifier of waypoint to get
pwaypoint	Pointer to receive waypoint data

Returns

True if waypoint found and data copied

Definition at line 1981 of file ocpn_plugin_gui.cpp.

GetTouchMode()

DECL_EXP bool GetTouchMode ( )

extern

Gets touch interface mode state.

Returns

True if touch interface is enabled

Definition at line 2615 of file ocpn_plugin_gui.cpp.

GetTrack_Plugin()

DECL_EXP std::unique_ptr< PlugIn_Track > GetTrack_Plugin ( const wxString &  GUID )

extern

Gets track details by GUID.

Parameters

guid	GUID of track to get

Returns

Unique pointer to track data, NULL if not found

Definition at line 1605 of file ocpn_plugin_gui.cpp.

GetTrackGUIDArray() [1/2]

DECL_EXP wxArrayString GetTrackGUIDArray ( OBJECT_LAYER_REQ  req )

extern

Gets array of track GUIDs with layer filtering.

Returns list of globally unique identifiers for tracks, filtered by layer requirements.

Parameters

req	Filter option: OBJECTS_ALL: Return all tracks regardless of layer membership OBJECTS_NO_LAYERS: Only return tracks that are not in any layer OBJECTS_ONLY_LAYERS: Only return tracks that are part of layers

Returns

Array of matching track GUID strings

Note

Tracks are recorded vessel paths that may be organized into layers

Layer membership affects track visibility and management

Definition at line 1103 of file ocpn_plugin_gui.cpp.

GetTrackGUIDArray() [2/2]

DECL_EXP wxArrayString GetTrackGUIDArray ( void  )

extern

Gets array of track GUIDs.

Returns list of globally unique identifiers for all tracks.

Returns

Array of track GUID strings

Definition at line 1044 of file ocpn_plugin_gui.cpp.

GetTrackingMode()

DECL_EXP bool GetTrackingMode ( )

extern

Get the current tracking mode status.

Returns

True if tracking mode is enabled, false otherwise.

Definition at line 2639 of file ocpn_plugin_gui.cpp.

getUsrDistanceUnit_Plugin()

DECL_EXP wxString getUsrDistanceUnit_Plugin ( int  unit = -1 )

extern

Gets display string for user's preferred distance unit.

Parameters

unit	Override unit choice (-1 for user preference): 0=nm, 1=km, 2=mi, 3=fathoms

Returns

Localized unit string (e.g. "nm", "km", "mi", "fathoms")

Definition at line 734 of file ocpn_plugin_gui.cpp.

getUsrSpeedUnit_Plugin()

DECL_EXP wxString getUsrSpeedUnit_Plugin ( int  unit = -1 )

extern

Gets display string for user's preferred speed unit.

Parameters

unit	Override unit choice (-1 for user preference): 0=knots, 1=km/h, 2=mph, 3=m/s

Returns

Localized unit string (e.g. "kts", "km/h", "mph", "m/s")

Definition at line 738 of file ocpn_plugin_gui.cpp.

getUsrTempUnit_Plugin()

DECL_EXP wxString getUsrTempUnit_Plugin ( int  unit = -1 )

extern

Gets display string for user's preferred temperature unit.

Parameters

unit	Override unit choice (-1 for user preference): 0=Celsius, 1=Fahrenheit

Returns

Localized unit string ("°C" or "°F")

Definition at line 744 of file ocpn_plugin_gui.cpp.

GetWaypoint_Plugin()

DECL_EXP std::unique_ptr< PlugIn_Waypoint > GetWaypoint_Plugin ( const wxString &  GUID )

extern

Gets waypoint details by GUID.

Parameters

guid	GUID of waypoint to get

Returns

Unique pointer to waypoint data, NULL if not found

Definition at line 1569 of file ocpn_plugin_gui.cpp.

GetWaypointEx_Plugin()

DECL_EXP std::unique_ptr< PlugIn_Waypoint_Ex > GetWaypointEx_Plugin ( const wxString &  GUID )

extern

Gets extended waypoint by GUID.

Returns smart pointer to waypoint with extended properties.

Parameters

guid	GUID of waypoint to get

Returns

Unique pointer to waypoint data, NULL if not found

Definition at line 2178 of file ocpn_plugin_gui.cpp.

GetWaypointGUIDArray() [1/2]

DECL_EXP wxArrayString GetWaypointGUIDArray ( OBJECT_LAYER_REQ  req )

extern

Gets array of waypoint/track GUIDs with layer filtering.

Returns list of globally unique identifiers for waypoints, filtered by layer requirements.

Parameters

req	Filter option: OBJECTS_ALL: Return all waypoints regardless of layer membership OBJECTS_NO_LAYERS: Only return waypoints that are not in any layer OBJECTS_ONLY_LAYERS: Only return waypoints that are part of layers

Returns

Array of matching waypoint GUID strings

Note

Independent waypoints and route waypoints may belong to layers

Layer filtering allows selective processing of waypoint subsets

See also

GetRouteGUIDArray()

GetTrackGUIDArray()

Definition at line 1053 of file ocpn_plugin_gui.cpp.

GetWaypointGUIDArray() [2/2]

DECL_EXP wxArrayString GetWaypointGUIDArray ( void  )

extern

Gets array of all waypoint/marks GUIDs.

Can be used in conjunction with GetSingleWaypoint() or GetSingleWaypointEx to retrieve waypoint/mark details by GUID.

Returns

Array of waypoint/mark unique identifiers

See also

GetSingleWaypoint()

GetSingleWaypointEx()

Definition at line 1014 of file ocpn_plugin_gui.cpp.

GetWritableDocumentsDir()

DECL_EXP wxString GetWritableDocumentsDir ( void  )

extern

Returns the platform-specific default documents directory.

Returns

Path to writeable documents directory

Definition at line 4275 of file pluginmanager.cpp.

InsertPlugInTool()

DECL_EXP int InsertPlugInTool	(	wxString	label,
		wxBitmap *	bitmap,
		wxBitmap *	bmpRollover,
		wxItemKind	kind,
		wxString	shortHelp,
		wxString	longHelp,
		wxObject *	clientData,
		int	position,
		int	tool_sel,
		opencpn_plugin *	pplugin
	)

Adds a tool to OpenCPN's toolbar.

This method creates and adds a new tool button to OpenCPN's main toolbar.

Parameters

label	Tool identifier and internal name
bitmap	Normal state bitmap
bmpRollover	Bitmap shown on mouseover (optional)
kind	Tool type (normal, toggle, radio button etc)
shortHelp	Tooltip text
longHelp	Detailed help text
clientData	Optional user data pointer
position	Position in toolbar (-1 for end)
tool_sel	Tool selection mode
pplugin	Pointer to plugin instance

Returns

Tool ID for later reference, -1 if failed

Note

Tool IDs are managed internally and should be stored for later use

Position parameter allows inserting tools at specific locations

Definition at line 140 of file ocpn_plugin_gui.cpp.

InsertPlugInToolSVG()

DECL_EXP int InsertPlugInToolSVG	(	wxString	label,
		wxString	SVGfile,
		wxString	SVGfileRollover,
		wxString	SVGfileToggled,
		wxItemKind	kind,
		wxString	shortHelp,
		wxString	longHelp,
		wxObject *	clientData,
		int	position,
		int	tool_sel,
		opencpn_plugin *	pplugin
	)

Adds a tool using SVG graphics.

Like InsertPlugInTool but using SVG files for scalable graphics.

Parameters

label	Tool identifier and internal name
SVGfile	Normal state SVG file path
SVGfileRollover	Rollover state SVG file path
SVGfileToggled	Toggled state SVG file path
kind	Tool type (normal, toggle etc)
shortHelp	Tooltip text
longHelp	Detailed help text
clientData	Optional user data
position	Position in toolbar (-1 for end)
tool_sel	Tool selection mode
pplugin	Pointer to plugin instance

Returns

Tool ID or -1 if failed

Definition at line 168 of file ocpn_plugin_gui.cpp.

IsTouchInterface_PlugIn()

DECL_EXP bool IsTouchInterface_PlugIn ( void  )

extern

Checks if touch interface mode is enabled.

Returns whether OpenCPN is currently operating in touch-optimized mode. Touch mode affects UI element sizes and interaction behaviors.

Returns

True if touch mode enabled, false if standard mouse/keyboard mode

Note

Touch mode can be toggled by user preference

Affects toolbar, dialog and control sizes

May affect gesture recognition

Definition at line 360 of file ocpn_plugin_gui.cpp.

JumpToPosition()

DECL_EXP void JumpToPosition	(	double	lat,
		double	lon,
		double	scale
	)

Centers chart display on specified position at given scale.

Parameters

lat	Latitude in decimal degrees
lon	Longitude in decimal degrees
scale	Display scale factor

Definition at line 410 of file ocpn_plugin_gui.cpp.

LaunchDefaultBrowser_Plugin()

bool LaunchDefaultBrowser_Plugin

(

wxString

url

)

Definition at line 1536 of file ocpn_plugin_gui.cpp.

OCPN_cancelDownloadFileBackground()

DECL_EXP void OCPN_cancelDownloadFileBackground ( long  handle )

extern

Cancels a background download.

Parameters

handle

Download handle from OCPN_downloadFileBackground()

Definition at line 5410 of file pluginmanager.cpp.

OCPN_downloadFile()

DECL_EXP _OCPN_DLStatus OCPN_downloadFile ( const wxString &  url, const wxString &  outputFile, const wxString &  title, const wxString &  message, const wxBitmap &  bitmap, wxWindow *  parent, long  style, int  timeout_secs  )

extern

Synchronously downloads a file with progress dialog.

Downloads a file from a URL while showing a progress dialog. This function blocks until the download completes or fails.

Parameters

url	URL to download from
outputFile	Local file path to save to
title	Progress dialog title
message	Progress dialog message
bitmap	Optional bitmap to show in dialog
parent	Parent window for dialog
style	Dialog style flags (see OCPN_DLDialogStyle)
timeout_secs	Timeout in seconds (0 for no timeout)

Returns

Download status:

• OCPN_DL_NO_ERROR: Success
• OCPN_DL_FAILED: Download failed
• OCPN_DL_ABORTED: User cancelled
• OCPN_DL_USER_TIMEOUT: Timeout expired

Definition at line 5173 of file pluginmanager.cpp.

OCPN_downloadFileBackground()

DECL_EXP _OCPN_DLStatus OCPN_downloadFileBackground ( const wxString &  url, const wxString &  outputFile, wxEvtHandler *  handler, long *  handle  )

extern

Asynchronously downloads a file in the background.

Initiates a background download that does not block. Progress and completion are reported via events sent to the provided handler.

Parameters

url	URL to download from
outputFile	Local file path to save to
handler	Event handler to receive download events
handle	Will receive handle to track download

Returns

Initial status:

• OCPN_DL_STARTED: Download started
• OCPN_DL_FAILED: Failed to start download

Note

Handler will receive OCPN_downloadEvent events

Use handle with OCPN_cancelDownloadFileBackground()

Definition at line 5315 of file pluginmanager.cpp.

OCPN_GetDisplayContentScaleFactor()

DECL_EXP double OCPN_GetDisplayContentScaleFactor ( )

extern

Gets content scaling factor for current display.

Returns the display scaling factor used for scaling UI content on high DPI displays. Common on GTK3 and Mac Retina displays.

Returns

Display content scale factor: 1.0 = Standard/100% scaling 2.0 = 200% scaling/Retina etc.

Note

Used for proper scaling on high DPI displays

Different from WinDIPScaleFactor()

Definition at line 2264 of file ocpn_plugin_gui.cpp.

OCPN_GetWinDIPScaleFactor()

DECL_EXP double OCPN_GetWinDIPScaleFactor ( )

extern

Gets Windows-specific DPI scaling factor.

Returns Windows DPI scaling factor configured in display settings.

Returns

Windows DPI scale factor: 1.0 = 96 DPI (100%) 1.25 = 120 DPI (125%) 1.5 = 144 DPI (150%) etc.

Note

Windows-specific scaling mechanism

Used in conjunction with ContentScaleFactor

Definition at line 2272 of file ocpn_plugin_gui.cpp.

OCPN_isOnline()

DECL_EXP bool OCPN_isOnline ( )

extern

Checks internet connectivity.

Returns

True if internet appears to be available

Definition at line 5459 of file pluginmanager.cpp.

OCPN_postDataHttp()

DECL_EXP _OCPN_DLStatus OCPN_postDataHttp ( const wxString &  url, const wxString &  parameters, wxString &  result, int  timeout_secs  )

extern

Performs HTTP POST request.

Makes a blocking HTTP POST request and returns the response.

Parameters

url	URL to post to
parameters	POST parameters/data
result	Will receive response body
timeout_secs	Timeout in seconds

Returns

Status code (see OCPN_DLStatus)

Definition at line 5430 of file pluginmanager.cpp.

OCPNGetFont()

DECL_EXP wxFont * OCPNGetFont	(	wxString	TextElement,
		int	default_size = 0
	)

Gets a font for UI elements.

Plugins can use this to access OpenCPN's font management system which supports locale-dependent fonts and colors. Font configurations are cached and shared to minimize memory usage.

Parameters

TextElement

UI element identifier. Supported values: "AISTargetAlert": AIS alert messages "AISTargetQuery": AIS information dialogs "StatusBar": Main status bar text "AIS Target Name": Labels for AIS targets "ObjectQuery": Chart object information text "RouteLegInfoRollover": Route information hover windows "ExtendedTideIcon": Text on extended tide icons "CurrentValue": Current measurement values "Console Legend": Console text labels (e.g. "XTE", "BRG") "Console Value": Console numeric values "AISRollover": AIS target rollover text "TideCurrentGraphRollover": Tide and current graph hover text "Marks": Waypoint label text "ChartTexts": Text rendered directly on charts "ToolTips": Tooltip text "Dialog": Dialog box and control panel text "Menu": Menu item text "GridText": Grid annotation text

default_size

Font size in points, 0 to use system default size

Returns

Pointer to configured wxFont, do not delete it

Note

Each UI element can have different fonts per locale to support language-specific fonts. Color is also managed - use OCPNGetFontColor() to get the configured color.

The "console" in OpenCPN displays key navigation data such as Cross Track Error (XTE), Bearing (BRG), Velocity Made Good (VMG), Range (RNG), and Time to Go (TTG). By default, the text is large and green, optimized for visibility.

Definition at line 303 of file ocpn_plugin_gui.cpp.

OCPNMessageBox_PlugIn()

int DECL_EXP OCPNMessageBox_PlugIn	(	wxWindow *	parent,
		const wxString &	message,
		const wxString &	caption = _T("Message"),
		int	style = wxOK,
		int	x = -1,
		int	y = -1
	)

Shows a message box dialog.

Displays a platform-native message dialog with specified text and buttons.

Parameters

parent	Parent window
message	Message text to display
caption	Dialog title text
style	Button/icon style flags (wxOK, wxCANCEL, etc)
x	Optional X position (-1 for default)
y	Optional Y position (-1 for default)

Returns

ID of button pressed

Definition at line 4266 of file pluginmanager.cpp.

PI_GetObjectDisplayCategory()

PI_DisCat DECL_EXP PI_GetObjectDisplayCategory

(

PI_S57Obj *

pObj

)

Gets display category for object.

Parameters

pObj	Object to get category for

Returns

Display category enum value

Definition at line 4654 of file pluginmanager.cpp.

PI_GetObjectDisplayPriority()

PI_DisPrio DECL_EXP PI_GetObjectDisplayPriority

(

PI_S57Obj *

pObj

)

Gets display priority for object.

Parameters

pObj	Object to get priority for

Returns

Display priority enum value

Definition at line 4644 of file pluginmanager.cpp.

PI_GetObjectLUPName()

PI_LUPname DECL_EXP PI_GetObjectLUPName

(

PI_S57Obj *

pObj

)

Gets Look-Up Table (LUP) name for object.

The LUP in the S-52 standard defines how chart features should be symbolized and displayed.

See also

PI_LUPname

Parameters

pObj	Object to get LUP name for

Returns

LUP name enum value

Definition at line 4635 of file pluginmanager.cpp.

PI_GetObjectRenderBox()

bool DECL_EXP PI_GetObjectRenderBox	(	PI_S57Obj *	pObj,
		double *	lat_min,
		double *	lat_max,
		double *	lon_min,
		double *	lon_max
	)

Gets geographic bounding box of S57 object.

Parameters

pObj	S57 object to get bounds for
lat_min	Min latitude output
lat_max	Max latitude output
lon_min	Min longitude output
lon_max	Max longitude output

Returns

True if bounds were calculated

Definition at line 4622 of file pluginmanager.cpp.

PI_GetPLIBBoundaryStyle()

int DECL_EXP PI_GetPLIBBoundaryStyle

(

)

Gets configured S52 boundary style.

Returns

Integer boundary style: 0 = Plain boundaries 1 = Symbolized boundaries

Definition at line 4358 of file pluginmanager.cpp.

PI_GetPLIBColorScheme()

wxString DECL_EXP PI_GetPLIBColorScheme

(

)

Gets current color scheme used by S52 PLIB.

Returns

Color scheme name ("DAY", "DUSK", or "NIGHT")

Definition at line 4340 of file pluginmanager.cpp.

PI_GetPLIBDepthUnitInt()

int DECL_EXP PI_GetPLIBDepthUnitInt

(

)

Gets configured depth unit for S52 display.

Returns

Integer depth unit code: 0 = Meters 1 = Feet 2 = Fathoms

Definition at line 4344 of file pluginmanager.cpp.

PI_GetPLIBMarinerSafetyContour()

double DECL_EXP PI_GetPLIBMarinerSafetyContour

(

)

Gets configured safety contour depth.

Returns

Safety contour depth in configured units

Definition at line 4662 of file pluginmanager.cpp.

PI_GetPLIBStateHash()

int DECL_EXP PI_GetPLIBStateHash

(

)

Gets hash value representing current PLIB state.

Used to detect configuration changes.

Returns

Integer hash of PLIB settings

Definition at line 4398 of file pluginmanager.cpp.

PI_GetPLIBSymbolStyle()

int DECL_EXP PI_GetPLIBSymbolStyle

(

)

Gets configured S52 symbol style.

Returns

Integer symbol style: 0 = Simplified symbols 1 = Traditional paper chart symbols

Definition at line 4351 of file pluginmanager.cpp.

PI_PLIBFreeContext()

void DECL_EXP PI_PLIBFreeContext

(

void *

pContext

)

Frees S52 PLIB context.

Parameters

pContext

Context pointer to free

Definition at line 4705 of file pluginmanager.cpp.

PI_PLIBObjectRenderCheck()

bool DECL_EXP PI_PLIBObjectRenderCheck	(	PI_S57Obj *	pObj,
		PlugIn_ViewPort *	vp
	)

Checks if object should be rendered.

Parameters

pObj	Object to check
vp	Current viewport

Returns

True if object should be rendered

Definition at line 4365 of file pluginmanager.cpp.

PI_PLIBPrepareForNewRender()

void DECL_EXP PI_PLIBPrepareForNewRender

(

void

)

Prepares PLIB for new rendering pass.

Clears internal caches and states.

Definition at line 4691 of file pluginmanager.cpp.

PI_PLIBRenderAreaToDC()

int DECL_EXP PI_PLIBRenderAreaToDC	(	wxDC *	pdc,
		PI_S57Obj *	pObj,
		PlugIn_ViewPort *	vp,
		wxRect	rect,
		unsigned char *	pixbuf
	)

Renders an S57 area object using standard device context.

Specialized rendering for area features like depth areas, land areas etc. Supports pixel buffer output for optimized drawing.

Parameters

pdc	Device context to draw into
pObj	S57 area object to render
vp	Current viewport parameters
rect	Rectangle defining render area
pixbuf	Optional pixel buffer for cached rendering

Returns

Status code (0 = success)

Note

For area patterns and fills

Context must be set with PLIBSetContext() first

Definition at line 4780 of file pluginmanager.cpp.

PI_PLIBRenderAreaToGL()

int DECL_EXP PI_PLIBRenderAreaToGL	(	const wxGLContext &	glcc,
		PI_S57Obj *	pObj,
		PlugIn_ViewPort *	vp,
		wxRect &	render_rect
	)

Renders an S57 area object using OpenGL.

OpenGL-optimized rendering for area features with hardware acceleration.

Parameters

glcc	OpenGL context for rendering
pObj	S57 area object to render
vp	Current viewport parameters
render_rect	Rectangle defining render bounds

Returns

Status code (0 = success)

Note

For hardware-accelerated area rendering

Context must be set with PLIBSetContext() first

Definition at line 4863 of file pluginmanager.cpp.

PI_PLIBRenderObjectToDC()

int DECL_EXP PI_PLIBRenderObjectToDC	(	wxDC *	pdc,
		PI_S57Obj *	pObj,
		PlugIn_ViewPort *	vp
	)

Renders an S57 object using standard device context.

Draws a chart object using S52 presentation library rules through a standard wxDC device context.

Parameters

pdc	Device context to draw into
pObj	S57 object to render
vp	Current viewport parameters

Returns

Status code (0 = success)

Note

For non-OpenGL rendering

Context must be set with PLIBSetContext() first

Definition at line 4738 of file pluginmanager.cpp.

PI_PLIBRenderObjectToGL()

int DECL_EXP PI_PLIBRenderObjectToGL	(	const wxGLContext &	glcc,
		PI_S57Obj *	pObj,
		PlugIn_ViewPort *	vp,
		wxRect &	render_rect
	)

Renders any S57 object using OpenGL.

Generic OpenGL rendering for any chart object type with hardware acceleration.

Parameters

glcc	OpenGL context for rendering
pObj	S57 object to render
vp	Current viewport parameters
render_rect	Rectangle defining render bounds

Returns

Status code (0 = success)

Note

For hardware-accelerated rendering

Context must be set with PLIBSetContext() first

Handles points, lines, areas and text

Definition at line 4940 of file pluginmanager.cpp.

PI_PLIBSetContext()

bool DECL_EXP PI_PLIBSetContext

(

PI_S57Obj *

pObj

)

Sets S52 PLIB rendering context for an object.

Prepares the S52 presentation library context for rendering a chart object. Must be called before rendering to ensure proper symbolization.

Parameters

pObj	S57 object to set context for

Returns

True if context was set successfully

Definition at line 4514 of file pluginmanager.cpp.

PI_PLIBSetLineFeaturePriority()

void DECL_EXP PI_PLIBSetLineFeaturePriority	(	PI_S57Obj *	pObj,
		int	prio
	)

Sets rendering priority for line feature.

Parameters

pObj	Line object to set priority for
prio	New priority value

Definition at line 4666 of file pluginmanager.cpp.

PI_PLIBSetRenderCaps()

void DECL_EXP PI_PLIBSetRenderCaps

(

unsigned int

flags

)

Sets rendering capability flags.

Parameters

flags

Bitwise combination of PLIB_CAPS flags: PLIB_CAPS_LINE_VBO PLIB_CAPS_LINE_BUFFER PLIB_CAPS_SINGLEGEO_BUFFER etc.

Definition at line 4703 of file pluginmanager.cpp.

PI_UpdateContext()

void DECL_EXP PI_UpdateContext

(

PI_S57Obj *

pObj

)

Updates rendering context for S57 object.

Parameters

pObj	Object to update context for

Definition at line 4581 of file pluginmanager.cpp.

PlatformDirSelectorDialog()

DECL_EXP int PlatformDirSelectorDialog ( wxWindow *  parent, wxString *  file_spec, wxString  Title, wxString  initDir  )

extern

Shows platform-optimized directory selector dialog.

Displays a platform-native directory selection dialog that is optimized for each operating system's conventions and capabilities.

Parameters

parent	Parent window for the dialog
file_spec	Will receive selected directory path
Title	Dialog title text
initDir	Initial directory to show

Returns

Dialog result:

• wxID_OK if directory selected
• wxID_CANCEL if dialog cancelled

Note

Uses native file pickers on Windows/Mac

Falls back to wxWidgets dialog on other platforms

Selected path uses platform-appropriate separators

Definition at line 1454 of file ocpn_plugin_gui.cpp.

PlatformFileSelectorDialog()

DECL_EXP int PlatformFileSelectorDialog ( wxWindow *  parent, wxString *  file_spec, wxString  Title, wxString  initDir, wxString  suggestedName, wxString  wildcard  )

extern

Shows platform-optimized file selector dialog.

Displays a platform-native file selection dialog that is optimized for each operating system's conventions and capabilities.

Parameters

parent	Parent window for the dialog
file_spec	Will receive selected file path
Title	Dialog title text
initDir	Initial directory to show
suggestedName	Suggested filename
wildcard	File type filter (e.g. "*.txt")

Returns

Dialog result:

• wxID_OK if file selected
• wxID_CANCEL if dialog cancelled

Note

Uses native file pickers on Windows/Mac

Falls back to wxWidgets dialog on other platforms

Selected path uses platform-appropriate separators

Wildcard format varies by platform

Definition at line 1459 of file ocpn_plugin_gui.cpp.

PlugIn_GSHHS_CrossesLand()

DECL_EXP bool PlugIn_GSHHS_CrossesLand	(	double	lat1,
		double	lon1,
		double	lat2,
		double	lon2
	)

Checks if a great circle route crosses land.

Tests if a direct path between two points intersects with land using GSHHS (Global Self-consistent Hierarchical High-resolution Shorelines) data.

Parameters

lat1	Start latitude in decimal degrees
lon1	Start longitude in decimal degrees
lat2	End latitude in decimal degrees
lon2	End longitude in decimal degrees

Returns

True if route crosses land, false if water only

Definition at line 746 of file ocpn_plugin_gui.cpp.

PlugInAISDrawGL()

DECL_EXP void PlugInAISDrawGL ( wxGLCanvas *  glcanvas, const PlugIn_ViewPort &  vp  )

extern

Renders AIS targets on a secondary OpenGL canvas.

This function allows plugins to render AIS targets on additional OpenGL canvases beyond the main chart display. This is useful for creating auxiliary navigation views that need to show vessel traffic.

Parameters

glcanvas	The OpenGL canvas to draw on
vp	Current viewport settings for the canvas

Note

Canvas must have valid OpenGL context

Uses same AIS target database as main display

Respects global AIS display settings

Draws using same symbology as main display

Definition at line 1497 of file ocpn_plugin_gui.cpp.

PluginCenterOwnship()

DECL_EXP void PluginCenterOwnship ( int  CanvasIndex )

extern

Center the chart view on the own ship position for a specific canvas.

Parameters

CanvasIndex

Index of the target canvas (0 for the first canvas).

Definition at line 2691 of file ocpn_plugin_gui.cpp.

PlugInGetDisplaySizeMM()

DECL_EXP double PlugInGetDisplaySizeMM ( )

extern

Gets physical display size in millimeters.

Returns the physical display dimensions to allow proper scaling of navigation elements like range rings, which need to maintain true physical size regardless of screen resolution.

Returns

Display size in millimeters

Note

Returns the primary display size on multi-monitor systems

Used for physical size calculations like range rings

Some systems may return nominal rather than actual size

Value is independent of screen resolution/DPI

Definition at line 1514 of file ocpn_plugin_gui.cpp.

PluginGetFocusCanvas()

DECL_EXP wxWindow * PluginGetFocusCanvas ( )

extern

Gets the currently focused chart canvas.

Returns the chart canvas window that currently has input focus in multi-canvas configurations. A canvas gains focus when:

• User clicks within the canvas area
• User uses keyboard shortcuts to switch canvas focus
• Canvas is explicitly given focus programmatically

Focus determines which canvas:

• Receives keyboard input events
• Is the target for navigation commands
• Shows active canvas indicators
• Gets tool/menu actions by default

Returns

Pointer to focused canvas window, NULL if none focused

See also

GetCanvasIndexUnderMouse() To find canvas under mouse cursor

GetCanvasCount() To get total number of canvases

GetCanvasByIndex() To get canvas by index number

Definition at line 1634 of file ocpn_plugin_gui.cpp.

PluginGetFollowMode()

DECL_EXP bool PluginGetFollowMode ( int  CanvasIndex )

extern

Get the current follow mode status for a specific canvas.

Parameters

CanvasIndex

Index of the target canvas (0 for the first canvas).

Returns

True if follow mode is enabled, false otherwise.

Definition at line 2714 of file ocpn_plugin_gui.cpp.

PlugInGetMaxAvailableGshhgQuality()

DECL_EXP int PlugInGetMaxAvailableGshhgQuality ( )

extern

Gets maximum available GSHHS coastline data quality.

Returns the highest quality level of GSHHS data installed.

Returns

Integer quality level (0-4, see PlugInGetMinAvailableGshhgQuality())

Note

Used to determine best available coastline detail

Higher qualities provide more detailed shorelines

Higher qualities require more storage and memory

Examples

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

PlugInGetMinAvailableGshhgQuality()

DECL_EXP int PlugInGetMinAvailableGshhgQuality ( )

extern

Gets minimum available GSHHS coastline data quality.

Returns the lowest quality level of GSHHS (Global Self-consistent, Hierarchical, High-resolution Shoreline) data installed. GSHHS data comes in different resolutions/qualities for different zoom levels.

Returns

Integer quality level: 0 = Crude quality (lowest) 1 = Low quality 2 = Intermediate quality 3 = High quality 4 = Full quality (highest)

Note

Used to determine available coastline detail levels

Lower qualities use less memory but show less detail

Quality selection affects chart drawing performance

Examples

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

PluginGetOverlayRenderCanvas()

DECL_EXP wxWindow * PluginGetOverlayRenderCanvas ( )

extern

Gets the canvas currently designated for overlay rendering.

Returns the chart canvas window that should receive plugin overlay graphics in multi-canvas configurations.

Returns

Pointer to overlay target canvas, NULL if none available

Definition at line 1636 of file ocpn_plugin_gui.cpp.

PlugInHandleAutopilotRoute()

DECL_EXP void PlugInHandleAutopilotRoute ( bool  enable )

extern

Controls autopilot route handling.

Enables or disables sending of active route information to autopilot. When enabled, OpenCPN will send route waypoints and other navigation data to connected autopilot devices.

Parameters

enable

True to enable autopilot route updates, false to disable

Note

Requires compatible autopilot interface

Only affects routes, not tracks or individual waypoints

Route must be activated for updates to be sent

Definition at line 1532 of file ocpn_plugin_gui.cpp.

PlugInHasNormalizedViewPort()

DECL_EXP bool PlugInHasNormalizedViewPort ( PlugIn_ViewPort *  vp )

extern

Checks if viewport has been normalized.

Tests whether the viewport parameters have been adjusted to a normalized form suitable for OpenGL rendering.

Parameters

vp	Viewport to check

Returns

True if viewport is normalized, false if not

Definition at line 1293 of file ocpn_plugin_gui.cpp.

PlugInMultMatrixViewport()

DECL_EXP void PlugInMultMatrixViewport ( PlugIn_ViewPort *  vp, float  lat = 0, float  lon = 0  )

extern

Applies viewport transformation matrix.

Applies rotation, scaling and translation to viewport based on reference point. Used with OpenGL display lists for efficient rendering.

Parameters

vp	Viewport to transform
lat	Optional reference latitude (default 0)
lon	Optional reference longitude (default 0)

Note

Pairs with PlugInNormalizeViewport()

Used for OpenGL display list optimization

Reference point affects translation component

Definition at line 1304 of file ocpn_plugin_gui.cpp.

PlugInNormalizeViewport()

DECL_EXP void PlugInNormalizeViewport ( PlugIn_ViewPort *  vp, float  lat = 0, float  lon = 0  )

extern

Normalizes viewport parameters.

Adjusts viewport parameters to a normalized form for consistent OpenGL rendering. The normalized form simplifies transformations and coordinates.

Parameters

vp	Viewport to normalize
lat	Optional reference latitude (default 0)
lon	Optional reference longitude (default 0)

Note

Pairs with PlugInMultMatrixViewport()

Reference point affects normalization origin

Required for proper OpenGL display list usage

Definition at line 1321 of file ocpn_plugin_gui.cpp.

PlugInPlaySound()

DECL_EXP void PlugInPlaySound ( wxString &  sound_file )

extern

Plays a sound file asynchronously.

Parameters

sound_file

Path to audio file to play

Note

Supported formats depend on sound backend

Definition at line 762 of file ocpn_plugin_gui.cpp.

PlugInPlaySoundEx()

DECL_EXP bool PlugInPlaySoundEx ( wxString &  sound_file, int  deviceIndex = -1  )

extern

Start playing a sound file asynchronously.

Supported formats depends on sound backend. The deviceIx is only used on platforms using the portaudio sound backend where -1 indicates the default device.

Definition at line 1402 of file ocpn_plugin_gui.cpp.

PluginSetFollowMode()

DECL_EXP void PluginSetFollowMode ( int  CanvasIndex, bool  enable_follow  )

extern

Set follow mode for a specific canvas.

When follow mode is enabled, the chart will automatically move with the vessel position.

Parameters

CanvasIndex	Index of the target canvas (0 for the first canvas).
enable_follow	True to enable follow mode, false to disable.

Definition at line 2705 of file ocpn_plugin_gui.cpp.

PlugInSetFontColor()

DECL_EXP bool PlugInSetFontColor ( const wxString  TextElement, const wxColour  color  )

extern

Sets text color for a UI element.

Parameters

TextElement	UI element ID. See OCPNGetFont()
color	New text color to use

Returns

True if element found and color was set, false if not found

Note

Changes are held in memory only and not persisted to config

See also

OCPNGetFont()

Definition at line 1506 of file ocpn_plugin_gui.cpp.

PluginZoomCanvas()

DECL_EXP void PluginZoomCanvas ( int  CanvasIndex, double  factor  )

extern

Zoom a specific chart canvas by the given factor.

Values greater than 1.0 zoom in, values less than 1.0 zoom out.

Parameters

CanvasIndex	Index of the target canvas (0 for the first canvas).
factor	Zoom factor to apply.

Definition at line 2674 of file ocpn_plugin_gui.cpp.

PositionBearingDistanceMercator_Plugin()

DECL_EXP void PositionBearingDistanceMercator_Plugin	(	double	lat,
		double	lon,
		double	brg,
		double	dist,
		double *	dlat,
		double *	dlon
	)

Calculates destination point given start point, bearing and distance.

Uses Mercator projection math.

Parameters

lat	Start latitude in decimal degrees
lon	Start longitude in decimal degrees
brg	Bearing in degrees true
dist	Distance in nautical miles
dlat	Destination latitude (output)
dlon	Destination longitude (output)

Definition at line 656 of file ocpn_plugin_gui.cpp.

PushNMEABuffer()

DECL_EXP void PushNMEABuffer

(

wxString

str

)

Pushes NMEA sentence to the system.

Adds an NMEA sentence to OpenCPN's data stream as if received from device.

Parameters

str	Complete NMEA sentence including checksum

Definition at line 431 of file ocpn_plugin_gui.cpp.

RegisterTXPGNs()

DECL_EXP CommDriverResult RegisterTXPGNs ( DriverHandle  handle, std::vector< int > &  pgn_list  )

extern

Register PGNs that this application intends to transmit for some NMEA 2000 adapters like Actisense NGT-1.

This function is required specifically for NMEA 2000 adapters like the Actisense NGT-1. For these devices, registration of transmit PGNs is required before sending any messages. This is an adapter-specific requirement, not a requirement of the NMEA 2000 standard itself.

This function is only implemented for serial NMEA 2000 adapters (specifically the Actisense NGT-1). For other connection types (TCP, UDP), the function will return success and perform no registration.

Parameters

handle	The driver handle obtained from GetActiveDrivers()
pgn_list	List of PGNs this application will transmit

Returns

RESULT_COMM_NO_ERROR if registration successful RESULT_COMM_INVALID_PARMS if pgn_list is empty RESULT_COMM_INVALID_HANDLE if handle is invalid RESULT_COMM_REGISTER_PGN_ERROR if PGN registration failed

Example usage:

// Register to transmit wind data and rudder commands
std::vector<int> pgns = {130306,  // Wind Data
                        127245};  // Rudder
auto result = RegisterTXPGNs(driver_handle, pgns);
if (result != RESULT_COMM_NO_ERROR) {
    // Handle error
}

Note

For Actisense NGT-1 adapters, this registration must be done before transmitting any NMEA 2000 messages. The registration remains in effect until the application closes or explicitly registers a new list. Before any device can transmit messages on an NMEA 2000 network, it must first announce which message types (PGNs) it will transmit. This allows other devices on the network to:

• Know what data is available.
• Request specific data from the transmitting device.
• Properly handle network address claims.

Definition at line 222 of file plugin_api.cpp.

RemoveCanvasContextMenuItem()

DECL_EXP void RemoveCanvasContextMenuItem

(

int

item

)

Removes a context menu item completely.

Unlike SetCanvasContextMenuItemViz(), this permanently removes the menu item.

Parameters

item	Menu item ID returned from AddCanvasContextMenuItem()

Definition at line 223 of file ocpn_plugin_gui.cpp.

RemoveCanvasMenuItem()

DECL_EXP void RemoveCanvasMenuItem	(	int	item,
		const char *	name = ""
	)

Removes a context menu item completely.

Unlike SetCanvasMenuItemViz(), this permanently removes the menu item.

Parameters

item	Menu item ID returned from AddCanvasMenuItem()
name	Optional canvas name for multi-canvas configs (empty for default)

Definition at line 206 of file ocpn_plugin_gui.cpp.

RemoveChartFromDBInPlace()

DECL_EXP int RemoveChartFromDBInPlace

(

wxString &

full_path

)

Removes a chart from database without full rebuild.

Parameters

full_path

Full path to chart file to remove

Returns

0 if successful, -1 if failed

Definition at line 517 of file ocpn_plugin_gui.cpp.

RemovePlugInTool()

DECL_EXP void RemovePlugInTool

(

int

tool_id

)

Removes a tool from OpenCPN's toolbar.

This method removes a previously added plugin tool from the toolbar.

Parameters

tool_id

Tool ID returned by InsertPlugInTool()

Definition at line 152 of file ocpn_plugin_gui.cpp.

RequestRefresh()

DECL_EXP void RequestRefresh

(

wxWindow *

win

)

Requests window refresh.

Triggers a redraw of the specified window.

Parameters

window

Window to refresh

Definition at line 243 of file ocpn_plugin_gui.cpp.

RequestWindowRefresh()

DECL_EXP void RequestWindowRefresh	(	wxWindow *	win,
		bool	eraseBackground
	)

Requests window refresh.

Triggers a redraw of the specified window.

Parameters

win	Window to refresh
eraseBackground	True to erase background before redraw

Definition at line 2648 of file ocpn_plugin_gui.cpp.

SendPluginMessage()

DECL_EXP void SendPluginMessage	(	wxString	message_id,
		wxString	message_body
	)

Sends message to other plugins.

Broadcasts a message that other plugins can receive.

Parameters

message_id	Message identifier
message_body	Message content

Definition at line 394 of file ocpn_plugin_gui.cpp.

SetAppColorScheme()

DECL_EXP void SetAppColorScheme ( PI_ColorScheme  cs )

extern

Set the application color scheme.

Changes the color scheme for the entire application including charts, UI elements, and plugin displays.

Parameters

cs	The color scheme to apply (DAY, DUSK, or NIGHT).

Definition at line 2641 of file ocpn_plugin_gui.cpp.

SetCanvasContextMenuItemGrey()

DECL_EXP void SetCanvasContextMenuItemGrey	(	int	item,
		bool	grey
	)

Sets menu item enabled/disabled state.

Greys out (disables) or enables a context menu item.

Parameters

item	Menu item ID to modify
grey	True to disable (grey out), false to enable

Definition at line 219 of file ocpn_plugin_gui.cpp.

SetCanvasContextMenuItemViz()

DECL_EXP void SetCanvasContextMenuItemViz	(	int	item,
		bool	viz
	)

Temporarily changes context menu item visibility.

Hides or shows a context menu item without removing it.

Parameters

item	Menu item ID to modify
viz	True to show item, false to hide

Definition at line 215 of file ocpn_plugin_gui.cpp.

SetCanvasMenuItemGrey()

DECL_EXP void SetCanvasMenuItemGrey	(	int	item,
		bool	grey,
		const char *	name = ""
	)

Sets menu item enabled/disabled state.

Greys out (disables) or enables a context menu item.

Parameters

item	Menu item ID to modify
grey	True to disable (grey out), false to enable
name	Optional canvas name (empty for default)

Definition at line 202 of file ocpn_plugin_gui.cpp.

SetCanvasMenuItemViz()

DECL_EXP void SetCanvasMenuItemViz	(	int	item,
		bool	viz,
		const char *	name = ""
	)

Temporarily changes context menu item visibility.

Hides or shows a context menu item without removing it.

Parameters

item	Menu item ID to modify
viz	True to show item, false to hide
name	Optional canvas name (empty for default)

Definition at line 198 of file ocpn_plugin_gui.cpp.

SetCanvasProjection()

DECL_EXP void SetCanvasProjection ( int  projection )

extern

Sets chart projection type.

Changes the projection used for chart display.

Parameters

projection

Projection type from PI_ProjectionType enum: PI_PROJECTION_MERCATOR PI_PROJECTION_TRANSVERSE_MERCATOR PI_PROJECTION_POLYCONIC etc.

Definition at line 1394 of file ocpn_plugin_gui.cpp.

SetCanvasRotation()

DECL_EXP void SetCanvasRotation ( double  rotation )

extern

Sets chart display rotation angle.

Rotates the chart display by the specified angle.

Parameters

rotation

Rotation angle in degrees (0-360) 0 = North up 90 = East up etc.

Definition at line 1384 of file ocpn_plugin_gui.cpp.

SetCanvasTilt()

DECL_EXP void SetCanvasTilt ( double  tilt )

extern

Gets current canvas tilt angle.

Returns the tilt angle of the chart display canvas in degrees. Tilt provides a 3D perspective view of the chart.

Returns

Tilt angle in degrees (0-90) 0 = Normal top-down view 90 = Horizontal view

Definition at line 1390 of file ocpn_plugin_gui.cpp.

SetCursor_PlugIn()

DECL_EXP void SetCursor_PlugIn ( wxCursor *  pPlugin_Cursor = NULL )

extern

Sets mouse cursor.

Changes the mouse cursor displayed over chart window.

Parameters

pPlugin_Cursor

Pointer to cursor to use, NULL for default

Definition at line 1429 of file ocpn_plugin_gui.cpp.

SetEnableMainToolbar()

DECL_EXP void SetEnableMainToolbar ( bool  enable )

extern

Show or hide the main toolbar.

Parameters

enable

True to show the toolbar, false to hide it.

Definition at line 2682 of file ocpn_plugin_gui.cpp.

SetENCDisplayCategory()

DECL_EXP void SetENCDisplayCategory ( PI_DisCat  cat, int  CanvasIndex  )

extern

Sets ENC (Electronic Navigation Chart) feature display category.

Parameters

cat	Display category to use (BASE, STANDARD, OTHER, etc)
CanvasIndex	Index of target canvas

Definition at line 2473 of file ocpn_plugin_gui.cpp.

SetFullScreen()

DECL_EXP void SetFullScreen ( bool  full_screen_on )

extern

Sets full screen mode.

Parameters

full_screen_on

True to enable full screen mode, false for windowed

Definition at line 2291 of file ocpn_plugin_gui.cpp.

SetGlobalColor()

DECL_EXP void SetGlobalColor ( std::string  table, std::string  name, wxColor  color  )

extern

Sets a color in the global color scheme.

Parameters

table	Color scheme name ("DAY", "DUSK", "NIGHT")
name	Color identifier within scheme
color	New color value to set

Definition at line 2383 of file ocpn_plugin_gui.cpp.

SetMUICursor_PlugIn()

DECL_EXP void SetMUICursor_PlugIn ( wxCursor *  pCursor, int  canvasIndex  )

extern

Sets mouse cursor for specific canvas.

Changes the mouse cursor displayed over a specific chart canvas window.

Parameters

pCursor	Pointer to cursor to use, NULL for default
canvasIndex	Index of target canvas

Definition at line 1699 of file ocpn_plugin_gui.cpp.

SetNavigationMode()

DECL_EXP void SetNavigationMode ( PI_NavMode  mode, int  CanvasIndex  )

extern

Sets the navigation mode for a specific chart canvas.

Parameters

mode	Navigation mode to set: PI_NORTH_UP_MODE: North always at top PI_COURSE_UP_MODE: Course over ground at top PI_HEAD_UP_MODE: Vessel heading at top
CanvasIndex	Index of target canvas (0-based)

Definition at line 2505 of file ocpn_plugin_gui.cpp.

SetToolbarItemState()

DECL_EXP void SetToolbarItemState	(	int	item,
		bool	toggle
	)

Sets toolbar item toggle state.

Sets the pressed/unpressed state for toggle type tools.

Parameters

item	Tool ID to modify
toggle	True for pressed state, false for unpressed

Definition at line 160 of file ocpn_plugin_gui.cpp.

SetToolbarToolBitmaps()

DECL_EXP void SetToolbarToolBitmaps	(	int	item,
		wxBitmap *	bitmap,
		wxBitmap *	bmpRollover
	)

Updates toolbar tool bitmaps.

Changes the normal and rollover bitmaps for an existing tool.

Parameters

item	Tool ID to modify
bitmap	New normal state bitmap
bmpRollover	New rollover bitmap

Definition at line 164 of file ocpn_plugin_gui.cpp.

SetToolbarToolBitmapsSVG()

DECL_EXP void SetToolbarToolBitmapsSVG	(	int	item,
		wxString	SVGfile,
		wxString	SVGfileRollover,
		wxString	SVGfileToggled
	)

Updates SVG graphics for toolbar tool.

Changes the SVG files used for a tool's different states.

Parameters

item	Tool ID to modify
SVGfile	Normal state SVG file
SVGfileRollover	Rollover state SVG file
SVGfileToggled	Toggled state SVG file

Definition at line 181 of file ocpn_plugin_gui.cpp.

SetToolbarToolViz()

DECL_EXP void SetToolbarToolViz	(	int	item,
		bool	viz
	)

Temporarily changes toolbar tool visibility.

Shows or hides a toolbar tool without removing it.

Parameters

item	Tool ID to modify
viz	True to show tool, false to hide

Definition at line 156 of file ocpn_plugin_gui.cpp.

SetTrackingMode()

DECL_EXP void SetTrackingMode ( bool  enable )

extern

Enable or disable tracking mode.

When tracking mode is enabled, the vessel's position is recorded in the active track.

Parameters

enable

True to enable tracking, false to disable.

Definition at line 2633 of file ocpn_plugin_gui.cpp.

ShowGlobalSettingsDialog()

DECL_EXP void ShowGlobalSettingsDialog ( )

extern

Display the global settings dialog.

Opens the main OpenCPN options/preferences dialog.

Definition at line 2687 of file ocpn_plugin_gui.cpp.

ShuttingDown()

DECL_EXP bool ShuttingDown ( void  )

extern

Checks if OpenCPN is in shutdown process.

Returns

True if OpenCPN is shutting down, false otherwise

Definition at line 1648 of file ocpn_plugin_gui.cpp.

toSDMM_PlugIn()

DECL_EXP wxString toSDMM_PlugIn ( int  NEflag, double  a, bool  hi_precision = true  )

extern

Formats latitude/longitude in degrees and decimal minutes.

Converts decimal degrees to deg/min format with N/S/E/W indicator.

Parameters

NEflag	North/East flag (true=N/E, false=S/W)
a	Decimal degrees value
hi_precision	True for higher precision output

Returns

Formatted string like "50° 12.345' N"

Definition at line 4258 of file pluginmanager.cpp.

toSM_ECC_Plugin()

DECL_EXP void toSM_ECC_Plugin	(	double	lat,
		double	lon,
		double	lat0,
		double	lon0,
		double *	x,
		double *	y
	)

Converts geographic coordinates to Elliptical Simple Mercator projection.

Parameters

lat	Latitude in decimal degrees
lon	Longitude in decimal degrees
lat0	Reference latitude
lon0	Central meridian
x	Easting coordinate (output)
y	Northing coordinate (output)

Definition at line 692 of file ocpn_plugin_gui.cpp.

toSM_Plugin()

DECL_EXP void toSM_Plugin	(	double	lat,
		double	lon,
		double	lat0,
		double	lon0,
		double *	x,
		double *	y
	)

Converts geographic coordinates to Simple Mercator projection.

Parameters

lat	Latitude in decimal degrees
lon	Longitude in decimal degrees
lat0	Reference latitude
lon0	Central meridian
x	Easting coordinate (output)
y	Northing coordinate (output)

Definition at line 682 of file ocpn_plugin_gui.cpp.

toTM_Plugin()

DECL_EXP void toTM_Plugin	(	float	lat,
		float	lon,
		float	lat0,
		float	lon0,
		double *	x,
		double *	y
	)

Converts geographic coordinates to Transverse Mercator projection.

Parameters

lat	Latitude in decimal degrees
lon	Longitude in decimal degrees
lat0	Reference latitude
lon0	Central meridian
x	Easting coordinate (output)
y	Northing coordinate (output)

Definition at line 672 of file ocpn_plugin_gui.cpp.

toUsrDateTimeFormat_Plugin()

DECL_EXP wxString toUsrDateTimeFormat_Plugin ( const wxDateTime  date_time, const DateTimeFormatOptions &  options = DateTimeFormatOptions()  )

extern

Format a wxDateTime to a localized string representation, conforming to the global date/time format and timezone settings.

The function uses the timezone configuration to format the date/time either in UTC, local time, or local mean time (LMT) based on the longitude.

Note

This function should be used instead of wxDateTime.Format() to ensure consistent date/time formatting across the entire application.

Parameters

date_time	The date/time to format.
options	The date/time format options.

Returns

wxString The formatted date/time string.

Definition at line 5309 of file pluginmanager.cpp.

toUsrDistance_Plugin()

DECL_EXP double toUsrDistance_Plugin	(	double	nm_distance,
		int	unit = -1
	)

Converts nautical miles to user's preferred distance unit.

Parameters

nm_distance	Distance value in nautical miles
unit	Override unit choice (-1 for user preference): 0=nm, 1=km, 2=mi, 3=fathoms

Returns

Distance in user's preferred unit

Note

Default unit is determined by OpenCPN settings if unit=-1

Definition at line 702 of file ocpn_plugin_gui.cpp.

toUsrSpeed_Plugin()

DECL_EXP double toUsrSpeed_Plugin	(	double	kts_speed,
		int	unit = -1
	)

Converts knots to user's preferred speed unit.

Parameters

kts_speed	Speed value in knots
unit	Override unit choice (-1 for user preference): 0=knots, 1=km/h, 2=mph, 3=m/s

Returns

Speed in user's preferred unit

Definition at line 710 of file ocpn_plugin_gui.cpp.

toUsrTemp_Plugin()

DECL_EXP double toUsrTemp_Plugin	(	double	cel_temp,
		int	unit = -1
	)

Converts Celsius to user's preferred temperature unit.

Parameters

cel_temp	Temperature in Celsius
unit	Override unit choice (-1 for user preference): 0=Celsius, 1=Fahrenheit

Returns

Temperature in user's preferred unit

Definition at line 726 of file ocpn_plugin_gui.cpp.

UpdateChartDBInplace()

DECL_EXP bool UpdateChartDBInplace ( wxArrayString  dir_array, bool  b_force_update, bool  b_ProgressDialog  )

extern

Updates chart database in place.

Updates chart database with new chart directories.

Parameters

dir_array	Array of directory paths to scan
b_force_update	Force full update even if no changes detected
b_ProgressDialog	Show progress dialog during update

Returns

True if database was updated

Definition at line 460 of file ocpn_plugin_gui.cpp.

UpdatePlugInRoute()

DECL_EXP bool UpdatePlugInRoute ( PlugIn_Route *  proute )

extern

Updates an existing route.

Updates properties and waypoints of a route already in OpenCPN's route manager.

Parameters

proute

Route with updated properties (GUID must match existing route)

Returns

True if route was successfully updated

Definition at line 1201 of file ocpn_plugin_gui.cpp.

UpdatePlugInRouteEx()

DECL_EXP bool UpdatePlugInRouteEx ( PlugIn_Route_Ex *  proute )

extern

Updates an existing extended route.

Modifies extended properties of an existing route.

Parameters

proute

Updated route data (GUID must match existing)

Returns

True if successfully updated

Definition at line 2153 of file ocpn_plugin_gui.cpp.

UpdatePlugInTrack()

DECL_EXP bool UpdatePlugInTrack ( PlugIn_Track *  ptrack )

extern

Updates an existing track.

Updates properties and waypoints of a track already in OpenCPN's track manager.

Parameters

ptrack

Track with updated properties (GUID must match existing track)

Returns

True if track was successfully updated

Definition at line 1276 of file ocpn_plugin_gui.cpp.

UpdateSingleWaypoint()

DECL_EXP bool UpdateSingleWaypoint ( PlugIn_Waypoint *  pwaypoint )

extern

Updates a single waypoint.

Modifies properties of an existing waypoint.

Parameters

pwaypoint

Waypoint with updated properties (GUID must match existing)

Returns

True if successfully updated

Definition at line 903 of file ocpn_plugin_gui.cpp.

UpdateSingleWaypointEx()

DECL_EXP bool UpdateSingleWaypointEx ( PlugIn_Waypoint_Ex *  pwaypoint )

extern

Updates an existing extended waypoint.

Modifies extended properties of an existing waypoint.

Parameters

pwaypoint

Updated waypoint data (GUID must match existing)

Returns

True if successfully updated

Definition at line 2024 of file ocpn_plugin_gui.cpp.

WriteCommDriver()

DECL_EXP CommDriverResult WriteCommDriver ( DriverHandle  handle, const std::shared_ptr< std::vector< uint8_t > > &  payload  )

extern

Send a non-NMEA2000 message.

The call is not blocking.

Parameters

handle	Obtained from GetActiveDrivers()
payload	Message data, for example a complete Nmea0183 message. From 1.19: if the handle "protocol" attribute is "internal" it is parsed as <id><space><message> where the id is used when listening/ subscribing to message.

Returns

value number of bytes queued for transmission.

Definition at line 156 of file plugin_api.cpp.

WriteCommDriverN2K()

DECL_EXP CommDriverResult WriteCommDriverN2K ( DriverHandle  handle, int  PGN, int  destinationCANAddress, int  priority, const std::shared_ptr< std::vector< uint8_t > > &  payload  )

extern

Send a PGN message to an NMEA2000 address.

Definition at line 197 of file plugin_api.cpp.

ZeroXTE()

DECL_EXP void ZeroXTE

(

)

Resets cross track error to zero.

Sets the current cross track error (XTE) value to zero. This affects navigation displays and autopilot output.

Note

Useful when starting a new course or clearing navigation errors

XTE is the perpendicular distance from current position to planned route

Definition at line 1728 of file ocpn_plugin_gui.cpp.

Variable Documentation

wxEVT_DOWNLOAD_EVENT

DECL_EXP wxEventType wxEVT_DOWNLOAD_EVENT

extern

Definition at line 5010 of file pluginmanager.cpp.