OpenCPN Partial API docs
Loading...
Searching...
No Matches
ocpn_plugin.h
Go to the documentation of this file.
1/**************************************************************************
2 * Copyright (C) 2010 - 2024 by David S. Register *
3 * *
4 * This program is free software; you can redistribute it and/or modify *
5 * it under the terms of the GNU General Public License as published by *
6 * the Free Software Foundation; either version 2 of the License, or *
7 * (at your option) any later version. *
8 * *
9 * This program is distributed in the hope that it will be useful, *
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
12 * GNU General Public License for more details. *
13 * *
14 * You should have received a copy of the GNU General Public License *
15 * along with this program; if not, write to the *
16 * Free Software Foundation, Inc., *
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. *
18 **************************************************************************/
19
25#ifndef _PLUGIN_H_
26#define _PLUGIN_H_
27
28#ifndef DECL_EXP
29#if defined(__WXMSW__) || defined(__CYGWIN__)
30#define DECL_EXP __declspec(dllexport)
31#elif defined __GNUC__ && __GNUC__ >= 4
32#define DECL_EXP __attribute__((visibility("default")))
33#elif defined __WXOSX__
34#define DECL_EXP __attribute__((visibility("default")))
35#else
36#define DECL_EXP
37#endif
38#endif
39
40#if defined(__WXMSW__) && defined(MAKING_PLUGIN)
41#define DECL_IMP __declspec(dllimport)
42#else
43#define DECL_IMP
44#endif
45
46#include <wx/xml/xml.h>
47#include <wx/dcmemory.h>
48#include <wx/dialog.h>
49#include <wx/event.h>
50#include <wx/menuitem.h>
51#include <wx/gdicmn.h>
52
53#ifdef ocpnUSE_SVG
54#include <wx/bitmap.h>
55#endif // ocpnUSE_SVG
56
57#include <cstdint>
58#include <memory>
59#include <vector>
60#include <unordered_map>
61
62class wxGLContext;
63
64// This is the most modern API Version number
65// It is expected that the API will remain downward compatible, meaning that
66// PlugIns conforming to API Version less than the most modern will also
67// be correctly supported.
68#define API_VERSION_MAJOR 1
69#define API_VERSION_MINOR 20
70
71// Fwd Definitions
72class wxFileConfig;
73class wxNotebook;
74class wxFont;
75class wxAuiManager;
76class wxScrolledWindow;
77class wxGLCanvas;
78
79//---------------------------------------------------------------------------------------------------------
80//
81// Bitfield PlugIn Capabilities flag definition
82//
83//---------------------------------------------------------------------------------------------------------
87#define WANTS_OVERLAY_CALLBACK 0x00000001
91#define WANTS_CURSOR_LATLON 0x00000002
101#define WANTS_TOOLBAR_CALLBACK 0x00000004
107#define INSTALLS_TOOLBAR_TOOL 0x00000008
110#define WANTS_CONFIG 0x00000010
113#define INSTALLS_TOOLBOX_PAGE 0x00000020
116#define INSTALLS_CONTEXTMENU_ITEMS 0x00000040
119#define WANTS_NMEA_SENTENCES 0x00000080
123#define WANTS_NMEA_EVENTS 0x00000100
126#define WANTS_AIS_SENTENCES 0x00000200
129#define USES_AUI_MANAGER 0x00000400
132#define WANTS_PREFERENCES 0x00000800
135#define INSTALLS_PLUGIN_CHART 0x00001000
138#define WANTS_ONPAINT_VIEWPORT 0x00002000
141#define WANTS_PLUGIN_MESSAGING 0x00004000
142#define WANTS_OPENGL_OVERLAY_CALLBACK 0x00008000
143#define WANTS_DYNAMIC_OPENGL_OVERLAY_CALLBACK 0x00010000
146#define WANTS_LATE_INIT 0x00020000
149#define INSTALLS_PLUGIN_CHART_GL 0x00040000
152#define WANTS_MOUSE_EVENTS 0x00080000
155#define WANTS_VECTOR_CHART_OBJECT_INFO 0x00100000
158#define WANTS_KEYBOARD_EVENTS 0x00200000
161#define WANTS_PRESHUTDOWN_HOOK 0x00400000
162
163//---------------------------------------------------------------------------------------------------------
164//
165// Overlay priorities
166//
167//---------------------------------------------------------------------------------------------------------
168#define OVERLAY_LEGACY 0
169#define OVERLAY_OVER_SHIPS 64
170#define OVERLAY_OVER_EMBOSS 96
171#define OVERLAY_OVER_UI 128
172
173//----------------------------------------------------------------------------------------------------------
174// Some PlugIn API interface object class definitions
175//----------------------------------------------------------------------------------------------------------
190
195public:
196 double clat;
197 double clon;
199 double skew;
200 double rotation;
201
203
206 wxRect rv_rect;
207 bool b_quilt;
210
211 double lat_min;
212 double lat_max;
213 double lon_min;
214 double lon_max;
215
216 bool
218};
219
224public:
225 double Lat;
226 double Lon;
227 double Cog;
228 double Sog;
229 double Var;
230 time_t FixTime;
231 int nSats;
232};
244public:
251 double Lat;
252
259 double Lon;
260
264 double Cog;
265
270 double Sog;
271
273 double Var;
274
279 double Hdm;
280
286 double Hdt;
287
293 time_t FixTime;
294
301 int nSats;
302};
303
308public:
309 double Xte;
311 double Btw;
312 double Dtw;
313 wxString wp_name;
314 bool arrival;
316};
317
326
331public:
332 int MMSI;
333 int Class;
335 double SOG;
336 double COG;
337 double HDG;
338 double Lon;
339 double Lat;
340 int ROTAIS;
341 char CallSign[8];
342 char ShipName[21];
343 unsigned char ShipType;
344 int IMO;
345
346 double Range_NM;
347 double Brg;
348
349 // Per target collision parameters
351 double TCPA;
352 double CPA;
353
355};
356
371
381
391
414
418typedef struct _ExtentPI {
419 double SLAT;
420 double WLON;
421 double NLAT;
422 double ELON;
424
425// PlugInChartBase::Init() init_flags constants
428#define PI_FULL_INIT 0
431#define PI_HEADER_ONLY 1
433#define PI_THUMB_ONLY 2
434
448class DECL_EXP PlugInChartBase : public wxObject {
449public:
450 // These methods Must be overriden in any derived class
452 virtual ~PlugInChartBase();
453
474 virtual wxString GetFileSearchMask(void);
475
500 virtual int Init(const wxString &full_path, int init_flags);
501
521 virtual void SetColorScheme(int cs, bool bApplyImmediate);
522
543 virtual double GetNormalScaleMin(double canvas_scale_factor,
544 bool b_allow_overzoom);
562 virtual double GetNormalScaleMax(double canvas_scale_factor,
563 int canvas_width);
578 virtual double GetNearestPreferredScalePPM(double target_scale_ppm);
579
597 virtual bool GetChartExtent(ExtentPI *pext);
598
625 virtual wxBitmap &RenderRegionView(const PlugIn_ViewPort &VPoint,
626 const wxRegion &Region);
627
642 virtual bool AdjustVP(PlugIn_ViewPort &vp_last, PlugIn_ViewPort &vp_proposed);
643
659 virtual void GetValidCanvasRegion(const PlugIn_ViewPort &VPoint,
660 wxRegion *pValidRegion);
661
679 virtual int GetCOVREntries() { return 0; }
680
696 virtual int GetCOVRTablePoints(int iTable) { return 0; }
697
711 virtual int GetCOVRTablenPoints(int iTable) { return 0; }
712
733 virtual float *GetCOVRTableHead(int iTable) { return (float *)NULL; }
734
757 virtual wxBitmap *GetThumbnail(int tnx, int tny, int cs);
758
759 // Accessors, need not be overridden in derived class if the member
760 // variables are maintained
761
775 virtual wxString GetFullPath() const { return m_FullPath; }
776
798 virtual ChartTypeEnumPI GetChartType() { return m_ChartType; }
799
813 virtual ChartFamilyEnumPI GetChartFamily() { return m_ChartFamily; }
814
834 virtual OcpnProjTypePI GetChartProjection() { return m_projection; }
835
848 virtual wxString GetName() { return m_Name; }
849
860 virtual wxString GetDescription() { return m_Description; }
861
873 virtual wxString GetID() { return m_ID; }
874
888 virtual wxString GetSE() { return m_SE; }
889
905 virtual wxString GetDepthUnits() { return m_DepthUnits; }
906
923 virtual wxString GetSoundingsDatum() { return m_SoundingsDatum; }
924
940 virtual wxString GetDatumString() { return m_datum_str; }
941
955 virtual wxString GetExtraInfo() { return m_ExtraInfo; }
956
969 virtual wxString GetPubDate() { return m_PubYear; }
970
984 virtual double GetChartErrorFactor() { return m_Chart_Error_Factor; }
985
1001 virtual ChartDepthUnitTypePI GetDepthUnitId() { return m_depth_unit_id; }
1002
1017 virtual bool IsReadyToRender() { return m_bReadyToRender; }
1018
1031 virtual int GetNativeScale() { return m_Chart_Scale; };
1032
1045 virtual double GetChartSkew() { return m_Chart_Skew; }
1046
1059 virtual wxDateTime GetEditionDate(void) { return m_EdDate; }
1060
1061 // Methods pertaining to CHART_FAMILY_RASTER type PlugIn charts only
1062
1081 virtual void ComputeSourceRectangle(const PlugIn_ViewPort &vp,
1082 wxRect *pSourceRect);
1083
1098 virtual double GetRasterScaleFactor();
1099
1120 virtual bool GetChartBits(wxRect &source, unsigned char *pPix, int sub_samp);
1121
1133 virtual int GetSize_X();
1134
1146 virtual int GetSize_Y();
1147
1162 virtual void latlong_to_chartpix(double lat, double lon, double &pixx,
1163 double &pixy);
1164
1179 virtual void chartpix_to_latlong(double pixx, double pixy, double *plat,
1180 double *plon);
1181
1182protected:
1183 ChartTypeEnumPI m_ChartType;
1184 ChartFamilyEnumPI m_ChartFamily;
1185
1186 wxString m_FullPath;
1187 OcpnProjTypePI m_projection;
1188 int m_Chart_Scale;
1189 double m_Chart_Skew;
1190
1191 wxDateTime m_EdDate;
1192 bool m_bReadyToRender;
1193
1194 wxString m_Name;
1195 wxString m_Description;
1196 wxString m_ID;
1197 wxString m_SE;
1198 wxString m_SoundingsDatum;
1199 wxString m_datum_str;
1200 wxString m_PubYear;
1201 wxString m_DepthUnits;
1202 wxString m_ExtraInfo;
1203
1204 ChartDepthUnitTypePI m_depth_unit_id;
1205
1206 double m_Chart_Error_Factor;
1207};
1208
1209// Declare an array of PlugIn_AIS_Targets
1210WX_DEFINE_ARRAY_PTR(PlugIn_AIS_Target *, ArrayOfPlugIn_AIS_Targets);
1211
1226class DECL_EXP opencpn_plugin {
1227public:
1228 opencpn_plugin(void *pmgr) {}
1229 virtual ~opencpn_plugin();
1230
1231 // Public API to the PlugIn class
1232
1233 // This group of methods is required, and will be called by the opencpn
1234 // host opencpn PlugIns must implement this group
1235
1250 virtual int Init(void);
1251
1261 virtual bool DeInit(void);
1262
1275 virtual int GetAPIVersionMajor();
1276
1289 virtual int GetAPIVersionMinor();
1290
1302 virtual int GetPlugInVersionMajor();
1303
1315 virtual int GetPlugInVersionMinor();
1316
1329 virtual wxBitmap *GetPlugInBitmap();
1330
1331 // These three methods should produce valid, meaningful strings always
1332 // ---EVEN IF--- the PlugIn has not (yet) been initialized.
1333 // They are used by the PlugInManager GUI
1334
1346 virtual wxString GetCommonName();
1347
1359 virtual wxString GetShortDescription();
1360
1374 virtual wxString GetLongDescription();
1375
1376 // This group is optional.
1377 // PlugIns may override any of these methods as required
1378
1390 virtual void SetDefaults(void);
1391
1405 virtual int GetToolbarToolCount(void);
1406
1419 virtual int GetToolboxPanelCount(void);
1420
1435 virtual void SetupToolboxPanel(int page_sel, wxNotebook *pnotebook);
1436
1452 virtual void OnCloseToolboxPanel(int page_sel, int ok_apply_cancel);
1453
1467 virtual void ShowPreferencesDialog(wxWindow *parent);
1468
1494 virtual bool RenderOverlay(wxMemoryDC *pmdc, PlugIn_ViewPort *vp);
1495
1509 virtual void SetCursorLatLon(double lat, double lon);
1528 virtual void SetCurrentViewPort(PlugIn_ViewPort &vp);
1529
1555 virtual void SetPositionFix(PlugIn_Position_Fix &pfix);
1570 virtual void SetNMEASentence(wxString &sentence);
1587 virtual void SetAISSentence(wxString &sentence);
1588
1598 virtual void ProcessParentResize(int x, int y);
1599
1611 virtual void SetColorScheme(PI_ColorScheme cs);
1612
1621 virtual void OnToolbarToolCallback(int id);
1622
1631 virtual void OnContextMenuItemCallback(int id);
1632
1640 virtual void UpdateAuiStatus(void);
1641
1653 virtual wxArrayString GetDynamicChartClassNameArray(void);
1654};
1655
1656// the types of the class factories used to create PlugIn instances
1657typedef opencpn_plugin *create_t(void *);
1658typedef void destroy_t(opencpn_plugin *);
1659
1660#ifdef __clang__
1661#pragma clang diagnostic push
1662#pragma clang diagnostic ignored "-Woverloaded-virtual"
1663#endif
1664
1665class DECL_EXP opencpn_plugin_16 : public opencpn_plugin {
1666public:
1667 opencpn_plugin_16(void *pmgr);
1668 virtual ~opencpn_plugin_16();
1669
1671
1689 virtual bool RenderOverlay(wxDC &dc, PlugIn_ViewPort *vp);
1690
1705 virtual void SetPluginMessage(wxString &message_id, wxString &message_body);
1706};
1707
1708class DECL_EXP opencpn_plugin_17 : public opencpn_plugin {
1709public:
1710 opencpn_plugin_17(void *pmgr);
1711 virtual ~opencpn_plugin_17();
1712
1714
1715 virtual bool RenderOverlay(wxDC &dc, PlugIn_ViewPort *vp);
1716 virtual bool RenderGLOverlay(wxGLContext *pcontext, PlugIn_ViewPort *vp);
1717
1718 virtual void SetPluginMessage(wxString &message_id, wxString &message_body);
1719};
1720
1721class DECL_EXP opencpn_plugin_18 : public opencpn_plugin {
1722public:
1723 opencpn_plugin_18(void *pmgr);
1724 virtual ~opencpn_plugin_18();
1725
1727
1728 virtual bool RenderOverlay(wxDC &dc, PlugIn_ViewPort *vp);
1750 virtual bool RenderGLOverlay(wxGLContext *pcontext, PlugIn_ViewPort *vp);
1751 virtual void SetPluginMessage(wxString &message_id, wxString &message_body);
1752
1773 virtual void SetPositionFixEx(PlugIn_Position_Fix_Ex &pfix);
1774};
1775
1776#ifdef __clang__
1777#pragma clang diagnostic pop
1778#endif
1779
1780class DECL_EXP opencpn_plugin_19 : public opencpn_plugin_18 {
1781public:
1782 opencpn_plugin_19(void *pmgr);
1783 virtual ~opencpn_plugin_19();
1784
1792 virtual void OnSetupOptions(void);
1793};
1794
1795class DECL_EXP opencpn_plugin_110 : public opencpn_plugin_19 {
1796public:
1797 opencpn_plugin_110(void *pmgr);
1798 virtual ~opencpn_plugin_110();
1799
1800 virtual void LateInit(void); // If WANTS_LATE_INIT is returned by Init()
1801};
1802
1804public:
1805 opencpn_plugin_111(void *pmgr);
1806 virtual ~opencpn_plugin_111();
1807};
1808
1810public:
1811 opencpn_plugin_112(void *pmgr);
1812 virtual ~opencpn_plugin_112();
1813
1823 virtual bool MouseEventHook(wxMouseEvent &event);
1824
1839 virtual void SendVectorChartObjectInfo(wxString &chart, wxString &feature,
1840 wxString &objname, double lat,
1841 double lon, double scale,
1842 int nativescale);
1843};
1844
1846public:
1847 opencpn_plugin_113(void *pmgr);
1848 virtual ~opencpn_plugin_113();
1849
1859 virtual bool KeyboardEventHook(wxKeyEvent &event);
1860
1868 virtual void OnToolbarToolDownCallback(int id);
1869
1877 virtual void OnToolbarToolUpCallback(int id);
1878};
1879
1881public:
1882 opencpn_plugin_114(void *pmgr);
1883 virtual ~opencpn_plugin_114();
1884};
1885
1887public:
1888 opencpn_plugin_115(void *pmgr);
1889 virtual ~opencpn_plugin_115();
1890};
1891
1893public:
1894 opencpn_plugin_116(void *pmgr);
1895 virtual ~opencpn_plugin_116();
1908 virtual bool RenderGLOverlayMultiCanvas(wxGLContext *pcontext,
1909 PlugIn_ViewPort *vp, int canvasIndex);
1910
1923 virtual bool RenderOverlayMultiCanvas(wxDC &dc, PlugIn_ViewPort *vp,
1924 int canvasIndex);
1933 virtual void PrepareContextMenu(int canvasIndex);
1934};
1935
1937public:
1938 opencpn_plugin_117(void *pmgr);
1945 virtual int GetPlugInVersionPatch();
1946
1948 virtual int GetPlugInVersionPost();
1949
1951 virtual const char *GetPlugInVersionPre();
1952
1954 virtual const char *GetPlugInVersionBuild();
1955
1956 /*Provide active leg data to plugins*/
1957 virtual void SetActiveLegInfo(Plugin_Active_Leg_Info &leg_info);
1958};
1959
1961public:
1962 opencpn_plugin_118(void *pmgr);
1963
1966
1975#ifdef _MSC_VER
1976 virtual bool RenderGLOverlayMultiCanvas(wxGLContext *pcontext,
1977 PlugIn_ViewPort *vp, int canvasIndex,
1978 int priority = -1);
1979#else
1980 virtual bool RenderGLOverlayMultiCanvas(wxGLContext *pcontext,
1981 PlugIn_ViewPort *vp, int canvasIndex,
1982 int priority);
1983
1984 bool RenderGLOverlayMultiCanvas(wxGLContext *pcontext, PlugIn_ViewPort *vp,
1985 int canvas_ix) override {
1986 return RenderGLOverlayMultiCanvas(pcontext, vp, canvas_ix, -1);
1987 }
1988#endif
1989
1998#ifdef _MSC_VER
1999 virtual bool RenderOverlayMultiCanvas(wxDC &dc, PlugIn_ViewPort *vp,
2000 int canvasIndex, int priority = -1);
2001#else
2002 virtual bool RenderOverlayMultiCanvas(wxDC &dc, PlugIn_ViewPort *vp,
2003 int canvas_ix, int priority);
2005 int canvas_ix) override {
2006 return RenderOverlayMultiCanvas(dc, vp, canvas_ix, -1);
2007 }
2008#endif
2009};
2010
2012public:
2013 opencpn_plugin_119(void *pmgr);
2014
2032 virtual void PreShutdownHook();
2033};
2034
2036public:
2037 opencpn_plugin_120(void *pmgr);
2038
2039 virtual void OnContextMenuItemCallbackExt(int id, std::string obj_ident,
2040 std::string obj_type, double lat,
2041 double lon);
2042};
2043
2044//------------------------------------------------------------------
2045// Route and Waypoint PlugIn support
2046//
2047//------------------------------------------------------------------
2048
2060class DECL_EXP Plugin_Hyperlink {
2061public:
2062 wxString DescrText;
2063 wxString Link;
2064 wxString Type;
2065};
2066
2067WX_DECLARE_LIST(Plugin_Hyperlink, Plugin_HyperlinkList);
2068
2083class DECL_EXP PlugIn_Waypoint {
2084public:
2089
2099 PlugIn_Waypoint(double lat, double lon, const wxString &icon_ident,
2100 const wxString &wp_name, const wxString &GUID = _T(""));
2102
2103 double m_lat;
2104 double m_lon;
2105 wxString m_GUID;
2106 wxString m_MarkName;
2108 wxDateTime m_CreateTime;
2110 wxString m_IconName;
2111
2112 Plugin_HyperlinkList *m_HyperlinkList;
2113};
2114
2115WX_DECLARE_LIST(PlugIn_Waypoint, Plugin_WaypointList);
2116
2123class DECL_EXP PlugIn_Route {
2124public:
2125 PlugIn_Route(void);
2126 ~PlugIn_Route(void);
2127
2128 wxString m_NameString;
2129 wxString m_StartString;
2130 wxString m_EndString;
2131 wxString m_GUID;
2132
2137 Plugin_WaypointList *pWaypointList;
2138};
2139
2153class DECL_EXP PlugIn_Track {
2154public:
2155 PlugIn_Track(void);
2156 ~PlugIn_Track(void);
2157
2158 wxString m_NameString;
2159 wxString m_StartString;
2160 wxString m_EndString;
2161 wxString m_GUID;
2162
2169 Plugin_WaypointList *pWaypointList;
2170};
2171
2172//----------------------------------------------------------------------------------------------------------
2173// The PlugIn CallBack API Definition
2174//
2175// The API back up to the PlugIn Manager
2176// PlugIns may call these static functions as necessary for system services
2177//
2178//----------------------------------------------------------------------------------------------------------
2179
2200extern "C" DECL_EXP int InsertPlugInTool(wxString label, wxBitmap *bitmap,
2201 wxBitmap *bmpRollover, wxItemKind kind,
2202 wxString shortHelp, wxString longHelp,
2203 wxObject *clientData, int position,
2204 int tool_sel, opencpn_plugin *pplugin);
2212extern "C" DECL_EXP void RemovePlugInTool(int tool_id);
2213
2222extern "C" DECL_EXP void SetToolbarToolViz(int item, bool viz);
2223
2232extern "C" DECL_EXP void SetToolbarItemState(int item, bool toggle);
2233
2243extern "C" DECL_EXP void SetToolbarToolBitmaps(int item, wxBitmap *bitmap,
2244 wxBitmap *bmpRollover);
2263extern "C" DECL_EXP int InsertPlugInToolSVG(
2264 wxString label, wxString SVGfile, wxString SVGfileRollover,
2265 wxString SVGfileToggled, wxItemKind kind, wxString shortHelp,
2266 wxString longHelp, wxObject *clientData, int position, int tool_sel,
2267 opencpn_plugin *pplugin);
2268
2279extern "C" DECL_EXP void SetToolbarToolBitmapsSVG(int item, wxString SVGfile,
2280 wxString SVGfileRollover,
2281 wxString SVGfileToggled);
2291extern "C" DECL_EXP int AddCanvasContextMenuItem(wxMenuItem *pitem,
2292 opencpn_plugin *pplugin);
2300extern "C" DECL_EXP void RemoveCanvasContextMenuItem(int item);
2301
2310extern "C" DECL_EXP void SetCanvasContextMenuItemViz(int item, bool viz);
2311
2320extern "C" DECL_EXP void SetCanvasContextMenuItemGrey(int item, bool grey);
2321
2331extern "C" DECL_EXP wxFileConfig *GetOCPNConfigObject(void);
2332
2340extern "C" DECL_EXP void RequestRefresh(wxWindow *);
2341
2351extern "C" DECL_EXP bool GetGlobalColor(wxString colorName, wxColour *pcolour);
2352
2364extern "C" DECL_EXP void GetCanvasPixLL(PlugIn_ViewPort *vp, wxPoint *pp,
2365 double lat, double lon);
2377extern "C" DECL_EXP void GetCanvasLLPix(PlugIn_ViewPort *vp, wxPoint p,
2378 double *plat, double *plon);
2386extern "C" DECL_EXP wxWindow *GetOCPNCanvasWindow();
2387
2426extern "C" DECL_EXP wxFont *OCPNGetFont(wxString TextElement,
2427 int default_size = 0);
2428
2441extern "C" DECL_EXP wxString *GetpSharedDataLocation();
2442
2451extern "C" DECL_EXP ArrayOfPlugIn_AIS_Targets *GetAISTargetArray(void);
2452
2462extern "C" DECL_EXP wxAuiManager *GetFrameAuiManager(void);
2463
2472extern "C" DECL_EXP bool AddLocaleCatalog(wxString catalog);
2473
2481extern "C" DECL_EXP void PushNMEABuffer(wxString str);
2482
2492extern DECL_EXP wxXmlDocument GetChartDatabaseEntryXML(int dbIndex,
2493 bool b_getGeom);
2504extern DECL_EXP bool UpdateChartDBInplace(wxArrayString dir_array,
2505 bool b_force_update,
2506 bool b_ProgressDialog);
2514extern DECL_EXP wxArrayString GetChartDBDirArrayString();
2515
2524extern "C" DECL_EXP void SendPluginMessage(wxString message_id,
2525 wxString message_body);
2533extern "C" DECL_EXP void DimeWindow(wxWindow *);
2534
2542extern "C" DECL_EXP void JumpToPosition(double lat, double lon, double scale);
2543
2544/* API 1.9 adds some common cartographic functions to avoid unnecessary code
2545 * duplication */
2546/* Study the original OpenCPN source (georef.c) for functional definitions */
2547
2572extern "C" DECL_EXP void PositionBearingDistanceMercator_Plugin(
2573 double lat, double lon, double brg, double dist, double *dlat,
2574 double *dlon);
2597extern "C" DECL_EXP void DistanceBearingMercator_Plugin(
2598 double lat0, double lon0, double lat1, double lon1, double *brg,
2599 double *dist);
2600
2610extern "C" DECL_EXP double DistGreatCircle_Plugin(double slat, double slon,
2611 double dlat, double dlon);
2622extern "C" DECL_EXP void toTM_Plugin(float lat, float lon, float lat0,
2623 float lon0, double *x, double *y);
2624
2635extern "C" DECL_EXP void fromTM_Plugin(double x, double y, double lat0,
2636 double lon0, double *lat, double *lon);
2637
2648extern "C" DECL_EXP void toSM_Plugin(double lat, double lon, double lat0,
2649 double lon0, double *x, double *y);
2650
2661extern "C" DECL_EXP void fromSM_Plugin(double x, double y, double lat0,
2662 double lon0, double *lat, double *lon);
2663
2674extern "C" DECL_EXP void toSM_ECC_Plugin(double lat, double lon, double lat0,
2675 double lon0, double *x, double *y);
2676
2687extern "C" DECL_EXP void fromSM_ECC_Plugin(double x, double y, double lat0,
2688 double lon0, double *lat,
2689 double *lon);
2690
2701extern "C" DECL_EXP bool DecodeSingleVDOMessage(const wxString &str,
2703 wxString *acc);
2704
2711extern "C" DECL_EXP int GetChartbarHeight(void);
2742extern "C" DECL_EXP bool GetActiveRoutepointGPX(char *buffer,
2743 unsigned int buffer_length);
2744
2745/* API 1.9 */
2746
2775
2790extern DECL_EXP wxScrolledWindow *AddOptionsPage(OptionsParentPI parent,
2791 wxString title);
2792
2800extern DECL_EXP bool DeleteOptionsPage(wxScrolledWindow *page);
2801
2802/* API 1.10 */
2803
2804/* API 1.10 adds some common functions to avoid unnecessary code duplication */
2805/* Study the original OpenCPN source for functional definitions */
2816extern "C" DECL_EXP double toUsrDistance_Plugin(double nm_distance,
2817 int unit = -1);
2818
2827extern "C" DECL_EXP double fromUsrDistance_Plugin(double usr_distance,
2828 int unit = -1);
2829
2838extern "C" DECL_EXP double toUsrSpeed_Plugin(double kts_speed, int unit = -1);
2839
2848extern "C" DECL_EXP double fromUsrSpeed_Plugin(double usr_speed, int unit = -1);
2849
2858extern "C" DECL_EXP double toUsrTemp_Plugin(double cel_temp, int unit = -1);
2859
2868extern "C" DECL_EXP double fromUsrTemp_Plugin(double usr_temp, int unit = -1);
2869
2877extern DECL_EXP wxString getUsrDistanceUnit_Plugin(int unit = -1);
2878
2886extern DECL_EXP wxString getUsrSpeedUnit_Plugin(int unit = -1);
2887
2895extern DECL_EXP wxString getUsrTempUnit_Plugin(int unit = -1);
2896
2904extern DECL_EXP wxString getUsrWindSpeedUnit_Plugin(int unit = -1);
2905
2914extern DECL_EXP double toUsrWindSpeed_Plugin(double kts_wspeed, int unit = -1);
2915
2924extern DECL_EXP double fromUsrWindSpeed_Plugin(double usr_wspeed,
2925 int unit = -1);
2926
2934extern DECL_EXP wxString getUsrDepthUnit_Plugin(int unit = -1);
2935
2944extern DECL_EXP double toUsrDepth_Plugin(double m_depth, int unit = -1);
2945
2954extern DECL_EXP double fromUsrDepth_Plugin(double usr_depth, int unit = -1);
2955
2972extern DECL_EXP double fromDMM_PlugIn(wxString sdms);
2973
2987struct DECL_EXP DateTimeFormatOptions {
2989 virtual ~DateTimeFormatOptions();
2990
3011
3027 wxString time_zone;
3028
3036
3042
3043 int version = 1; // For future compatibility checks
3044
3064 format_string = fmt;
3065 return *this;
3066 }
3067
3086 DateTimeFormatOptions &SetTimezone(const wxString &tz) {
3087 time_zone = tz;
3088 return *this;
3089 }
3090
3098 show_timezone = show;
3099 return *this;
3100 }
3101
3120 longitude = lon;
3121 return *this;
3122 }
3123};
3124
3144extern DECL_EXP wxString toUsrDateTimeFormat_Plugin(
3145 const wxDateTime date_time,
3147
3159extern DECL_EXP wxString GetNewGUID();
3160
3173extern "C" DECL_EXP bool PlugIn_GSHHS_CrossesLand(double lat1, double lon1,
3174 double lat2, double lon2);
3181extern DECL_EXP void PlugInPlaySound(wxString &sound_file);
3182
3183// API 1.10 Route and Waypoint Support
3184
3193extern DECL_EXP wxBitmap *FindSystemWaypointIcon(wxString &icon_name);
3194
3205extern DECL_EXP bool AddCustomWaypointIcon(wxBitmap *pimage, wxString key,
3206 wxString description);
3207
3217extern DECL_EXP bool AddSingleWaypoint(PlugIn_Waypoint *pwaypoint,
3218 bool b_permanent = true);
3219
3228extern DECL_EXP bool DeleteSingleWaypoint(wxString &GUID);
3229
3238extern DECL_EXP bool UpdateSingleWaypoint(PlugIn_Waypoint *pwaypoint);
3239
3249extern DECL_EXP bool AddPlugInRoute(PlugIn_Route *proute,
3250 bool b_permanent = true);
3251
3260extern DECL_EXP bool DeletePlugInRoute(wxString &GUID);
3261
3271extern DECL_EXP bool UpdatePlugInRoute(PlugIn_Route *proute);
3272
3282extern DECL_EXP bool AddPlugInTrack(PlugIn_Track *ptrack,
3283 bool b_permanent = true);
3284
3293extern DECL_EXP bool DeletePlugInTrack(wxString &GUID);
3294
3304extern DECL_EXP bool UpdatePlugInTrack(PlugIn_Track *ptrack);
3305
3306/* API 1.11 */
3307
3308/* API 1.11 adds some more common functions to avoid unnecessary code
3309 * duplication */
3310
3319wxColour DECL_EXP GetBaseGlobalColor(wxString colorName);
3320
3334int DECL_EXP OCPNMessageBox_PlugIn(wxWindow *parent, const wxString &message,
3335 const wxString &caption = _T("Message"),
3336 int style = wxOK, int x = -1, int y = -1);
3337
3352extern DECL_EXP wxString toSDMM_PlugIn(int NEflag, double a,
3353 bool hi_precision = true);
3354
3364extern "C" DECL_EXP wxString *GetpPrivateApplicationDataLocation();
3365
3373extern DECL_EXP wxString GetOCPN_ExePath(void);
3374
3383extern "C" DECL_EXP wxString *GetpPlugInLocation();
3384
3393extern DECL_EXP wxString GetPlugInPath(opencpn_plugin *pplugin);
3394
3404extern "C" DECL_EXP int AddChartToDBInPlace(wxString &full_path,
3405 bool b_RefreshCanvas);
3412extern "C" DECL_EXP int RemoveChartFromDBInPlace(wxString &full_path);
3413
3422extern DECL_EXP wxString GetLocaleCanonicalName();
3423
3438#define PLIB_CAPS_LINE_VBO 1
3442#define PLIB_CAPS_LINE_BUFFER 1 << 1
3443
3447#define PLIB_CAPS_SINGLEGEO_BUFFER 1 << 2
3448
3452#define PLIB_CAPS_OBJSEGLIST 1 << 3
3453
3457#define PLIB_CAPS_OBJCATMUTATE 1 << 4
3458
3459class PI_S57Obj;
3460
3461WX_DECLARE_LIST(PI_S57Obj, ListOfPI_S57Obj);
3462
3463// ----------------------------------------------------------------------------
3464// PlugInChartBaseGL
3465// Derived from PlugInChartBase, add OpenGL Vector chart support
3466// ----------------------------------------------------------------------------
3467
3480class DECL_EXP PlugInChartBaseGL : public PlugInChartBase {
3481public:
3483 virtual ~PlugInChartBaseGL();
3484
3499 virtual int RenderRegionViewOnGL(const wxGLContext &glc,
3500 const PlugIn_ViewPort &VPoint,
3501 const wxRegion &Region, bool b_use_stencil);
3502
3515 virtual ListOfPI_S57Obj *GetObjRuleListAtLatLon(float lat, float lon,
3516 float select_radius,
3517 PlugIn_ViewPort *VPoint);
3518
3528 virtual wxString CreateObjDescriptions(ListOfPI_S57Obj *obj_list);
3529
3535 virtual int GetNoCOVREntries();
3536
3543 virtual int GetNoCOVRTablePoints(int iTable);
3544
3551 virtual int GetNoCOVRTablenPoints(int iTable);
3552
3559 virtual float *GetNoCOVRTableHead(int iTable);
3560};
3561
3562// ----------------------------------------------------------------------------
3563// PlugInChartBaseGLPlus2
3564// Derived from PlugInChartBaseGL, add additional chart management methods
3565// ----------------------------------------------------------------------------
3566
3576public:
3578 virtual ~PlugInChartBaseGLPlus2();
3579
3596 virtual ListOfPI_S57Obj *GetLightsObjRuleListVisibleAtLatLon(
3597 float lat, float lon, PlugIn_ViewPort *VPoint);
3598};
3599
3600// ----------------------------------------------------------------------------
3601// PlugInChartBaseExtended
3602// Derived from PlugInChartBase, add extended chart support methods
3603// ----------------------------------------------------------------------------
3604
3613public:
3615 virtual ~PlugInChartBaseExtended();
3616
3629 virtual int RenderRegionViewOnGL(const wxGLContext &glc,
3630 const PlugIn_ViewPort &VPoint,
3631 const wxRegion &Region, bool b_use_stencil);
3632
3643 virtual wxBitmap &RenderRegionViewOnDCNoText(const PlugIn_ViewPort &VPoint,
3644 const wxRegion &Region);
3645
3656 virtual bool RenderRegionViewOnDCTextOnly(wxMemoryDC &dc,
3657 const PlugIn_ViewPort &VPoint,
3658 const wxRegion &Region);
3659
3671 virtual int RenderRegionViewOnGLNoText(const wxGLContext &glc,
3672 const PlugIn_ViewPort &VPoint,
3673 const wxRegion &Region,
3674 bool b_use_stencil);
3675
3687 virtual int RenderRegionViewOnGLTextOnly(const wxGLContext &glc,
3688 const PlugIn_ViewPort &VPoint,
3689 const wxRegion &Region,
3690 bool b_use_stencil);
3691
3692 virtual ListOfPI_S57Obj *GetObjRuleListAtLatLon(float lat, float lon,
3693 float select_radius,
3694 PlugIn_ViewPort *VPoint);
3695 virtual wxString CreateObjDescriptions(ListOfPI_S57Obj *obj_list);
3696
3697 virtual int GetNoCOVREntries();
3698 virtual int GetNoCOVRTablePoints(int iTable);
3699 virtual int GetNoCOVRTablenPoints(int iTable);
3700 virtual float *GetNoCOVRTableHead(int iTable);
3701
3708 virtual void ClearPLIBTextList();
3709};
3710
3711// ----------------------------------------------------------------------------
3712// PlugInChartBaseExtendedPlus2
3713// Derived from PlugInChartBaseExtended, add additional extended chart support
3714// methods
3715// ----------------------------------------------------------------------------
3716
3718public:
3721
3722 virtual ListOfPI_S57Obj *GetLightsObjRuleListVisibleAtLatLon(
3723 float lat, float lon, PlugIn_ViewPort *VPoint);
3724};
3725
3726class wxArrayOfS57attVal;
3727
3746
3770
3799
3813
3839
3847class DECL_EXP PI_S57Obj {
3848public:
3849 // Public Methods
3850 PI_S57Obj();
3851
3852public:
3853 // Instance Data
3854 char FeatureName[8];
3856
3858 wxArrayOfS57attVal *attVal;
3860
3861 int iOBJL;
3862 int Index;
3863
3864 double x;
3865 double y;
3866 double z;
3867 int npt;
3868 void *geoPt;
3869 double *geoPtz;
3870 double *geoPtMulti;
3871
3873
3874 double m_lat;
3875 double m_lon;
3876
3879
3880 double lat_min;
3881 double lat_max;
3882 double lon_min;
3883 double lon_max;
3884
3886
3888 int nRef;
3889
3890 bool bIsAton;
3892
3897
3899
3903
3904 // Coordinate transform coefficients
3905 double x_rate;
3906 double y_rate;
3907 double x_origin;
3908 double y_origin;
3909
3910 // OpenGL rendering parameters
3915
3919};
3920
3926wxString DECL_EXP PI_GetPLIBColorScheme();
3935int DECL_EXP PI_GetPLIBDepthUnitInt();
3936
3944int DECL_EXP PI_GetPLIBSymbolStyle();
3945
3953int DECL_EXP PI_GetPLIBBoundaryStyle();
3954
3961int DECL_EXP PI_GetPLIBStateHash();
3962
3968double DECL_EXP PI_GetPLIBMarinerSafetyContour();
3969
3980bool DECL_EXP PI_GetObjectRenderBox(PI_S57Obj *pObj, double *lat_min,
3981 double *lat_max, double *lon_min,
3982 double *lon_max);
3983
3989void DECL_EXP PI_UpdateContext(PI_S57Obj *pObj);
3990
3998bool DECL_EXP PI_PLIBObjectRenderCheck(PI_S57Obj *pObj, PlugIn_ViewPort *vp);
3999
4012
4020
4028
4035void DECL_EXP PI_PLIBSetLineFeaturePriority(PI_S57Obj *pObj, int prio);
4036
4041void DECL_EXP PI_PLIBPrepareForNewRender(void);
4042
4048void DECL_EXP PI_PLIBFreeContext(void *pContext);
4049
4059void DECL_EXP PI_PLIBSetRenderCaps(unsigned int flags);
4060
4070bool DECL_EXP PI_PLIBSetContext(PI_S57Obj *pObj);
4071
4086int DECL_EXP PI_PLIBRenderObjectToDC(wxDC *pdc, PI_S57Obj *pObj,
4087 PlugIn_ViewPort *vp);
4088
4105int DECL_EXP PI_PLIBRenderAreaToDC(wxDC *pdc, PI_S57Obj *pObj,
4106 PlugIn_ViewPort *vp, wxRect rect,
4107 unsigned char *pixbuf);
4108
4123int DECL_EXP PI_PLIBRenderAreaToGL(const wxGLContext &glcc, PI_S57Obj *pObj,
4124 PlugIn_ViewPort *vp, wxRect &render_rect);
4125
4142int DECL_EXP PI_PLIBRenderObjectToGL(const wxGLContext &glcc, PI_S57Obj *pObj,
4143 PlugIn_ViewPort *vp, wxRect &render_rect);
4144
4145/* API 1.11 OpenGL Display List and vertex buffer object routines
4146
4147 Effectively these two routines cancel each other so all
4148 of the translation, scaling and rotation can be done by opengl.
4149
4150 Display lists need only be built infrequently, but used in each frame
4151 greatly accelerates the speed of rendering. This avoids costly calculations,
4152 and also allows the vertexes to be stored in graphics memory.
4153
4154 static int dl = 0;
4155 glPushMatrix();
4156 PlugInMultMatrixViewport(current_viewport);
4157 if(dl)
4158 glCallList(dl);
4159 else {
4160 dl = glGenLists(1);
4161 PlugInViewPort norm_viewport = current_viewport;
4162 NormalizeViewPort(norm_viewport);
4163 glNewList(dl, GL_COMPILE_AND_EXECUTE);
4164 ... // use norm_viewport with GetCanvasLLPix here
4165 glEndList();
4166 }
4167 glPopMatrix();
4168 ... // use current_viewport with GetCanvasLLPix again
4169*/
4170
4180extern DECL_EXP bool PlugInHasNormalizedViewPort(PlugIn_ViewPort *vp);
4181
4196extern DECL_EXP void PlugInMultMatrixViewport(PlugIn_ViewPort *vp,
4197 float lat = 0, float lon = 0);
4198
4213extern DECL_EXP void PlugInNormalizeViewport(PlugIn_ViewPort *vp, float lat = 0,
4214 float lon = 0);
4215
4216class wxPoint2DDouble;
4217
4229extern "C" DECL_EXP void GetDoubleCanvasPixLL(PlugIn_ViewPort *vp,
4230 wxPoint2DDouble *pp, double lat,
4231 double lon);
4232
4233/* API 1.13 */
4234/* API 1.13 adds some more common functions to avoid unnecessary code
4235 * duplication */
4236
4245extern DECL_EXP double fromDMM_Plugin(wxString sdms);
4246
4257extern DECL_EXP void SetCanvasRotation(double rotation);
4258
4270extern DECL_EXP void SetCanvasProjection(int projection);
4271
4281extern DECL_EXP bool GetSingleWaypoint(wxString GUID,
4282 PlugIn_Waypoint *pwaypoint);
4283
4296extern DECL_EXP bool CheckEdgePan_PlugIn(int x, int y, bool dragging,
4297 int margin, int delta);
4298
4307extern DECL_EXP wxBitmap GetIcon_PlugIn(const wxString &name);
4308
4316extern DECL_EXP void SetCursor_PlugIn(wxCursor *pPlugin_Cursor = NULL);
4317
4353extern DECL_EXP wxFont *GetOCPNScaledFont_PlugIn(wxString TextElement,
4354 int default_size = 0);
4355
4369extern DECL_EXP wxFont GetOCPNGUIScaledFont_PlugIn(wxString item);
4370
4386extern DECL_EXP double GetOCPNGUIToolScaleFactor_PlugIn(int GUIScaledFactor);
4387
4402extern DECL_EXP double GetOCPNGUIToolScaleFactor_PlugIn();
4403
4418extern DECL_EXP float GetOCPNChartScaleFactor_Plugin();
4419
4427extern DECL_EXP wxColour GetFontColour_PlugIn(wxString TextElement);
4428
4439extern DECL_EXP double GetCanvasTilt();
4440
4451extern DECL_EXP void SetCanvasTilt(double tilt);
4452
4458extern DECL_EXP bool PlugInPlaySoundEx(wxString &sound_file,
4459 int deviceIndex = -1);
4460
4473extern DECL_EXP void AddChartDirectory(wxString &path);
4474
4485extern DECL_EXP void ForceChartDBUpdate();
4486
4498extern DECL_EXP void ForceChartDBRebuild();
4499
4505extern DECL_EXP wxString GetWritableDocumentsDir(void);
4506
4512extern DECL_EXP wxDialog *GetActiveOptionsDialog();
4513
4524extern DECL_EXP wxArrayString GetWaypointGUIDArray(void);
4525
4531extern DECL_EXP wxArrayString GetIconNameArray(void);
4532
4543extern DECL_EXP bool AddPersistentFontKey(wxString TextElement);
4544
4556extern DECL_EXP wxString GetActiveStyleName();
4557
4573extern DECL_EXP wxBitmap GetBitmapFromSVGFile(wxString filename,
4574 unsigned int width,
4575 unsigned int height);
4576
4589extern DECL_EXP bool IsTouchInterface_PlugIn(void);
4590
4591/* Platform optimized File/Dir selector dialogs */
4610extern DECL_EXP int PlatformDirSelectorDialog(wxWindow *parent,
4611 wxString *file_spec,
4612 wxString Title, wxString initDir);
4613
4635extern DECL_EXP int PlatformFileSelectorDialog(wxWindow *parent,
4636 wxString *file_spec,
4637 wxString Title, wxString initDir,
4638 wxString suggestedName,
4639 wxString wildcard);
4640
4641/* OpenCPN HTTP File Download PlugIn Interface */
4642
4643/* Various method Return Codes, etc */
4658
4671
4672// Style definitions for Synchronous file download modal dialogs, if
4673// desired. Abstracted from wxCURL package
4677 0x0002,
4680 OCPN_DLDS_SIZE = 0x0010,
4683 0x0020,
4684
4685 // styles related to the use of wxCurlConnectionSettingsDialog:
4686
4688 0x0040,
4693 0x0100,
4694
4695 OCPN_DLDS_CONN_SETTINGS_ALL = OCPN_DLDS_CONN_SETTINGS_AUTH |
4698
4699 OCPN_DLDS_SHOW_ALL = OCPN_DLDS_ELAPSED_TIME | OCPN_DLDS_ESTIMATED_TIME |
4702 OCPN_DLDS_CONN_SETTINGS_ALL,
4703
4705 OCPN_DLDS_CAN_START = 0x0400,
4708
4710 0x1000,
4711
4712 // by default all available features are enabled:
4713 OCPN_DLDS_DEFAULT_STYLE = OCPN_DLDS_CAN_START | OCPN_DLDS_CAN_PAUSE |
4714 OCPN_DLDS_CAN_ABORT | OCPN_DLDS_SHOW_ALL |
4716};
4717
4718#define ONLINE_CHECK_RETRY \
4719 30 // Recheck the Internet connection availability every ONLINE_CHECK_RETRY s
4720
4741extern DECL_EXP _OCPN_DLStatus OCPN_downloadFile(
4742 const wxString &url, const wxString &outputFile, const wxString &title,
4743 const wxString &message, const wxBitmap &bitmap, wxWindow *parent,
4744 long style, int timeout_secs);
4745
4763extern DECL_EXP _OCPN_DLStatus
4764OCPN_downloadFileBackground(const wxString &url, const wxString &outputFile,
4765 wxEvtHandler *handler, long *handle);
4766
4772extern DECL_EXP void OCPN_cancelDownloadFileBackground(long handle);
4773
4785extern DECL_EXP _OCPN_DLStatus OCPN_postDataHttp(const wxString &url,
4786 const wxString &parameters,
4787 wxString &result,
4788 int timeout_secs);
4789
4795extern DECL_EXP bool OCPN_isOnline();
4796
4797/* Supporting Event for Background downloading */
4798/* OCPN_downloadEvent Definition */
4799
4800/* PlugIn should be ready/able to handle this event after initiating a
4801 * background file transfer
4802 *
4803 * The event as received should be parsed primarily by the getDLEventCondition()
4804 * method. This will allow identification of download start, progress, and end
4805 * states.
4806 *
4807 * Other accessor methods contain status, byte counts, etc.
4808 *
4809 * A PlugIn may safely destroy its EvtHandler after receipt of an
4810 * OCPN_downloadEvent with getDLEventCondition == OCPN_DL_EVENT_TYPE_END
4811 */
4812class DECL_EXP OCPN_downloadEvent : public wxEvent {
4813public:
4814 OCPN_downloadEvent(wxEventType commandType = wxEVT_NULL, int id = 0);
4816
4817 // accessors
4818 _OCPN_DLStatus getDLEventStatus() { return m_stat; }
4819 OCPN_DLCondition getDLEventCondition() { return m_condition; }
4820
4821 void setDLEventStatus(_OCPN_DLStatus stat) { m_stat = stat; }
4822 void setDLEventCondition(OCPN_DLCondition cond) { m_condition = cond; }
4823
4824 void setTotal(long bytes) { m_totalBytes = bytes; }
4825 void setTransferred(long bytes) { m_sofarBytes = bytes; }
4826 long getTotal() { return m_totalBytes; }
4827 long getTransferred() { return m_sofarBytes; }
4828
4829 void setComplete(bool b_complete) { m_b_complete = b_complete; }
4830 bool getComplete() { return m_b_complete; }
4831
4832 // required for sending with wxPostEvent()
4833 wxEvent *Clone() const;
4834
4835private:
4836 OCPN_DLStatus m_stat;
4837 OCPN_DLCondition m_condition;
4838
4839 long m_totalBytes;
4840 long m_sofarBytes;
4841 bool m_b_complete;
4842};
4843
4844// extern WXDLLIMPEXP_CORE const wxEventType wxEVT_DOWNLOAD_EVENT;
4845
4846#ifdef MAKING_PLUGIN
4847extern DECL_IMP wxEventType wxEVT_DOWNLOAD_EVENT;
4848#else
4849extern DECL_EXP wxEventType wxEVT_DOWNLOAD_EVENT;
4850#endif
4851
4852/* API 1.14 */
4853/* API 1.14 adds some more common functions to avoid unnecessary code
4854 * duplication */
4855
4856extern DECL_EXP bool LaunchDefaultBrowser_Plugin(wxString url);
4857
4858// API 1.14 Extra canvas Support
4859
4875extern DECL_EXP void PlugInAISDrawGL(wxGLCanvas *glcanvas,
4876 const PlugIn_ViewPort &vp);
4877
4887extern DECL_EXP bool PlugInSetFontColor(const wxString TextElement,
4888 const wxColour color);
4889
4890// API 1.15
4891
4906extern DECL_EXP double PlugInGetDisplaySizeMM();
4907
4920extern DECL_EXP wxFont *FindOrCreateFont_PlugIn(
4921 int point_size, wxFontFamily family, wxFontStyle style, wxFontWeight weight,
4922 bool underline = false, const wxString &facename = wxEmptyString,
4923 wxFontEncoding encoding = wxFONTENCODING_DEFAULT);
4924
4944
4957
4971extern DECL_EXP void PlugInHandleAutopilotRoute(bool enable);
4972
4973// API 1.16
4974//
4989extern DECL_EXP wxString GetPluginDataDir(const char *plugin_name);
4990
4996extern DECL_EXP bool ShuttingDown(void);
4997
4998// Support for MUI MultiCanvas model
4999
5022extern DECL_EXP wxWindow *PluginGetFocusCanvas();
5023
5032extern DECL_EXP wxWindow *PluginGetOverlayRenderCanvas();
5033
5042extern "C" DECL_EXP void CanvasJumpToPosition(wxWindow *canvas, double lat,
5043 double lon, double scale);
5055extern "C" DECL_EXP int AddCanvasMenuItem(wxMenuItem *pitem,
5056 opencpn_plugin *pplugin,
5057 const char *name = "");
5066extern "C" DECL_EXP void RemoveCanvasMenuItem(int item, const char *name = "");
5067
5077extern "C" DECL_EXP void SetCanvasMenuItemViz(int item, bool viz,
5078 const char *name = "");
5079
5089extern "C" DECL_EXP void SetCanvasMenuItemGrey(int item, bool grey,
5090 const char *name = "");
5091
5092// Extract waypoints, routes and tracks
5098extern DECL_EXP wxString GetSelectedWaypointGUID_Plugin();
5099
5105extern DECL_EXP wxString GetSelectedRouteGUID_Plugin();
5106
5112extern DECL_EXP wxString GetSelectedTrackGUID_Plugin();
5113
5120extern DECL_EXP std::unique_ptr<PlugIn_Waypoint> GetWaypoint_Plugin(
5121 const wxString &);
5122
5129extern DECL_EXP std::unique_ptr<PlugIn_Route> GetRoute_Plugin(const wxString &);
5130
5137extern DECL_EXP std::unique_ptr<PlugIn_Track> GetTrack_Plugin(const wxString &);
5138
5144extern DECL_EXP wxWindow *GetCanvasUnderMouse();
5145
5159extern DECL_EXP int GetCanvasIndexUnderMouse();
5160
5161// extern DECL_EXP std::vector<wxWindow *> GetCanvasArray();
5174extern DECL_EXP wxWindow *GetCanvasByIndex(int canvasIndex);
5175
5186extern DECL_EXP int GetCanvasCount();
5187
5202extern DECL_EXP bool CheckMUIEdgePan_PlugIn(int x, int y, bool dragging,
5203 int margin, int delta,
5204 int canvasIndex);
5205
5214extern DECL_EXP void SetMUICursor_PlugIn(wxCursor *pCursor, int canvasIndex);
5215
5216// API 1.17
5217//
5218
5227extern DECL_EXP wxRect GetMasterToolbarRect();
5228
5248
5256extern DECL_EXP int GetLatLonFormat(void);
5257
5258// API 1.17
5259
5270extern "C" DECL_EXP void ZeroXTE();
5271
5295class DECL_EXP PlugIn_Waypoint_Ex {
5296public:
5298 PlugIn_Waypoint_Ex(double lat, double lon, const wxString &icon_ident,
5299 const wxString &wp_name, const wxString &GUID = "",
5300 const double ScaMin = 1e9, const bool bNameVisible = false,
5301 const int nRanges = 0, const double RangeDistance = 1.0,
5302 const wxColor RangeColor = wxColor(255, 0, 0));
5314 void InitDefaults();
5315
5327 bool GetFSStatus();
5328
5337 int GetRouteMembershipCount();
5338
5339 double m_lat;
5340 double m_lon;
5341 wxString m_GUID;
5342 wxString m_MarkName;
5344 wxDateTime m_CreateTime;
5347
5348 double scamin;
5351
5355
5356 wxString IconName;
5358
5364 Plugin_HyperlinkList *m_HyperlinkList;
5365};
5366
5367WX_DECLARE_LIST(PlugIn_Waypoint_Ex, Plugin_WaypointExList);
5368
5369class DECL_EXP PlugIn_Waypoint_ExV2 {
5370public:
5372 PlugIn_Waypoint_ExV2(double lat, double lon, const wxString &icon_ident,
5373 const wxString &wp_name, const wxString &GUID = "",
5374 const double ScaMin = 1e9, const double ScaMax = 1e6,
5375 const bool bNameVisible = false,
5376 const int nRangeRings = 0,
5377 const double RangeDistance = 1.0,
5378 const int RangeRingSpaceUnits = 0, // 0:nm, 1:km
5379 const wxColor RangeColor = wxColor(255, 0, 0),
5380 const double WaypointArrivalRadius = 0.0,
5381 const bool ShowWaypointRangeRings = false,
5382 const double PlannedSpeed = 0.0,
5383 const wxString TideStation = wxEmptyString);
5384
5385 virtual ~PlugIn_Waypoint_ExV2();
5386
5398 bool GetFSStatus();
5399
5408 int GetRouteMembershipCount();
5409
5410 double m_lat;
5411 double m_lon;
5412 wxString m_GUID;
5413 wxString m_MarkName;
5415 wxDateTime m_CreateTime;
5418
5419 double scamin;
5422
5427
5428 wxString IconName;
5430
5436 Plugin_HyperlinkList *m_HyperlinkList;
5437
5438 // New fields that are not in PlugIn_Waypoint_Ex
5439 double scamax;
5444 wxDateTime m_ETD;
5447
5448protected:
5459 void InitDefaults();
5460};
5461
5462WX_DECLARE_LIST(PlugIn_Waypoint_ExV2, Plugin_WaypointExV2List);
5463
5486class DECL_EXP PlugIn_Route_Ex {
5487public:
5488 PlugIn_Route_Ex(void);
5489 ~PlugIn_Route_Ex(void);
5490
5491 wxString m_NameString;
5492 wxString m_StartString;
5493 wxString m_EndString;
5494 wxString m_GUID;
5497 wxString m_Description;
5498
5504 Plugin_WaypointExList *pWaypointList;
5505};
5506
5521class DECL_EXP PlugIn_Route_ExV2 {
5522public:
5524 virtual ~PlugIn_Route_ExV2();
5525
5526 wxString m_NameString;
5527 wxString m_StartString;
5528 wxString m_EndString;
5529 wxString m_GUID;
5532 wxString m_Description;
5533
5539 Plugin_WaypointExV2List *pWaypointList;
5540};
5541
5549extern DECL_EXP wxArrayString GetRouteGUIDArray(void);
5550
5558extern DECL_EXP wxArrayString GetTrackGUIDArray(void);
5559
5567extern DECL_EXP bool GetSingleWaypointEx(wxString GUID,
5568 PlugIn_Waypoint_Ex *pwaypoint);
5569
5577extern DECL_EXP bool GetSingleWaypointExV2(wxString GUID,
5578 PlugIn_Waypoint_ExV2 *pwaypoint);
5579
5587extern DECL_EXP bool AddSingleWaypointEx(PlugIn_Waypoint_Ex *pwaypoint,
5588 bool b_permanent = true);
5589
5597extern DECL_EXP bool AddSingleWaypointExV2(PlugIn_Waypoint_ExV2 *pwaypoint,
5598 bool b_permanent = true);
5599
5606extern DECL_EXP bool UpdateSingleWaypointEx(PlugIn_Waypoint_Ex *pwaypoint);
5607
5614extern DECL_EXP bool UpdateSingleWaypointExV2(PlugIn_Waypoint_ExV2 *pwaypoint);
5615
5623extern DECL_EXP bool AddPlugInRouteEx(PlugIn_Route_Ex *proute,
5624 bool b_permanent = true);
5625
5632extern DECL_EXP bool AddPlugInRouteExV2(PlugIn_Route_ExV2 *proute,
5633 bool b_permanent = true);
5634
5641extern DECL_EXP bool UpdatePlugInRouteEx(PlugIn_Route_Ex *proute);
5642
5651extern DECL_EXP bool UpdatePlugInRouteExV2(PlugIn_Route_ExV2 *proute);
5652
5661extern DECL_EXP std::unique_ptr<PlugIn_Waypoint_Ex> GetWaypointEx_Plugin(
5662 const wxString &GUID);
5663
5672extern DECL_EXP std::unique_ptr<PlugIn_Waypoint_ExV2> GetWaypointExV2_Plugin(
5673 const wxString &GUID);
5674
5683extern DECL_EXP std::unique_ptr<PlugIn_Route_Ex> GetRouteEx_Plugin(
5684 const wxString &GUID);
5685
5694extern DECL_EXP std::unique_ptr<PlugIn_Route_ExV2> GetRouteExV2_Plugin(
5695 const wxString &GUID);
5696
5702extern DECL_EXP wxString GetActiveWaypointGUID(void);
5703
5709extern DECL_EXP wxString GetActiveRouteGUID(void);
5710
5711// API 1.18
5712
5727extern DECL_EXP double OCPN_GetDisplayContentScaleFactor();
5728
5743extern DECL_EXP double OCPN_GetWinDIPScaleFactor();
5744
5752extern DECL_EXP std::vector<std::string> GetPriorityMaps();
5753
5758extern DECL_EXP void UpdateAndApplyPriorityMaps(std::vector<std::string> map);
5759
5767extern DECL_EXP std::vector<std::string> GetActivePriorityIdentifiers();
5768
5776extern DECL_EXP int GetGlobalWatchdogTimoutSeconds();
5777
5789
5790// FIXME (dave) Implement these
5807extern DECL_EXP wxArrayString GetRouteGUIDArray(OBJECT_LAYER_REQ req);
5808
5824extern DECL_EXP wxArrayString GetTrackGUIDArray(OBJECT_LAYER_REQ req);
5825
5843extern DECL_EXP wxArrayString GetWaypointGUIDArray(OBJECT_LAYER_REQ req);
5844
5847/* Listening to messages. */
5848class ObservableListener;
5849
5851class ObservedEvt;
5852
5853// This is a verbatim copy from observable_evt.h, don't define twice.
5854#ifndef OBSERVABLE_EVT_H
5855#define OBSERVABLE_EVT_H
5856
5857wxDECLARE_EVENT(obsNOTIFY, ObservedEvt);
5858
5873class ObservedEvt : public wxCommandEvent {
5874public:
5881 ObservedEvt(wxEventType commandType = obsNOTIFY, int id = 0)
5882 : wxCommandEvent(commandType, id) {}
5883 ObservedEvt(const ObservedEvt &event) : wxCommandEvent(event) {
5884 this->m_shared_ptr = event.m_shared_ptr;
5885 }
5886
5894 wxEvent *Clone() const { return new ObservedEvt(*this); }
5895
5901 std::shared_ptr<const void> GetSharedPtr() const { return m_shared_ptr; }
5902
5908 void SetSharedPtr(std::shared_ptr<const void> p) { m_shared_ptr = p; }
5909
5910private:
5911 std::shared_ptr<const void> m_shared_ptr;
5912};
5913
5914#endif // OBSERVABLE_EVT_H
5915
5916class ObservableListener;
5917
5925 const uint64_t id;
5930 NMEA2000Id(int value) : id(static_cast<uint64_t>(value)) {};
5931};
5932
5943extern DECL_EXP std::shared_ptr<ObservableListener> GetListener(
5944 NMEA2000Id id, wxEventType ev, wxEvtHandler *handler);
5945
5953 const std::string id;
5958 NMEA0183Id(const std::string &s) : id(s) {};
5959};
5960
5971extern DECL_EXP std::shared_ptr<ObservableListener> GetListener(
5972 NMEA0183Id id, wxEventType ev, wxEvtHandler *handler);
5973
5981 const std::string id;
5986 SignalkId(const std::string &s) : id(s) {};
5987};
5988
5999extern DECL_EXP std::shared_ptr<ObservableListener> GetListener(
6000 SignalkId id, wxEventType ev, wxEvtHandler *handler);
6001
6017extern DECL_EXP std::vector<uint8_t> GetN2000Payload(NMEA2000Id id,
6018 ObservedEvt ev);
6019
6036extern DECL_EXP std::shared_ptr<void> GetSignalkPayload(ObservedEvt ev);
6037
6042extern DECL_EXP std::string GetN2000Source(NMEA2000Id id, ObservedEvt ev);
6043
6045extern DECL_EXP std::string GetN0183Payload(NMEA0183Id id, ObservedEvt ev);
6046
6054 const int type;
6059 NavDataId() : type(0) {}
6060};
6061
6073extern DECL_EXP std::shared_ptr<ObservableListener> GetListener(
6074 NavDataId id, wxEventType ev, wxEvtHandler *handler);
6075
6083 double lat;
6084 double lon;
6085 double sog;
6086 double cog;
6087 double var;
6088 double hdt;
6089 time_t time;
6090};
6091
6093extern DECL_EXP PluginNavdata GetEventNavdata(ObservedEvt ev);
6094
6096/*
6097 * Plugins may access comm ports for direct output.
6098 * The general program flow for a plugin may look something like this
6099 * pseudo-code:
6100 * 1. Plugin will query OCPN core for a list of active comm drivers.
6101 * 2. Plugin will inspect the list, and query OCPN core for driver
6102 * attributes.
6103 * 3. Plugin will select a comm driver with appropriate attributes for output.
6104 * 4. Plugin will register a list of PGNs expected to be transmitted
6105 * (N2K specific)
6106 * 5. Plugin may then send a payload buffer to a specific comm driver for
6107 * output as soon as possible.
6108 *
6109 * The mechanism for specifying a particular comm driver uses the notion of
6110 * "handles". Each active comm driver has an associated opaque handle, managed
6111 * by OCPN core. All references by a plugin to a driver are by means of its
6112 * handle. Handles should be considered to be "opaque", meaning that the exact
6113 * contents of the handle are of no specific value to the plugin, and only
6114 * have meaning to the OCPN core management of drivers.
6115 */
6116
6118typedef std::string DriverHandle;
6119
6142
6144extern DECL_EXP std::vector<DriverHandle> GetActiveDrivers();
6145
6160extern DECL_EXP const std::unordered_map<std::string, std::string>
6162
6163/* Writing to a specific driver */
6173extern DECL_EXP CommDriverResult WriteCommDriver(
6174 DriverHandle handle, const std::shared_ptr<std::vector<uint8_t>> &payload);
6175
6177extern DECL_EXP CommDriverResult WriteCommDriverN2K(
6178 DriverHandle handle, int PGN, int destinationCANAddress, int priority,
6179 const std::shared_ptr<std::vector<uint8_t>> &payload);
6180
6223extern DECL_EXP CommDriverResult RegisterTXPGNs(DriverHandle handle,
6224 std::vector<int> &pgn_list);
6225
6226// API 1.20
6227//
6228
6265
6268 const std::string id;
6269 PluginMsgId(const std::string &s) : id(s) {};
6270};
6271
6276extern DECL_EXP std::shared_ptr<ObservableListener> GetListener(
6277 PluginMsgId id, wxEventType ev, wxEvtHandler *handler);
6278
6283extern DECL_EXP std::string GetPluginMsgPayload(PluginMsgId id, ObservedEvt ev);
6284
6290extern DECL_EXP void ExitOCPN();
6291
6300extern "C" DECL_EXP void RequestWindowRefresh(wxWindow *win,
6301 bool eraseBackground);
6302
6308extern DECL_EXP bool GetFullScreen();
6309
6315extern DECL_EXP void SetFullScreen(bool full_screen_on);
6316
6322extern DECL_EXP void EnableTouchMode(bool enable);
6323
6329extern DECL_EXP bool GetTouchMode();
6330
6338extern DECL_EXP void SetGlobalColor(std::string table, std::string name,
6339 wxColor color);
6340
6348extern DECL_EXP wxColor GetGlobalColorD(std::string map_name, std::string name);
6349
6355extern DECL_EXP void EnableStatusBar(bool enable);
6356
6362extern DECL_EXP void EnableMenu(bool enable);
6363
6369extern DECL_EXP bool GetEnableStatusBar();
6370
6376extern DECL_EXP bool GetEnableMenu();
6377
6387extern DECL_EXP void SetNavigationMode(PI_NavMode mode, int CanvasIndex);
6388
6395extern DECL_EXP PI_NavMode GetNavigationMode(int CanvasIndex);
6396
6404extern DECL_EXP void EnableLookaheadMode(bool enable, int CanvasIndex);
6405
6412extern DECL_EXP bool GetEnableLookaheadMode(int CanvasIndex);
6413
6420extern DECL_EXP void EnableMUIBar(bool enable, int CanvasIndex);
6421
6428extern DECL_EXP void EnableCompassGPSIcon(bool enable, int CanvasIndex);
6429
6436extern DECL_EXP void EnableChartBar(bool enable, int CanvasIndex);
6437
6444extern DECL_EXP bool GetEnableMUIBar(int CanvasIndex);
6445
6452extern DECL_EXP bool GetEnableCompassGPSIcon(int CanvasIndex);
6453
6460extern DECL_EXP bool GetEnableChartBar(int CanvasIndex);
6461
6469extern DECL_EXP void EnableCanvasFocusBar(bool enable, int CanvasIndex);
6470
6477extern DECL_EXP bool GetEnableCanvasFocusBar(int CanvasIndex);
6478
6479/*
6480 * Allow plugin control of "Chart Panel Options" dialog
6481 */
6482
6489extern DECL_EXP void EnableLatLonGrid(bool enable, int CanvasIndex);
6490
6497extern DECL_EXP void EnableChartOutlines(bool enable, int CanvasIndex);
6498
6505extern DECL_EXP void EnableDepthUnitDisplay(bool enable, int CanvasIndex);
6506
6513extern DECL_EXP void EnableAisTargetDisplay(bool enable, int CanvasIndex);
6514
6521extern DECL_EXP void EnableTideStationsDisplay(bool enable, int CanvasIndex);
6522
6529extern DECL_EXP void EnableCurrentStationsDisplay(bool enable, int CanvasIndex);
6530
6537extern DECL_EXP void EnableENCTextDisplay(bool enable, int CanvasIndex);
6538
6545extern DECL_EXP void EnableENCDepthSoundingsDisplay(bool enable,
6546 int CanvasIndex);
6547
6554extern DECL_EXP void EnableBuoyLightLabelsDisplay(bool enable, int CanvasIndex);
6555
6562extern DECL_EXP void EnableLightsDisplay(bool enable, int CanvasIndex);
6563
6570extern DECL_EXP void EnableLightDescriptionsDisplay(bool enable,
6571 int CanvasIndex);
6572
6579extern DECL_EXP void SetENCDisplayCategory(PI_DisCat cat, int CanvasIndex);
6580
6587extern DECL_EXP bool GetEnableLatLonGrid(int CanvasIndex);
6588
6595extern DECL_EXP bool GetEnableChartOutlines(int CanvasIndex);
6596
6603extern DECL_EXP bool GetEnableDepthUnitDisplay(int CanvasIndex);
6604
6611extern DECL_EXP bool GetEnableAisTargetDisplay(int CanvasIndex);
6612
6619extern DECL_EXP bool GetEnableTideStationsDisplay(int CanvasIndex);
6620
6627extern DECL_EXP bool GetEnableCurrentStationsDisplay(int CanvasIndex);
6628
6635extern DECL_EXP bool GetEnableENCTextDisplay(int CanvasIndex);
6636
6643extern DECL_EXP bool GetEnableENCDepthSoundingsDisplay(int CanvasIndex);
6644
6651extern DECL_EXP bool GetEnableBuoyLightLabelsDisplay(int CanvasIndex);
6652
6659extern DECL_EXP bool GetEnableLightsDisplay(int CanvasIndex);
6660
6667extern DECL_EXP bool GetEnableLightDescriptionsDisplay(int CanvasIndex);
6668
6679extern DECL_EXP PI_DisCat GetENCDisplayCategory(int CanvasIndex);
6680
6689extern DECL_EXP void PluginSetFollowMode(int CanvasIndex, bool enable_follow);
6690
6697extern DECL_EXP bool PluginGetFollowMode(int CanvasIndex);
6698
6706extern DECL_EXP void SetTrackingMode(bool enable);
6707
6713extern DECL_EXP bool GetTrackingMode();
6714
6722extern DECL_EXP void SetAppColorScheme(PI_ColorScheme cs);
6723
6729extern DECL_EXP PI_ColorScheme GetAppColorScheme();
6730
6739extern DECL_EXP void EnableSplitScreenLayout(bool enable = true);
6740
6741// ChartCanvas control utilities
6742
6750extern DECL_EXP void PluginZoomCanvas(int CanvasIndex, double factor);
6751
6757extern DECL_EXP bool GetEnableMainToolbar();
6758
6764extern DECL_EXP void SetEnableMainToolbar(bool enable);
6765
6770extern DECL_EXP void ShowGlobalSettingsDialog();
6771
6777extern DECL_EXP void PluginCenterOwnship(int CanvasIndex);
6778
6786extern DECL_EXP bool GetEnableTenHertzUpdate();
6787
6794extern DECL_EXP void EnableTenHertzUpdate(bool enable);
6795
6801extern DECL_EXP void ConfigFlushAndReload();
6802
6803/*
6804 * Reload and restore all connections by direct read of config file
6805 */
6806extern DECL_EXP void ReloadConfigConnections();
6807
6811enum class PI_NotificationSeverity : int {
6812 PI_kInformational = 0,
6813 PI_kWarning = 1,
6814 PI_kCritical = 2
6815};
6816
6818public:
6820 const std::string &_message, int _timeout_start,
6821 int _timeout_left, std::string _guid);
6822 virtual ~PI_Notification() {};
6823
6824 PI_NotificationSeverity severity;
6825 std::string message;
6826 int auto_timeout_left;
6827 int auto_timeout_start;
6828 std::string guid;
6829 std::string action_verb; // Either "ACK" or "POST", when set by a
6830 // PI_Notification message payload.
6831 // Empty otherwise
6832};
6833
6834extern DECL_EXP int GetActiveNotificationCount();
6835extern DECL_EXP PI_NotificationSeverity GetMaxActiveNotificationLevel();
6836extern DECL_EXP std::string RaiseNotification(
6837 const PI_NotificationSeverity _severity, const std::string &_message,
6838 int timeout_secs = -1);
6839extern DECL_EXP bool AcknowledgeNotification(const std::string &guid);
6840extern DECL_EXP std::vector<std::shared_ptr<PI_Notification>>
6841GetActiveNotifications();
6842extern DECL_EXP void EnableNotificationCanvasIcon(bool enable);
6843
6844/*
6845 * Messaging interface for Notification Framework
6846 *
6847 */
6848
6849/*
6850 * Typical use pattern
6851 *
6852 * 1) Establish listener
6853 wxDEFINE_EVENT(EVT_NOTIFICATION_FRAME, ObservedEvt);
6854 static std::shared_ptr<ObservableListener> listener_note;
6855 NotificationMsgId note_id = NotificationMsgId();
6856 listener_note = GetListener(note_id, EVT_NOTIFICATION_FRAME, this);
6857 Bind(EVT_NOTIFICATION_FRAME, [&](ObservedEvt ev) { HandleNotification(ev); });
6858 *
6859 *
6860 *
6861 * 2) Define actions on receipt
6862 static void HandleNotification(ObservedEvt &ev) {
6863 NotificationMsgId id;
6864 std::shared_ptr<PI_Notification>payload=GetNotificationMsgPayload(id, ev);
6865 if (payload->action_verb == "ACK"){
6866 // Do Acknowledge notification actions
6867 }
6868 else if (payload->action_verb == "POST") {
6869 // Do Add Notification actions
6870 }
6871 }
6872
6873*/
6876 const std::string id;
6877 NotificationMsgId(const std::string &s) : id(s) {};
6878 NotificationMsgId() {};
6879};
6880
6885extern DECL_EXP std::shared_ptr<ObservableListener> GetListener(
6886 NotificationMsgId id, wxEventType ev, wxEvtHandler *handler);
6887
6891extern DECL_EXP std::shared_ptr<PI_Notification> GetNotificationMsgPayload(
6893
6894// * Plugin polled Comm Status support
6895enum class PI_Conn_Bus : int { N0183 = 0, Signalk = 1, N2000 = 2 };
6896
6897enum class PI_Comm_State : int {
6898 Disabled = 0,
6899 NoStats = 1,
6900 NoData = 2,
6901 Unavailable = 3,
6902 Ok = 4
6903};
6904
6906public:
6907 PI_Comm_State state;
6908 unsigned rx_count;
6909 unsigned tx_count;
6910 unsigned error_count;
6911};
6912
6913extern DECL_EXP PI_Comm_Status GetConnState(const std::string &iface,
6914 PI_Conn_Bus _bus);
6915
6916extern "C" DECL_EXP int AddCanvasContextMenuItemExt(
6917 wxMenuItem *pitem, opencpn_plugin *pplugin, const std::string object_type);
6918
6919#endif //_PLUGIN_H_
Keeps listening over it's lifespan, removes itself on destruction.
Definition observable.h:131
Custom event class for OpenCPN's notification system.
ObservedEvt(wxEventType commandType=obsNOTIFY, int id=0)
Constructor.
void SetSharedPtr(std::shared_ptr< const void > p)
Sets the event's payload data.
wxEvent * Clone() const
Creates a cloned copy of this event.
std::shared_ptr< const void > GetSharedPtr() const
Gets the event's payload data.
unsigned error_count
Number of detected errors since program start.
unsigned tx_count
Number of bytes sent since program start.
unsigned rx_count
Number of bytes received since program start.
Class representing an S-57 chart object.
int auxParm3
Auxiliary parameter 3.
PI_S57Obj * next
Linked list pointer.
PI_DisCat m_DisplayCat
Display category (base, standard, other)
double m_lon
Reference longitude.
double lon_max
Bounding box maximum longitude.
int Scamin
Minimum display scale.
int * m_lsindex_array
Array of line segment indices.
double x
X coordinate for point features.
int auxParm1
Auxiliary parameter 1.
void * m_chart_context
Parent chart context.
int m_n_lsindex
Number of line segments.
double lon_min
Bounding box minimum longitude.
PI_S57Obj * child
Child object list (for multipoint soundings)
double x_rate
X scale factor.
int npt
Number of points in geometry.
int auxParm2
Auxiliary parameter 2.
double lat_max
Bounding box maximum latitude.
int auxParm0
Auxiliary parameter 0.
int iOBJL
Object lookup index.
void * pPolyTessGeo
Tesselated polygon geometry.
double chart_ref_lon
Chart reference longitude.
bool bIsAssociable
True if object can have relationships.
int m_n_edge_max_points
Maximum points per edge.
void * geoPt
Geometry data for lines/areas.
double y
Y coordinate for point features.
int nRef
Reference count for memory management.
int n_attr
Number of attributes.
double * geoPtMulti
Lat/lon pairs for decomposed points.
double y_origin
Y origin offset.
PI_line_segment_element * m_ls_list
Line segment list.
int Index
Runtime object index.
void * S52_Context
S52 presentation data.
bool bIsClone
True if object is a clone.
char * att_array
Array of attribute types.
double * geoPtz
Z values for multipoint features.
double m_lat
Reference latitude.
int m_DPRI
Display priority.
bool m_bcategory_mutable
True if category can change.
bool bIsAton
True if object is an aid to navigation.
double chart_ref_lat
Chart reference latitude.
double z
Z coordinate (usually depth)
wxArrayOfS57attVal * attVal
Array of attribute values.
double y_rate
Y scale factor.
double lat_min
Bounding box minimum latitude.
double x_origin
X origin offset.
int Primitive_type
Geometry type (point, line, area)
Represents a line segment element for efficient vector chart rendering.
int priority
Drawing priority (higher draws on top)
int type
Line type identifier.
void * private0
Private data pointer for implementation use.
float lon_min
Minimum longitude of segment's bounding box.
float lat_min
Minimum latitude of segment's bounding box.
size_t vbo_offset
Offset into vertex buffer object for this segment.
float lat_max
Maximum latitude of segment's bounding box.
float lon_max
Maximum longitude of segment's bounding box.
PI_line_segment_element * next
Pointer to next segment in linked list.
size_t n_points
Number of points in this line segment.
Extended chart base class with separated text rendering.
Extended OpenGL-optimized chart base class with additional querying capabilities.
OpenGL-optimized chart base class for plugin chart types.
Base class for implementing custom chart types in OpenCPN plugins.
virtual ChartFamilyEnumPI GetChartFamily()
Returns the chart family classification.
virtual wxString GetID()
Returns a unique identifier for the chart.
virtual wxString GetDatumString()
Returns the horizontal geodetic datum of the chart.
virtual wxString GetName()
Returns the chart's name or title.
virtual wxDateTime GetEditionDate(void)
Returns the edition date of the chart.
virtual int GetCOVRTablenPoints(int iTable)
Alternative method to get the number of points in a coverage table entry.
virtual int GetCOVREntries()
Returns the number of coverage table entries for this chart.
virtual wxString GetSoundingsDatum()
Returns the vertical datum used for soundings in the chart.
virtual wxString GetExtraInfo()
Returns additional information about the chart.
virtual wxString GetDescription()
Returns a descriptive text about the chart.
virtual wxString GetFullPath() const
Returns the full file path of the chart.
virtual wxString GetSE()
Returns the chart's source edition identifier.
virtual bool IsReadyToRender()
Indicates whether the chart is ready for rendering.
virtual int GetNativeScale()
Returns the native scale of the chart.
virtual double GetChartSkew()
Returns the skew/rotation angle of the chart.
virtual wxString GetDepthUnits()
Returns the depth units used in the chart.
virtual float * GetCOVRTableHead(int iTable)
Returns a pointer to the coverage table data for a specific entry.
virtual double GetChartErrorFactor()
Returns the error factor for the chart.
virtual OcpnProjTypePI GetChartProjection()
Returns the projection type used by the chart.
virtual wxString GetPubDate()
Returns the publication date/year of the chart.
virtual ChartTypeEnumPI GetChartType()
Returns the chart type identifier.
virtual int GetCOVRTablePoints(int iTable)
Returns the number of points in a specific coverage table entry.
virtual ChartDepthUnitTypePI GetDepthUnitId()
Returns the depth unit type identifier.
AIS target information accessible to plugins.
char CallSign[8]
Call sign, includes NULL terminator.
double HDG
Heading in degrees true.
int ROTAIS
Rate of turn as indicated in AIS message.
unsigned char ShipType
Ship type as per ITU-R M.1371.
double Lat
Latitude in decimal degrees.
int MMSI
Maritime Mobile Service Identity number.
bool bCPA_Valid
True if CPA calculation is valid.
double Brg
Bearing to target in degrees true.
double Lon
Longitude in decimal degrees.
double CPA
Closest Point of Approach in nautical miles.
int Class
AIS class (Class A: 0, Class B: 1)
double SOG
Speed over ground in knots.
double Range_NM
Range to target in nautical miles.
int NavStatus
Navigational status (0-15 as per ITU-R M.1371)
int IMO
IMO ship identification number.
char ShipName[21]
Ship name, includes NULL terminator.
double TCPA
Time to Closest Point of Approach in minutes.
double COG
Course over ground in degrees.
plugin_ais_alarm_type alarm_state
Current alarm state for this target.
Extended position fix information.
int nSats
Number of satellites used in the fix.
double Var
Magnetic variation in degrees, typically from RMC message.
double Cog
Course over ground in degrees [0-360).
double Lat
Latitude in decimal degrees.
double Hdm
Heading magnetic in degrees [0-360).
time_t FixTime
UTC time of fix.
double Lon
Longitude in decimal degrees.
double Sog
Speed over ground in knots.
double Hdt
Heading true in degrees [0-360).
Basic position fix information.
double Cog
Course over ground in degrees [0-360).
double Sog
Speed over ground in knots.
time_t FixTime
UTC time of fix as time_t value.
double Lat
Latitude in decimal degrees.
int nSats
Number of satellites used in the fix.
double Var
Magnetic variation in degrees, typically from RMC message.
double Lon
Longitude in decimal degrees.
Enhanced route class for working with PlugIn_Waypoint_ExV2 waypoints.
bool m_isVisible
True if route should be displayed.
Plugin_WaypointExV2List * pWaypointList
List of waypoints making up this route in order.
wxString m_StartString
Description of route start point.
wxString m_Description
Optional route description/notes.
wxString m_NameString
User-visible name of the route.
bool m_isActive
True if this is the active route.
wxString m_GUID
Globally unique identifier.
wxString m_EndString
Description of route end point.
Extended route class for managing complex route features.
wxString m_Description
Optional route description/notes.
wxString m_EndString
Description of route end point.
Plugin_WaypointExList * pWaypointList
List of waypoints making up this route in order.
wxString m_NameString
User-visible name of the route.
bool m_isVisible
True if route should be displayed.
wxString m_GUID
Globally unique identifier.
bool m_isActive
True if this is the active route.
wxString m_StartString
Description of route start point.
Plugin route class for managing ordered waypoint collections.
wxString m_GUID
Globally unique identifier.
wxString m_EndString
Name/description of ending point.
wxString m_NameString
Route name.
Plugin_WaypointList * pWaypointList
List of waypoints making up this route in order.
wxString m_StartString
Name/description of starting point.
Plugin track class for managing recorded track data.
Plugin_WaypointList * pWaypointList
List of waypoints making up this track in chronological order.
wxString m_GUID
Globally unique identifier.
wxString m_EndString
Description of track end point/time.
wxString m_StartString
Description of track start point/time.
wxString m_NameString
Display name of the track.
Contains view parameters and status information for a chart display viewport.
double view_scale_ppm
Display scale in pixels per meter.
wxRect rv_rect
Rectangle defining the rendered view area.
int pix_width
Viewport width in pixels.
double lon_max
Maximum longitude of the viewport.
double clon
Center longitude of the viewport in decimal degrees.
double lat_max
Maximum latitude of the viewport.
int pix_height
Viewport height in pixels.
double clat
Center latitude of the viewport in decimal degrees.
double skew
Display skew angle in radians.
double rotation
Display rotation angle in radians.
bool bValid
True if this viewport is valid and can be used for rendering.
double lon_min
Minimum longitude of the viewport.
double lat_min
Minimum latitude of the viewport.
int m_projection_type
Chart projection type (PROJECTION_MERCATOR, etc.)
bool b_quilt
True if the viewport is in quilt mode (showing multiple charts)
float chart_scale
Conventional chart displayed scale (e.g., 1:50000)
wxDateTime m_ETD
Estimated departure time in UTC, or wxInvalidDateTime if not set.
wxString m_MarkDescription
Optional description text.
wxString m_GUID
Globally unique identifier.
wxString m_TideStation
Tide Station Identifier.
wxDateTime m_CreateTime
Creation timestamp in UTC.
bool m_bShowWaypointRangeRings
True to show range rings on chart.
wxString IconDescription
User-friendly description of icon.
double m_lat
Latitude in decimal degrees.
wxColour RangeRingColor
Color to draw range rings.
bool IsActive
Active state (e.g. destination)
Plugin_HyperlinkList * m_HyperlinkList
List of hyperlinks associated with this waypoint.
double scamin
Minimum display scale (1:X) for waypoint visibility.
double scamax
Maximum display scale (1:X) for waypoint visibility.
bool b_useScamin
True to enable scale-dependent visibility.
wxString IconName
Name of icon to use for waypoint symbol.
bool IsNameVisible
True to show waypoint name on chart.
double m_PlannedSpeed
Planned speed for next leg (knots)
double RangeRingSpace
Distance between range rings in preferred units.
double m_lon
Longitude in decimal degrees.
double m_WaypointArrivalRadius
Arrival radius in nautical miles.
int RangeRingSpaceUnits
Units for range ring spacing - 0:nm, 1:km.
wxString m_MarkName
Display name of waypoint.
bool IsVisible
Visibility state on chart.
int nrange_rings
Number of range rings to display around waypoint.
Extended waypoint class with additional navigation features.
wxDateTime m_CreateTime
Creation timestamp in UTC.
wxColour RangeRingColor
Color to draw range rings.
int nrange_rings
Number of range rings to display around waypoint.
wxString IconDescription
User-friendly description of icon.
bool b_useScamin
True to enable scale-dependent visibility.
double RangeRingSpace
Distance between range rings in preferred units.
Plugin_HyperlinkList * m_HyperlinkList
List of hyperlinks associated with this waypoint.
wxString m_MarkName
Display name of waypoint.
wxString m_GUID
Globally unique identifier.
double m_lon
Longitude in decimal degrees.
wxString IconName
Name of icon to use for waypoint symbol.
double scamin
Minimum display scale (1:X) for waypoint visibility.
bool IsNameVisible
True to show waypoint name on chart.
double m_lat
Latitude in decimal degrees.
wxString m_MarkDescription
Optional description text.
bool IsActive
Active state (e.g. destination)
bool IsVisible
Visibility state on chart.
Plugin waypoint class providing core waypoint/mark functionality.
double m_lon
Longitude in decimal degrees.
wxString m_IconName
Icon identifier.
wxString m_MarkDescription
Optional description.
wxString m_GUID
Globally unique identifier.
bool m_IsVisible
Visibility state.
wxDateTime m_CreateTime
Creation timestamp in UTC.
wxString m_MarkName
Display name.
double m_lat
Latitude in decimal degrees.
Plugin_HyperlinkList * m_HyperlinkList
List of associated hyperlinks.
Information about the currently active route leg.
double Dtw
Distance to waypoint in nautical miles.
wxString wp_name
Name of destination waypoint for the active leg.
double Xte
Cross track error in nautical miles, negative values indicate left side of track.
double Btw
Bearing to waypoint in degrees true.
bool arrival
True when vessel is within the arrival circle of the destination waypoint.
virtual bool RenderOverlayMultiCanvas(wxDC &dc, PlugIn_ViewPort *vp, int canvasIndex)
Renders plugin overlay graphics with canvas selection.
virtual bool RenderGLOverlayMultiCanvas(wxGLContext *pcontext, PlugIn_ViewPort *vp, int canvasIndex)
Renders plugin overlay graphics in OpenGL mode with canvas selection.
bool RenderGLOverlayMultiCanvas(wxGLContext *pcontext, PlugIn_ViewPort *vp, int canvas_ix) override
Renders plugin overlay graphics in OpenGL mode with canvas selection.
bool RenderOverlayMultiCanvas(wxDC &dc, PlugIn_ViewPort *vp, int canvas_ix) override
Renders plugin overlay graphics with canvas selection.
Base class for OpenCPN plugins.
virtual bool RenderOverlay(wxMemoryDC *pmdc, PlugIn_ViewPort *vp)
Render plugin overlay graphics using standard device context.
DECL_EXP void RemovePlugInTool(int tool_id)
Removes a tool from OpenCPN's toolbar.
DECL_EXP void EnableNotificationCanvasIcon(bool enable)
Plugin Notification Framework GUI support.
DECL_EXP void ForceChartDBUpdate()
Forces an update of the chart database.
DECL_EXP wxArrayString GetRouteGUIDArray(void)
Gets array of route GUIDs.
DECL_EXP std::unique_ptr< PlugIn_Route_Ex > GetRouteEx_Plugin(const wxString &GUID)
Gets extended route by GUID.
DECL_EXP CommDriverResult WriteCommDriverN2K(DriverHandle handle, int PGN, int destinationCANAddress, int priority, const std::shared_ptr< std::vector< uint8_t > > &payload)
Send a PGN message to an NMEA2000 address.
_OBJECT_LAYER_REQ
Filter options for object queries.
@ OBJECTS_ALL
Return all objects including those in layers.
@ OBJECTS_ONLY_LAYERS
Return only objects that are in layers.
@ OBJECTS_NO_LAYERS
Exclude objects that are in layers.
DECL_EXP void toSM_ECC_Plugin(double lat, double lon, double lat0, double lon0, double *x, double *y)
Converts geographic coordinates to Elliptical Simple Mercator projection.
DECL_EXP void EnableENCDepthSoundingsDisplay(bool enable, int CanvasIndex)
Controls ENC depth sounding display.
DECL_EXP void EnableChartBar(bool enable, int CanvasIndex)
Controls visibility of chart info bar.
DECL_EXP double fromDMM_Plugin(wxString sdms)
Converts degrees/decimal minutes string to decimal degrees.
DECL_EXP void SetCanvasMenuItemGrey(int item, bool grey, const char *name="")
Sets menu item enabled/disabled state.
DECL_EXP void EnableLatLonGrid(bool enable, int CanvasIndex)
Controls latitude/longitude grid display.
DECL_EXP void SetNavigationMode(PI_NavMode mode, int CanvasIndex)
Sets the navigation mode for a specific chart canvas.
DECL_EXP bool GetEnableENCDepthSoundingsDisplay(int CanvasIndex)
Gets ENC depth sounding visibility.
DECL_EXP void EnableENCTextDisplay(bool enable, int CanvasIndex)
Controls ENC text label display.
DECL_EXP wxXmlDocument GetChartDatabaseEntryXML(int dbIndex, bool b_getGeom)
Gets chart database entry as XML.
DECL_EXP void AddChartDirectory(wxString &path)
Adds a chart directory to OpenCPN's chart database.
DECL_EXP wxBitmap GetBitmapFromSVGFile(wxString filename, unsigned int width, unsigned int height)
Creates bitmap from SVG file.
DECL_EXP wxArrayString GetChartDBDirArrayString()
Gets chart database directory list.
DECL_EXP wxWindow * GetCanvasByIndex(int canvasIndex)
Gets chart canvas window by index.
DECL_EXP bool GetEnableCanvasFocusBar(int CanvasIndex)
Gets focus indicator visibility state.
DECL_EXP void UpdateAndApplyPriorityMaps(std::vector< std::string > map)
Sets and applies new priority mapping scheme.
DECL_EXP int GetCanvasIndexUnderMouse()
Gets index of chart canvas under mouse cursor.
DECL_EXP void DimeWindow(wxWindow *)
Applies system color scheme to window.
plugin_ais_alarm_type
Enumeration of AIS alarm states.
@ PI_AIS_ALARM_ACKNOWLEDGED
Alarm has been acknowledged by the user.
@ PI_AIS_NO_ALARM
No alarm condition exists.
@ PI_AIS_ALARM_SET
Alarm has been set but not acknowledged.
DECL_EXP bool GetSingleWaypointExV2(wxString GUID, PlugIn_Waypoint_ExV2 *pwaypoint)
Gets extended waypoint data by GUID.
enum ChartDepthUnitTypePI _ChartDepthUnitTypePI
Enumeration of depth unit types used in charts.
DECL_EXP std::unique_ptr< PlugIn_Waypoint_ExV2 > GetWaypointExV2_Plugin(const wxString &GUID)
Gets complete waypoint details by GUID.
DECL_EXP void EnableCanvasFocusBar(bool enable, int CanvasIndex)
Controls visibility of canvas focus indicator.
DECL_EXP void EnableTideStationsDisplay(bool enable, int CanvasIndex)
Controls tide station icon display.
enum _PI_DisCat PI_DisCat
Display categories for S52 chart features.
DECL_EXP void RemoveCanvasContextMenuItem(int item)
Removes a context menu item completely.
void DECL_EXP PI_PLIBSetRenderCaps(unsigned int flags)
Sets rendering capability flags.
DECL_EXP void fromSM_ECC_Plugin(double x, double y, double lat0, double lon0, double *lat, double *lon)
Converts Elliptical Simple Mercator coordinates to geographic.
DECL_EXP bool GetEnableChartBar(int CanvasIndex)
Gets chart bar visibility state.
DECL_EXP wxFont GetOCPNGUIScaledFont_PlugIn(wxString item)
Gets a uniquely scaled font copy for responsive UI elements.
DECL_EXP double DistGreatCircle_Plugin(double slat, double slon, double dlat, double dlon)
Calculates great circle distance between two points.
CommDriverResult
Error return values
@ RESULT_COMM_INVALID_PARMS
Invalid parameters provided to operation.
@ RESULT_COMM_REGISTER_GATEWAY_ERROR
Failed to register with gateway device.
@ RESULT_COMM_TX_ERROR
Error occurred during transmission.
@ RESULT_COMM_REGISTER_PGN_ERROR
Failed to register PGN parameters.
@ RESULT_COMM_NO_ERROR
Operation completed successfully.
@ RESULT_COMM_INVALID_HANDLE
Invalid or unknown driver handle specified.
DECL_EXP void RequestWindowRefresh(wxWindow *win, bool eraseBackground)
Requests window refresh.
DECL_EXP bool UpdateChartDBInplace(wxArrayString dir_array, bool b_force_update, bool b_ProgressDialog)
Updates chart database in place.
DECL_EXP wxString GetLocaleCanonicalName()
Gets system locale canonical name.
DECL_EXP bool GetEnableDepthUnitDisplay(int CanvasIndex)
Gets depth unit display state.
enum OptionsParentPI _OptionsParentPI
Enum defining parent pages in OpenCPN options dialog where plugins can add panels.
DECL_EXP void SetToolbarItemState(int item, bool toggle)
Sets toolbar item toggle state.
DECL_EXP bool UpdatePlugInRoute(PlugIn_Route *proute)
Updates an existing route.
DECL_EXP bool AddLocaleCatalog(wxString catalog)
Adds a locale catalog for translations.
int DECL_EXP PI_PLIBRenderObjectToDC(wxDC *pdc, PI_S57Obj *pObj, PlugIn_ViewPort *vp)
Renders an S57 object using standard device context.
DECL_EXP _OCPN_DLStatus OCPN_downloadFile(const wxString &url, const wxString &outputFile, const wxString &title, const wxString &message, const wxBitmap &bitmap, wxWindow *parent, long style, int timeout_secs)
Synchronously download a file with progress dialog.
void DECL_EXP PI_PLIBSetLineFeaturePriority(PI_S57Obj *pObj, int prio)
Sets rendering priority for line feature.
enum _PI_DisPrio PI_DisPrio
Display priority levels for S52 chart objects.
DECL_EXP void EnableCurrentStationsDisplay(bool enable, int CanvasIndex)
Controls current station icon display.
DECL_EXP wxArrayString GetIconNameArray(void)
Gets array of available waypoint icons.
DECL_EXP void toTM_Plugin(float lat, float lon, float lat0, float lon0, double *x, double *y)
Converts geographic coordinates to Transverse Mercator projection.
DECL_EXP bool GetGlobalColor(wxString colorName, wxColour *pcolour)
Gets a global color value.
DECL_EXP bool GetSingleWaypointEx(wxString GUID, PlugIn_Waypoint_Ex *pwaypoint)
Gets extended waypoint data by GUID.
DECL_EXP int PlatformFileSelectorDialog(wxWindow *parent, wxString *file_spec, wxString Title, wxString initDir, wxString suggestedName, wxString wildcard)
Shows platform-optimized file selector dialog.
DECL_EXP PI_DisCat GetENCDisplayCategory(int CanvasIndex)
Gets current ENC display category.
void DECL_EXP PI_UpdateContext(PI_S57Obj *pObj)
Updates rendering context for S57 object.
DECL_EXP int AddCanvasContextMenuItem(wxMenuItem *pitem, opencpn_plugin *pplugin)
Adds item to chart canvas context menu.
DECL_EXP double fromUsrSpeed_Plugin(double usr_speed, int unit=-1)
Converts from user's preferred speed unit to knots.
DECL_EXP _OCPN_DLStatus OCPN_postDataHttp(const wxString &url, const wxString &parameters, wxString &result, int timeout_secs)
Performs HTTP POST request.
DECL_EXP wxString GetActiveRouteGUID(void)
Gets GUID of currently active route.
DECL_EXP void RequestRefresh(wxWindow *)
Requests window refresh.
void DECL_EXP PI_PLIBPrepareForNewRender(void)
Prepares PLIB for new rendering pass.
DECL_EXP PI_NavMode GetNavigationMode(int CanvasIndex)
Gets current navigation mode for a canvas.
DECL_EXP void SetCanvasRotation(double rotation)
Sets chart display rotation angle.
DECL_EXP void PlugInMultMatrixViewport(PlugIn_ViewPort *vp, float lat=0, float lon=0)
Applies viewport transformation matrix.
DECL_EXP double toUsrDepth_Plugin(double m_depth, int unit=-1)
Converts meters to user's preferred depth unit.
DECL_EXP PI_Comm_Status GetConnState(const std::string &iface, PI_Conn_Bus _bus)
Plugin polled Comm Status support.
int DECL_EXP PI_GetPLIBDepthUnitInt()
Gets configured depth unit for S52 display.
DECL_EXP wxArrayString GetWaypointGUIDArray(void)
Gets array of all waypoint/marks GUIDs.
DECL_EXP double toUsrTemp_Plugin(double cel_temp, int unit=-1)
Converts Celsius to user's preferred temperature unit.
DECL_EXP bool CheckEdgePan_PlugIn(int x, int y, bool dragging, int margin, int delta)
Checks if chart should pan when cursor near edge.
DECL_EXP wxString * GetpSharedDataLocation()
Gets shared application data location.
DECL_EXP double toUsrSpeed_Plugin(double kts_speed, int unit=-1)
Converts knots to user's preferred speed unit.
DECL_EXP bool GetEnableBuoyLightLabelsDisplay(int CanvasIndex)
Gets buoy/light label visibility.
_OCPN_DLCondition
Event types for HTTP file download operations.
@ OCPN_DL_EVENT_TYPE_UNKNOWN
Unknown event type.
@ OCPN_DL_EVENT_TYPE_PROGRESS
Download progress update.
@ OCPN_DL_EVENT_TYPE_END
Download has completed.
@ OCPN_DL_EVENT_TYPE_START
Download is starting.
DECL_EXP bool DeleteOptionsPage(wxScrolledWindow *page)
Remove a previously added options page.
DECL_EXP void EnableTenHertzUpdate(bool enable)
Enable or disable 10 Hz update rate.
DECL_EXP void EnableLightDescriptionsDisplay(bool enable, int CanvasIndex)
Controls light description text display.
DECL_EXP bool AddPlugInRouteEx(PlugIn_Route_Ex *proute, bool b_permanent=true)
Adds a route with extended features.
bool DECL_EXP PI_PLIBObjectRenderCheck(PI_S57Obj *pObj, PlugIn_ViewPort *vp)
Checks if object should be rendered.
DECL_EXP void GetCanvasPixLL(PlugIn_ViewPort *vp, wxPoint *pp, double lat, double lon)
Converts lat/lon to canvas physical pixel coordinates.
DECL_EXP bool PlugIn_GSHHS_CrossesLand(double lat1, double lon1, double lat2, double lon2)
Checks if a great circle route crosses land.
ChartTypeEnumPI
Enumeration of chart types.
@ PI_CHART_TYPE_PLUGIN
Chart type provided by a plugin.
@ PI_CHART_TYPE_CM93COMP
CM93 Composite vector chart format.
@ PI_CHART_TYPE_CM93
CM93 vector chart format.
@ PI_CHART_TYPE_S57
S-57 vector chart format.
@ PI_CHART_TYPE_UNKNOWN
Chart type is unknown or undefined.
@ PI_CHART_TYPE_DONTCARE
Chart type is not important for the operation.
@ PI_CHART_TYPE_KAP
BSB/KAP raster chart format.
@ PI_CHART_TYPE_DUMMY
Dummy chart used when no actual chart is available.
@ PI_CHART_TYPE_GEO
GEO raster chart format.
DECL_EXP int GetChartbarHeight(void)
Gets height of chart bar in pixels.
DECL_EXP wxString GetNewGUID()
Generates a new globally unique identifier (GUID).
PI_ColorScheme
Enumeration of color schemes.
@ PI_GLOBAL_COLOR_SCHEME_DAY
Day color scheme, optimized for bright ambient light.
@ PI_GLOBAL_COLOR_SCHEME_NIGHT
Night color scheme, optimized for dark conditions with minimal impact on night vision.
@ PI_N_COLOR_SCHEMES
Number of color schemes, used for bounds checking.
@ PI_GLOBAL_COLOR_SCHEME_RGB
RGB color scheme, unmodified colors.
@ PI_GLOBAL_COLOR_SCHEME_DUSK
Dusk color scheme, optimized for low ambient light.
DECL_EXP wxString toSDMM_PlugIn(int NEflag, double a, bool hi_precision=true)
Convert decimal degrees to a formatted string.
DECL_EXP void SetEnableMainToolbar(bool enable)
Show or hide the main toolbar.
enum _OCPN_DLCondition OCPN_DLCondition
Event types for HTTP file download operations.
DECL_EXP wxString GetActiveStyleName()
Gets name of currently active style sheet.
DECL_EXP void EnableAisTargetDisplay(bool enable, int CanvasIndex)
Controls AIS target display.
DECL_EXP void ZeroXTE()
Resets cross track error to zero.
DECL_EXP void SetENCDisplayCategory(PI_DisCat cat, int CanvasIndex)
Sets ENC (Electronic Navigation Chart) feature display category.
DECL_EXP wxString GetOCPN_ExePath(void)
Gets OpenCPN executable path.
int DECL_EXP OCPNMessageBox_PlugIn(wxWindow *parent, const wxString &message, const wxString &caption=_T("Message"), int style=wxOK, int x=-1, int y=-1)
Shows a message box dialog.
DECL_EXP wxString * GetpPlugInLocation()
Gets plugins directory location.
DECL_EXP std::string GetN2000Source(NMEA2000Id id, ObservedEvt ev)
Return source identifier (iface) of a received n2000 message of type id in ev.
DECL_EXP int GetLatLonFormat(void)
Gets currently selected latitude/longitude display format.
PI_NotificationSeverity
Plugin Notification Framework support.
DECL_EXP std::shared_ptr< void > GetSignalkPayload(ObservedEvt ev)
Get SignalK status payload after receiving a message.
DECL_EXP double OCPN_GetWinDIPScaleFactor()
Gets Windows-specific DPI scaling factor.
DECL_EXP std::shared_ptr< ObservableListener > GetListener(NMEA2000Id id, wxEventType ev, wxEvtHandler *handler)
Gets listener for NMEA 2000 messages.
DECL_EXP wxWindow * GetCanvasUnderMouse()
Gets canvas window under mouse cursor.
DECL_EXP void EnableBuoyLightLabelsDisplay(bool enable, int CanvasIndex)
Controls buoy/light name label display.
int DECL_EXP PI_PLIBRenderAreaToDC(wxDC *pdc, PI_S57Obj *pObj, PlugIn_ViewPort *vp, wxRect rect, unsigned char *pixbuf)
Renders an S57 area object using standard device context.
DECL_EXP void SetGlobalColor(std::string table, std::string name, wxColor color)
Sets a color in the global color scheme.
DECL_EXP void PushNMEABuffer(wxString str)
Pushes NMEA sentence to the system.
DECL_EXP bool OCPN_isOnline()
Checks internet connectivity.
DECL_EXP void SetCanvasContextMenuItemGrey(int item, bool grey)
Sets menu item enabled/disabled state.
DECL_EXP std::unique_ptr< PlugIn_Waypoint > GetWaypoint_Plugin(const wxString &)
Gets waypoint details by GUID.
enum PI_InitReturn _PI_InitReturn
Return values for plugin initialization.
DECL_EXP void CanvasJumpToPosition(wxWindow *canvas, double lat, double lon, double scale)
Centers specified canvas on given position at given scale.
DECL_EXP double fromUsrTemp_Plugin(double usr_temp, int unit=-1)
Converts from user's preferred temperature unit to Celsius.
DECL_EXP bool GetEnableMenu()
Gets menu bar visibility state.
bool DECL_EXP PI_GetObjectRenderBox(PI_S57Obj *pObj, double *lat_min, double *lat_max, double *lon_min, double *lon_max)
Gets geographic bounding box of S57 object.
_OCPN_DLStatus
Status codes for HTTP file download operations.
@ OCPN_DL_NO_ERROR
Download completed successfully.
@ OCPN_DL_USER_TIMEOUT
Download timed out waiting for user action.
@ OCPN_DL_STARTED
Download has begun but not yet complete.
@ OCPN_DL_FAILED
Download failed (general error)
@ OCPN_DL_UNKNOWN
Unknown or uninitialized status.
@ OCPN_DL_ABORTED
Download was cancelled by user.
SDDMFORMAT
Coordinate format options for lat/lon display.
@ DEGREES_DECIMAL_MINUTES
Format like "50° 12.345' N".
@ DEGREES_MINUTES_SECONDS
Format like "50° 12' 34.5" N".
@ DECIMAL_DEGREES
Format like "50.12345° N".
@ END_SDDMFORMATS
Number of available formats.
DECL_EXP bool IsTouchInterface_PlugIn(void)
Checks if touch interface mode is enabled.
DECL_EXP wxString GetPlugInPath(opencpn_plugin *pplugin)
Gets the installation path for a specific plugin.
DECL_EXP double GetCanvasTilt()
Gets current canvas tilt angle.
DECL_EXP bool GetEnableAisTargetDisplay(int CanvasIndex)
Gets AIS target display state.
OCPN_DLDialogStyle
@ OCPN_DLDS_CONN_SETTINGS_AUTH
The dialog allows the user to change the authentication settings.
@ OCPN_DLDS_CAN_START
The transfer won't start automatically.
@ OCPN_DLDS_URL
The dialog shows the URL involved in the transfer.
@ OCPN_DLDS_AUTO_CLOSE
The dialog auto closes when transfer is complete.
@ OCPN_DLDS_CAN_ABORT
The transfer can be aborted by the user.
@ OCPN_DLDS_ESTIMATED_TIME
The dialog shows the estimated total time.
@ OCPN_DLDS_SIZE
The dialog shows the size of the resource to download/upload.
@ OCPN_DLDS_CONN_SETTINGS_PROXY
The dialog allows the user to change the proxy settings.
@ OCPN_DLDS_REMAINING_TIME
The dialog shows the remaining time.
@ OCPN_DLDS_SPEED
The dialog shows the transfer speed.
@ OCPN_DLDS_ELAPSED_TIME
The dialog shows the elapsed time.
@ OCPN_DLDS_CAN_PAUSE
The transfer can be paused.
@ OCPN_DLDS_CONN_SETTINGS_PORT
The dialog allows the user to change the port for the transfer.
DECL_EXP void RemoveCanvasMenuItem(int item, const char *name="")
Removes a context menu item completely.
DECL_EXP void EnableStatusBar(bool enable)
Shows/hides the status bar.
ChartFamilyEnumPI
Enumeration of chart families (broad categories).
@ PI_CHART_FAMILY_UNKNOWN
Chart family is unknown.
@ PI_CHART_FAMILY_VECTOR
Vector chart formats (S-57, CM93, etc.)
@ PI_CHART_FAMILY_RASTER
Raster chart formats (KAP, GEO, etc.)
@ PI_CHART_FAMILY_DONTCARE
Chart family is not important for the operation.
DECL_EXP void EnableChartOutlines(bool enable, int CanvasIndex)
Controls chart outline display.
DECL_EXP bool UpdatePlugInRouteExV2(PlugIn_Route_ExV2 *proute)
Updates existing route with V2 waypoints.
DECL_EXP wxString GetWritableDocumentsDir(void)
Returns the platform-specific default documents directory.
DECL_EXP wxString GetSelectedTrackGUID_Plugin()
Gets GUID of currently selected track.
DECL_EXP bool GetEnableTenHertzUpdate()
Check if 10 Hz update rate is enabled.
DECL_EXP std::unique_ptr< PlugIn_Route_ExV2 > GetRouteExV2_Plugin(const wxString &GUID)
Gets route details with V2 waypoints by GUID.
DECL_EXP bool DeletePlugInRoute(wxString &GUID)
Deletes a route.
DECL_EXP void GetDoubleCanvasPixLL(PlugIn_ViewPort *vp, wxPoint2DDouble *pp, double lat, double lon)
Converts lat/lon to canvas pixels with double precision.
DECL_EXP bool GetFullScreen()
Gets full screen state.
DECL_EXP bool PluginGetFollowMode(int CanvasIndex)
Get the current follow mode status for a specific canvas.
DECL_EXP bool GetSingleWaypoint(wxString GUID, PlugIn_Waypoint *pwaypoint)
Gets waypoint data by GUID.
enum _PI_LUPname PI_LUPname
Name identifiers for S57 lookup table sets.
DECL_EXP double OCPN_GetDisplayContentScaleFactor()
Gets content scaling factor for current display.
DECL_EXP double fromUsrDepth_Plugin(double usr_depth, int unit=-1)
Converts from user's preferred depth unit to meters.
DECL_EXP bool UpdatePlugInTrack(PlugIn_Track *ptrack)
Updates an existing track.
DECL_EXP wxArrayString GetTrackGUIDArray(void)
Gets array of track GUIDs.
DECL_EXP bool GetEnableLightsDisplay(int CanvasIndex)
Gets light icon visibility.
int DECL_EXP PI_GetPLIBStateHash()
Gets hash value representing current PLIB state.
DECL_EXP double toUsrDistance_Plugin(double nm_distance, int unit=-1)
Converts nautical miles to user's preferred distance unit.
DECL_EXP bool GetActiveRoutepointGPX(char *buffer, unsigned int buffer_length)
Gets GPX representation of active route waypoint.
DECL_EXP wxBitmap * FindSystemWaypointIcon(wxString &icon_name)
Finds built-in system waypoint icon.
DECL_EXP void ExitOCPN()
Exits OpenCPN application.
DECL_EXP int PlugInGetMinAvailableGshhgQuality()
Gets minimum available GSHHS coastline data quality.
DECL_EXP bool GetEnableLookaheadMode(int CanvasIndex)
Gets look-ahead mode state for a canvas.
DECL_EXP wxString getUsrTempUnit_Plugin(int unit=-1)
Gets display string for user's preferred temperature unit.
DECL_EXP double fromDMM_PlugIn(wxString sdms)
Parse a formatted coordinate string to get decimal degrees.
DECL_EXP int PlugInGetMaxAvailableGshhgQuality()
Gets maximum available GSHHS coastline data quality.
ChartDepthUnitTypePI
Enumeration of depth unit types used in charts.
@ PI_DEPTH_UNIT_METERS
Depths shown in meters.
@ PI_DEPTH_UNIT_UNKNOWN
Depth unit is unknown or not specified.
@ PI_DEPTH_UNIT_FATHOMS
Depths shown in fathoms.
@ PI_DEPTH_UNIT_FEET
Depths shown in feet.
DECL_EXP bool PlugInHasNormalizedViewPort(PlugIn_ViewPort *vp)
Checks if viewport has been normalized.
DECL_EXP bool AddSingleWaypoint(PlugIn_Waypoint *pwaypoint, bool b_permanent=true)
Adds a single waypoint.
DECL_EXP double fromUsrWindSpeed_Plugin(double usr_wspeed, int unit=-1)
Converts from user's preferred wind speed unit to knots.
DECL_EXP bool PlugInSetFontColor(const wxString TextElement, const wxColour color)
Sets text color for a UI element.
DECL_EXP wxString getUsrWindSpeedUnit_Plugin(int unit=-1)
Gets display string for user's preferred wind speed unit.
DECL_EXP bool DeleteSingleWaypoint(wxString &GUID)
Deletes a single waypoint.
DECL_EXP bool ShuttingDown(void)
Checks if OpenCPN is in shutdown process.
DECL_EXP void EnableDepthUnitDisplay(bool enable, int CanvasIndex)
Controls depth unit display.
DECL_EXP void PlugInAISDrawGL(wxGLCanvas *glcanvas, const PlugIn_ViewPort &vp)
Renders AIS targets on a secondary OpenGL canvas.
DECL_EXP void PlugInHandleAutopilotRoute(bool enable)
Controls autopilot route handling.
DECL_EXP void EnableMUIBar(bool enable, int CanvasIndex)
Controls visibility of MUI (Mobile/Touch User Interface) bar.
DECL_EXP void JumpToPosition(double lat, double lon, double scale)
Centers chart display on specified position at given scale.
DECL_EXP CommDriverResult WriteCommDriver(DriverHandle handle, const std::shared_ptr< std::vector< uint8_t > > &payload)
Send a non-NMEA2000 message.
DECL_EXP int PlatformDirSelectorDialog(wxWindow *parent, wxString *file_spec, wxString Title, wxString initDir)
Shows platform-optimized directory selector dialog.
DECL_EXP std::string GetN0183Payload(NMEA0183Id id, ObservedEvt ev)
Return payload in a received n0183 message of type id in ev.
wxString DECL_EXP PI_GetPLIBColorScheme()
Gets current color scheme used by S52 PLIB.
DECL_EXP void SetToolbarToolBitmaps(int item, wxBitmap *bitmap, wxBitmap *bmpRollover)
Updates toolbar tool bitmaps.
DECL_EXP bool GetTrackingMode()
Get the current tracking mode status.
std::string DriverHandle
Plugin API supporting direct access to comm drivers for output purposes.
PI_LUPname DECL_EXP PI_GetObjectLUPName(PI_S57Obj *pObj)
Gets Look-Up Table (LUP) name for object.
DECL_EXP bool AddPersistentFontKey(wxString TextElement)
Registers a new font configuration element.
enum _OCPN_DLStatus OCPN_DLStatus
Status codes for HTTP file download operations.
DECL_EXP bool AddPlugInRouteExV2(PlugIn_Route_ExV2 *proute, bool b_permanent=true)
Adds a new route with V2 waypoints.
DECL_EXP wxAuiManager * GetFrameAuiManager(void)
Gets main frame AUI manager.
DECL_EXP void PlugInNormalizeViewport(PlugIn_ViewPort *vp, float lat=0, float lon=0)
Normalizes viewport parameters.
DECL_EXP wxString getUsrDistanceUnit_Plugin(int unit=-1)
Gets display string for user's preferred distance unit.
struct _ExtentPI ExtentPI
Geographic extent structure defining a bounding box.
DECL_EXP wxFileConfig * GetOCPNConfigObject(void)
Gets OpenCPN's configuration object.
DECL_EXP bool AddCustomWaypointIcon(wxBitmap *pimage, wxString key, wxString description)
Adds a custom waypoint icon.
DECL_EXP wxString toUsrDateTimeFormat_Plugin(const wxDateTime date_time, const DateTimeFormatOptions &options=DateTimeFormatOptions())
Format a date/time to a localized string representation, conforming to the global date/time format an...
DECL_EXP wxRect GetMasterToolbarRect()
Gets bounding rectangle of master toolbar.
DECL_EXP wxWindow * PluginGetOverlayRenderCanvas()
Gets the canvas currently designated for overlay rendering.
DECL_EXP void EnableLookaheadMode(bool enable, int CanvasIndex)
Enables/disables look-ahead mode for a canvas.
DECL_EXP void OCPN_cancelDownloadFileBackground(long handle)
Cancels a background download.
DECL_EXP PI_ColorScheme GetAppColorScheme()
Get the current application color scheme.
DECL_EXP PluginNavdata GetEventNavdata(ObservedEvt ev)
Return BasicNavDataMsg decoded data available in ev.
DECL_EXP bool UpdateSingleWaypointExV2(PlugIn_Waypoint_ExV2 *pwaypoint)
Updates an existing extended V2 waypoint.
DECL_EXP int AddChartToDBInPlace(wxString &full_path, bool b_RefreshCanvas)
Adds a chart to the database without full rebuild.
DECL_EXP void toSM_Plugin(double lat, double lon, double lat0, double lon0, double *x, double *y)
Converts geographic coordinates to Simple Mercator projection.
DECL_EXP wxString getUsrDepthUnit_Plugin(int unit=-1)
Gets display string for user's preferred depth unit.
DECL_EXP void EnableMenu(bool enable)
Shows/hides the main menu bar.
DECL_EXP wxFont * OCPNGetFont(wxString TextElement, int default_size=0)
Gets a font for UI elements.
DECL_EXP int GetGlobalWatchdogTimoutSeconds()
Gets global watchdog timeout value.
DECL_EXP void SetTrackingMode(bool enable)
Enable or disable tracking mode.
enum ChartTypeEnumPI _ChartTypeEnumPI
Enumeration of chart types.
DECL_EXP std::shared_ptr< PI_Notification > GetNotificationMsgPayload(NotificationMsgId id, ObservedEvt ev)
Retrieve the Notification Event in a Notification message.
enum OcpnProjTypePI _OcpnProjTypePI
Enumeration of chart projection types.
DECL_EXP bool GetEnableStatusBar()
Gets status bar visibility state.
DECL_EXP float GetOCPNChartScaleFactor_Plugin()
Gets chart rendering scale factor.
void DECL_EXP PI_PLIBFreeContext(void *pContext)
Frees S52 PLIB context.
DECL_EXP bool GetEnableChartOutlines(int CanvasIndex)
Gets chart outline visibility state.
DECL_EXP std::unique_ptr< PlugIn_Track > GetTrack_Plugin(const wxString &)
Gets track details by GUID.
DECL_EXP bool AddPlugInRoute(PlugIn_Route *proute, bool b_permanent=true)
Adds a new route.
DECL_EXP std::vector< uint8_t > GetN2000Payload(NMEA2000Id id, ObservedEvt ev)
Return N2K payload for a received n2000 message of type id in ev.
DECL_EXP wxColour GetFontColour_PlugIn(wxString TextElement)
Gets color configured for a UI text element.
DECL_EXP bool GetEnableMainToolbar()
Check if the main toolbar is enabled.
enum ChartFamilyEnumPI _ChartFamilyEnumPI
Enumeration of chart families (broad categories).
DECL_EXP wxFont * FindOrCreateFont_PlugIn(int point_size, wxFontFamily family, wxFontStyle style, wxFontWeight weight, bool underline=false, const wxString &facename=wxEmptyString, wxFontEncoding encoding=wxFONTENCODING_DEFAULT)
Creates or finds a font in the font cache.
DECL_EXP void SetCanvasContextMenuItemViz(int item, bool viz)
Temporarily changes context menu item visibility.
DECL_EXP bool PlugInPlaySoundEx(wxString &sound_file, int deviceIndex=-1)
Start playing a sound file asynchronously.
DECL_EXP wxBitmap GetIcon_PlugIn(const wxString &name)
Gets icon bitmap by name.
DECL_EXP double toUsrWindSpeed_Plugin(double kts_wspeed, int unit=-1)
Converts knots to user's preferred wind speed unit.
DECL_EXP wxWindow * GetOCPNCanvasWindow()
Gets OpenCPN's main canvas window.
_PI_NavMode
Navigation mode options for chart display orientation.
@ PI_NORTH_UP_MODE
North Up Mode - True north is always at the top of the display.
@ PI_COURSE_UP_MODE
Course Up Mode - Current course over ground at the top.
@ PI_HEAD_UP_MODE
Head Up Mode - Current vessel heading at the top.
DECL_EXP void SetMUICursor_PlugIn(wxCursor *pCursor, int canvasIndex)
Sets mouse cursor for specific canvas.
DECL_EXP const std::unordered_map< std::string, std::string > GetAttributes(DriverHandle handle)
Query a specific driver for attributes.
DECL_EXP int InsertPlugInTool(wxString label, wxBitmap *bitmap, wxBitmap *bmpRollover, wxItemKind kind, wxString shortHelp, wxString longHelp, wxObject *clientData, int position, int tool_sel, opencpn_plugin *pplugin)
Adds a tool to OpenCPN's toolbar.
DECL_EXP void ConfigFlushAndReload()
Flush configuration changes to disk and reload settings.
DECL_EXP bool AddSingleWaypointEx(PlugIn_Waypoint_Ex *pwaypoint, bool b_permanent=true)
Adds a waypoint with extended properties.
DECL_EXP bool GetEnableLatLonGrid(int CanvasIndex)
Gets latitude/longitude grid visibility state.
_PI_DisPrio
Display priority levels for S52 chart objects.
@ PI_PRIO_AREA_2
Superimposed areas including water features.
@ PI_PRIO_NUM
Number of priority levels.
@ PI_PRIO_AREA_1
Superimposed areas.
@ PI_PRIO_MARINERS
VRM, EBL, own ship (highest priority)
@ PI_PRIO_SYMB_POINT
Point symbols including land features.
@ PI_PRIO_ROUTEING
Routeing lines (TSS, recommended tracks)
@ PI_PRIO_GROUP1
S57 group 1 filled areas (land, etc)
@ PI_PRIO_SYMB_AREA
Area symbols including traffic areas.
@ PI_PRIO_SYMB_LINE
Line symbols including restricted areas.
@ PI_PRIO_NODATA
No data fill area pattern (lowest priority)
@ PI_PRIO_HAZARDS
Hazards, buoys, beacons.
bool DECL_EXP PI_PLIBSetContext(PI_S57Obj *pObj)
Sets S52 PLIB rendering context for an object.
DECL_EXP bool UpdatePlugInRouteEx(PlugIn_Route_Ex *proute)
Updates an existing extended route.
DECL_EXP std::vector< DriverHandle > GetActiveDrivers()
Query OCPN core for a list of active drivers
DECL_EXP void SetCursor_PlugIn(wxCursor *pPlugin_Cursor=NULL)
Sets mouse cursor.
enum CommDriverResult _CommDriverResult
Error return values
DECL_EXP void PositionBearingDistanceMercator_Plugin(double lat, double lon, double brg, double dist, double *dlat, double *dlon)
Calculates destination point given starting point, bearing and distance.
DECL_EXP std::unique_ptr< PlugIn_Route > GetRoute_Plugin(const wxString &)
Gets route details by GUID.
_PI_DisCat
Display categories for S52 chart features.
@ PI_DISP_CAT_NUM
Number of categories (for array sizing)
@ PI_OTHER
Other - additional features for detailed navigation.
@ PI_MARINERS_OTHER
Additional mariner specified features.
@ PI_DISPLAYBASE
Display Base - features that must always be shown.
@ PI_STANDARD
Standard - default features for safe navigation.
@ PI_MARINERS_STANDARD
Mariner specified standard features.
DECL_EXP bool DecodeSingleVDOMessage(const wxString &str, PlugIn_Position_Fix_Ex *pos, wxString *acc)
Decodes a single VDO (Own Ship AIS) message.
PI_DisPrio DECL_EXP PI_GetObjectDisplayPriority(PI_S57Obj *pObj)
Gets display priority for object.
DECL_EXP double PlugInGetDisplaySizeMM()
Gets physical display size in millimeters.
DECL_EXP std::string GetPluginMsgPayload(PluginMsgId id, ObservedEvt ev)
Retrieve the string in a plugin message, internal or received on the REST insterface.
DECL_EXP double fromUsrDistance_Plugin(double usr_distance, int unit=-1)
Converts from user's preferred distance unit to nautical miles.
DECL_EXP wxWindow * PluginGetFocusCanvas()
Gets the currently focused chart canvas.
int DECL_EXP PI_PLIBRenderAreaToGL(const wxGLContext &glcc, PI_S57Obj *pObj, PlugIn_ViewPort *vp, wxRect &render_rect)
Renders an S57 area object using OpenGL.
DECL_EXP bool UpdateSingleWaypointEx(PlugIn_Waypoint_Ex *pwaypoint)
Updates an existing extended waypoint.
DECL_EXP void SetFullScreen(bool full_screen_on)
Sets full screen mode.
DECL_EXP void PluginCenterOwnship(int CanvasIndex)
Center the chart view on the own ship position for a specific canvas.
DECL_EXP double GetOCPNGUIToolScaleFactor_PlugIn()
Gets current global GUI scaling factor.
DECL_EXP wxString GetSelectedRouteGUID_Plugin()
Gets GUID of currently selected route.
DECL_EXP void DistanceBearingMercator_Plugin(double lat0, double lon0, double lat1, double lon1, double *brg, double *dist)
Calculates bearing and distance between two points using Mercator projection.
DECL_EXP std::unique_ptr< PlugIn_Waypoint_Ex > GetWaypointEx_Plugin(const wxString &GUID)
Gets extended waypoint by GUID.
DECL_EXP wxColor GetGlobalColorD(std::string map_name, std::string name)
Gets a color from the global color scheme.
enum _PI_NavMode PI_NavMode
Navigation mode options for chart display orientation.
DECL_EXP void ShowGlobalSettingsDialog()
Display the global settings dialog.
DECL_EXP void SetToolbarToolBitmapsSVG(int item, wxString SVGfile, wxString SVGfileRollover, wxString SVGfileToggled)
Updates SVG graphics for toolbar tool.
DECL_EXP void PlugInPlaySound(wxString &sound_file)
Plays a sound file asynchronously.
_PI_LUPname
Name identifiers for S57 lookup table sets.
@ PI_PLAIN_BOUNDARIES
Area objects with simple boundaries.
@ PI_PAPER_CHART
Point objects using traditional paper chart symbols.
@ PI_LINES
Line objects (e.g., depth contours, coastlines)
@ PI_LUPNAME_NUM
Total number of lookup table types.
@ PI_SIMPLIFIED
Point objects using simplified symbols.
@ PI_SYMBOLIZED_BOUNDARIES
Area objects with symbolized boundaries.
DECL_EXP std::vector< std::string > GetPriorityMaps()
Gets list of configured priority mapping schemes.
DECL_EXP ArrayOfPlugIn_AIS_Targets * GetAISTargetArray(void)
Gets array of AIS targets.
DECL_EXP void EnableSplitScreenLayout(bool enable=true)
Enable or disable the split-screen layout.
DECL_EXP bool UpdateSingleWaypoint(PlugIn_Waypoint *pwaypoint)
Updates a single waypoint.
DECL_EXP void SetCanvasProjection(int projection)
Sets chart projection type.
DECL_EXP bool AddPlugInTrack(PlugIn_Track *ptrack, bool b_permanent=true)
Adds a new track.
DECL_EXP int InsertPlugInToolSVG(wxString label, wxString SVGfile, wxString SVGfileRollover, wxString SVGfileToggled, wxItemKind kind, wxString shortHelp, wxString longHelp, wxObject *clientData, int position, int tool_sel, opencpn_plugin *pplugin)
Adds a tool using SVG graphics.
DECL_EXP wxString getUsrSpeedUnit_Plugin(int unit=-1)
Gets display string for user's preferred speed unit.
wxColour DECL_EXP GetBaseGlobalColor(wxString colorName)
Gets a global system color.
DECL_EXP bool GetEnableENCTextDisplay(int CanvasIndex)
Gets ENC text label visibility.
DECL_EXP bool GetEnableCompassGPSIcon(int CanvasIndex)
Gets compass icon visibility state.
OcpnProjTypePI
Enumeration of chart projection types.
@ PI_PROJECTION_UNKNOWN
Projection type is unknown or undefined.
@ PI_PROJECTION_MERCATOR
Mercator projection, standard for navigation charts.
@ PI_PROJECTION_STEREOGRAPHIC
Stereographic projection, used for polar and specialty charts.
@ PI_PROJECTION_GNOMONIC
Gnomonic projection, in which great circles appear as straight lines.
@ PI_PROJECTION_POLAR
Polar projection, used for polar regions.
@ PI_PROJECTION_POLYCONIC
Polyconic projection, sometimes used for inland charts.
@ PI_PROJECTION_TRANSVERSE_MERCATOR
Transverse Mercator projection, used for some coastal charts.
@ PI_PROJECTION_ORTHOGRAPHIC
Orthographic projection, showing Earth as viewed from space.
@ PI_PROJECTION_EQUIRECTANGULAR
Equirectangular/Plate Carrée projection, simple lat/lon grid.
DECL_EXP bool GetEnableMUIBar(int CanvasIndex)
Gets MUI bar visibility state.
DECL_EXP bool CheckMUIEdgePan_PlugIn(int x, int y, bool dragging, int margin, int delta, int canvasIndex)
Checks if chart should pan when cursor near edge.
DECL_EXP void EnableTouchMode(bool enable)
Enables/disables touch interface mode.
DECL_EXP void PluginZoomCanvas(int CanvasIndex, double factor)
Zoom a specific chart canvas by the given factor.
DECL_EXP wxString GetActiveWaypointGUID(void)
Gets GUID of currently active waypoint.
DECL_EXP bool AddSingleWaypointExV2(PlugIn_Waypoint_ExV2 *pwaypoint, bool b_permanent=true)
Adds a waypoint with extended V2 properties.
DECL_EXP void GetCanvasLLPix(PlugIn_ViewPort *vp, wxPoint p, double *plat, double *plon)
Converts canvas physical pixel coordinates to lat/lon.
DECL_EXP bool GetEnableLightDescriptionsDisplay(int CanvasIndex)
Gets light description text visibility.
enum _OBJECT_LAYER_REQ OBJECT_LAYER_REQ
Filter options for object queries.
DECL_EXP CommDriverResult RegisterTXPGNs(DriverHandle handle, std::vector< int > &pgn_list)
Register PGNs that this application intends to transmit for some NMEA 2000 adapters like Actisense NG...
DECL_EXP void SendPluginMessage(wxString message_id, wxString message_body)
Sends message to other plugins.
DECL_EXP wxString * GetpPrivateApplicationDataLocation()
Gets private application data directory.
DECL_EXP wxDialog * GetActiveOptionsDialog()
Gets pointer to active options dialog.
DECL_EXP void SetAppColorScheme(PI_ColorScheme cs)
Set the application color scheme.
DECL_EXP bool DeletePlugInTrack(wxString &GUID)
Deletes a track.
DECL_EXP bool GetEnableCurrentStationsDisplay(int CanvasIndex)
Gets current station icon visibility.
DECL_EXP int AddCanvasMenuItem(wxMenuItem *pitem, opencpn_plugin *pplugin, const char *name="")
Adds item to canvas context menu.
int DECL_EXP PI_PLIBRenderObjectToGL(const wxGLContext &glcc, PI_S57Obj *pObj, PlugIn_ViewPort *vp, wxRect &render_rect)
Renders any S57 object using OpenGL.
DECL_EXP bool GetEnableTideStationsDisplay(int CanvasIndex)
Gets tide station icon visibility.
DECL_EXP void SetCanvasMenuItemViz(int item, bool viz, const char *name="")
Temporarily changes context menu item visibility.
DECL_EXP void SetCanvasTilt(double tilt)
Gets current canvas tilt angle.
DECL_EXP std::vector< std::string > GetActivePriorityIdentifiers()
Gets list of active priority identifiers.
DECL_EXP void fromSM_Plugin(double x, double y, double lat0, double lon0, double *lat, double *lon)
Converts Simple Mercator coordinates to geographic.
DECL_EXP int GetCanvasCount()
Gets total number of chart canvases.
DECL_EXP void PluginSetFollowMode(int CanvasIndex, bool enable_follow)
Set follow mode for a specific canvas.
double DECL_EXP PI_GetPLIBMarinerSafetyContour()
Gets configured safety contour depth.
DECL_EXP void EnableLightsDisplay(bool enable, int CanvasIndex)
Controls light icon display.
PI_InitReturn
Return values for plugin initialization.
@ PI_INIT_OK
Initialization successful.
@ PI_INIT_FAIL_NOERROR
Init failed, request no explicit error message.
@ PI_INIT_FAIL_RETRY
Init failed, retry suggested.
@ PI_INIT_FAIL_REMOVE
Init failed, suggest remove from further use.
DECL_EXP void fromTM_Plugin(double x, double y, double lat0, double lon0, double *lat, double *lon)
Converts Transverse Mercator coordinates to geographic.
PI_DisCat DECL_EXP PI_GetObjectDisplayCategory(PI_S57Obj *pObj)
Gets display category for object.
DECL_EXP int RemoveChartFromDBInPlace(wxString &full_path)
Removes a chart from database without full rebuild.
DECL_EXP _OCPN_DLStatus OCPN_downloadFileBackground(const wxString &url, const wxString &outputFile, wxEvtHandler *handler, long *handle)
Asynchronously downloads a file in the background.
DECL_EXP wxString GetPluginDataDir(const char *plugin_name)
Returns an installed plugin's data directory given a plugin name.
DECL_EXP wxScrolledWindow * AddOptionsPage(OptionsParentPI parent, wxString title)
Adds a new preferences page to OpenCPN options dialog.
DECL_EXP bool GetTouchMode()
Gets touch interface mode state.
DECL_EXP wxString GetSelectedWaypointGUID_Plugin()
Gets GUID of currently selected waypoint.
DECL_EXP void ForceChartDBRebuild()
Forces complete rebuild of chart database.
OptionsParentPI
Enum defining parent pages in OpenCPN options dialog where plugins can add panels.
@ PI_OPTIONS_PARENT_DISPLAY
Display settings section.
@ PI_OPTIONS_PARENT_UI
User Interface section.
@ PI_OPTIONS_PARENT_SHIPS
Ships section.
@ PI_OPTIONS_PARENT_CHARTS
Charts section.
@ PI_OPTIONS_PARENT_PLUGINS
Plugins section.
@ PI_OPTIONS_PARENT_CONNECTIONS
Connections section.
DECL_EXP void SetToolbarToolViz(int item, bool viz)
Temporarily changes toolbar tool visibility.
int DECL_EXP PI_GetPLIBSymbolStyle()
Gets configured S52 symbol style.
DECL_EXP void EnableCompassGPSIcon(bool enable, int CanvasIndex)
Controls visibility of compass/GPS status icon.
int DECL_EXP PI_GetPLIBBoundaryStyle()
Gets configured S52 boundary style.
Configuration options for date and time formatting.
bool show_timezone
Whether to show timezone information in the formatted date/time string.
wxString format_string
The format string for date/time.
DateTimeFormatOptions & SetFormatString(const wxString &fmt)
Sets the date/time format pattern string.
DateTimeFormatOptions & SetShowTimezone(bool show)
Sets whether to show timezone information in the formatted output.
DateTimeFormatOptions & SetTimezone(const wxString &tz)
Sets the timezone mode for date/time display.
wxString time_zone
The timezone to use when formatting the date/time.
DateTimeFormatOptions & SetLongitude(double lon)
Sets the reference longitude for Local Mean Time (LMT) calculations.
double longitude
The longitude to use when formatting the date/time in Local Mean Time (LMT).
Identifier for NMEA 0183 sentence types.
const std::string id
Sentence identifier.
NMEA0183Id(const std::string &s)
Creates identifier from sentence type.
Identifier for NMEA 2000 message types.
const uint64_t id
The PGN value.
NMEA2000Id(int value)
Creates identifier from PGN value.
Navigation data message identifier.
const int type
Message type identifier (currently only 0 supported)
NavDataId()
Default constructor.
Facade for NotificationMsg.
Facade for NavAddrPluginMsg.
Basic navigation data structure.
double var
Magnetic variation in degrees.
double cog
Course over ground in degrees.
double lon
Longitude in decimal degrees.
double lat
Latitude in decimal degrees.
double sog
Speed over ground in knots.
double hdt
True heading in degrees.
time_t time
UTC timestamp of data.
Identifier for Signal K paths.
SignalkId(const std::string &s)
Creates identifier from Signal K path.
const std::string id
Signal K path.
Geographic extent structure defining a bounding box.
double NLAT
Northern latitude boundary in decimal degrees.
double WLON
Western longitude boundary in decimal degrees.
double SLAT
Southern latitude boundary in decimal degrees.
double ELON
Eastern longitude boundary in decimal degrees.