wxchartviewer.h

/*
** Name:        wxchartviewer.h
** Purpose:     wxChartViewer class declaration
** Author:      Ulrich Telle
** Created:     2018-05-09
** Copyright:   (C) 2018-2025, Ulrich Telle
** License:     LGPL - 3.0 + WITH WxWindows - exception - 3.1
*/


 
#ifndef WXCHARTDIR_WXCHARTVIEWER_H
#define WXCHARTDIR_WXCHARTVIEWER_H
 
// wxWidgets headers
 
// wxChartViewer headers
#include "wxchartviewer_defs.h"
#include "wxchartviewer_version.h"
 
#include <wx/bitmap.h>
#include <wx/event.h>
#include <wx/panel.h>
#include <wx/timer.h>
#include <wx/graphics.h>
#include <wx/overlay.h>
#include <wx/popupwin.h>
 
#include "chartdir.h"
 
#ifdef CD_NAMESPACE
namespace CD_NAMESPACE
{
#endif
 
namespace Chart
{
  // Mouse usage mode constants
  enum
  {
    MouseUsageDefault = 0,
    MouseUsageScroll  = 1,
    MouseUsageZoomIn  = 3,
    MouseUsageZoomOut = 4
  };
}
 
#ifdef CD_NAMESPACE
}
#endif
 
// Forward declarations
class WXDLLIMPEXP_FWD_WXCHARTVIEWER wxEnhancedTooltip;
class WXDLLIMPEXP_FWD_WXCHARTVIEWER wxViewPortControl;


class WXDLLIMPEXP_WXCHARTVIEWER wxChartViewer : public wxPanel, public ViewPortManager
{
public:

  wxChartViewer(wxWindow* parent = 0, wxWindowID id = wxID_ANY, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, long style = wxTAB_TRAVERSAL, const wxString& name = wxPanelNameStr);

  ~wxChartViewer();


  virtual void setDPI(int dpi);


  virtual int getDPI();


  virtual void setChart(BaseChart* chart);


  virtual BaseChart* getChart();


  virtual void setImageMap(const char* imageMap);


  virtual ImageMapHandler* getImageMapHandler();


  virtual void setDefaultToolTip(const wxString& text);


  virtual void setCDMLToolTipPrefix(const wxString& prefix);


  virtual void setViewPortControl(wxViewPortControl* vpc);


  virtual wxViewPortControl* getViewPortControl();


  virtual void setSelectionBorderWidth(int width);


  virtual int getSelectionBorderWidth();


  virtual void setSelectionBorderColor(const wxColour& color);


  virtual wxColour getSelectionBorderColor();


  virtual void setSelectionBorderStyle(wxPenStyle style);


  virtual wxPenStyle getSelectionBorderStyle();


  virtual void setMouseUsage(int mouseUsage);


  virtual int getMouseUsage();


  virtual void setZoomDirection(int direction);


  virtual int getZoomDirection();


  virtual void setScrollDirection(int direction);


  virtual int getScrollDirection();


  virtual void setZoomInRatio(double ratio);


  virtual double getZoomInRatio();


  virtual void setZoomOutRatio(double ratio);


  virtual double getZoomOutRatio();


  virtual void setMouseWheelZoomRatio(double ratio);


  virtual double getMouseWheelZoomRatio();


  virtual void setMinimumDrag(int offset);


  virtual int getMinimumDrag();


  virtual void setUpdateInterval(int interval);


  virtual int getUpdateInterval();


  virtual bool needUpdateChart();


  virtual bool needUpdateImageMap();


  virtual bool isMouseOnPlotArea();


  virtual bool isInMouseMoveEvent();


  virtual bool isInViewPortChangedEvent();


  virtual bool isMouseDragging();


  virtual void updateViewPort(bool needUpdateChart, bool needUpdateImageMap);

  // Request wxChartViewer to redisplay the chart
  virtual void updateDisplay();


  virtual bool onMouseWheelZoom(int x, int y, int zDelta);


  virtual void removeDynamicLayer(const wxString& msg);


  virtual int getChartMouseX();


  virtual int getChartMouseY();


  virtual int getPlotAreaMouseX();


  virtual int getPlotAreaMouseY();


  virtual double getViewPortRight() { return getViewPortLeft() + getViewPortWidth(); }


  virtual double getViewPortBottom() { return getViewPortTop() + getViewPortHeight(); }


  static double ConvertDateTimeToChartTime(wxDateTime dt);


