PlugIn GUI API Functions. More...

#include "dychart.h"
#include <wx/wx.h>
#include <wx/arrstr.h>
#include <wx/dc.h>
#include <wx/dcmemory.h>
#include <wx/event.h>
#include <wx/glcanvas.h>
#include <wx/notebook.h>
#include <wx/string.h>
#include <wx/window.h>
#include "model/ais_decoder.h"
#include "model/comm_navmsg_bus.h"
#include "model/idents.h"
#include "model/multiplexer.h"
#include "model/notification_manager.h"
#include "model/own_ship.h"
#include "model/plugin_comm.h"
#include "model/route.h"
#include "model/track.h"
#include "ais.h"
#include "chartdb.h"
#include "chcanv.h"
#include "ConfigMgr.h"
#include "FontMgr.h"
#include "glChartCanvas.h"
#include "gui_lib.h"
#include "navutil.h"
#include "ocpn_app.h"
#include "OCPN_AUIManager.h"
#include "ocpn_frame.h"
#include "OCPNPlatform.h"
#include "ocpn_plugin.h"
#include "options.h"
#include "piano.h"
#include "pluginmanager.h"
#include "routemanagerdialog.h"
#include "routeman_gui.h"
#include "s52plib.h"
#include "SoundFactory.h"
#include "svg_utils.h"
#include "SystemCmdSound.h"
#include "toolbar.h"
#include "waypointman_gui.h"
#include "shapefile_basemap.h"
#include <wx/listimpl.cpp>

Functions
	WX_DEFINE_ARRAY_PTR (ChartCanvas *, arrayofCanvasPtr)

void	NotifySetupOptionsPlugin (const PlugInData *pic)

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.

void	RemovePlugInTool (int tool_id)
	Removes a tool from OpenCPN's toolbar.

void	SetToolbarToolViz (int item, bool viz)
	Temporarily changes toolbar tool visibility.

void	SetToolbarItemState (int item, bool toggle)
	Sets toolbar item toggle state.

void	SetToolbarToolBitmaps (int item, wxBitmap bitmap, wxBitmap bmpRollover)
	Updates toolbar tool bitmaps.

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.

void	SetToolbarToolBitmapsSVG (int item, wxString SVGfile, wxString SVGfileRollover, wxString SVGfileToggled)
	Updates SVG graphics for toolbar tool.

int	AddCanvasMenuItem (wxMenuItem pitem, opencpn_plugin pplugin, const char *name)
	Adds item to canvas context menu.

void	SetCanvasMenuItemViz (int item, bool viz, const char *name)
	Temporarily changes context menu item visibility.

void	SetCanvasMenuItemGrey (int item, bool grey, const char *name)
	Sets menu item enabled/disabled state.

void	RemoveCanvasMenuItem (int item, const char *name)
	Removes a context menu item completely.

int	AddCanvasContextMenuItem (wxMenuItem pitem, opencpn_plugin pplugin)
	Adds item to chart canvas context menu.

void	SetCanvasContextMenuItemViz (int item, bool viz)
	Temporarily changes context menu item visibility.

void	SetCanvasContextMenuItemGrey (int item, bool grey)
	Sets menu item enabled/disabled state.

void	RemoveCanvasContextMenuItem (int item)
	Removes a context menu item completely.

wxFileConfig *	GetOCPNConfigObject (void)
	Gets OpenCPN's configuration object.

wxWindow *	GetOCPNCanvasWindow ()
	Gets OpenCPN's main canvas window.

void	RequestRefresh (wxWindow *win)
	Requests window refresh.

void	GetCanvasPixLL (PlugIn_ViewPort vp, wxPoint pp, double lat, double lon)
	Converts lat/lon to canvas physical pixel coordinates.

void	GetDoubleCanvasPixLL (PlugIn_ViewPort vp, wxPoint2DDouble pp, double lat, double lon)
	Converts lat/lon to canvas pixels with double precision.

void	GetCanvasLLPix (PlugIn_ViewPort vp, wxPoint p, double plat, double *plon)
	Converts canvas physical pixel coordinates to lat/lon.

bool	GetGlobalColor (wxString colorName, wxColour *pcolour)
	Gets a global color value.

wxFont *	OCPNGetFont (wxString TextElement, int default_size)
	Gets a font for UI elements.

wxFont *	GetOCPNScaledFont_PlugIn (wxString TextElement, int default_size)

double	GetOCPNGUIToolScaleFactor_PlugIn (int GUIScaleFactor)
	Gets GUI scaling factor for a specific scaling level.

double	GetOCPNGUIToolScaleFactor_PlugIn ()
	Gets current global GUI scaling factor.

float	GetOCPNChartScaleFactor_Plugin ()
	Gets chart rendering scale factor.

wxFont	GetOCPNGUIScaledFont_PlugIn (wxString item)
	Gets a uniquely scaled font copy for responsive UI elements.

bool	AddPersistentFontKey (wxString TextElement)
	Registers a new font configuration element.

wxString	GetActiveStyleName ()
	Gets name of currently active style sheet.

wxBitmap	GetBitmapFromSVGFile (wxString filename, unsigned int width, unsigned int height)
	Creates bitmap from SVG file.

bool	IsTouchInterface_PlugIn (void)
	Checks if touch interface mode is enabled.

wxColour	GetFontColour_PlugIn (wxString TextElement)
	Gets color configured for a UI text element.

wxString *	GetpSharedDataLocation (void)
	Gets shared application data location.

ArrayOfPlugIn_AIS_Targets *	GetAISTargetArray (void)
	Gets array of AIS targets.

wxAuiManager *	GetFrameAuiManager (void)
	Gets main frame AUI manager.

void	SendPluginMessage (wxString message_id, wxString message_body)
	Sends message to other plugins.

void	DimeWindow (wxWindow *win)
	Applies system color scheme to window.

void	JumpToPosition (double lat, double lon, double scale)
	Centers chart display on specified position at given scale.

bool	AddLocaleCatalog (wxString catalog)
	Adds a locale catalog for translations.

wxString	GetLocaleCanonicalName ()
	Gets system locale canonical name.

void	PushNMEABuffer (wxString buf)
	Pushes NMEA sentence to the system.

wxXmlDocument	GetChartDatabaseEntryXML (int dbIndex, bool b_getGeom)
	Gets chart database entry as XML.

bool	UpdateChartDBInplace (wxArrayString dir_array, bool b_force_update, bool b_ProgressDialog)
	Updates chart database in place.

wxArrayString	GetChartDBDirArrayString ()
	Gets chart database directory list.

int	AddChartToDBInPlace (wxString &full_path, bool b_RefreshCanvas)
	Adds a chart to the database without full rebuild.

int	RemoveChartFromDBInPlace (wxString &full_path)
	Removes a chart from database without full rebuild.

wxScrolledWindow *	AddOptionsPage (OptionsParentPI parent, wxString title)
	Adds a new preferences page to OpenCPN options dialog.

bool	DeleteOptionsPage (wxScrolledWindow *page)
	Removes a previously added options page.

bool	DecodeSingleVDOMessage (const wxString &str, PlugIn_Position_Fix_Ex pos, wxString accumulator)
	Decodes a single VDO (Own Ship AIS) message.

int	GetChartbarHeight (void)
	Gets height of chart bar in pixels.

bool	GetRoutepointGPX (RoutePoint pRoutePoint, char buffer, unsigned int buffer_length)

bool	GetActiveRoutepointGPX (char *buffer, unsigned int buffer_length)
	Gets GPX representation of active route waypoint.

void	PositionBearingDistanceMercator_Plugin (double lat, double lon, double brg, double dist, double dlat, double dlon)
	Calculates destination point given start point, bearing and distance.

void	DistanceBearingMercator_Plugin (double lat0, double lon0, double lat1, double lon1, double brg, double dist)
	Calculates bearing and distance between two points.

double	DistGreatCircle_Plugin (double slat, double slon, double dlat, double dlon)
	Calculates great circle distance between two points.

void	toTM_Plugin (float lat, float lon, float lat0, float lon0, double x, double y)
	Converts geographic coordinates to Transverse Mercator projection.

void	fromTM_Plugin (double x, double y, double lat0, double lon0, double lat, double lon)
	Converts Transverse Mercator coordinates to geographic.

void	toSM_Plugin (double lat, double lon, double lat0, double lon0, double x, double y)
	Converts geographic coordinates to Simple Mercator projection.

void	fromSM_Plugin (double x, double y, double lat0, double lon0, double lat, double lon)
	Converts Simple Mercator coordinates to geographic.

void	toSM_ECC_Plugin (double lat, double lon, double lat0, double lon0, double x, double y)
	Converts geographic coordinates to Elliptical Simple Mercator projection.

void	fromSM_ECC_Plugin (double x, double y, double lat0, double lon0, double lat, double lon)
	Converts Elliptical Simple Mercator coordinates to geographic.

double	toUsrDistance_Plugin (double nm_distance, int unit)
	Converts nautical miles to user's preferred distance unit.

double	fromUsrDistance_Plugin (double usr_distance, int unit)
	Converts from user's preferred distance unit to nautical miles.

double	toUsrSpeed_Plugin (double kts_speed, int unit)
	Converts knots to user's preferred speed unit.

double	toUsrWindSpeed_Plugin (double kts_speed, int unit)
	Converts knots to user's preferred wind speed unit.

double	fromUsrSpeed_Plugin (double usr_speed, int unit)
	Converts from user's preferred speed unit to knots.

double	fromUsrWindSpeed_Plugin (double usr_wspeed, int unit)
	Converts from user's preferred wind speed unit to knots.

double	toUsrTemp_Plugin (double cel_temp, int unit)
	Converts Celsius to user's preferred temperature unit.

double	fromUsrTemp_Plugin (double usr_temp, int unit)
	Converts from user's preferred temperature unit to Celsius.

wxString	getUsrDistanceUnit_Plugin (int unit)
	Gets display string for user's preferred distance unit.

wxString	getUsrSpeedUnit_Plugin (int unit)
	Gets display string for user's preferred speed unit.

wxString	getUsrWindSpeedUnit_Plugin (int unit)
	Gets display string for user's preferred wind speed unit.

wxString	getUsrTempUnit_Plugin (int unit)
	Gets display string for user's preferred temperature unit.

double	toUsrDepth_Plugin (double m_depth, int unit)
	Converts meters to user's preferred depth unit.

