grib_ui_dlg.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 GRIBUICTRLBAR_H_
#define GRIBUICTRLBAR_H_
 
#include <wx/wxprec.h>
 
#ifndef WX_PRECOMP
#include <wx/wx.h>
#endif
#include <wx/glcanvas.h>
 
#include "cursor_data.h"
#include "grabber_win.h"
#include "grib_reader.h"
#include "grib_record_set.h"
#include "grib_request_dlg.h"
#include "grib_settings_dlg.h"
#include "grib_ui_dlg_base.h"
#include "iso_line.h"
 
#ifndef PI
#define PI 3.1415926535897931160E0 /* pi */
#endif
 
extern double m_cursor_lat, m_cursor_lon;
 
class GRIBUICtrlBar;
class GRIBUICData;
class GRIBFile;
class GRIBRecord;
class GribRecordTree;
class GRIBOverlayFactory;
class GribRecordSet;
class GribRequestSetting;
class GribGrabberWin;
class GribSpacerWin;
 
class wxFileConfig;
class GribPi;
class wxGraphicsContext;
 
WX_DECLARE_OBJARRAY(GribRecordSet, ArrayOfGribRecordSets);
 
enum ZoneSelection {
  AUTO_SELECTION,   
  SAVED_SELECTION,  
  START_SELECTION,
  DRAW_SELECTION,
  COMPLETE_SELECTION
};
 
typedef struct {
  int atmModelIndex;
  int waveModelIndex;
  int resolutionIndex;
  int durationIndex;
  int runIndex;
  int intervalIndex;
  bool wind;
  bool gust;
  bool pressure;
  bool temperature;
  bool cape;
  bool reflectivity;
  bool cloudCover;
  bool precipitation;
  bool waveHeight;
  bool windWaves;
} XyGribConfig_t;
 
class GribTimelineRecordSet : public GribRecordSet {
public:
  GribTimelineRecordSet(unsigned int cnt);
  //    GribTimelineRecordSet(GribRecordSet &GRS1, GribRecordSet &GRS2, double
  //    interp_const);
  ~GribTimelineRecordSet() override;
 
  void ClearCachedData();
 
  wxArrayPtrVoid *m_IsobarArray[Idx_COUNT];
};
 
//----------------------------------------------------------------------------------------------------------
//    GRIB CtrlBar Specification
//----------------------------------------------------------------------------------------------------------
class GRIBUICtrlBar : public GRIBUICtrlBarBase {
  friend class GribRequestSetting;
 
public:
  GRIBUICtrlBar(wxWindow *parent, wxWindowID id, const wxString &title,
                const wxPoint &pos, const wxSize &size, long style, GribPi *ppi,
                double scale_factor);
  ~GRIBUICtrlBar() override;
 
  void OpenFile(bool newestFile = false);
 
  void ContextMenuItemCallback(int id);
  void SetFactoryOptions();
 
  wxDateTime TimelineTime();
  GribTimelineRecordSet *GetTimeLineRecordSet(wxDateTime time);
  void StopPlayBack();
  void TimelineChanged();
  void CreateActiveFileFromNames(const wxArrayString &filenames);
  void PopulateComboDataList();
  void ComputeBestForecastForNow();
  void SetViewPortUnderMouse(PlugIn_ViewPort *vp);
  void SetViewPortWithFocus(PlugIn_ViewPort *vp);
  void SetTimeLineMax(bool SetValue);
  void SetCursorLatLon(double lat, double lon);
  void UpdateTrackingControl();
  void SetDialogsStyleSizePosition(bool force_recompute = false);
  void SetRequestButtonBitmap(int type);
  GRIBUICData *GetCDataDialog() { return m_gGRIBUICData; }
  bool InDataPlot(int id) {
    return id > wxID_ANY && id < (int)GribOverlaySettings::GEO_ALTITUDE;
  }
  void SetScaledBitmap(double factor);
  void OpenFileFromJSON(wxString json);
 
  //
  double getTimeInterpolatedValue(int idx, double lon, double lat,
                                  wxDateTime t);
  bool getTimeInterpolatedValues(double &M, double &A, int idx1, int idx2,
                                 double lon, double lat, wxDateTime t);
 
  wxWindow *pParent;
  GribOverlaySettings m_OverlaySettings;
  GribTimelineRecordSet *m_pTimelineSet;
 
  wxTimer m_tPlayStop;
  GribPi *pPlugIn;
  GribRequestSetting *pReq_Dialog;
  GRIBFile *m_bGRIBActiveFile;
  bool m_bDataPlot[GribOverlaySettings::GEO_ALTITUDE];  // only for no altitude
                                                        // parameters
  bool m_CDataIsShown;
  int m_ZoneSelAllowed;
  int m_old_DialogStyle;
  void DoZoomToCenter();
  wxString GetGribDir() {
    if (m_grib_dir.IsEmpty() || !wxDirExists(m_grib_dir)) {
      m_grib_dir = GetpPrivateApplicationDataLocation()
                       ->Append(wxFileName::GetPathSeparator())
                       .Append("grib");
 
      if (!wxDirExists(m_grib_dir)) wxMkdir(m_grib_dir);
 
      wxString dir_spec;
      int response = PlatformDirSelectorDialog(
          this, &dir_spec, _("Choose GRIB File Directory"), m_grib_dir);
 
      if (response == wxID_OK) {
        m_grib_dir = (dir_spec);
      }
    }
    return m_grib_dir;
  }
 