  static wxDateTime ConvertChartTimeToDateTime(double ct);
 
  DECLARE_EVENT_TABLE()
 
protected:
  // wxChartViewer event handlers


  void OnMouseMove(wxMouseEvent &evt);


  void OnPaint(wxPaintEvent & evt);


  void PaintNow(BaseChart* chart);


  void Render(wxDC& dc, BaseChart* chart);


  virtual void OnDelayedMouseMove();


  virtual void OnMouseCaptureLost(wxMouseCaptureLostEvent& evt);


  virtual void OnMousePressEvent(wxMouseEvent& evt);


  virtual void OnMouseReleaseEvent(wxMouseEvent& evt);


  virtual void OnLeaveEvent(wxMouseEvent& evt);


  virtual void OnWheelEvent(wxMouseEvent& evt);


  virtual void OnHoldTimerEvent (wxTimerEvent& evt);


  virtual void OnDelayTimerEvent(wxTimerEvent& evt);


  virtual void OnSetCursor();
 
private:
  BaseChart*       m_currentChart;             
  ImageMapHandler* m_hotSpotTester;            
  BaseChart*       m_imageMapChart;            
  wxString         m_defaultToolTip;           
  wxColour         m_selectBoxLineColor;       
  int              m_selectBoxLineWidth;       
  wxPenStyle       m_selectBoxLineStyle;       
 
  int    m_mouseUsage;             
  int    m_zoomDirection;          
  int    m_scrollDirection;        
  double m_zoomInRatio;            
  double m_zoomOutRatio;           
  double m_mouseWheelZoomRatio;    
  int    m_minDragAmount;          
  int    m_updateInterval;         
  bool   m_needUpdateChart;        
  bool   m_needUpdateImageMap;     

 
  int  m_currentHotSpot;           
  bool m_isClickable;              
  bool m_isOnPlotArea;             
  bool m_isPlotAreaMouseDown;      
  bool m_isDragScrolling;          
  bool m_isMouseTracking;          
  bool m_isInMouseMove;            
 
  // Dragging support
 
  int  m_plotAreaMouseDownXPos;    
  int  m_plotAreaMouseDownYPos;    

  bool IsDrag(int direction, wxMouseEvent& event);

  void GetDragZoomRect(int px, int py, int& x, int& y, int& w, int& h);

  void OnPlotAreaMouseDrag(wxMouseEvent& point);
 
  // Selection rectangle
 
  bool   m_rectVisible; 
  wxRect m_currentRect; 
  wxRect m_previousRect; 

  void SetSelectionRect(int x, int y, int width, int height);

  void SetRectVisible(bool b);

  void DrawSelectionRect(wxDC& dc);
 
  // Chart update rate control
 
  bool       m_holdTimerActive;               
  wxTimer    m_holdTimer;
  bool       m_isInViewPortChanged;           
 
  int        m_delayUpdateChart;              
  BaseChart* m_delayedChart;

  void CommitUpdateChart();
 
  unsigned int  m_lastMouseMove;              
  wxMouseEvent* m_delayedMouseEvent;            
  wxTimer       m_delayedMouseEventTimer;
  void CommitMouseMove(wxMouseEvent& event);  
 
  bool m_delayImageMapUpdate;                   
 
  // Track Cursor support
  int m_currentMouseX;                        
  int m_currentMouseY;                        
  int m_isInMouseMovePlotArea;                  
 
  // Dynamic Layer support
  wxString m_autoHideMsg;                     

  void ApplyAutoHide(const wxString& msg);
 
  // Enhanced tooltip support
  wxEnhancedTooltip* m_enhancedToolTip;
  wxString m_cdmlToolTipPrefix;
  void ShowToolTip(const wxString& text, const wxPoint& cursorPosition);
  void ShowEnhancedToolTip(const wxString& text, const wxPoint& cursorPosition = wxPoint(0,0));
  void MoveEnhancedToolTip(const wxPoint& cursorPosition, const wxRect& rFrom);
 
  // wxViewPortControl support
  wxViewPortControl* m_vpControl;             
  bool               m_reentrantGuard;              
 
  wxBitmap  m_chartBitmap;  
 
  // High DPI support
  double ToImageX(int x);
  double ToImageY(int y);
  int ToDisplayX(double x);
  int ToDisplayY(double y);
  int m_dpi;
  double m_toImageScaleX;
  double m_toImageScaleY;
};


class wxViewPortControl : public wxPanel, public ViewPortControlBase
{
public:

  wxViewPortControl(wxWindow* parent = 0, wxWindowID id = wxID_ANY, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, long style = wxTAB_TRAVERSAL, const wxString& name = wxPanelNameStr);

  ~wxViewPortControl();


  virtual void setChart(BaseChart* chart);


  virtual BaseChart* getChart();


  virtual void setViewer(wxChartViewer* viewer);


  virtual wxChartViewer* getViewer();


  virtual void updateDisplay();
 
  DECLARE_EVENT_TABLE()
 
protected:

  void OnPaint(wxPaintEvent & evt);


  void PaintNow(BaseChart* chart);


  void Render(wxDC& dc, BaseChart* chart);
 
  // wxChartViewer event handlers

  virtual void OnMouseMoveEvent(wxMouseEvent& evt);


  virtual void OnMousePressEvent(wxMouseEvent& evt);


  virtual void OnMouseReleaseEvent(wxMouseEvent& evt);


  virtual void OnMouseWheelEvent(wxMouseEvent& evt);


  virtual void OnMouseCaptureLost(wxMouseCaptureLostEvent& evt);
 
private:
  virtual void OnViewPortChanged();

  bool IsDrag(wxMouseEvent& event);

  void PaintDisplay();

  void SyncState();

  void UpdateCursor(int position);

  void UpdateChartViewerIfNecessary();

  double ToImageX(int x);

  double ToImageY(int y);
 
  wxChartViewer* m_chartViewer;           
  BaseChart*     m_chart;                 
  bool           m_reentrantGuard;        
 
  int  m_mouseDownX;                      
  int  m_mouseDownY;                      
  bool m_isPlotAreaMouseDown;             
};

wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_WXCHARTVIEWER, wxEVT_CHARTVIEWER_CLICKED, wxCommandEvent);
wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_WXCHARTVIEWER, wxEVT_CHARTVIEWER_VIEWPORT_CHANGED, wxCommandEvent);
wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_WXCHARTVIEWER, wxEVT_CHARTVIEWER_MOUSEMOVE_CHART, wxCommandEvent);
wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_WXCHARTVIEWER, wxEVT_CHARTVIEWER_MOUSELEAVE_CHART, wxCommandEvent);
wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_WXCHARTVIEWER, wxEVT_CHARTVIEWER_MOUSEMOVE_PLOTAREA, wxCommandEvent);
wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_WXCHARTVIEWER, wxEVT_CHARTVIEWER_MOUSELEAVE_PLOTAREA, wxCommandEvent);
wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_WXCHARTVIEWER, wxEVT_CHARTVIEWER_MOUSEWHEEL, wxCommandEvent);

#define EVT_CHARTVIEWER_CLICKED(winid, fn) \
  wx__DECLARE_EVT1(wxEVT_CHARTVIEWER_CLICKED, winid, wxCommandEventHandler(fn))
#define EVT_CHARTVIEWER_VIEWPORT_CHANGED(winid, fn) \
  wx__DECLARE_EVT1(wxEVT_CHARTVIEWER_VIEWPORT_CHANGED, winid, wxCommandEventHandler(fn))
#define EVT_CHARTVIEWER_MOUSEMOVE_CHART(winid, fn) \
  wx__DECLARE_EVT1(wxEVT_CHARTVIEWER_MOUSEMOVE_CHART, winid, wxCommandEventHandler(fn))
#define EVT_CHARTVIEWER_MOUSELEAVE_CHART(winid, fn) \
  wx__DECLARE_EVT1(wxEVT_CHARTVIEWER_MOUSELEAVE_CHART, winid, wxCommandEventHandler(fn))
#define EVT_CHARTVIEWER_MOUSEMOVE_PLOTAREA(winid, fn) \
  wx__DECLARE_EVT1(wxEVT_CHARTVIEWER_MOUSEMOVE_PLOTAREA, winid, wxCommandEventHandler(fn))
#define EVT_CHARTVIEWER_MOUSELEAVE_PLOTAREA(winid, fn) \
  wx__DECLARE_EVT1(wxEVT_CHARTVIEWER_MOUSELEAVE_PLOTAREA, winid, wxCommandEventHandler(fn))
#define EVT_CHARTVIEWER_MOUSEWHEEL(winid, fn) \
  wx__DECLARE_EVT1(wxEVT_CHARTVIEWER_MOUSEWHEEL, winid, wxCommandEventHandler(fn))
 
#endif // WXCHARTDIR_WXCHARTVIEWER_H