double	fromUsrDepth_Plugin (double usr_depth, int unit)
	Converts from user's preferred depth unit to meters.

wxString	getUsrDepthUnit_Plugin (int unit)
	Gets display string for user's preferred depth unit.

double	fromDMM_PlugIn (wxString sdms)
	Parse a formatted coordinate string to get decimal degrees.

bool	PlugIn_GSHHS_CrossesLand (double lat1, double lon1, double lat2, double lon2)
	Checks if a great circle route crosses land.

void	PlugInPlaySound (wxString &sound_file)
	Plays a sound file asynchronously.

wxString	GetNewGUID (void)
	Generates a new globally unique identifier (GUID).

bool	AddCustomWaypointIcon (wxBitmap *pimage, wxString key, wxString description)
	Adds a custom waypoint icon.

bool	AddSingleWaypoint (PlugIn_Waypoint *pwaypoint, bool b_permanent)
	Adds a single waypoint.

bool	DeleteSingleWaypoint (wxString &GUID)
	Deletes a single waypoint.

bool	UpdateSingleWaypoint (PlugIn_Waypoint *pwaypoint)
	Updates a single waypoint.

bool	GetSingleWaypoint (wxString GUID, PlugIn_Waypoint *pwaypoint)
	Gets waypoint data by GUID.

wxArrayString	GetWaypointGUIDArray (void)
	Gets array of all waypoint/marks GUIDs.

wxArrayString	GetRouteGUIDArray (void)
	Gets array of route GUIDs.

wxArrayString	GetTrackGUIDArray (void)
	Gets array of track GUIDs.

wxArrayString	GetWaypointGUIDArray (OBJECT_LAYER_REQ req)
	Gets array of waypoint/track GUIDs with layer filtering.

wxArrayString	GetRouteGUIDArray (OBJECT_LAYER_REQ req)
	Gets array of route GUIDs with layer filtering.

wxArrayString	GetTrackGUIDArray (OBJECT_LAYER_REQ req)
	Gets array of track GUIDs with layer filtering.

wxArrayString	GetIconNameArray (void)
	Gets array of available waypoint icons.

bool	AddPlugInRoute (PlugIn_Route *proute, bool b_permanent)
	Adds a new route.

bool	DeletePlugInRoute (wxString &GUID)
	Deletes a route.

bool	UpdatePlugInRoute (PlugIn_Route *proute)
	Updates an existing route.

bool	AddPlugInTrack (PlugIn_Track *ptrack, bool b_permanent)
	Adds a new track.

bool	DeletePlugInTrack (wxString &GUID)
	Deletes a track.

bool	UpdatePlugInTrack (PlugIn_Track *ptrack)
	Updates an existing track.

bool	PlugInHasNormalizedViewPort (PlugIn_ViewPort *vp)
	Checks if viewport has been normalized.

void	PlugInMultMatrixViewport (PlugIn_ViewPort *vp, float lat, float lon)
	Applies viewport transformation matrix.

void	PlugInNormalizeViewport (PlugIn_ViewPort *vp, float lat, float lon)
	Normalizes viewport parameters.

PlugIn_AIS_Target *	Create_PI_AIS_Target (AisTargetData *ptarget)

double	fromDMM_Plugin (wxString sdms)
	Converts degrees/decimal minutes string to decimal degrees.

void	SetCanvasRotation (double rotation)
	Sets chart display rotation angle.

double	GetCanvasTilt ()
	Gets current canvas tilt angle.

void	SetCanvasTilt (double tilt)
	Gets current canvas tilt angle.

void	SetCanvasProjection (int projection)
	Sets chart projection type.

bool	PlugInPlaySoundEx (wxString &sound_file, int deviceIndex)
	Start playing a sound file asynchronously.

bool	CheckEdgePan_PlugIn (int x, int y, bool dragging, int margin, int delta)
	Checks if chart should pan when cursor near edge.

wxBitmap	GetIcon_PlugIn (const wxString &name)
	Gets icon bitmap by name.

void	SetCursor_PlugIn (wxCursor *pCursor)
	Sets mouse cursor.

void	AddChartDirectory (wxString &path)
	Adds a chart directory to OpenCPN's chart database.

void	ForceChartDBUpdate ()
	Forces an update of the chart database.

void	ForceChartDBRebuild ()
	Forces complete rebuild of chart database.

wxDialog *	GetActiveOptionsDialog ()
	Gets pointer to active options dialog.

int	PlatformDirSelectorDialog (wxWindow parent, wxString file_spec, wxString Title, wxString initDir)
	Shows platform-optimized directory selector dialog.

int	PlatformFileSelectorDialog (wxWindow parent, wxString file_spec, wxString Title, wxString initDir, wxString suggestedName, wxString wildcard)
	Shows platform-optimized file selector dialog.

ViewPort	CreateCompatibleViewportEx (const PlugIn_ViewPort &pivp)

void	PlugInAISDrawGL (wxGLCanvas *glcanvas, const PlugIn_ViewPort &vp)
	Renders AIS targets on a secondary OpenGL canvas.

bool	PlugInSetFontColor (const wxString TextElement, const wxColour color)
	Sets text color for a UI element.

double	PlugInGetDisplaySizeMM ()
	Gets physical display size in millimeters.

wxFont *	FindOrCreateFont_PlugIn (int point_size, wxFontFamily family, wxFontStyle style, wxFontWeight weight, bool underline, const wxString &facename, wxFontEncoding encoding)
	Creates or finds a font in the font cache.

int	PluginGetMinAvailableGshhgQuality ()

int	PluginGetMaxAvailableGshhgQuality ()

void	PlugInHandleAutopilotRoute (bool enable)
	Controls autopilot route handling.

bool	LaunchDefaultBrowser_Plugin (wxString url)

wxString	GetSelectedWaypointGUID_Plugin ()
	Gets GUID of currently selected waypoint.

wxString	GetSelectedRouteGUID_Plugin ()
	Gets GUID of currently selected route.

wxString	GetSelectedTrackGUID_Plugin ()
	Gets GUID of currently selected track.

std::unique_ptr< PlugIn_Waypoint >	GetWaypoint_Plugin (const wxString &GUID)
	Gets waypoint details by GUID.

std::unique_ptr< PlugIn_Route >	GetRoute_Plugin (const wxString &GUID)
	Gets route details by GUID.

std::unique_ptr< PlugIn_Track >	GetTrack_Plugin (const wxString &GUID)
	Gets track details by GUID.

wxWindow *	PluginGetFocusCanvas ()
	Gets the currently focused chart canvas.

wxWindow *	PluginGetOverlayRenderCanvas ()
	Gets the canvas currently designated for overlay rendering.

void	CanvasJumpToPosition (wxWindow *canvas, double lat, double lon, double scale)
	Centers specified canvas on given position at given scale.

bool	ShuttingDown (void)
	Checks if OpenCPN is in shutdown process.

wxWindow *	GetCanvasUnderMouse (void)
	Gets canvas window under mouse cursor.

int	GetCanvasIndexUnderMouse (void)
	Gets index of chart canvas under mouse cursor.

wxWindow *	GetCanvasByIndex (int canvasIndex)
	Gets chart canvas window by index.

bool	CheckMUIEdgePan_PlugIn (int x, int y, bool dragging, int margin, int delta, int canvasIndex)
	Checks if chart should pan when cursor near edge.

void	SetMUICursor_PlugIn (wxCursor *pCursor, int canvasIndex)
	Sets mouse cursor for specific canvas.

int	GetCanvasCount ()
	Gets total number of chart canvases.

int	GetLatLonFormat ()
	Gets currently selected latitude/longitude display format.

wxRect	GetMasterToolbarRect ()
	Gets bounding rectangle of master toolbar.

void	ZeroXTE ()
	Resets cross track error to zero.

RoutePoint *	CreateNewPoint (const PlugIn_Waypoint_Ex *src, bool b_permanent)

bool	GetSingleWaypointEx (wxString GUID, PlugIn_Waypoint_Ex *pwaypoint)
	Gets extended waypoint data by GUID.

bool	AddSingleWaypointEx (PlugIn_Waypoint_Ex *pwaypointex, bool b_permanent)
	Adds a waypoint with extended properties.

bool	UpdateSingleWaypointEx (PlugIn_Waypoint_Ex *pwaypoint)
	Updates an existing extended waypoint.

bool	AddPlugInRouteEx (PlugIn_Route_Ex *proute, bool b_permanent)
	Adds a route with extended features.

bool	UpdatePlugInRouteEx (PlugIn_Route_Ex *proute)
	Updates an existing extended route.

std::unique_ptr< PlugIn_Waypoint_Ex >	GetWaypointEx_Plugin (const wxString &GUID)
	Gets extended waypoint by GUID.

std::unique_ptr< PlugIn_Route_Ex >	GetRouteEx_Plugin (const wxString &GUID)
	Gets extended route by GUID.

wxString	GetActiveWaypointGUID (void)
	Gets GUID of currently active waypoint.

wxString	GetActiveRouteGUID (void)
	Gets GUID of currently active route.

int	GetGlobalWatchdogTimoutSeconds ()
	Comm Global Watchdog Query

std::vector< std::string >	GetPriorityMaps ()
	Comm Priority query support methods

std::vector< std::string >	GetActivePriorityIdentifiers ()
	Gets list of active priority identifiers.

double	OCPN_GetDisplayContentScaleFactor ()
	Gets content scaling factor for current display.

double	OCPN_GetWinDIPScaleFactor ()
	Gets Windows-specific DPI scaling factor.

void	ExitOCPN ()
	Exits OpenCPN application.

bool	GetFullScreen ()
	Gets full screen state.

void	SetFullScreen (bool set_full_screen_on)
	Sets full screen mode.

void	EnableMUIBar (bool enable, int CanvasIndex)
	Controls visibility of MUI (Mobile/Touch User Interface) bar.

bool	GetEnableMUIBar (int CanvasIndex)
	Gets MUI bar visibility state.

void	EnableCompassGPSIcon (bool enable, int CanvasIndex)
	Controls visibility of compass/GPS status icon.

bool	GetEnableCompassGPSIcon (int CanvasIndex)
	Gets compass icon visibility state.

void	EnableStatusBar (bool enable)
	Shows/hides the status bar.

bool	GetEnableStatusBar ()
	Gets status bar visibility state.

void	EnableChartBar (bool enable, int CanvasIndex)
	Controls visibility of chart info bar.

