instrument.h

Go to the documentation of this file.

/**************************************************************************
 *   Copyright (C) 2010 by Jean-Eudes Onfray                               *
 *   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 InSTRUMENT_H_
#define InSTRUMENT_H_
 
#include <bitset>
 
#include <wx/wxprec.h>
 
#ifndef WX_PRECOMP
#include <wx/wx.h>
#endif
 
#if !wxUSE_GRAPHICS_CONTEXT
#define wxGCDC wxDC
#endif
 
// Required GetGlobalColor
#include <wx/dcbuffer.h>
#include <wx/dcgraph.h>  // supplemental, for Mac
#include <wx/fontdata.h>
 
#include "ocpn_plugin.h"
 
#define DefaultWidth 150
 
// The degree sign in UTF8, should be correctly handled on both Win & Unix.
const wxString DEGREE_SIGN = wxString::Format("%c", 0x00B0);
 
extern wxFontData *g_pFontTitle;
extern wxFontData *g_pFontData;
extern wxFontData *g_pFontLabel;
extern wxFontData *g_pFontSmall;
 
extern wxFontData *g_pUSFontTitle;
extern wxFontData *g_pUSFontData;
extern wxFontData *g_pUSFontLabel;
extern wxFontData *g_pUSFontSmall;
 
extern wxAlignment g_TitleAlignment;
extern double g_TitleVerticalOffset;
extern int g_iTitleMargin;
extern bool g_bShowUnit;
extern wxAlignment g_DataAlignment;
extern int g_iDataMargin;
extern int g_iInstrumentSpacing;
 
wxString toSDMM(int NEflag, double a);
 
class DashboardInstrument;
class DashboardInstrument_Single;
class DashboardInstrument_Position;
class DashboardInstrument_Sun;
 
enum DASH_CAP {
  OCPN_DBP_STC_LAT = 0,  
  OCPN_DBP_STC_LON,      
  OCPN_DBP_STC_SOG,      
  OCPN_DBP_STC_COG,      
  OCPN_DBP_STC_STW,      
  OCPN_DBP_STC_HDM,      
  OCPN_DBP_STC_HDT,      
  OCPN_DBP_STC_HMV,   
  OCPN_DBP_STC_BRG,   
  OCPN_DBP_STC_AWA,   
  OCPN_DBP_STC_AWS,   
  OCPN_DBP_STC_TWA,   
  OCPN_DBP_STC_TWS,   
  OCPN_DBP_STC_DPT,   
  OCPN_DBP_STC_TMP,   
  OCPN_DBP_STC_VMG,   
  OCPN_DBP_STC_VMGW,  
  OCPN_DBP_STC_RSA,   
  OCPN_DBP_STC_SAT,   
  OCPN_DBP_STC_GPS,   
  OCPN_DBP_STC_PLA,   
  OCPN_DBP_STC_PLO,   
  OCPN_DBP_STC_CLK,   
  OCPN_DBP_STC_MON,   // Does not seem to be used anywhere
  OCPN_DBP_STC_ATMP,  
  OCPN_DBP_STC_TWD,   
  OCPN_DBP_STC_TWS2,  
  OCPN_DBP_STC_VLW1,  
  OCPN_DBP_STC_VLW2,  
  OCPN_DBP_STC_MDA,   
  OCPN_DBP_STC_MCOG,  
  OCPN_DBP_STC_PITCH,  
  OCPN_DBP_STC_HEEL,   
  OCPN_DBP_STC_ALTI,   
  OCPN_DBP_STC_HUM,    
  OCPN_DBP_STC_WCC,    
                       // Insert new instrument capability flags here
  OCPN_DBP_STC_LAST    // This should always be the last enum in this list
};
 
#define N_INSTRUMENTS \
  ((int)OCPN_DBP_STC_LAST)  // Number of instrument capability flags
 
using CapType = std::bitset<N_INSTRUMENTS>;
 
wxColour GetColourSchemeBackgroundColour(wxColour co);
wxColour GetColourSchemeFont(wxColour co);
 
class InstrumentProperties {
public:
  InstrumentProperties() { SetDefault(); }
  InstrumentProperties(int aInstrument, int Listplace) {
    m_aInstrument = aInstrument;
    m_Listplace = Listplace;
    m_ShowUnit = -1;
    m_DataAlignment = wxALIGN_INVALID;
    m_DataMargin = -1;
    m_InstrumentSpacing = -1;
    m_Format = "";
    m_Title = "";
    m_TitleFont = *(g_pFontTitle);
    m_USTitleFont = *(g_pUSFontTitle);
    m_DataFont = *(g_pFontData);
    m_USDataFont = *(g_pUSFontData);
    m_LabelFont = *(g_pFontLabel);
    m_USLabelFont = *(g_pUSFontLabel);
    m_SmallFont = *(g_pFontSmall);
    m_USSmallFont = *(g_pUSFontSmall);
    GetGlobalColor("DASHL", &m_TitleBackgroundColour);
    GetGlobalColor("DASHB", &m_DataBackgroundColour);
    GetGlobalColor("DASHN", &m_Arrow_First_Colour);
    GetGlobalColor("BLUE3", &m_Arrow_Second_Colour);
  }
 
  ~InstrumentProperties() = default;
 
  void SetDefault() {
    m_aInstrument = -1;
    m_Listplace = -1;
    m_ShowUnit = -1;
    m_DataAlignment = wxALIGN_INVALID;
    m_DataMargin = -1;
    m_InstrumentSpacing = -1;
    m_Format = "";
    m_Title = "";
    m_TitleFont = *(g_pFontTitle);
    m_USTitleFont = *(g_pUSFontTitle);
    m_DataFont = *(g_pFontData);
    m_USDataFont = *(g_pUSFontData);
    m_LabelFont = *(g_pFontLabel);
    m_USLabelFont = *(g_pUSFontLabel);
    m_SmallFont = *(g_pFontSmall);
    m_USSmallFont = *(g_pUSFontSmall);
    GetGlobalColor("DASHL", &m_TitleBackgroundColour);
    GetGlobalColor("DASHB", &m_DataBackgroundColour);
    GetGlobalColor("DASHN", &m_Arrow_First_Colour);
    GetGlobalColor("BLUE3", &m_Arrow_Second_Colour);
  };
  int m_aInstrument;
  int m_Listplace;
  int m_ShowUnit;
  wxAlignment m_DataAlignment;
  int m_DataMargin;
  int m_InstrumentSpacing;
  wxString m_Format;
  wxString m_Title;
  wxFontData m_TitleFont;
  wxFontData m_USTitleFont;
  wxColour m_TitleBackgroundColour;
  wxFontData m_DataFont;
  wxFontData m_USDataFont;
  wxColour m_DataBackgroundColour;
  wxFontData m_LabelFont;
  wxFontData m_USLabelFont;
  wxFontData m_SmallFont;
  wxFontData m_USSmallFont;
  wxColour m_Arrow_First_Colour;
  wxColour m_Arrow_Second_Colour;
};
 
class DashboardInstrument : public wxControl {
public:
  DashboardInstrument(wxWindow *pparent, wxWindowID id, wxString title,
                      DASH_CAP cap_flag,
                      InstrumentProperties *Properties = nullptr);
  ~DashboardInstrument() override = default;
 
  CapType GetCapacity();
  void OnEraseBackground(wxEraseEvent &WXUNUSED(evt));
  virtual wxSize GetSize(int orient, wxSize hint) = 0;
  void OnPaint(wxPaintEvent &WXUNUSED(event));
  virtual void SetData(DASH_CAP st, double data, wxString unit) = 0;
  void SetDrawSoloInPane(bool value);
  void MouseEvent(wxMouseEvent &event);
#ifdef HAVE_WX_GESTURE_EVENTS
  void OnLongPress(wxLongPressEvent &event);
#endif
  void OnLeftUp(wxMouseEvent &event);
  void SetCapFlag(DASH_CAP val) { m_cap_flag.set(val); }
  bool HasCapFlag(DASH_CAP val) { return m_cap_flag.test(val); }
  int instrumentTypeId;
  InstrumentProperties *m_Properties;
 
protected:
  CapType m_cap_flag;
  int m_InstrumentSpacing;
  int m_DataTextHeight;
  int m_DataMargin;
  int m_TitleWidth;
  int m_TitleHeight;
  int m_DataTop;
  int m_TitleTop;
  bool m_DataRightAlign;
  bool m_TitleRightAlign;
  wxString m_title;
  virtual void Draw(wxGCDC *dc) = 0;
  virtual void InitDataTextHeight(const wxString &sampleText, int &sampleWidth);
  virtual void InitTitleSize();
  virtual void InitTitleAndDataPosition(int drawHeight);
  virtual int GetFullHeight(int drawHeight);
  virtual int GetDataBottom(int clientHeight);
  virtual void SetDataFont(wxGCDC *dc);
 
private:
  bool m_drawSoloInPane;
  bool m_popupWanted;
};
 
class DashboardInstrument_Single : public DashboardInstrument {
public:
  DashboardInstrument_Single(wxWindow *pparent, wxWindowID id, wxString title,
                             InstrumentProperties *Properties, DASH_CAP cap,
                             wxString format);
  ~DashboardInstrument_Single() override = default;
 
  wxSize GetSize(int orient, wxSize hint) override;
  void SetData(DASH_CAP st, double data, wxString unit) override;
 
protected:
  wxString m_data;
  wxString m_format;
  //  int m_DataHeight;
  //  InstrumentProperties* m_Properties;
 
  void Draw(wxGCDC *dc) override;
};
 
class DashboardInstrument_Position : public DashboardInstrument {
public:
  DashboardInstrument_Position(wxWindow *pparent, wxWindowID id, wxString title,
                               InstrumentProperties *Properties = nullptr,
                               DASH_CAP cap_flag1 = OCPN_DBP_STC_LAT,
                               DASH_CAP cap_flag2 = OCPN_DBP_STC_LON);
  ~DashboardInstrument_Position() override = default;
 
  wxSize GetSize(int orient, wxSize hint) override;
  void SetData(DASH_CAP st, double data, wxString unit) override;
 
protected:
  wxString m_data1;
  wxString m_data2;
  DASH_CAP m_cap_flag1;
  DASH_CAP m_cap_flag2;
  //  int m_DataHeight;
 
  void Draw(wxGCDC *dc) override;
};
 
#endif  // InSTRUMENT_H_