forked from OpenCPN/OpenCPN
-
Notifications
You must be signed in to change notification settings - Fork 0
/
ocpn_plugin.h
1357 lines (1035 loc) · 51.9 KB
/
ocpn_plugin.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/***************************************************************************
*
* Project: OpenCPN
* Purpose: PlugIn Object Definition/API
* Author: David Register
*
***************************************************************************
* Copyright (C) 2010 by David S. Register *
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
* This program is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* GNU General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License *
* along with this program; if not, write to the *
* Free Software Foundation, Inc., *
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. *
**************************************************************************/
#ifndef _PLUGIN_H_
#define _PLUGIN_H_
#ifndef DECL_EXP
#ifdef __WXMSW__
# define DECL_EXP __declspec(dllexport)
#else
# ifdef __GNUC__
# define DECL_EXP __attribute__((visibility("default")))
# endif
#endif
#endif
#ifdef __WXMSW__
#ifdef MAKING_PLUGIN
# define DECL_IMP __declspec(dllimport)
#endif
#endif
#include <wx/xml/xml.h>
#ifdef ocpnUSE_SVG
#include "wxsvg/include/wxSVG/svg.h"
#endif // ocpnUSE_SVG
#include <memory>
class wxGLContext;
// This is the most modern API Version number
// It is expected that the API will remain downward compatible, meaning that
// PlugIns conforming to API Version less then the most modern will also
// be correctly supported.
#define API_VERSION_MAJOR 1
#define API_VERSION_MINOR 16
// Fwd Definitions
class wxFileConfig;
class wxNotebook;
class wxFont;
class wxAuiManager;
class wxScrolledWindow;
class wxGLCanvas;
//---------------------------------------------------------------------------------------------------------
//
// Bitfield PlugIn Capabilites flag definition
//
//---------------------------------------------------------------------------------------------------------
#define WANTS_OVERLAY_CALLBACK 0x00000001
#define WANTS_CURSOR_LATLON 0x00000002
#define WANTS_TOOLBAR_CALLBACK 0x00000004
#define INSTALLS_TOOLBAR_TOOL 0x00000008
#define WANTS_CONFIG 0x00000010
#define INSTALLS_TOOLBOX_PAGE 0x00000020
#define INSTALLS_CONTEXTMENU_ITEMS 0x00000040
#define WANTS_NMEA_SENTENCES 0x00000080
#define WANTS_NMEA_EVENTS 0x00000100
#define WANTS_AIS_SENTENCES 0x00000200
#define USES_AUI_MANAGER 0x00000400
#define WANTS_PREFERENCES 0x00000800
#define INSTALLS_PLUGIN_CHART 0x00001000
#define WANTS_ONPAINT_VIEWPORT 0x00002000
#define WANTS_PLUGIN_MESSAGING 0x00004000
#define WANTS_OPENGL_OVERLAY_CALLBACK 0x00008000
#define WANTS_DYNAMIC_OPENGL_OVERLAY_CALLBACK 0x00010000
#define WANTS_LATE_INIT 0x00020000
#define INSTALLS_PLUGIN_CHART_GL 0x00040000
#define WANTS_MOUSE_EVENTS 0x00080000
#define WANTS_VECTOR_CHART_OBJECT_INFO 0x00100000
#define WANTS_KEYBOARD_EVENTS 0x00200000
//----------------------------------------------------------------------------------------------------------
// Some PlugIn API interface object class definitions
//----------------------------------------------------------------------------------------------------------
enum PI_ColorScheme
{
PI_GLOBAL_COLOR_SCHEME_RGB,
PI_GLOBAL_COLOR_SCHEME_DAY,
PI_GLOBAL_COLOR_SCHEME_DUSK,
PI_GLOBAL_COLOR_SCHEME_NIGHT,
PI_N_COLOR_SCHEMES
};
class PlugIn_ViewPort
{
public:
double clat; // center point
double clon;
double view_scale_ppm;
double skew;
double rotation;
float chart_scale; // conventional chart displayed scale
int pix_width;
int pix_height;
wxRect rv_rect;
bool b_quilt;
int m_projection_type;
double lat_min, lat_max, lon_min, lon_max;
bool bValid; // This VP is valid
};
class PlugIn_Position_Fix
{
public:
double Lat;
double Lon;
double Cog;
double Sog;
double Var; // Variation, typically from RMC message
time_t FixTime;
int nSats;
};
class PlugIn_Position_Fix_Ex
{
public:
double Lat;
double Lon;
double Cog;
double Sog;
double Var; // Variation, typically from RMC message
double Hdm;
double Hdt;
time_t FixTime;
int nSats;
};
// Describe AIS Alarm state
enum plugin_ais_alarm_type
{
PI_AIS_NO_ALARM = 0,
PI_AIS_ALARM_SET,
PI_AIS_ALARM_ACKNOWLEDGED
};
class PlugIn_AIS_Target
{
public:
int MMSI;
int Class;
int NavStatus;
double SOG;
double COG;
double HDG;
double Lon;
double Lat;
int ROTAIS;
char CallSign[8]; // includes terminator
char ShipName[21];
unsigned char ShipType;
int IMO;
double Range_NM;
double Brg;
// Per target collision parameters
bool bCPA_Valid;
double TCPA; // Minutes
double CPA; // Nautical Miles
plugin_ais_alarm_type alarm_state;
};
// ChartType constants
typedef enum ChartTypeEnumPI
{
PI_CHART_TYPE_UNKNOWN = 0,
PI_CHART_TYPE_DUMMY,
PI_CHART_TYPE_DONTCARE,
PI_CHART_TYPE_KAP,
PI_CHART_TYPE_GEO,
PI_CHART_TYPE_S57,
PI_CHART_TYPE_CM93,
PI_CHART_TYPE_CM93COMP,
PI_CHART_TYPE_PLUGIN
}_ChartTypeEnumPI;
// ChartFamily constants
typedef enum ChartFamilyEnumPI
{
PI_CHART_FAMILY_UNKNOWN = 0,
PI_CHART_FAMILY_RASTER,
PI_CHART_FAMILY_VECTOR,
PI_CHART_FAMILY_DONTCARE
}_ChartFamilyEnumPI;
// Depth unit type enum
typedef enum ChartDepthUnitTypePI
{
PI_DEPTH_UNIT_UNKNOWN,
PI_DEPTH_UNIT_FEET,
PI_DEPTH_UNIT_METERS,
PI_DEPTH_UNIT_FATHOMS
}_ChartDepthUnitTypePI;
// Projection type enum
typedef enum OcpnProjTypePI
{
PI_PROJECTION_UNKNOWN,
PI_PROJECTION_MERCATOR,
PI_PROJECTION_TRANSVERSE_MERCATOR,
PI_PROJECTION_POLYCONIC,
PI_PROJECTION_ORTHOGRAPHIC,
PI_PROJECTION_POLAR,
PI_PROJECTION_STEREOGRAPHIC,
PI_PROJECTION_GNOMONIC,
PI_PROJECTION_EQUIRECTANGULAR
}_OcpnProjTypePI;
typedef struct _ExtentPI{
double SLAT;
double WLON;
double NLAT;
double ELON;
}ExtentPI;
// PlugInChartBase::Init() init_flags constants
#define PI_FULL_INIT 0
#define PI_HEADER_ONLY 1
#define PI_THUMB_ONLY 2
// ----------------------------------------------------------------------------
// PlugInChartBase
// This class is the base class for Plug-able chart types
// ----------------------------------------------------------------------------
class DECL_EXP PlugInChartBase : public wxObject
{
public:
// These methods Must be overriden in any derived class
PlugInChartBase();
virtual ~PlugInChartBase();
virtual wxString GetFileSearchMask(void);
virtual int Init( const wxString& full_path, int init_flags );
virtual void SetColorScheme(int cs, bool bApplyImmediate);
virtual double GetNormalScaleMin(double canvas_scale_factor, bool b_allow_overzoom);
virtual double GetNormalScaleMax(double canvas_scale_factor, int canvas_width);
virtual double GetNearestPreferredScalePPM(double target_scale_ppm);
virtual bool GetChartExtent(ExtentPI *pext);
virtual wxBitmap &RenderRegionView(const PlugIn_ViewPort& VPoint, const wxRegion &Region);
virtual bool AdjustVP(PlugIn_ViewPort &vp_last, PlugIn_ViewPort &vp_proposed);
virtual void GetValidCanvasRegion(const PlugIn_ViewPort& VPoint, wxRegion *pValidRegion);
virtual int GetCOVREntries(){ return 0; }
virtual int GetCOVRTablePoints(int iTable) { return 0; }
virtual int GetCOVRTablenPoints(int iTable){ return 0; }
virtual float *GetCOVRTableHead(int iTable){ return (float *)NULL; }
virtual wxBitmap *GetThumbnail(int tnx, int tny, int cs);
// Accessors, need not be overridden in derived class if the member variables are maintained
virtual wxString GetFullPath() const { return m_FullPath;}
virtual ChartTypeEnumPI GetChartType() { return m_ChartType;}
virtual ChartFamilyEnumPI GetChartFamily() { return m_ChartFamily;}
virtual OcpnProjTypePI GetChartProjection() { return m_projection;}
virtual wxString GetName() { return m_Name;}
virtual wxString GetDescription() { return m_Description;}
virtual wxString GetID() { return m_ID;}
virtual wxString GetSE() { return m_SE;}
virtual wxString GetDepthUnits() { return m_DepthUnits;}
virtual wxString GetSoundingsDatum() { return m_SoundingsDatum;}
virtual wxString GetDatumString() { return m_datum_str;}
virtual wxString GetExtraInfo() { return m_ExtraInfo; }
virtual wxString GetPubDate() { return m_PubYear;}
virtual double GetChartErrorFactor() { return m_Chart_Error_Factor;}
virtual ChartDepthUnitTypePI GetDepthUnitId() { return m_depth_unit_id;}
virtual bool IsReadyToRender() { return m_bReadyToRender;}
virtual int GetNativeScale() { return m_Chart_Scale; };
virtual double GetChartSkew() { return m_Chart_Skew; }
virtual wxDateTime GetEditionDate(void) { return m_EdDate;}
// Methods pertaining to CHART_FAMILY_RASTER type PlugIn charts only
virtual void ComputeSourceRectangle(const PlugIn_ViewPort &vp, wxRect *pSourceRect);
virtual double GetRasterScaleFactor();
virtual bool GetChartBits( wxRect& source, unsigned char *pPix, int sub_samp );
virtual int GetSize_X();
virtual int GetSize_Y();
virtual void latlong_to_chartpix(double lat, double lon, double &pixx, double &pixy);
virtual void chartpix_to_latlong(double pixx, double pixy, double *plat, double *plon);
protected:
ChartTypeEnumPI m_ChartType;
ChartFamilyEnumPI m_ChartFamily;
wxString m_FullPath;
OcpnProjTypePI m_projection;
int m_Chart_Scale;
double m_Chart_Skew;
wxDateTime m_EdDate;
bool m_bReadyToRender;
wxString m_Name;
wxString m_Description;
wxString m_ID;
wxString m_SE;
wxString m_SoundingsDatum;
wxString m_datum_str;
wxString m_PubYear;
wxString m_DepthUnits;
wxString m_ExtraInfo;
ChartDepthUnitTypePI m_depth_unit_id;
double m_Chart_Error_Factor;
};
// Declare an array of PlugIn_AIS_Targets
WX_DEFINE_ARRAY_PTR(PlugIn_AIS_Target *, ArrayOfPlugIn_AIS_Targets);
//----------------------------------------------------------------------------------------------------------
// The Generic PlugIn Interface Class Definition
//
// This is a virtual class.
// opencpn PlugIns must derive from this class.
// There are two types of methods in this class
// a. Required...must be overridden and implemented by PlugIns
// b. Optional..may be overridden by PlugIns
// PlugIns must implement optional method overrides consistent with their
// declared capabilities flag as returned by Init().
//----------------------------------------------------------------------------------------------------------
class DECL_EXP opencpn_plugin
{
public:
opencpn_plugin(void *pmgr) {}
virtual ~opencpn_plugin();
// Public API to the PlugIn class
// This group of methods is required, and will be called by the opencpn host
// opencpn PlugIns must implement this group
virtual int Init(void); // Return the PlugIn Capabilites flag
virtual bool DeInit(void);
virtual int GetAPIVersionMajor();
virtual int GetAPIVersionMinor();
virtual int GetPlugInVersionMajor();
virtual int GetPlugInVersionMinor();
virtual wxBitmap *GetPlugInBitmap();
// These three methods should produce valid, meaningful strings always
// ---EVEN IF--- the PlugIn has not (yet) been initialized.
// They are used by the PlugInManager GUI
virtual wxString GetCommonName();
virtual wxString GetShortDescription();
virtual wxString GetLongDescription();
// This group is optional.
// PlugIns may override any of these methods as required
virtual void SetDefaults(void); //This will be called upon enabling a PlugIn via the user Dialog
//It gives a chance to setup any default options and behavior
virtual int GetToolbarToolCount(void);
virtual int GetToolboxPanelCount(void);
virtual void SetupToolboxPanel(int page_sel, wxNotebook* pnotebook);
virtual void OnCloseToolboxPanel(int page_sel, int ok_apply_cancel);
virtual void ShowPreferencesDialog( wxWindow* parent );
virtual bool RenderOverlay(wxMemoryDC *pmdc, PlugIn_ViewPort *vp);
virtual void SetCursorLatLon(double lat, double lon);
virtual void SetCurrentViewPort(PlugIn_ViewPort &vp);
virtual void SetPositionFix(PlugIn_Position_Fix &pfix);
virtual void SetNMEASentence(wxString &sentence);
virtual void SetAISSentence(wxString &sentence);
virtual void ProcessParentResize(int x, int y);
virtual void SetColorScheme(PI_ColorScheme cs);
virtual void OnToolbarToolCallback(int id);
virtual void OnContextMenuItemCallback(int id);
virtual void UpdateAuiStatus(void);
virtual wxArrayString GetDynamicChartClassNameArray(void);
};
// the types of the class factories used to create PlugIn instances
typedef opencpn_plugin* create_t(void*);
typedef void destroy_t(opencpn_plugin*);
class DECL_EXP opencpn_plugin_16 : public opencpn_plugin
{
public:
opencpn_plugin_16(void *pmgr);
virtual ~opencpn_plugin_16();
virtual bool RenderOverlay(wxDC &dc, PlugIn_ViewPort *vp);
virtual void SetPluginMessage(wxString &message_id, wxString &message_body);
};
class DECL_EXP opencpn_plugin_17 : public opencpn_plugin
{
public:
opencpn_plugin_17(void *pmgr);
virtual ~opencpn_plugin_17();
virtual bool RenderOverlay(wxDC &dc, PlugIn_ViewPort *vp);
virtual bool RenderGLOverlay(wxGLContext *pcontext, PlugIn_ViewPort *vp);
virtual void SetPluginMessage(wxString &message_id, wxString &message_body);
};
class DECL_EXP opencpn_plugin_18 : public opencpn_plugin
{
public:
opencpn_plugin_18(void *pmgr);
virtual ~opencpn_plugin_18();
virtual bool RenderOverlay(wxDC &dc, PlugIn_ViewPort *vp);
virtual bool RenderGLOverlay(wxGLContext *pcontext, PlugIn_ViewPort *vp);
virtual void SetPluginMessage(wxString &message_id, wxString &message_body);
virtual void SetPositionFixEx(PlugIn_Position_Fix_Ex &pfix);
};
class DECL_EXP opencpn_plugin_19 : public opencpn_plugin_18
{
public:
opencpn_plugin_19(void *pmgr);
virtual ~opencpn_plugin_19();
virtual void OnSetupOptions(void);
};
class DECL_EXP opencpn_plugin_110 : public opencpn_plugin_19
{
public:
opencpn_plugin_110(void *pmgr);
virtual ~opencpn_plugin_110();
virtual void LateInit(void); // If WANTS_LATE_INIT is returned by Init()
};
class DECL_EXP opencpn_plugin_111 : public opencpn_plugin_110
{
public:
opencpn_plugin_111(void *pmgr);
virtual ~opencpn_plugin_111();
};
class DECL_EXP opencpn_plugin_112 : public opencpn_plugin_111
{
public:
opencpn_plugin_112(void *pmgr);
virtual ~opencpn_plugin_112();
virtual bool MouseEventHook( wxMouseEvent &event );
virtual void SendVectorChartObjectInfo(wxString &chart, wxString &feature, wxString &objname, double lat, double lon, double scale, int nativescale);
};
class DECL_EXP opencpn_plugin_113 : public opencpn_plugin_112
{
public:
opencpn_plugin_113(void *pmgr);
virtual ~opencpn_plugin_113();
virtual bool KeyboardEventHook( wxKeyEvent &event );
virtual void OnToolbarToolDownCallback(int id);
virtual void OnToolbarToolUpCallback(int id);
};
class DECL_EXP opencpn_plugin_114 : public opencpn_plugin_113
{
public:
opencpn_plugin_114(void *pmgr);
virtual ~opencpn_plugin_114();
};
class DECL_EXP opencpn_plugin_115 : public opencpn_plugin_114
{
public:
opencpn_plugin_115(void *pmgr);
virtual ~opencpn_plugin_115();
};
//------------------------------------------------------------------
// Route and Waypoint PlugIn support
//
//------------------------------------------------------------------
class DECL_EXP Plugin_Hyperlink
{
public:
wxString DescrText;
wxString Link;
wxString Type;
};
WX_DECLARE_LIST(Plugin_Hyperlink, Plugin_HyperlinkList);
class DECL_EXP PlugIn_Waypoint
{
public:
PlugIn_Waypoint();
PlugIn_Waypoint(double lat, double lon,
const wxString& icon_ident, const wxString& wp_name,
const wxString& GUID = _T("") );
~PlugIn_Waypoint();
double m_lat;
double m_lon;
wxString m_GUID;
wxString m_MarkName;
wxString m_MarkDescription;
wxDateTime m_CreateTime;
bool m_IsVisible;
wxString m_IconName;
Plugin_HyperlinkList *m_HyperlinkList;
};
WX_DECLARE_LIST(PlugIn_Waypoint, Plugin_WaypointList);
class DECL_EXP PlugIn_Route
{
public:
PlugIn_Route(void);
~PlugIn_Route(void);
wxString m_NameString;
wxString m_StartString;
wxString m_EndString;
wxString m_GUID;
Plugin_WaypointList *pWaypointList;
};
class DECL_EXP PlugIn_Track
{
public:
PlugIn_Track(void);
~PlugIn_Track(void);
wxString m_NameString;
wxString m_StartString;
wxString m_EndString;
wxString m_GUID;
Plugin_WaypointList *pWaypointList;
};
//----------------------------------------------------------------------------------------------------------
// The PlugIn CallBack API Definition
//
// The API back up to the PlugIn Manager
// PlugIns may call these static functions as necessary for system services
//
//----------------------------------------------------------------------------------------------------------
extern "C" 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);
extern "C" DECL_EXP void RemovePlugInTool(int tool_id);
extern "C" DECL_EXP void SetToolbarToolViz(int item, bool viz); // Temporarily change toolbar tool viz
extern "C" DECL_EXP void SetToolbarItemState(int item, bool toggle);
extern "C" DECL_EXP void SetToolbarToolBitmaps(int item, wxBitmap *bitmap, wxBitmap *bmpRollover);
extern "C" 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);
extern "C" DECL_EXP void SetToolbarToolBitmapsSVG(int item, wxString SVGfile,
wxString SVGfileRollover,
wxString SVGfileToggled );
extern "C" DECL_EXP int AddCanvasContextMenuItem(wxMenuItem *pitem, opencpn_plugin *pplugin );
extern "C" DECL_EXP void RemoveCanvasContextMenuItem(int item); // Fully remove this item
extern "C" DECL_EXP void SetCanvasContextMenuItemViz(int item, bool viz); // Temporarily change context menu ptions
extern "C" DECL_EXP void SetCanvasContextMenuItemGrey(int item, bool grey);
extern "C" DECL_EXP wxFileConfig *GetOCPNConfigObject(void);
extern "C" DECL_EXP void RequestRefresh(wxWindow *);
extern "C" DECL_EXP bool GetGlobalColor(wxString colorName, wxColour *pcolour);
extern "C" DECL_EXP void GetCanvasPixLL(PlugIn_ViewPort *vp, wxPoint *pp, double lat, double lon);
extern "C" DECL_EXP void GetCanvasLLPix( PlugIn_ViewPort *vp, wxPoint p, double *plat, double *plon);
extern "C" DECL_EXP wxWindow *GetOCPNCanvasWindow();
extern "C" DECL_EXP wxFont *OCPNGetFont(wxString TextElement, int default_size);
extern "C" DECL_EXP wxString *GetpSharedDataLocation();
extern "C" DECL_EXP ArrayOfPlugIn_AIS_Targets *GetAISTargetArray(void);
extern "C" DECL_EXP wxAuiManager *GetFrameAuiManager(void);
extern "C" DECL_EXP bool AddLocaleCatalog( wxString catalog );
extern "C" DECL_EXP void PushNMEABuffer( wxString str );
extern DECL_EXP wxXmlDocument GetChartDatabaseEntryXML(int dbIndex, bool b_getGeom);
extern DECL_EXP bool UpdateChartDBInplace(wxArrayString dir_array,
bool b_force_update,
bool b_ProgressDialog);
extern DECL_EXP wxArrayString GetChartDBDirArrayString();
extern "C" DECL_EXP void SendPluginMessage( wxString message_id, wxString message_body );
extern "C" DECL_EXP void DimeWindow(wxWindow *);
extern "C" DECL_EXP void JumpToPosition(double lat, double lon, double scale);
/* API 1.9 adds some common cartographic functions to avoid unnecessary code duplication */
/* Study the original OpenCPN source (georef.c) for functional definitions */
extern "C" DECL_EXP void PositionBearingDistanceMercator_Plugin(double lat, double lon, double brg, double dist, double *dlat, double *dlon);
extern "C" DECL_EXP void DistanceBearingMercator_Plugin(double lat0, double lon0, double lat1, double lon1, double *brg, double *dist);
extern "C" DECL_EXP double DistGreatCircle_Plugin(double slat, double slon, double dlat, double dlon);
extern "C" DECL_EXP void toTM_Plugin(float lat, float lon, float lat0, float lon0, double *x, double *y);
extern "C" DECL_EXP void fromTM_Plugin(double x, double y, double lat0, double lon0, double *lat, double *lon);
extern "C" DECL_EXP void toSM_Plugin(double lat, double lon, double lat0, double lon0, double *x, double *y);
extern "C" DECL_EXP void fromSM_Plugin(double x, double y, double lat0, double lon0, double *lat, double *lon);
extern "C" DECL_EXP void toSM_ECC_Plugin(double lat, double lon, double lat0, double lon0, double *x, double *y);
extern "C" DECL_EXP void fromSM_ECC_Plugin(double x, double y, double lat0, double lon0, double *lat, double *lon);
extern "C" DECL_EXP bool DecodeSingleVDOMessage( const wxString& str, PlugIn_Position_Fix_Ex *pos, wxString *acc );
extern "C" DECL_EXP int GetChartbarHeight( void );
extern "C" DECL_EXP bool GetActiveRoutepointGPX( char *buffer, unsigned int buffer_length );
/* API 1.9 */
typedef enum OptionsParentPI
{
PI_OPTIONS_PARENT_DISPLAY,
PI_OPTIONS_PARENT_CONNECTIONS,
PI_OPTIONS_PARENT_CHARTS,
PI_OPTIONS_PARENT_SHIPS,
PI_OPTIONS_PARENT_UI,
PI_OPTIONS_PARENT_PLUGINS
}_OptionsParentPI;
extern DECL_EXP wxScrolledWindow *AddOptionsPage( OptionsParentPI parent, wxString title );
extern DECL_EXP bool DeleteOptionsPage( wxScrolledWindow* page );
/* API 1.10 */
/* API 1.10 adds some common functions to avoid unnecessary code duplication */
/* Study the original OpenCPN source for functional definitions */
extern "C" DECL_EXP double toUsrDistance_Plugin( double nm_distance, int unit = -1 );
extern "C" DECL_EXP double fromUsrDistance_Plugin( double usr_distance, int unit = -1 );
extern "C" DECL_EXP double toUsrSpeed_Plugin( double kts_speed, int unit = -1 );
extern "C" DECL_EXP double fromUsrSpeed_Plugin( double usr_speed, int unit = -1 );
extern DECL_EXP wxString getUsrDistanceUnit_Plugin( int unit = -1 );
extern DECL_EXP wxString getUsrSpeedUnit_Plugin( int unit = -1 );
extern DECL_EXP wxString GetNewGUID();
extern "C" DECL_EXP bool PlugIn_GSHHS_CrossesLand(double lat1, double lon1, double lat2, double lon2);
extern DECL_EXP void PlugInPlaySound( wxString &sound_file );
// API 1.10 Route and Waypoint Support
extern DECL_EXP wxBitmap *FindSystemWaypointIcon( wxString& icon_name );
extern DECL_EXP bool AddCustomWaypointIcon( wxBitmap *pimage, wxString key, wxString description );
extern DECL_EXP bool AddSingleWaypoint( PlugIn_Waypoint *pwaypoint, bool b_permanent = true);
extern DECL_EXP bool DeleteSingleWaypoint( wxString &GUID );
extern DECL_EXP bool UpdateSingleWaypoint( PlugIn_Waypoint *pwaypoint );
extern DECL_EXP bool AddPlugInRoute( PlugIn_Route *proute, bool b_permanent = true );
extern DECL_EXP bool DeletePlugInRoute( wxString& GUID );
extern DECL_EXP bool UpdatePlugInRoute ( PlugIn_Route *proute );
extern DECL_EXP bool AddPlugInTrack( PlugIn_Track *ptrack, bool b_permanent = true );
extern DECL_EXP bool DeletePlugInTrack( wxString& GUID );
extern DECL_EXP bool UpdatePlugInTrack ( PlugIn_Track *ptrack );
/* API 1.11 */
/* API 1.11 adds some more common functions to avoid unnecessary code duplication */
wxColour DECL_EXP GetBaseGlobalColor(wxString colorName);
int DECL_EXP OCPNMessageBox_PlugIn(wxWindow *parent,
const wxString& message,
const wxString& caption = _T("Message"),
int style = wxOK, int x = -1, int y = -1);
extern DECL_EXP wxString toSDMM_PlugIn(int NEflag, double a, bool hi_precision = true);
extern "C" DECL_EXP wxString *GetpPrivateApplicationDataLocation();
extern DECL_EXP wxString GetOCPN_ExePath( void );
extern "C" DECL_EXP wxString *GetpPlugInLocation();
extern DECL_EXP wxString GetPlugInPath(opencpn_plugin *pplugin);
extern "C" DECL_EXP int AddChartToDBInPlace( wxString &full_path, bool b_RefreshCanvas );
extern "C" DECL_EXP int RemoveChartFromDBInPlace( wxString &full_path );
extern DECL_EXP wxString GetLocaleCanonicalName();
// API 1.11 adds access to S52 Presentation library
//Types
// A flag field that defines the object capabilities passed by a chart to the S52 PLIB
#define PLIB_CAPS_LINE_VBO 1
#define PLIB_CAPS_LINE_BUFFER 1 << 1
#define PLIB_CAPS_SINGLEGEO_BUFFER 1 << 2
#define PLIB_CAPS_OBJSEGLIST 1 << 3
#define PLIB_CAPS_OBJCATMUTATE 1 << 4
class PI_S57Obj;
WX_DECLARE_LIST(PI_S57Obj, ListOfPI_S57Obj);
class PI_ChartObj;
WX_DECLARE_LIST(PI_ChartObj, ListOfPI_ChartObj);
// ----------------------------------------------------------------------------
// PlugInChartBaseGL
// Derived from PlugInChartBase, add OpenGL Vector chart support
// ----------------------------------------------------------------------------
class ListOfS57ObjRegion;
class DECL_EXP PlugInChartBaseGL : public PlugInChartBase
{
public:
PlugInChartBaseGL();
virtual ~PlugInChartBaseGL();
virtual int RenderRegionViewOnGL( const wxGLContext &glc, const PlugIn_ViewPort& VPoint,
const wxRegion &Region, bool b_use_stencil );
virtual ListOfPI_S57Obj *GetObjRuleListAtLatLon(float lat, float lon, float select_radius, PlugIn_ViewPort *VPoint);
virtual wxString CreateObjDescriptions( ListOfPI_S57Obj* obj_list );
virtual int GetNoCOVREntries();
virtual int GetNoCOVRTablePoints(int iTable);
virtual int GetNoCOVRTablenPoints(int iTable);
virtual float *GetNoCOVRTableHead(int iTable);
};
// ----------------------------------------------------------------------------
// PlugInChartBaseExtended
// Derived from PlugInChartBase, add extended chart support methods
// ----------------------------------------------------------------------------
class DECL_EXP PlugInChartBaseExtended : public PlugInChartBase
{
public:
PlugInChartBaseExtended();
virtual ~PlugInChartBaseExtended();
virtual int RenderRegionViewOnGL( const wxGLContext &glc, const PlugIn_ViewPort& VPoint,
const wxRegion &Region, bool b_use_stencil );
virtual wxBitmap &RenderRegionViewOnDCNoText( const PlugIn_ViewPort& VPoint, const wxRegion &Region);
virtual bool RenderRegionViewOnDCTextOnly( wxMemoryDC &dc, const PlugIn_ViewPort& VPoint, const wxRegion &Region);
virtual int RenderRegionViewOnGLNoText( const wxGLContext &glc, const PlugIn_ViewPort& VPoint,
const wxRegion &Region, bool b_use_stencil );
virtual int RenderRegionViewOnGLTextOnly( const wxGLContext &glc, const PlugIn_ViewPort& VPoint,
const wxRegion &Region, bool b_use_stencil );
virtual ListOfPI_S57Obj *GetObjRuleListAtLatLon(float lat, float lon, float select_radius, PlugIn_ViewPort *VPoint);
virtual wxString CreateObjDescriptions( ListOfPI_S57Obj* obj_list );
virtual int GetNoCOVREntries();
virtual int GetNoCOVRTablePoints(int iTable);
virtual int GetNoCOVRTablenPoints(int iTable);
virtual float *GetNoCOVRTableHead(int iTable);
virtual void ClearPLIBTextList();
virtual ListOfS57ObjRegion *GetHazards(const void *region, ListOfS57ObjRegion *lst = 0);
};
class wxArrayOfS57attVal;
// name of the addressed look up table set (fifth letter)
typedef enum _PI_LUPname{
PI_SIMPLIFIED = 'L', // points
PI_PAPER_CHART = 'R', // points
PI_LINES = 'S', // lines
PI_PLAIN_BOUNDARIES = 'N', // areas
PI_SYMBOLIZED_BOUNDARIES = 'O', // areas
PI_LUPNAME_NUM = 5
}PI_LUPname;
// display category type
typedef enum _PI_DisCat{
PI_DISPLAYBASE = 'D', //
PI_STANDARD = 'S', //
PI_OTHER = 'O', // O for OTHER
PI_MARINERS_STANDARD = 'M', // Mariner specified
PI_MARINERS_OTHER, // value not defined
PI_DISP_CAT_NUM, // value not defined
}PI_DisCat;
// Display Priority
typedef enum _PI_DisPrio{
PI_PRIO_NODATA = '0', // no data fill area pattern
PI_PRIO_GROUP1 = '1', // S57 group 1 filled areas
PI_PRIO_AREA_1 = '2', // superimposed areas
PI_PRIO_AREA_2 = '3', // superimposed areas also water features
PI_PRIO_SYMB_POINT = '4', // point symbol also land features
PI_PRIO_SYMB_LINE = '5', // line symbol also restricted areas
PI_PRIO_SYMB_AREA = '6', // area symbol also traffic areas
PI_PRIO_ROUTEING = '7', // routeing lines
PI_PRIO_HAZARDS = '8', // hazards
PI_PRIO_MARINERS = '9', // VRM, EBL, own ship
PI_PRIO_NUM = 10 // number of priority levels
}PI_DisPrio;
typedef enum PI_InitReturn
{
PI_INIT_OK = 0,
PI_INIT_FAIL_RETRY, // Init failed, retry suggested
PI_INIT_FAIL_REMOVE, // Init failed, suggest remove from further use
PI_INIT_FAIL_NOERROR // Init failed, request no explicit error message
}_PI_InitReturn;
class PI_line_segment_element
{
public:
size_t vbo_offset;
size_t n_points;
int priority;
float lat_max; // segment bounding box
float lat_min;
float lon_max;
float lon_min;
int type;
void *private0;
PI_line_segment_element *next;
};
class DECL_EXP PI_S57Obj
{
public:
// Public Methods
PI_S57Obj();
~PI_S57Obj();
public:
// Instance Data
char FeatureName[8];
int Primitive_type;
char *att_array;
wxArrayOfS57attVal *attVal;
int n_attr;
int iOBJL;
int Index;
double x; // for POINT
double y;
double z;
int npt; // number of points as needed by arrays
void *geoPt; // for LINE & AREA not described by PolyTessGeo
double *geoPtz; // an array[3] for MultiPoint, SM with Z, i.e. depth
double *geoPtMulti; // an array[2] for MultiPoint, lat/lon to make bbox
// of decomposed points
void *pPolyTessGeo;
double m_lat; // The lat/lon of the object's "reference" point
double m_lon;
double chart_ref_lat;
double chart_ref_lon;
double lat_min;
double lat_max;
double lon_min;
double lon_max;
int Scamin; // SCAMIN attribute decoded during load
bool bIsClone;
int nRef; // Reference counter, to signal OK for deletion
bool bIsAton; // This object is an aid-to-navigation
bool bIsAssociable; // This object is DRGARE or DEPARE
int m_n_lsindex;
int *m_lsindex_array;
int m_n_edge_max_points;
void *m_chart_context;
PI_DisCat m_DisplayCat;
void * S52_Context;
PI_S57Obj *child; // child list, used only for MultiPoint Soundings
PI_S57Obj *next; // List linkage
// This transform converts from object geometry
// to SM coordinates.
double x_rate; // These auxiliary transform coefficients are
double y_rate; // to be used in GetPointPix() and friends
double x_origin; // on a per-object basis if necessary
double y_origin;
int auxParm0; // some per-object auxiliary parameters, used for OpenGL
int auxParm1;
int auxParm2;
int auxParm3;
PI_line_segment_element *m_ls_list;
bool m_bcategory_mutable;
int m_DPRI;
};
wxString DECL_EXP PI_GetPLIBColorScheme();
int DECL_EXP PI_GetPLIBDepthUnitInt();
int DECL_EXP PI_GetPLIBSymbolStyle();
int DECL_EXP PI_GetPLIBBoundaryStyle();