bool	GetEnableChartBar (int CanvasIndex)
	Gets chart bar visibility state.

void	EnableMenu (bool enable)
	Shows/hides the main menu bar.

bool	GetEnableMenu ()
	Gets menu bar visibility state.

void	SetGlobalColor (std::string table, std::string name, wxColor color)
	Sets a color in the global color scheme.

wxColor	GetGlobalColorD (std::string map_name, std::string name)
	Gets a color from the global color scheme.

void	EnableLatLonGrid (bool enable, int CanvasIndex)
	Controls latitude/longitude grid display.

void	EnableChartOutlines (bool enable, int CanvasIndex)
	Controls chart outline display.

void	EnableDepthUnitDisplay (bool enable, int CanvasIndex)
	Controls depth unit display.

void	EnableAisTargetDisplay (bool enable, int CanvasIndex)
	Controls AIS target display.

void	EnableTideStationsDisplay (bool enable, int CanvasIndex)
	Controls tide station icon display.

void	EnableCurrentStationsDisplay (bool enable, int CanvasIndex)
	Controls current station icon display.

void	EnableENCTextDisplay (bool enable, int CanvasIndex)
	Controls ENC text label display.

void	EnableENCDepthSoundingsDisplay (bool enable, int CanvasIndex)
	Controls ENC depth sounding display.

void	EnableBuoyLightLabelsDisplay (bool enable, int CanvasIndex)
	Controls buoy/light name label display.

void	EnableLightsDisplay (bool enable, int CanvasIndex)
	Controls light icon display.

void	EnableLightDescriptionsDisplay (bool enable, int CanvasIndex)
	Controls light description text display.

void	SetENCDisplayCategory (PI_DisCat cat, int CanvasIndex)
	Sets ENC (Electronic Navigation Chart) feature display category.

PI_DisCat	GetENCDisplayCategory (int CanvasIndex)
	Gets current ENC display category.

void	SetNavigationMode (PI_NavMode mode, int CanvasIndex)
	Sets the navigation mode for a specific chart canvas.

PI_NavMode	GetNavigationMode (int CanvasIndex)
	Gets current navigation mode for a canvas.

bool	GetEnableLatLonGrid (int CanvasIndex)
	Gets latitude/longitude grid visibility state.

bool	GetEnableChartOutlines (int CanvasIndex)
	Gets chart outline visibility state.

bool	GetEnableDepthUnitDisplay (int CanvasIndex)
	Gets depth unit display state.

bool	GetEnableAisTargetDisplay (int CanvasIndex)
	Gets AIS target display state.

bool	GetEnableTideStationsDisplay (int CanvasIndex)
	Gets tide station icon visibility.

bool	GetEnableCurrentStationsDisplay (int CanvasIndex)
	Gets current station icon visibility.

bool	GetEnableENCTextDisplay (int CanvasIndex)
	Gets ENC text label visibility.

bool	GetEnableENCDepthSoundingsDisplay (int CanvasIndex)
	Gets ENC depth sounding visibility.

bool	GetEnableBuoyLightLabelsDisplay (int CanvasIndex)
	Gets buoy/light label visibility.

bool	GetEnableLightsDisplay (int CanvasIndex)
	Gets light icon visibility.

bool	GetShowENCLightDesc (int CanvasIndex)

void	EnableTouchMode (bool enable)
	Enables/disables touch interface mode.

bool	GetTouchMode ()
	Gets touch interface mode state.

void	EnableLookaheadMode (bool enable, int CanvasIndex)
	Enables/disables look-ahead mode for a canvas.

bool	GetEnableLookaheadMode (int CanvasIndex)
	Gets look-ahead mode state for a canvas.

void	SetTrackingMode (bool enable)
	Enable or disable tracking mode.

bool	GetTrackingMode ()
	Get the current tracking mode status.

void	SetAppColorScheme (PI_ColorScheme cs)
	Set the application color scheme.

PI_ColorScheme	GetAppColorScheme ()
	Get the current application color scheme.

void	RequestWindowRefresh (wxWindow *win, bool eraseBackground)
	Requests window refresh.

void	EnableSplitScreenLayout (bool enable)
	Enable or disable the split-screen layout.

void	PluginZoomCanvas (int CanvasIndex, double factor)
	Zoom a specific chart canvas by the given factor.

bool	GetEnableMainToolbar ()
	Check if the main toolbar is enabled.

void	SetEnableMainToolbar (bool enable)
	Show or hide the main toolbar.

void	ShowGlobalSettingsDialog ()
	Display the global settings dialog.

void	PluginCenterOwnship (int CanvasIndex)
	Center the chart view on the own ship position for a specific canvas.

void	PluginSetFollowMode (int CanvasIndex, bool enable_follow)
	Set follow mode for a specific canvas.

bool	PluginGetFollowMode (int CanvasIndex)
	Get the current follow mode status for a specific canvas.

void	EnableCanvasFocusBar (bool enable, int CanvasIndex)
	Controls visibility of canvas focus indicator.

bool	GetEnableCanvasFocusBar (int CanvasIndex)
	Gets focus indicator visibility state.

bool	GetEnableTenHertzUpdate ()
	Check if 10 Hz update rate is enabled.

void	EnableTenHertzUpdate (bool enable)
	Enable or disable 10 Hz update rate.

void	ConfigFlushAndReload ()
	Flush configuration changes to disk and reload settings.

void	EnableNotificationCanvasIcon (bool enable)
	Plugin Notification Framework GUI support.

Variables
PlugInManager *	s_ppim

MyConfig *	pConfig

OCPN_AUIManager *	g_pauimgr

wxLocale *	plocale_def_lang

OCPNPlatform *	g_Platform

ChartDB *	ChartData

MyFrame *	gFrame

ocpnStyle::StyleManager *	g_StyleManager

options *	g_pOptions

Multiplexer *	g_pMUX

bool	g_bShowChartBar

Routeman *	g_pRouteMan

Select *	pSelect

RouteManagerDialog *	pRouteManagerDialog

RouteList *	pRouteList

std::vector< Track * >	g_TrackList

PlugInManager *	g_pi_manager

s52plib *	ps52plib

wxString	ChartListFileName

options *	g_options

ColorScheme	global_color_scheme

wxArrayString	g_locale_catalog_array

int	g_GUIScaleFactor

int	g_ChartScaleFactor

wxString	g_locale
	Global locale setting for OpenCPN UI.

ocpnFloatingToolbarDialog *	g_MainToolbar

int	g_chart_zoom_modifier_raster

int	g_chart_zoom_modifier_vector

double	g_display_size_mm
	The width of the physical screen in millimeters.

bool	g_bopengl

AisDecoder *	g_pAIS

ChartGroupArray *	g_pGroupArray

ShapeBaseChartSet	gShapeBasemap

unsigned int	g_canvasConfig

wxString	g_CmdSoundString

unsigned int	gs_plib_flags

ChartCanvas *	g_focusCanvas

ChartCanvas *	g_overlayCanvas

bool	g_bquiting

bool	g_disable_main_toolbar

bool	g_btenhertz

bool	g_CanvasHideNotificationIcon

arrayofCanvasPtr	g_canvasArray

OcpnSound *	g_PluginSound = SoundFactory()

bool	g_useMUI

bool	g_bShowStatusBar

bool	g_bShowMenuBar

bool	g_bTrackActive

Detailed Description

PlugIn GUI API Functions.

Definition in file ocpn_plugin_gui.cpp.

Function Documentation

◆ AddCanvasContextMenuItem()

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

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

Definition at line 212 of file ocpn_plugin_gui.cpp.

◆ AddCanvasMenuItem()

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

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

Definition at line 192 of file ocpn_plugin_gui.cpp.

◆ AddChartDirectory()

void AddChartDirectory ( wxString & path )

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

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

Definition at line 1450 of file ocpn_plugin_gui.cpp.

◆ AddChartToDBInPlace()

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

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

Definition at line 484 of file ocpn_plugin_gui.cpp.

◆ AddCustomWaypointIcon()

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

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

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

Definition at line 829 of file ocpn_plugin_gui.cpp.

◆ AddLocaleCatalog()

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

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

Definition at line 417 of file ocpn_plugin_gui.cpp.

◆ AddOptionsPage()

wxScrolledWindow * AddOptionsPage	(	OptionsParentPI	parent,
		wxString	title
	)

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

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

Definition at line 550 of file ocpn_plugin_gui.cpp.

◆ AddPersistentFontKey()

bool AddPersistentFontKey ( wxString TextElement )

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()

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

Definition at line 329 of file ocpn_plugin_gui.cpp.

◆ AddPlugInRoute()

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

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

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

Definition at line 1149 of file ocpn_plugin_gui.cpp.

◆ AddPlugInRouteEx()

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

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

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

Definition at line 2114 of file ocpn_plugin_gui.cpp.

◆ AddPlugInTrack()

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

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

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

Definition at line 1235 of file ocpn_plugin_gui.cpp.

◆ AddSingleWaypoint()

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

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

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

Definition at line 857 of file ocpn_plugin_gui.cpp.

◆ AddSingleWaypointEx()

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

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

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

Definition at line 2009 of file ocpn_plugin_gui.cpp.

◆ CanvasJumpToPosition()

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)

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

Definition at line 1659 of file ocpn_plugin_gui.cpp.

◆ CheckEdgePan_PlugIn()

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

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

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

Definition at line 1436 of file ocpn_plugin_gui.cpp.

◆ CheckMUIEdgePan_PlugIn()

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

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

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

Definition at line 1701 of file ocpn_plugin_gui.cpp.

◆ ConfigFlushAndReload()

void ConfigFlushAndReload ( )

Flush configuration changes to disk and reload settings.

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

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

Definition at line 2757 of file ocpn_plugin_gui.cpp.

◆ Create_PI_AIS_Target()

PlugIn_AIS_Target * Create_PI_AIS_Target ( AisTargetData * ptarget )

Definition at line 1357 of file ocpn_plugin_gui.cpp.

◆ CreateCompatibleViewportEx()

ViewPort CreateCompatibleViewportEx ( const PlugIn_ViewPort & pivp )

Definition at line 1487 of file ocpn_plugin_gui.cpp.

◆ CreateNewPoint()

RoutePoint * CreateNewPoint	(	const PlugIn_Waypoint_Ex *	src,
		bool	b_permanent
	)

Definition at line 1967 of file ocpn_plugin_gui.cpp.

