wmm_pi.h

Go to the documentation of this file.

/**************************************************************************
 *   Copyright (C) 2011 by Pavel Kalian                                    *
 *                                                                         *
 *   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, see <https://www.gnu.org/licenses/>. *
 **************************************************************************/
 
#ifndef WMMPI_H_
#define WMMPI_H_
 
#include <wx/wxprec.h>
 
#ifndef WX_PRECOMP
#include <wx/wx.h>
#endif
 
#include <wx/fileconf.h>
 
#include "version.h"
#include "ocpn_plugin.h"
 
#include "EGM9615.h"
#include "GeomagnetismHeader.h"
#include "jsonreader.h"
#include "jsonwriter.h"
#include "magnetic_plot_map.h"
#include "pi_ocpndc.h"
#include "wmm_ui_dialog.h"
#include "wxWTranslateCatalog.h"
 
#define MY_API_VERSION_MAJOR 1
#define MY_API_VERSION_MINOR 9
 
#define WMM_TOOL_POSITION -1  // Request default positioning of toolbar tool
 
//-----------------------------------------------------------------------------------
//    The PlugIn Class Definition
//-----------------------------------------------------------------------------------
 
class WmmPi;
class WmmPrefsDialog;
 
class WmmUIDialog : public WmmUIDialogBase {
public:
  WmmUIDialog(WmmPi &_wmm_pi, wxWindow *parent, wxWindowID id = wxID_ANY,
              const wxString &title = "WMM",
              const wxPoint &pos = wxDefaultPosition,
              const wxSize &size = wxSize(250, 495),
              long style = wxCAPTION | wxDEFAULT_FRAME_STYLE | wxTAB_TRAVERSAL |
                           wxFRAME_FLOAT_ON_PARENT | wxFRAME_NO_TASKBAR)
      : WmmUIDialogBase(parent, id, title, pos, size, style),
        m_wmm_pi(_wmm_pi) {}
 
protected:
  WmmPi &m_wmm_pi;
  void EnablePlotChanged(wxCommandEvent &event) override;
  void PlotSettings(wxCommandEvent &event) override;
};
 
class WmmPlotSettingsDialog : public WmmPlotSettingsDialogBase {
public:
  WmmPlotSettingsDialog(wxWindow *parent, wxWindowID id = wxID_ANY,
                        const wxString &title = _("Magnetic Plot Settings"),
                        const wxPoint &pos = wxDefaultPosition,
                        const wxSize &size = wxSize(375, 180),
                        long style = wxDEFAULT_DIALOG_STYLE)
      : WmmPlotSettingsDialogBase(parent, id, title, pos, size, style) {}
 
protected:
  void About(wxCommandEvent &event) override;
  void Save(wxCommandEvent &event) override { EndDialog(wxID_OK); }
  void Cancel(wxCommandEvent &event) override { EndDialog(wxID_CANCEL); }
};
 
class WmmPi : public wxEvtHandler, public opencpn_plugin_118 {
public:
  WmmPi(void *ppimgr);
 
  //    The required PlugIn Methods
  int Init() override;
  bool DeInit() override;
 
  int GetAPIVersionMajor() override;
  int GetAPIVersionMinor() override;
  int GetPlugInVersionMajor() override;
  int GetPlugInVersionMinor() override;
  wxBitmap *GetPlugInBitmap() override;
  wxString GetCommonName() override;
  wxString GetShortDescription() override;
  wxString GetLongDescription() override;
 
  //    The required override PlugIn Methods
  void SetCursorLatLon(double lat, double lon) override;
  void SetPositionFix(PlugIn_Position_Fix &pfix) override;
 
  void RenderOverlayBoth(pi_ocpnDC *dc, PlugIn_ViewPort *vp);
  bool RenderOverlay(wxDC &dc, PlugIn_ViewPort *vp) override;
  bool RenderGLOverlay(wxGLContext *pcontext, PlugIn_ViewPort *vp) override;
  void RecomputePlot();
 
  int GetToolbarToolCount() override;
  void ShowPreferencesDialog(wxWindow *parent) override;
 
  void OnToolbarToolCallback(int id) override;
 
  //    Optional plugin overrides
  void SetColorScheme(PI_ColorScheme cs) override;
  void SetPluginMessage(wxString &message_id, wxString &message_body) override;
 
  void SetShowPlot(bool showplot) { m_bShowPlot = showplot; }
 
  //    Other public methods
  void SetWmmDialogX(int x) { m_wmm_dialog_x = x; };
  void SetWmmDialogY(int x) { m_wmm_dialog_y = x; }
 
  void ShowPlotSettings();
 
  //    WMM Declarations
  MAGtype_MagneticModel *MagneticModels[1];
  MAGtype_MagneticModel *MagneticModel, *TimedMagneticModel;
  MAGtype_Ellipsoid Ellip;
  MAGtype_CoordSpherical CoordSpherical;
  MAGtype_CoordGeodetic CoordGeodetic;
  MAGtype_Date UserDate;
  MAGtype_GeoMagneticElements GeoMagneticElements;
  MAGtype_Geoid Geoid;
  wxString filename;
 
  wxWindow *m_parent_window;
  WmmUIDialog *m_pWmmDialog;
 
  pi_ocpnDC *m_oDC;
 
private:
  wxFileConfig *m_pconfig;
  bool LoadConfig();
  bool SaveConfig();
 
  int m_wmm_dialog_x, m_wmm_dialog_y;
  int m_display_width, m_display_height;
  int m_iViewType;
  bool m_bShowPlotOptions;
  bool m_bShowAtCursor;
  bool m_bShowLiveIcon;
  bool m_bShowIcon;
  int m_iOpacity;
 
  wxString m_LastVal;
 
  int m_leftclick_tool_id;
 
  wxString AngleToText(double angle);
 
  bool m_bCachedPlotOk, m_bShowPlot;
  MagneticPlotMap m_DeclinationMap, m_InclinationMap, m_FieldStrengthMap;
  wxDateTime m_MapDate;
  int m_MapStep;
  int m_MapPoleAccuracy;
 
  void RearrangeWindow();
  void SetIconType();
  wxString m_wmm_dir;
  bool m_buseable, m_busegeoid;
 
  void SendVariationAt(double lat, double lon, int year, int month, int day);
  void SendBoatVariation();
  void SendCursorVariation();
  void SendBoatVarHVD(double d_var);  // send variation to NMEA handler
  void SendPGN127258(double d_var);   // send variation via N2k
  [[nodiscard]] unsigned char ComputeChecksum(wxString sentence) const;
 
  MAGtype_GeoMagneticElements m_cursorVariation;
  MAGtype_GeoMagneticElements m_boatVariation;
 
  bool m_bComputingPlot;
  wxFont *pFontSmall;
  double m_scale;
  wxString m_shareLocn;
 
  DriverHandle m_handleN2k;
};
 
int WMM_setupMagneticModel(char *data, MAGtype_MagneticModel *MagneticModel);
 
#endif  //      WMMPI_H_