  void GetProjectedLatLon(int &x, int &y, PlugIn_ViewPort *vp);
  bool ProjectionEnabled() {
    if (m_ProjectBoatPanel)
      return m_ProjectBoatPanel->ProjectionEnabled();
    else
      return false;
  }
  double m_highlight_latmax;
  double m_highlight_lonmax;
  double m_highlight_latmin;
  double m_highlight_lonmin;
  wxString m_grib_dir;
  wxArrayString m_file_names;
  void DoOnMouseEvent(wxMouseEvent &event) { OnMouseEvent(event); }
 
protected:
  void OnClose(wxCloseEvent &event) override;
  void OnSize(wxSizeEvent &event) override;
  void OnPaint(wxPaintEvent &event) override;
  void OnSettings(wxCommandEvent &event) override;
  void OnPlayStop(wxCommandEvent &event) override;
  void OnZoomToCenterClick(wxCommandEvent &event) override;
  void OnPrev(wxCommandEvent &event) override;
  void OnMouseEvent(wxMouseEvent &event) override;
  void OnRecordForecast(wxCommandEvent &event) override {
    StopPlayBack();
    m_InterpolateMode = false;
    m_pNowMode = false;
    TimelineChanged();
  }
  void OnNext(wxCommandEvent &event) override;
  void OnNow(wxCommandEvent &event) override {
    StopPlayBack();
    ComputeBestForecastForNow();
  }
  void OnAltitude(wxCommandEvent &event) override;
  void OnOpenFile(wxCommandEvent &event) override;
  void OnRequestForecastData(wxCommandEvent &event) override;
  void OnCompositeDialog(wxCommandEvent &event) override;
 
  void OnTimeline(wxScrollEvent &event) override;
  void OnShowCursorData(wxCommandEvent &event) override;
 
private:
  void OnPlayStopTimer(wxTimerEvent &event);
  void OnMove(wxMoveEvent &event);
  void OnMenuEvent(wxMenuEvent &event);
  void MenuAppend(wxMenu *menu, int id, wxString label, wxItemKind kind,
                  wxBitmap bitmap = wxNullBitmap, wxMenu *submenu = nullptr);
 
  void createRequestDialog();
 
  wxDateTime MinTime();
  wxArrayString GetFilesInDirectory();
  void SetGribTimelineRecordSet(GribTimelineRecordSet *pTimelineSet);
  int GetNearestIndex(wxDateTime time, int model);
  int GetNearestValue(wxDateTime time, int model);
  bool GetGribZoneLimits(GribTimelineRecordSet *timelineSet, double *latmin,
                         double *latmax, double *lonmin, double *lonmax);
  wxDateTime GetNow();
  void RestaureSelectionString();
  void SaveSelectionString() {
    m_SelectionIsSaved = true;
    m_Selection_index = m_cRecordForecast->GetSelection();
    m_Selection_label = m_cRecordForecast->GetString(m_Selection_index);
  }
 
  //    Data
  CursorData *m_gCursorData;
  GribGrabberWin *m_gGrabber;
  GRIBUICData *m_gGRIBUICData;
  PlugIn_ViewPort *m_vpMouse;
  int m_lastdatatype;
 
  int m_TimeLineHours;
  int m_FileIntervalIndex;
  bool m_InterpolateMode;
  bool m_pNowMode;
  bool m_HasAltitude;
 
  bool m_SelectionIsSaved;
  int m_Selection_index;
  wxString m_Selection_label;
  wxSize m_DialogsOffset;
  double m_projected_lat;
  double m_projected_lon;
  // XyGrib panel configuration
  XyGribConfig_t xyGribConfig;
  bool m_gtk_started;
 
  wxTimer m_tFormatRefresh;
  wxString m_sLastTimeFormat;  // Used to detect time format changes
 
  void OnFormatRefreshTimer(wxTimerEvent &event);
};
 
class GRIBFile {
public:
  GRIBFile(const wxArrayString &file_names, bool CumRec, bool WaveRec,
           bool newestFile = false);
  ~GRIBFile();
 
  [[nodiscard]] bool IsOK() const { return m_bOK; }
  wxArrayString &GetFileNames() { return m_FileNames; }
  wxString GetLastMessage() { return m_last_message; }
  ArrayOfGribRecordSets *GetRecordSetArrayPtr() {
    return &m_GribRecordSetArray;
  }
  [[nodiscard]] time_t GetRefDateTime() const { return m_pRefDateTime; }
 
  [[nodiscard]] unsigned int GetCounter() const { return m_counter; }
 
  WX_DEFINE_ARRAY_INT(int, GribIdxArray);
  GribIdxArray m_GribIdxArray;
 
private:
  static unsigned int ID;  
 
  const unsigned int m_counter;  
  bool m_bOK;                    
  wxString m_last_message;       
  wxArrayString m_FileNames;     
  GribReader *m_pGribReader;     
  time_t m_pRefDateTime;         
 
  ArrayOfGribRecordSets m_GribRecordSetArray;
 
  int m_nGribRecords;
};
 
//---------------------------------------------------------------------
//    GRIB CursorData Dialog Specification
//--------------------------------------------------------------------
class GRIBUICData : public GRIBUICDataBase {
public:
  GRIBUICData(GRIBUICtrlBar &parent);
  ~GRIBUICData() override = default;
 
  // GribGrabberWin      *m_gGrabber;
  GRIBUICtrlBar &m_gpparent;
  CursorData *m_gCursorData;
 
private:
  void OnMove(wxMoveEvent &event);
};
 
#endif  //      GRIBUICTRLBAR_H_