◆ DecodeSingleVDOMessage()

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

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

Definition at line 588 of file ocpn_plugin_gui.cpp.

◆ DeleteOptionsPage()

bool DeleteOptionsPage ( wxScrolledWindow * page )

Removes a previously added options page.

Parameters

page	Pointer to page previously returned by AddOptionsPage()

Returns: True if page was successfully removed

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

Definition at line 583 of file ocpn_plugin_gui.cpp.

◆ DeletePlugInRoute()

bool DeletePlugInRoute ( wxString & GUID )

Deletes a route.

Removes route identified by GUID from OpenCPN.

Parameters

GUID	Unique identifier of route to delete

Returns: True if successfully deleted

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

Definition at line 1206 of file ocpn_plugin_gui.cpp.

◆ DeletePlugInTrack()

bool DeletePlugInTrack ( wxString & GUID )

Deletes a track.

Removes track identified by GUID from OpenCPN.

Parameters

GUID	Unique identifier of track to delete

Returns: True if successfully deleted

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

Definition at line 1277 of file ocpn_plugin_gui.cpp.

◆ DeleteSingleWaypoint()

bool DeleteSingleWaypoint ( wxString & GUID )

Deletes a single waypoint.

Removes waypoint identified by GUID from OpenCPN.

Parameters

GUID	Unique identifier of waypoint to delete

Returns: True if successfully deleted

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

Definition at line 904 of file ocpn_plugin_gui.cpp.

◆ DimeWindow()

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

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

Definition at line 410 of file ocpn_plugin_gui.cpp.

◆ DistanceBearingMercator_Plugin()

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)

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

Definition at line 664 of file ocpn_plugin_gui.cpp.

◆ DistGreatCircle_Plugin()

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

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

Definition at line 669 of file ocpn_plugin_gui.cpp.

◆ EnableAisTargetDisplay()

void EnableAisTargetDisplay	(	bool	enable,
		int	CanvasIndex
	)

Controls AIS target display.

Parameters

enable	True to show AIS targets
CanvasIndex	Index of target canvas

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

Definition at line 2434 of file ocpn_plugin_gui.cpp.

◆ EnableBuoyLightLabelsDisplay()

void EnableBuoyLightLabelsDisplay	(	bool	enable,
		int	CanvasIndex
	)

Controls buoy/light name label display.

Parameters

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

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

Definition at line 2469 of file ocpn_plugin_gui.cpp.

◆ EnableCanvasFocusBar()

void EnableCanvasFocusBar	(	bool	enable,
		int	CanvasIndex
	)

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

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

Definition at line 2739 of file ocpn_plugin_gui.cpp.

◆ EnableChartBar()

void EnableChartBar	(	bool	enable,
		int	CanvasIndex
	)

Controls visibility of chart info bar.

Parameters

enable	True to show chart bar
CanvasIndex	Index of target canvas

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

Definition at line 2364 of file ocpn_plugin_gui.cpp.

◆ EnableChartOutlines()

void EnableChartOutlines	(	bool	enable,
		int	CanvasIndex
	)

Controls chart outline display.

Parameters

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

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

Definition at line 2420 of file ocpn_plugin_gui.cpp.

◆ EnableCompassGPSIcon()

void EnableCompassGPSIcon	(	bool	enable,
		int	CanvasIndex
	)

Controls visibility of compass/GPS status icon.

Parameters

enable	True to show compass icon
CanvasIndex	Index of target canvas

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

Definition at line 2338 of file ocpn_plugin_gui.cpp.

◆ EnableCurrentStationsDisplay()

void EnableCurrentStationsDisplay	(	bool	enable,
		int	CanvasIndex
	)

Controls current station icon display.

Parameters

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

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

Definition at line 2448 of file ocpn_plugin_gui.cpp.

◆ EnableDepthUnitDisplay()

void EnableDepthUnitDisplay	(	bool	enable,
		int	CanvasIndex
	)

Controls depth unit display.

Parameters

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

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

Definition at line 2427 of file ocpn_plugin_gui.cpp.

◆ EnableENCDepthSoundingsDisplay()

void EnableENCDepthSoundingsDisplay	(	bool	enable,
		int	CanvasIndex
	)

Controls ENC depth sounding display.

Parameters

enable	True to show depth soundings
CanvasIndex	Index of target canvas

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

Definition at line 2462 of file ocpn_plugin_gui.cpp.

◆ EnableENCTextDisplay()

void EnableENCTextDisplay	(	bool	enable,
		int	CanvasIndex
	)

Controls ENC text label display.

Parameters

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

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

Definition at line 2455 of file ocpn_plugin_gui.cpp.

◆ EnableLatLonGrid()

void EnableLatLonGrid	(	bool	enable,
		int	CanvasIndex
	)

Controls latitude/longitude grid display.

Parameters

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

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

Definition at line 2413 of file ocpn_plugin_gui.cpp.

◆ EnableLightDescriptionsDisplay()

void EnableLightDescriptionsDisplay	(	bool	enable,
		int	CanvasIndex
	)

Controls light description text display.

Parameters

enable	True to show light descriptions
CanvasIndex	Index of target canvas

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

Definition at line 2483 of file ocpn_plugin_gui.cpp.

◆ EnableLightsDisplay()

void EnableLightsDisplay	(	bool	enable,
		int	CanvasIndex
	)

Controls light icon display.

Parameters

enable	True to show light icons
CanvasIndex	Index of target canvas

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

Definition at line 2476 of file ocpn_plugin_gui.cpp.

◆ EnableLookaheadMode()

void EnableLookaheadMode	(	bool	enable,
		int	CanvasIndex
	)

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

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

Definition at line 2634 of file ocpn_plugin_gui.cpp.

◆ EnableMenu()

void EnableMenu ( bool enable )

Shows/hides the main menu bar.

Parameters

enable True to show menu bar, false to hide

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

Definition at line 2382 of file ocpn_plugin_gui.cpp.

◆ EnableMUIBar()

void EnableMUIBar	(	bool	enable,
		int	CanvasIndex
	)

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

Parameters

enable	True to show MUI bar
CanvasIndex	Index of target canvas

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

Definition at line 2317 of file ocpn_plugin_gui.cpp.

◆ EnableNotificationCanvasIcon()

void EnableNotificationCanvasIcon ( bool enable )

Plugin Notification Framework GUI support.

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

Definition at line 2779 of file ocpn_plugin_gui.cpp.

◆ EnableSplitScreenLayout()

void EnableSplitScreenLayout ( bool enable = true )

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.

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

Definition at line 2669 of file ocpn_plugin_gui.cpp.

◆ EnableStatusBar()

void EnableStatusBar ( bool enable )

Shows/hides the status bar.

Parameters

enable True to show status bar, false to hide

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

Definition at line 2357 of file ocpn_plugin_gui.cpp.

◆ EnableTenHertzUpdate()

void EnableTenHertzUpdate ( bool enable )

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.

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

Definition at line 2755 of file ocpn_plugin_gui.cpp.

◆ EnableTideStationsDisplay()

void EnableTideStationsDisplay	(	bool	enable,
		int	CanvasIndex
	)

Controls tide station icon display.

Parameters

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

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

Definition at line 2441 of file ocpn_plugin_gui.cpp.

◆ EnableTouchMode()

void EnableTouchMode ( bool enable )

Enables/disables touch interface mode.

Parameters

enable True to enable touch optimized interface

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

Definition at line 2630 of file ocpn_plugin_gui.cpp.

◆ ExitOCPN()

void ExitOCPN ( )

Exits OpenCPN application.

Triggers a clean shutdown of OpenCPN.

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

Definition at line 2304 of file ocpn_plugin_gui.cpp.

◆ FindOrCreateFont_PlugIn()

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.

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

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

Definition at line 1533 of file ocpn_plugin_gui.cpp.

◆ ForceChartDBRebuild()

void ForceChartDBRebuild ( )

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

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

Definition at line 1463 of file ocpn_plugin_gui.cpp.

◆ ForceChartDBUpdate()

void ForceChartDBUpdate ( )

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

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

Definition at line 1456 of file ocpn_plugin_gui.cpp.

◆ fromDMM_PlugIn()

double fromDMM_PlugIn ( wxString sdms )

Parse a formatted coordinate string to get decimal degrees.

This function attempts to parse a wide variety of formatted coordinate strings and convert them to decimal degrees. It handles formats like:

37°54.204' N
N37 54 12
37°54'12"
37.9034
122°18.621' W
122w 18 37
-122.31035

Parameters

sdms	The formatted coordinate string to parse

Returns: The decimal degrees value, or NaN if parsing failed

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

Definition at line 761 of file ocpn_plugin_gui.cpp.

◆ fromDMM_Plugin()

double fromDMM_Plugin ( wxString sdms )

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

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

Definition at line 1399 of file ocpn_plugin_gui.cpp.

◆ fromSM_ECC_Plugin()

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)

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

Definition at line 699 of file ocpn_plugin_gui.cpp.

◆ fromSM_Plugin()

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)

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

Definition at line 689 of file ocpn_plugin_gui.cpp.

◆ fromTM_Plugin()

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)

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

Definition at line 679 of file ocpn_plugin_gui.cpp.

◆ fromUsrDepth_Plugin()

double fromUsrDepth_Plugin	(	double	usr_depth,
		int	unit = `-1`
	)

Converts from user's preferred depth unit to meters.

Parameters

usr_depth	Depth in user's unit
unit	Override unit choice (-1 for user preference): 0=feet, 1=meters, 2=fathoms

Returns: Depth in meters

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

Definition at line 755 of file ocpn_plugin_gui.cpp.

◆ fromUsrDistance_Plugin()

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

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

Definition at line 708 of file ocpn_plugin_gui.cpp.

◆ fromUsrSpeed_Plugin()

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

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

Definition at line 720 of file ocpn_plugin_gui.cpp.

◆ fromUsrTemp_Plugin()

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

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

Definition at line 732 of file ocpn_plugin_gui.cpp.

◆ fromUsrWindSpeed_Plugin()

double fromUsrWindSpeed_Plugin	(	double	usr_wspeed,
		int	unit = `-1`
	)

Converts from user's preferred wind speed unit to knots.

Parameters

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

Returns: Wind speed in knots

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

Definition at line 724 of file ocpn_plugin_gui.cpp.

◆ GetActiveOptionsDialog()

wxDialog * GetActiveOptionsDialog ( )

Gets pointer to active options dialog.

