grib_pi.h

Go to the documentation of this file.

/***************************************************************************
 *   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, see <https://www.gnu.org/licenses/>. *
 ***************************************************************************/
 
#ifndef GRIBPI_H_
#define GRIBPI_H_
 
#include <wx/wxprec.h>
 
#ifndef WX_PRECOMP
#include <wx/wx.h>
#include <wx/glcanvas.h>
#endif
 
#include "jsonreader.h"
#include "jsonwriter.h"
 
#include "grib_settings_dlg.h"
#include "grib_overlay_factory.h"
#include "grib_ui_dlg.h"
#include "ocpn_plugin.h"
 
#define PLUGIN_VERSION_MAJOR 5
#define PLUGIN_VERSION_MINOR 0
 
#define MY_API_VERSION_MAJOR 1
#define MY_API_VERSION_MINOR 16
 
//------------------------------------------------------------------------------
//    The PlugIn Class Definition
//------------------------------------------------------------------------------
 
#define GRIB_TOOL_POSITION (-1)    // Request Toolbar tool default positioning
#define STARTING_STATE_STYLE 9999  // style option undefined
#define ATTACHED 0                 // dialog are attached
#define SEPARATED 1                // dialog are separated
#define ATTACHED_HAS_CAPTION 0     // dialog attached  has a caption
#define ATTACHED_NO_CAPTION 1      // dialog attached don't have caption
#define SEPARATED_HORIZONTAL 2     // dialog separated shown horizontally
#define SEPARATED_VERTICAL 3       // dialog separated shown vertically
 
class GribPreferencesDialog;
 
enum SettingsDisplay {
  B_ARROWS,
  ISO_LINE,
  ISO_ABBR,
  ISO_LINE_SHORT,
  ISO_LINE_VISI,
  D_ARROWS,
  OVERLAY,
  NUMBERS,
  PARTICLES
};
 
class GribPi : public opencpn_plugin_116 {
public:
  GribPi(void *ppimgr);
  ~GribPi() override;
 
  //    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 override PlugIn Methods
  bool MouseEventHook(wxMouseEvent &event) override;
  bool RenderOverlay(wxDC &dc, PlugIn_ViewPort *vp) override;
  bool RenderOverlayMultiCanvas(wxDC &dc, PlugIn_ViewPort *vp,
                                int canvasIndex) override;
  void SetCursorLatLon(double lat, double lon) override;
  void OnContextMenuItemCallback(int id) override;
  void SetPluginMessage(wxString &message_id, wxString &message_body) override;
  bool RenderGLOverlay(wxGLContext *pcontext, PlugIn_ViewPort *vp) override;
  bool RenderGLOverlayMultiCanvas(wxGLContext *pcontext, PlugIn_ViewPort *vp,
                                  int canvasIndex) override;
  void SendTimelineMessage(wxDateTime time);
  void SetDefaults() override;
  int GetToolBarToolCount();
  void ShowPreferencesDialog(wxWindow *parent) override;
  void OnToolbarToolCallback(int id) override;
  bool QualifyCtrlBarPosition(wxPoint position, wxSize size);
  void MoveDialog(wxDialog *dialog, wxPoint position);
  void SetPositionFixEx(PlugIn_Position_Fix_Ex &pfix) override;
 
  // Other public methods
  void SetCtrlBarXY(wxPoint p) { m_CtrlBarxy = p; }
  void SetCursorDataXY(wxPoint p) { m_CursorDataxy = p; }
  void SetCtrlBarSizeXY(wxSize p) { m_CtrlBar_Sizexy = p; }
  void SetColorScheme(PI_ColorScheme cs) override;
  void SetDialogFont(wxWindow *window, wxFont *font = OCPNGetFont(_("Dialog")));
  void SetCurrentViewPort(PlugIn_ViewPort &vp) override { m_current_vp = vp; }
  PlugIn_ViewPort &GetCurrentViewPort() { return m_current_vp; }
 
  void OnGribCtrlBarClose();
 
  wxPoint GetCtrlBarXY() { return m_CtrlBarxy; }
  wxPoint GetCursorDataXY() { return m_CursorDataxy; }
  [[nodiscard]] int GetStartOptions() const { return m_bStartOptions; }
  [[nodiscard]] bool GetCopyFirstCumRec() const { return m_bCopyFirstCumRec; }
  [[nodiscard]] bool GetCopyMissWaveRec() const { return m_bCopyMissWaveRec; }
 
  GRIBOverlayFactory *m_pGRIBOverlayFactory;
  [[nodiscard]] GRIBOverlayFactory *GetGRIBOverlayFactory() const {
    return m_pGRIBOverlayFactory;
  }
 
  void UpdatePrefs(GribPreferencesDialog *Pref);
 
  int m_MenuItem;
  bool m_DialogStyleChanged;
 
  wxSize m_coreToolbarSize;
  wxPoint m_coreToolbarPosn;
  bool m_bZoomToCenterAtInit;
  wxString m_local_sources_catalog;
  double m_boat_lat, m_boat_lon;
  double m_boat_cog, m_boat_sog;
  time_t m_boat_time;
 
private:
  bool LoadConfig();
  bool SaveConfig();
 
  bool DoRenderGLOverlay(wxGLContext *pcontext, PlugIn_ViewPort *vp,
                         int canvasIndex);
  bool DoRenderOverlay(wxDC &dc, PlugIn_ViewPort *vp, int canvasIndex);
 
  wxFileConfig *m_pconfig;
  wxWindow *m_parent_window;
 
  GRIBUICtrlBar *m_pGribCtrlBar;
 
  int m_display_width, m_display_height;
  int m_leftclick_tool_id;
 
  wxPoint m_CtrlBarxy, m_CursorDataxy;
  wxSize m_CtrlBar_Sizexy;
 
  //    Controls added to Preferences panel
  wxCheckBox *m_pGRIBUseHiDef;
  wxCheckBox *m_pGRIBUseGradualColors;
 
  GribTimelineRecordSet *m_pLastTimelineSet;
 
  // preference data
  bool m_bGRIBUseHiDef;
  bool m_bGRIBUseGradualColors;
  bool m_bDrawBarbedArrowHead;
  bool m_bCopyFirstCumRec;
  bool m_bCopyMissWaveRec;
  int m_bLoadLastOpenFile;
  int m_bStartOptions;
  wxString m_RequestConfig;
  wxString m_bMailToAddresses;
  wxString m_bMailFromAddress;
  wxString m_ZyGribLogin;
  wxString m_ZyGribCode;
  double m_GUIScaleFactor;
#ifdef __WXMSW__
  double m_GribIconsScaleFactor;
#endif
  bool m_bGRIBShowIcon;
 
  bool m_bShowGrib;
  PlugIn_ViewPort m_current_vp;
  wxBitmap m_panelBitmap;
};
 
//----------------------------------------------------------------------------------------
// Preference dialog definition
//----------------------------------------------------------------------------------------
 
class GribPreferencesDialog : public GribPreferencesDialogBase {
public:
  GribPreferencesDialog(wxWindow *pparent)
      : GribPreferencesDialogBase(pparent) {}
  ~GribPreferencesDialog() override = default;
 
protected:
  void OnOKClick(wxCommandEvent &event) override;
 
private:
  void OnStartOptionChange(wxCommandEvent &event) override;
};
#endif  //      GRIBPI_H_