Returns: Pointer to active wxDialog, NULL if no dialog shown

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

Definition at line 1469 of file ocpn_plugin_gui.cpp.

◆ GetActivePriorityIdentifiers()

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

Gets list of active priority identifiers.

Returns list of currently active data source priority identifiers.

Returns: Vector of active priority identifiers

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

Definition at line 2261 of file ocpn_plugin_gui.cpp.

◆ GetActiveRouteGUID()

wxString GetActiveRouteGUID ( void )

Gets GUID of currently active route.

Returns: GUID string, empty if no active route

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

Definition at line 2243 of file ocpn_plugin_gui.cpp.

◆ GetActiveRoutepointGPX()

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

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

Definition at line 650 of file ocpn_plugin_gui.cpp.

◆ GetActiveStyleName()

wxString GetActiveStyleName ( )

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

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

Definition at line 333 of file ocpn_plugin_gui.cpp.

◆ GetActiveWaypointGUID()

wxString GetActiveWaypointGUID ( void )

Gets GUID of currently active waypoint.

Returns: GUID string, empty if no active waypoint

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

Definition at line 2234 of file ocpn_plugin_gui.cpp.

◆ GetAISTargetArray()

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

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

Definition at line 372 of file ocpn_plugin_gui.cpp.

◆ GetAppColorScheme()

PI_ColorScheme GetAppColorScheme ( )

Get the current application color scheme.

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

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

Definition at line 2661 of file ocpn_plugin_gui.cpp.

◆ GetBitmapFromSVGFile()

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

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

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

Definition at line 340 of file ocpn_plugin_gui.cpp.

◆ GetCanvasByIndex()

wxWindow * GetCanvasByIndex ( int canvasIndex )

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

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

Definition at line 1690 of file ocpn_plugin_gui.cpp.

◆ GetCanvasCount()

int GetCanvasCount ( )

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

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

Definition at line 1726 of file ocpn_plugin_gui.cpp.

◆ GetCanvasIndexUnderMouse()

int GetCanvasIndexUnderMouse ( )

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

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

Definition at line 1669 of file ocpn_plugin_gui.cpp.

◆ GetCanvasLLPix()

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

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

Definition at line 282 of file ocpn_plugin_gui.cpp.

◆ GetCanvasPixLL()

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

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

Definition at line 249 of file ocpn_plugin_gui.cpp.

◆ GetCanvasTilt()

double GetCanvasTilt ( )

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

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

Definition at line 1405 of file ocpn_plugin_gui.cpp.

◆ GetCanvasUnderMouse()

wxWindow * GetCanvasUnderMouse ( )

Gets canvas window under mouse cursor.

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

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

Definition at line 1667 of file ocpn_plugin_gui.cpp.

◆ GetChartbarHeight()

int GetChartbarHeight ( void )

Gets height of chart bar in pixels.

Returns: Height of chart bar widget

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

Definition at line 614 of file ocpn_plugin_gui.cpp.

◆ GetChartDatabaseEntryXML()

wxXmlDocument GetChartDatabaseEntryXML	(	int	dbIndex,
		bool	b_getGeom
	)

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

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

Definition at line 456 of file ocpn_plugin_gui.cpp.

◆ GetChartDBDirArrayString()

wxArrayString GetChartDBDirArrayString ( )

Gets chart database directory list.

Returns array of chart directories in database.

Returns: Array of directory paths as strings

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

Definition at line 480 of file ocpn_plugin_gui.cpp.

◆ GetDoubleCanvasPixLL()

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

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

Definition at line 266 of file ocpn_plugin_gui.cpp.

◆ GetEnableAisTargetDisplay()

bool GetEnableAisTargetDisplay ( int CanvasIndex )

Gets AIS target display state.

Parameters

CanvasIndex Index of canvas to query

Returns: True if AIS targets are visible

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

Definition at line 2566 of file ocpn_plugin_gui.cpp.

◆ GetEnableBuoyLightLabelsDisplay()

bool GetEnableBuoyLightLabelsDisplay ( int CanvasIndex )

Gets buoy/light label visibility.

Parameters

CanvasIndex Index of canvas to query

Returns: True if buoy/light name labels are shown

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

Definition at line 2606 of file ocpn_plugin_gui.cpp.

◆ GetEnableCanvasFocusBar()

bool GetEnableCanvasFocusBar ( int CanvasIndex )

Gets focus indicator visibility state.

Parameters

CanvasIndex Index of canvas to query

Returns: True if focus indicator is visible

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

Definition at line 2745 of file ocpn_plugin_gui.cpp.

◆ GetEnableChartBar()

bool GetEnableChartBar ( int CanvasIndex )

Gets chart bar visibility state.

Parameters

CanvasIndex Index of canvas to query

Returns: True if chart bar is visible

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

Definition at line 2379 of file ocpn_plugin_gui.cpp.

◆ GetEnableChartOutlines()

bool GetEnableChartOutlines ( int CanvasIndex )

Gets chart outline visibility state.

Parameters

CanvasIndex Index of canvas to query

Returns: True if chart boundaries are visible

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

Definition at line 2550 of file ocpn_plugin_gui.cpp.

◆ GetEnableCompassGPSIcon()

bool GetEnableCompassGPSIcon ( int CanvasIndex )

Gets compass icon visibility state.

Parameters

CanvasIndex Index of canvas to query

Returns: True if compass icon is visible

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

Definition at line 2345 of file ocpn_plugin_gui.cpp.

◆ GetEnableCurrentStationsDisplay()

bool GetEnableCurrentStationsDisplay ( int CanvasIndex )

Gets current station icon visibility.

Parameters

CanvasIndex Index of canvas to query

Returns: True if current station markers are shown

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

Definition at line 2582 of file ocpn_plugin_gui.cpp.

◆ GetEnableDepthUnitDisplay()

bool GetEnableDepthUnitDisplay ( int CanvasIndex )

Gets depth unit display state.

Parameters

CanvasIndex Index of canvas to query

Returns: True if depth unit indicators are shown

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

Definition at line 2558 of file ocpn_plugin_gui.cpp.

◆ GetEnableENCDepthSoundingsDisplay()

bool GetEnableENCDepthSoundingsDisplay ( int CanvasIndex )

Gets ENC depth sounding visibility.

Parameters

CanvasIndex Index of canvas to query

Returns: True if depth soundings are shown

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

Definition at line 2598 of file ocpn_plugin_gui.cpp.

◆ GetEnableENCTextDisplay()

bool GetEnableENCTextDisplay ( int CanvasIndex )

Gets ENC text label visibility.

Parameters

CanvasIndex Index of canvas to query

Returns: True if ENC feature text labels are shown

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

Definition at line 2590 of file ocpn_plugin_gui.cpp.

◆ GetEnableLatLonGrid()

bool GetEnableLatLonGrid ( int CanvasIndex )

Gets latitude/longitude grid visibility state.

Parameters

CanvasIndex Index of canvas to query

Returns: True if lat/lon grid lines are visible

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

Definition at line 2542 of file ocpn_plugin_gui.cpp.

◆ GetEnableLightsDisplay()

bool GetEnableLightsDisplay ( int CanvasIndex )

Gets light icon visibility.

Parameters

CanvasIndex Index of canvas to query

Returns: True if light icons are shown

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

Definition at line 2614 of file ocpn_plugin_gui.cpp.

◆ GetEnableLookaheadMode()

bool GetEnableLookaheadMode ( int CanvasIndex )

Gets look-ahead mode state for a canvas.

Parameters

CanvasIndex Index of canvas to query

Returns: True if look-ahead mode enabled

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

Definition at line 2641 of file ocpn_plugin_gui.cpp.

◆ GetEnableMainToolbar()

bool GetEnableMainToolbar ( )

Check if the main toolbar is enabled.

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

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

Definition at line 2698 of file ocpn_plugin_gui.cpp.

◆ GetEnableMenu()

bool GetEnableMenu ( )

Gets menu bar visibility state.

Returns: True if menu bar is enabled/visible

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

Definition at line 2398 of file ocpn_plugin_gui.cpp.

◆ GetEnableMUIBar()

bool GetEnableMUIBar ( int CanvasIndex )

Gets MUI bar visibility state.

Parameters

CanvasIndex Index of canvas to query

Returns: True if MUI bar is visible

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

Definition at line 2336 of file ocpn_plugin_gui.cpp.

◆ GetEnableStatusBar()

bool GetEnableStatusBar ( )

Gets status bar visibility state.

Returns: True if status bar is enabled/visible

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

Definition at line 2362 of file ocpn_plugin_gui.cpp.

◆ GetEnableTenHertzUpdate()

bool GetEnableTenHertzUpdate ( )

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.

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

Definition at line 2753 of file ocpn_plugin_gui.cpp.

◆ GetEnableTideStationsDisplay()

bool GetEnableTideStationsDisplay ( int CanvasIndex )

Gets tide station icon visibility.

Parameters

CanvasIndex Index of canvas to query

Returns: True if tide station markers are shown

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

Definition at line 2574 of file ocpn_plugin_gui.cpp.

◆ GetENCDisplayCategory()

PI_DisCat GetENCDisplayCategory ( int CanvasIndex )

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.

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

Definition at line 2514 of file ocpn_plugin_gui.cpp.

◆ GetFontColour_PlugIn()

wxColour GetFontColour_PlugIn ( wxString TextElement )

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

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

Definition at line 364 of file ocpn_plugin_gui.cpp.

◆ GetFrameAuiManager()

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

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

Definition at line 394 of file ocpn_plugin_gui.cpp.

◆ GetFullScreen()

bool GetFullScreen ( )

Gets full screen state.

Returns: True if application is in full screen mode

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

Definition at line 2306 of file ocpn_plugin_gui.cpp.

◆ GetGlobalColor()

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 298 of file ocpn_plugin_gui.cpp.

◆ GetGlobalColorD()

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

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

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

Definition at line 2404 of file ocpn_plugin_gui.cpp.

◆ GetGlobalWatchdogTimoutSeconds()

int GetGlobalWatchdogTimoutSeconds ( )

Comm Global Watchdog Query

Gets global watchdog timeout value.

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

Definition at line 2253 of file ocpn_plugin_gui.cpp.

◆ GetIcon_PlugIn()

wxBitmap GetIcon_PlugIn ( const wxString & name )

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

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

Definition at line 1441 of file ocpn_plugin_gui.cpp.

◆ GetIconNameArray()

wxArrayString GetIconNameArray ( void )

Gets array of available waypoint icons.

Returns: Array of icon names that can be used for waypoints

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

Definition at line 1139 of file ocpn_plugin_gui.cpp.

◆ GetLatLonFormat()

int GetLatLonFormat ( void )

Gets currently selected latitude/longitude display format.

Returns the coordinate format currently configured in OpenCPN settings.

Returns: Format enum value (see SDDMFORMAT)

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

Definition at line 1732 of file ocpn_plugin_gui.cpp.

◆ GetLocaleCanonicalName()

wxString GetLocaleCanonicalName ( )

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

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

Definition at line 430 of file ocpn_plugin_gui.cpp.

◆ GetMasterToolbarRect()

wxRect GetMasterToolbarRect ( )

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

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

Definition at line 1734 of file ocpn_plugin_gui.cpp.

◆ GetNavigationMode()

PI_NavMode GetNavigationMode ( int CanvasIndex )

Gets current navigation mode for a canvas.

Parameters

CanvasIndex Index of canvas to query

Returns: Current navigation mode

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

Definition at line 2534 of file ocpn_plugin_gui.cpp.

◆ GetNewGUID()

wxString GetNewGUID ( )

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

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

Definition at line 827 of file ocpn_plugin_gui.cpp.

◆ GetOCPNCanvasWindow()

wxWindow * GetOCPNCanvasWindow ( )

Gets OpenCPN's main canvas window.

Provides access to the main chart display window.

Returns: Pointer to main canvas window

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

Definition at line 236 of file ocpn_plugin_gui.cpp.

◆ GetOCPNChartScaleFactor_Plugin()

float GetOCPNChartScaleFactor_Plugin ( )

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

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

Definition at line 321 of file ocpn_plugin_gui.cpp.

◆ GetOCPNConfigObject()

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

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

Definition at line 228 of file ocpn_plugin_gui.cpp.

◆ GetOCPNGUIScaledFont_PlugIn()

wxFont GetOCPNGUIScaledFont_PlugIn ( wxString item )

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()

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

Definition at line 325 of file ocpn_plugin_gui.cpp.

◆ GetOCPNGUIToolScaleFactor_PlugIn() [1/2]

double GetOCPNGUIToolScaleFactor_PlugIn ( )

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

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

Definition at line 317 of file ocpn_plugin_gui.cpp.

◆ GetOCPNGUIToolScaleFactor_PlugIn() [2/2]

double GetOCPNGUIToolScaleFactor_PlugIn ( int GUIScaledFactor )

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 313 of file ocpn_plugin_gui.cpp.

◆ GetOCPNScaledFont_PlugIn()

wxFont * GetOCPNScaledFont_PlugIn	(	wxString	TextElement,
		int	default_size
	)

Definition at line 309 of file ocpn_plugin_gui.cpp.

◆ GetPriorityMaps()

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

Comm Priority query support methods

Gets list of configured priority mapping schemes.

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

Definition at line 2256 of file ocpn_plugin_gui.cpp.

◆ GetpSharedDataLocation()

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

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

Definition at line 368 of file ocpn_plugin_gui.cpp.

◆ GetRoute_Plugin()

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

Gets route details by GUID.

Parameters

guid	GUID of route to get

Returns: Unique pointer to route data, NULL if not found

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

Definition at line 1592 of file ocpn_plugin_gui.cpp.

◆ GetRouteEx_Plugin()

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

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

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

Definition at line 2201 of file ocpn_plugin_gui.cpp.

◆ GetRouteGUIDArray() [1/2]

wxArrayString GetRouteGUIDArray ( OBJECT_LAYER_REQ req )

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 1095 of file ocpn_plugin_gui.cpp.

◆ GetRouteGUIDArray() [2/2]

wxArrayString GetRouteGUIDArray ( void )

Gets array of route GUIDs.

Returns list of globally unique identifiers for all routes.

Returns: Array of route GUID strings

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

Definition at line 1046 of file ocpn_plugin_gui.cpp.

◆ GetRoutepointGPX()

bool GetRoutepointGPX	(	RoutePoint *	pRoutePoint,
		char *	buffer,
		unsigned int	buffer_length
	)

Definition at line 625 of file ocpn_plugin_gui.cpp.

◆ GetSelectedRouteGUID_Plugin()

wxString GetSelectedRouteGUID_Plugin ( )

Gets GUID of currently selected route.

Returns: GUID string, empty if no route selected

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

Definition at line 1570 of file ocpn_plugin_gui.cpp.

◆ GetSelectedTrackGUID_Plugin()

wxString GetSelectedTrackGUID_Plugin ( )

Gets GUID of currently selected track.

Returns: GUID string, empty if no track selected

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

Definition at line 1578 of file ocpn_plugin_gui.cpp.

◆ GetSelectedWaypointGUID_Plugin()

wxString GetSelectedWaypointGUID_Plugin ( )

Gets GUID of currently selected waypoint.

Returns: GUID string, empty if no waypoint selected

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

Definition at line 1562 of file ocpn_plugin_gui.cpp.

◆ GetShowENCLightDesc()

bool GetShowENCLightDesc ( int CanvasIndex )

Definition at line 2622 of file ocpn_plugin_gui.cpp.

◆ GetSingleWaypoint()

bool GetSingleWaypoint	(	wxString	GUID,
		PlugIn_Waypoint *	pwaypoint
	)

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

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

Definition at line 1020 of file ocpn_plugin_gui.cpp.

◆ GetSingleWaypointEx()

bool GetSingleWaypointEx	(	wxString	GUID,
		PlugIn_Waypoint_Ex *	pwaypoint
	)

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

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

Definition at line 1998 of file ocpn_plugin_gui.cpp.

◆ GetTouchMode()

bool GetTouchMode ( )

Gets touch interface mode state.

Returns: True if touch interface is enabled

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

Definition at line 2632 of file ocpn_plugin_gui.cpp.

◆ GetTrack_Plugin()

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

Gets track details by GUID.

Parameters

guid	GUID of track to get

Returns: Unique pointer to track data, NULL if not found

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

Definition at line 1622 of file ocpn_plugin_gui.cpp.

◆ GetTrackGUIDArray() [1/2]

wxArrayString GetTrackGUIDArray ( OBJECT_LAYER_REQ req )

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 1120 of file ocpn_plugin_gui.cpp.

◆ GetTrackGUIDArray() [2/2]

wxArrayString GetTrackGUIDArray ( void )

Gets array of track GUIDs.

Returns list of globally unique identifiers for all tracks.

Returns: Array of track GUID strings

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

Definition at line 1061 of file ocpn_plugin_gui.cpp.

◆ GetTrackingMode()

bool GetTrackingMode ( )

Get the current tracking mode status.

Returns: True if tracking mode is enabled, false otherwise.

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

Definition at line 2656 of file ocpn_plugin_gui.cpp.

◆ getUsrDepthUnit_Plugin()

wxString getUsrDepthUnit_Plugin ( int unit = -1 )

Gets display string for user's preferred depth unit.

Parameters

unit	Override unit choice (-1 for user preference): 0=feet, 1=meters, 2=fathoms

Returns: Localized unit string (e.g. "ft", "m", "fa")

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

Definition at line 759 of file ocpn_plugin_gui.cpp.

◆ getUsrDistanceUnit_Plugin()

wxString getUsrDistanceUnit_Plugin ( int unit = -1 )

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")

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

Definition at line 736 of file ocpn_plugin_gui.cpp.

◆ getUsrSpeedUnit_Plugin()

wxString getUsrSpeedUnit_Plugin ( int unit = -1 )

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")

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

Definition at line 740 of file ocpn_plugin_gui.cpp.

◆ getUsrTempUnit_Plugin()

wxString getUsrTempUnit_Plugin ( int unit = -1 )

Gets display string for user's preferred temperature unit.

Parameters

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

Returns: Localized unit string ("°C", "°F", or "K")

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

Definition at line 746 of file ocpn_plugin_gui.cpp.

◆ getUsrWindSpeedUnit_Plugin()

wxString getUsrWindSpeedUnit_Plugin ( int unit = -1 )

Gets display string for user's preferred wind speed unit.

Parameters

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

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

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

Definition at line 742 of file ocpn_plugin_gui.cpp.

◆ GetWaypoint_Plugin()

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

Gets waypoint details by GUID.

Parameters

guid	GUID of waypoint to get

Returns: Unique pointer to waypoint data, NULL if not found

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

Definition at line 1586 of file ocpn_plugin_gui.cpp.

◆ GetWaypointEx_Plugin()

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

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

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

Definition at line 2195 of file ocpn_plugin_gui.cpp.

◆ GetWaypointGUIDArray() [1/2]

wxArrayString GetWaypointGUIDArray ( OBJECT_LAYER_REQ req )

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 1070 of file ocpn_plugin_gui.cpp.

◆ GetWaypointGUIDArray() [2/2]

wxArrayString GetWaypointGUIDArray ( void )

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()

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

Definition at line 1031 of file ocpn_plugin_gui.cpp.

◆ InsertPlugInTool()

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

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

Definition at line 142 of file ocpn_plugin_gui.cpp.

◆ InsertPlugInToolSVG()

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

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

Definition at line 170 of file ocpn_plugin_gui.cpp.

◆ IsTouchInterface_PlugIn()

bool IsTouchInterface_PlugIn ( void )

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

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

Definition at line 362 of file ocpn_plugin_gui.cpp.

◆ JumpToPosition()

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

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

Definition at line 412 of file ocpn_plugin_gui.cpp.

◆ LaunchDefaultBrowser_Plugin()

bool LaunchDefaultBrowser_Plugin ( wxString url )

Definition at line 1553 of file ocpn_plugin_gui.cpp.

◆ NotifySetupOptionsPlugin()

void NotifySetupOptionsPlugin ( const PlugInData * pic )

Definition at line 1594 of file pluginmanager.cpp.

◆ OCPN_GetDisplayContentScaleFactor()

double OCPN_GetDisplayContentScaleFactor ( )

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()

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

Definition at line 2281 of file ocpn_plugin_gui.cpp.

◆ OCPN_GetWinDIPScaleFactor()

double OCPN_GetWinDIPScaleFactor ( )

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

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

Definition at line 2289 of file ocpn_plugin_gui.cpp.

◆ OCPNGetFont()

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.

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

Definition at line 305 of file ocpn_plugin_gui.cpp.

◆ PlatformDirSelectorDialog()

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

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

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

Definition at line 1471 of file ocpn_plugin_gui.cpp.

◆ PlatformFileSelectorDialog()

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

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

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

Definition at line 1476 of file ocpn_plugin_gui.cpp.

◆ PlugIn_GSHHS_CrossesLand()

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

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

Definition at line 763 of file ocpn_plugin_gui.cpp.

◆ PlugInAISDrawGL()

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

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

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

Definition at line 1514 of file ocpn_plugin_gui.cpp.

◆ PluginCenterOwnship()

void PluginCenterOwnship ( int CanvasIndex )

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).

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

Definition at line 2708 of file ocpn_plugin_gui.cpp.

◆ PlugInGetDisplaySizeMM()

double PlugInGetDisplaySizeMM ( )

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

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

Definition at line 1531 of file ocpn_plugin_gui.cpp.

◆ PluginGetFocusCanvas()

wxWindow * PluginGetFocusCanvas ( )

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

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

Definition at line 1651 of file ocpn_plugin_gui.cpp.

◆ PluginGetFollowMode()

bool PluginGetFollowMode ( int CanvasIndex )

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.

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

Definition at line 2731 of file ocpn_plugin_gui.cpp.

◆ PluginGetMaxAvailableGshhgQuality()

int PluginGetMaxAvailableGshhgQuality ( )

Definition at line 1544 of file ocpn_plugin_gui.cpp.

◆ PluginGetMinAvailableGshhgQuality()

int PluginGetMinAvailableGshhgQuality ( )

Definition at line 1541 of file ocpn_plugin_gui.cpp.

◆ PluginGetOverlayRenderCanvas()

wxWindow * PluginGetOverlayRenderCanvas ( )

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

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

Definition at line 1653 of file ocpn_plugin_gui.cpp.

◆ PlugInHandleAutopilotRoute()

void PlugInHandleAutopilotRoute ( bool enable )

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

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

Definition at line 1549 of file ocpn_plugin_gui.cpp.

◆ PlugInHasNormalizedViewPort()

bool PlugInHasNormalizedViewPort ( PlugIn_ViewPort * vp )

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

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

Definition at line 1310 of file ocpn_plugin_gui.cpp.

◆ PlugInMultMatrixViewport()

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

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

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

Definition at line 1321 of file ocpn_plugin_gui.cpp.

◆ PlugInNormalizeViewport()

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

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

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

Definition at line 1338 of file ocpn_plugin_gui.cpp.

◆ PlugInPlaySound()

void PlugInPlaySound ( wxString & sound_file )

Plays a sound file asynchronously.

Parameters

sound_file Path to audio file to play

Note: Supported formats depend on sound backend

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

Definition at line 779 of file ocpn_plugin_gui.cpp.

◆ PlugInPlaySoundEx()

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

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.

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

Definition at line 1419 of file ocpn_plugin_gui.cpp.

◆ PluginSetFollowMode()

void PluginSetFollowMode	(	int	CanvasIndex,
		bool	enable_follow
	)

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.

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

Definition at line 2722 of file ocpn_plugin_gui.cpp.

◆ PlugInSetFontColor()

bool PlugInSetFontColor	(	const wxString	TextElement,
		const wxColour	color
	)

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()

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

Definition at line 1523 of file ocpn_plugin_gui.cpp.

◆ PluginZoomCanvas()

void PluginZoomCanvas	(	int	CanvasIndex,
		double	factor
	)

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.

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

Definition at line 2691 of file ocpn_plugin_gui.cpp.

◆ PositionBearingDistanceMercator_Plugin()

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)

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

Definition at line 658 of file ocpn_plugin_gui.cpp.

◆ PushNMEABuffer()

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

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

Definition at line 433 of file ocpn_plugin_gui.cpp.

◆ RemoveCanvasContextMenuItem()

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()

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

Definition at line 225 of file ocpn_plugin_gui.cpp.

◆ RemoveCanvasMenuItem()

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)

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

Definition at line 208 of file ocpn_plugin_gui.cpp.

◆ RemoveChartFromDBInPlace()

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

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

Definition at line 519 of file ocpn_plugin_gui.cpp.

◆ RemovePlugInTool()

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()

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

Definition at line 154 of file ocpn_plugin_gui.cpp.

◆ RequestRefresh()

void RequestRefresh ( wxWindow * win )

Requests window refresh.

Triggers a redraw of the specified window.

Parameters

window Window to refresh

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

Definition at line 245 of file ocpn_plugin_gui.cpp.

◆ RequestWindowRefresh()

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

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

Definition at line 2665 of file ocpn_plugin_gui.cpp.

◆ SendPluginMessage()

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

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

Definition at line 396 of file ocpn_plugin_gui.cpp.

◆ SetAppColorScheme()

void SetAppColorScheme ( PI_ColorScheme cs )

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).

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

Definition at line 2658 of file ocpn_plugin_gui.cpp.

◆ SetCanvasContextMenuItemGrey()

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

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

Definition at line 221 of file ocpn_plugin_gui.cpp.

◆ SetCanvasContextMenuItemViz()

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

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

Definition at line 217 of file ocpn_plugin_gui.cpp.

◆ SetCanvasMenuItemGrey()

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)

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

Definition at line 204 of file ocpn_plugin_gui.cpp.

◆ SetCanvasMenuItemViz()

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)

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

Definition at line 200 of file ocpn_plugin_gui.cpp.

◆ SetCanvasProjection()

void SetCanvasProjection ( int projection )

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.

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

Definition at line 1411 of file ocpn_plugin_gui.cpp.

◆ SetCanvasRotation()

void SetCanvasRotation ( double rotation )

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.

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

Definition at line 1401 of file ocpn_plugin_gui.cpp.

◆ SetCanvasTilt()

void SetCanvasTilt ( double tilt )

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

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

Definition at line 1407 of file ocpn_plugin_gui.cpp.

◆ SetCursor_PlugIn()

void SetCursor_PlugIn ( wxCursor * pPlugin_Cursor = NULL )

Sets mouse cursor.

Changes the mouse cursor displayed over chart window.

Parameters

pPlugin_Cursor Pointer to cursor to use, NULL for default

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

Definition at line 1446 of file ocpn_plugin_gui.cpp.

◆ SetEnableMainToolbar()

void SetEnableMainToolbar ( bool enable )

Show or hide the main toolbar.

Parameters

enable True to show the toolbar, false to hide it.

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

Definition at line 2699 of file ocpn_plugin_gui.cpp.

◆ SetENCDisplayCategory()

void SetENCDisplayCategory	(	PI_DisCat	cat,
		int	CanvasIndex
	)

Sets ENC (Electronic Navigation Chart) feature display category.

Parameters

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

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

Definition at line 2490 of file ocpn_plugin_gui.cpp.

◆ SetFullScreen()

void SetFullScreen ( bool full_screen_on )

Sets full screen mode.

Parameters

full_screen_on True to enable full screen mode, false for windowed

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

Definition at line 2308 of file ocpn_plugin_gui.cpp.

◆ SetGlobalColor()

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

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

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

Definition at line 2400 of file ocpn_plugin_gui.cpp.

◆ SetMUICursor_PlugIn()

void SetMUICursor_PlugIn	(	wxCursor *	pCursor,
		int	canvasIndex
	)

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

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

Definition at line 1716 of file ocpn_plugin_gui.cpp.

◆ SetNavigationMode()

void SetNavigationMode	(	PI_NavMode	mode,
		int	CanvasIndex
	)

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)

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

Definition at line 2522 of file ocpn_plugin_gui.cpp.

◆ SetToolbarItemState()

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

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

Definition at line 162 of file ocpn_plugin_gui.cpp.

◆ SetToolbarToolBitmaps()

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

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

Definition at line 166 of file ocpn_plugin_gui.cpp.

◆ SetToolbarToolBitmapsSVG()

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

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

Definition at line 183 of file ocpn_plugin_gui.cpp.

◆ SetToolbarToolViz()

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

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

Definition at line 158 of file ocpn_plugin_gui.cpp.

◆ SetTrackingMode()

void SetTrackingMode ( bool enable )

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.

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

Definition at line 2650 of file ocpn_plugin_gui.cpp.

◆ ShowGlobalSettingsDialog()

void ShowGlobalSettingsDialog ( )

Display the global settings dialog.

Opens the main OpenCPN options/preferences dialog.

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

Definition at line 2704 of file ocpn_plugin_gui.cpp.

◆ ShuttingDown()

bool ShuttingDown ( void )

Checks if OpenCPN is in shutdown process.

Returns: True if OpenCPN is shutting down, false otherwise

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

Definition at line 1665 of file ocpn_plugin_gui.cpp.

◆ toSM_ECC_Plugin()

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)

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

Definition at line 694 of file ocpn_plugin_gui.cpp.

◆ toSM_Plugin()

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)

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

Definition at line 684 of file ocpn_plugin_gui.cpp.

◆ toTM_Plugin()

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)

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

Definition at line 674 of file ocpn_plugin_gui.cpp.

◆ toUsrDepth_Plugin()

double toUsrDepth_Plugin	(	double	m_depth,
		int	unit = `-1`
	)

Converts meters to user's preferred depth unit.

Parameters

m_depth	Depth in meters
unit	Override unit choice (-1 for user preference): 0=feet, 1=meters, 2=fathoms

Returns: Depth in user's preferred unit

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

Definition at line 751 of file ocpn_plugin_gui.cpp.

◆ toUsrDistance_Plugin()

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

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

Definition at line 704 of file ocpn_plugin_gui.cpp.

◆ toUsrSpeed_Plugin()

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

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

Definition at line 712 of file ocpn_plugin_gui.cpp.

◆ toUsrTemp_Plugin()

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

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

Definition at line 728 of file ocpn_plugin_gui.cpp.

◆ toUsrWindSpeed_Plugin()

double toUsrWindSpeed_Plugin	(	double	kts_wspeed,
		int	unit = `-1`
	)

Converts knots to user's preferred wind speed unit.

Parameters

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

Returns: Wind speed in user's preferred unit

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

Definition at line 716 of file ocpn_plugin_gui.cpp.

◆ UpdateChartDBInplace()

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

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

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

Definition at line 462 of file ocpn_plugin_gui.cpp.

◆ UpdatePlugInRoute()

bool UpdatePlugInRoute ( PlugIn_Route * proute )

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

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

Definition at line 1218 of file ocpn_plugin_gui.cpp.

◆ UpdatePlugInRouteEx()

bool UpdatePlugInRouteEx ( PlugIn_Route_Ex * proute )

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

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

Definition at line 2170 of file ocpn_plugin_gui.cpp.

◆ UpdatePlugInTrack()

bool UpdatePlugInTrack ( PlugIn_Track * ptrack )

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

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

Definition at line 1293 of file ocpn_plugin_gui.cpp.

◆ UpdateSingleWaypoint()

bool UpdateSingleWaypoint ( PlugIn_Waypoint * pwaypoint )

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

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

Definition at line 920 of file ocpn_plugin_gui.cpp.

◆ UpdateSingleWaypointEx()

bool UpdateSingleWaypointEx ( PlugIn_Waypoint_Ex * pwaypoint )

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

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

Definition at line 2041 of file ocpn_plugin_gui.cpp.

◆ ZeroXTE()

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

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

Definition at line 1745 of file ocpn_plugin_gui.cpp.

Variable Documentation

◆ ChartData

ChartDB* ChartData

extern

Definition at line 268 of file ocpn_app.cpp.

◆ ChartListFileName

wxString ChartListFileName

extern

Definition at line 298 of file ocpn_app.cpp.

◆ g_bopengl

bool g_bopengl

extern

Definition at line 475 of file ocpn_app.cpp.

◆ g_bquiting

bool g_bquiting

extern

Definition at line 601 of file ocpn_app.cpp.

◆ g_bShowChartBar

bool g_bShowChartBar

extern

Definition at line 346 of file ocpn_app.cpp.

◆ g_bShowMenuBar

bool g_bShowMenuBar

extern

Definition at line 622 of file ocpn_app.cpp.

◆ g_bShowStatusBar

bool g_bShowStatusBar

extern

Definition at line 599 of file ocpn_app.cpp.

◆ g_btenhertz

bool g_btenhertz

extern

Definition at line 699 of file ocpn_app.cpp.

◆ g_bTrackActive

bool g_bTrackActive

extern

Definition at line 542 of file ocpn_app.cpp.

◆ g_canvasArray

arrayofCanvasPtr g_canvasArray

extern

Definition at line 691 of file ocpn_app.cpp.

◆ g_canvasConfig

unsigned int g_canvasConfig

extern

Definition at line 680 of file ocpn_app.cpp.

◆ g_CanvasHideNotificationIcon

bool g_CanvasHideNotificationIcon

extern

Definition at line 574 of file ocpn_app.cpp.

◆ g_chart_zoom_modifier_raster

int g_chart_zoom_modifier_raster

extern

Definition at line 669 of file ocpn_app.cpp.

◆ g_chart_zoom_modifier_vector

int g_chart_zoom_modifier_vector

extern

Definition at line 670 of file ocpn_app.cpp.

◆ g_ChartScaleFactor

int g_ChartScaleFactor

extern

Definition at line 398 of file ocpn_app.cpp.

◆ g_CmdSoundString

wxString g_CmdSoundString

extern

Definition at line 647 of file ocpn_app.cpp.

◆ g_disable_main_toolbar

bool g_disable_main_toolbar

extern

Definition at line 698 of file ocpn_app.cpp.

◆ g_display_size_mm

double g_display_size_mm

extern

The width of the physical screen in millimeters.

Definition at line 393 of file ocpn_app.cpp.

◆ g_focusCanvas

ChartCanvas* g_focusCanvas

extern

Definition at line 694 of file ocpn_app.cpp.

◆ g_GUIScaleFactor

int g_GUIScaleFactor

extern

Definition at line 397 of file ocpn_app.cpp.

◆ g_locale

wxString g_locale

extern

Global locale setting for OpenCPN UI.

If not set in config (empty string), uses system default locale. Stores the language/locale name in format "en_US", "fr_FR", etc. A valid setting triggers loading the corresponding .mo translation files from the appropriate locale directory.

Definition at line 591 of file ocpn_app.cpp.

◆ g_locale_catalog_array

wxArrayString g_locale_catalog_array

extern

Definition at line 676 of file ocpn_app.cpp.

◆ g_MainToolbar

ocpnFloatingToolbarDialog* g_MainToolbar

extern

Definition at line 615 of file ocpn_app.cpp.

◆ g_options

options* g_options

extern

Definition at line 522 of file ocpn_app.cpp.

◆ g_overlayCanvas

ChartCanvas* g_overlayCanvas

extern

Definition at line 695 of file ocpn_app.cpp.

◆ g_pAIS

AisDecoder* g_pAIS

extern

Definition at line 81 of file ais_decoder.cpp.

◆ g_pauimgr

OCPN_AUIManager* g_pauimgr

extern

Definition at line 610 of file ocpn_app.cpp.

◆ g_pGroupArray

ChartGroupArray* g_pGroupArray

extern

Definition at line 515 of file ocpn_app.cpp.

◆ g_pi_manager

PlugInManager* g_pi_manager

extern

Definition at line 507 of file ocpn_app.cpp.

◆ g_Platform

OCPNPlatform* g_Platform

extern

Definition at line 254 of file ocpn_app.cpp.

◆ g_PluginSound

OcpnSound* g_PluginSound = SoundFactory()

Definition at line 1415 of file ocpn_plugin_gui.cpp.

◆ g_pMUX

Multiplexer* g_pMUX

extern

Definition at line 63 of file multiplexer.cpp.

◆ g_pOptions

options* g_pOptions

extern

Definition at line 260 of file options.cpp.

◆ g_pRouteMan

Routeman* g_pRouteMan

extern

Definition at line 66 of file routeman.cpp.

◆ g_StyleManager

ocpnStyle::StyleManager* g_StyleManager

extern

Definition at line 340 of file ocpn_app.cpp.

◆ g_TrackList

std::vector<Track*> g_TrackList

extern

Definition at line 100 of file track.cpp.

◆ g_useMUI

bool g_useMUI

extern

Definition at line 681 of file ocpn_app.cpp.

◆ gFrame

MyFrame* gFrame

extern

Definition at line 263 of file ocpn_app.cpp.

◆ global_color_scheme

ColorScheme global_color_scheme

extern

Definition at line 371 of file ocpn_app.cpp.

◆ gs_plib_flags

unsigned int gs_plib_flags

Definition at line 117 of file ocpn_plugin_gui.cpp.

◆ gShapeBasemap

ShapeBaseChartSet gShapeBasemap

extern

Definition at line 314 of file chcanv.cpp.

◆ pConfig

MyConfig* pConfig

extern

Definition at line 267 of file ocpn_app.cpp.

◆ plocale_def_lang

wxLocale* plocale_def_lang

extern

Definition at line 580 of file ocpn_app.cpp.

◆ pRouteList

RouteList* pRouteList

extern

Definition at line 72 of file routeman.cpp.

◆ pRouteManagerDialog

RouteManagerDialog* pRouteManagerDialog

extern

Definition at line 280 of file ocpn_app.cpp.

◆ ps52plib

s52plib* ps52plib

extern

Definition at line 409 of file ocpn_app.cpp.

◆ pSelect

Select* pSelect

extern

Definition at line 37 of file select.cpp.

◆ s_ppim

PlugInManager* s_ppim

extern

Definition at line 865 of file pluginmanager.cpp.

Functions

Variables

Detailed Description

Function Documentation

◆ AddCanvasContextMenuItem()

◆ AddCanvasMenuItem()

◆ AddChartDirectory()

◆ AddChartToDBInPlace()

◆ AddCustomWaypointIcon()

◆ AddLocaleCatalog()

◆ AddOptionsPage()

◆ AddPersistentFontKey()

◆ AddPlugInRoute()

◆ AddPlugInRouteEx()

◆ AddPlugInTrack()

◆ AddSingleWaypoint()

◆ AddSingleWaypointEx()

◆ CanvasJumpToPosition()

◆ CheckEdgePan_PlugIn()

◆ CheckMUIEdgePan_PlugIn()

◆ ConfigFlushAndReload()

◆ Create_PI_AIS_Target()

◆ CreateCompatibleViewportEx()

◆ CreateNewPoint()

◆ DecodeSingleVDOMessage()

◆ DeleteOptionsPage()

◆ DeletePlugInRoute()

◆ DeletePlugInTrack()

◆ DeleteSingleWaypoint()

◆ DimeWindow()

◆ DistanceBearingMercator_Plugin()

◆ DistGreatCircle_Plugin()

◆ EnableAisTargetDisplay()

◆ EnableBuoyLightLabelsDisplay()

◆ EnableCanvasFocusBar()

◆ EnableChartBar()

◆ EnableChartOutlines()

◆ EnableCompassGPSIcon()

◆ EnableCurrentStationsDisplay()

◆ EnableDepthUnitDisplay()

◆ EnableENCDepthSoundingsDisplay()

◆ EnableENCTextDisplay()

◆ EnableLatLonGrid()

◆ EnableLightDescriptionsDisplay()

◆ EnableLightsDisplay()

◆ EnableLookaheadMode()

◆ EnableMenu()

◆ EnableMUIBar()

◆ EnableNotificationCanvasIcon()

◆ EnableSplitScreenLayout()

◆ EnableStatusBar()

◆ EnableTenHertzUpdate()

◆ EnableTideStationsDisplay()

◆ EnableTouchMode()

◆ ExitOCPN()

◆ FindOrCreateFont_PlugIn()

◆ ForceChartDBRebuild()

◆ ForceChartDBUpdate()

◆ fromDMM_PlugIn()

◆ fromDMM_Plugin()

◆ fromSM_ECC_Plugin()

◆ fromSM_Plugin()

◆ fromTM_Plugin()

◆ fromUsrDepth_Plugin()

◆ fromUsrDistance_Plugin()

◆ fromUsrSpeed_Plugin()

◆ fromUsrTemp_Plugin()

◆ fromUsrWindSpeed_Plugin()

◆ GetActiveOptionsDialog()

◆ GetActivePriorityIdentifiers()

◆ GetActiveRouteGUID()

◆ GetActiveRoutepointGPX()

◆ GetActiveStyleName()

◆ GetActiveWaypointGUID()

◆ GetAISTargetArray()

◆ GetAppColorScheme()

◆ GetBitmapFromSVGFile()

◆ GetCanvasByIndex()

◆ GetCanvasCount()

◆ GetCanvasIndexUnderMouse()