axis.h

// Name:    axis.h
// Purpose: axis base class declarations
// Author:  Moskvichev Andrey V.
// Created: 2008/11/07
// Copyright:   (c) 2008-2010 Moskvichev Andrey V.
// Licence: wxWidgets licence

#ifndef AXIS_H_
#define AXIS_H_

#include <wx/wxfreechartdefs.h>
#include <wx/dataset.h>

#include <wx/dynarray.h>

#include <wx/drawobject.h>
#include <wx/observable.h>

enum AXIS_LOCATION {
    AXIS_LEFT = 1,
    AXIS_RIGHT,
    AXIS_TOP,
    AXIS_BOTTOM,
};

class WXDLLIMPEXP_FREECHART Axis;

class WXDLLIMPEXP_FREECHART AxisObserver
{
public:
    AxisObserver();
    virtual ~AxisObserver();

    virtual void AxisChanged(Axis *axis) = 0;

    virtual void BoundsChanged(Axis *axis) = 0;
};

class WXDLLIMPEXP_FREECHART Axis : public wxObject, public Observable<AxisObserver>
{
    DECLARE_CLASS(Axis)

    friend class Plot;
    friend class AxisShare;
public:
    Axis(AXIS_LOCATION location);
    virtual ~Axis();

    AXIS_LOCATION GetLocation()
    {
        return m_location;
    }

    bool IsVertical()
    {
        return (m_location == AXIS_LEFT) || (m_location == AXIS_RIGHT);
    }

    bool IsHorizontal()
    {
        return !IsVertical();
    }

    void SetMargins(wxCoord marginMin, wxCoord marginMax);

    //
    // Dataset functions.
    //
    size_t GetDatasetCount();

    Dataset *GetDataset(size_t index);

    //
    // Mouse drag behavior
    //
    void SetZoomPanMode();

    //
    // Window functions.
    //

    void SetWindowWidth(double winWidth)
    {
        SetWindow(m_winPos, winWidth);
    }

    double GetWindowWidth()
    {
        return m_winWidth;
    }

    void SetWindowPosition(double winPos)
    {
        SetWindow(winPos, m_winWidth);
    }

    double GetWindowPosition()
    {
        return m_winPos;
    }

    void SetUseWindow(bool useWin)
    {
        if (m_useWin != useWin) {
            m_useWin = useWin;
            FireAxisChanged();
        }
    }

    void SetWindow(double winPos, double winWidth)
    {
        if (m_winPos != winPos || m_winWidth != winWidth) {
            m_winPos = winPos;
            m_winWidth = winWidth;
            FireAxisChanged();
        }
    }

    bool IntersectsWindow(double v0, double v1);

    void GetWindowBounds(double &winMin, double &winMax)
    {
        double minValue, maxValue;
        GetDataBounds(minValue, maxValue);

        if (m_useWin) {
            winMin = m_winPos;
            winMax = wxMin(maxValue, winMin + m_winWidth);
        }
        else {
            winMin = minValue;
            winMax = maxValue;
        }
    }

    void AddDataset(Dataset *dataset)
    {
        if (AcceptDataset(dataset)) {
            m_datasets.Add(dataset);
        }
    }

    virtual void GetDataBounds(double &minValue, double &maxValue) const = 0;

    virtual wxCoord GetExtent(wxDC &dc) = 0;

    virtual bool IsVisible(double value);

    virtual double BoundValue(double value);

    virtual wxCoord ToGraphics(wxDC &dc, int minCoord, int gRange, double value);

    virtual double ToData(wxDC &dc, int minCoord, int gRange, wxCoord g);

    virtual void UpdateBounds() = 0;

    virtual void Draw(wxDC &dc, wxRect rc) = 0;

    virtual void DrawGridLines(wxDC &dc, wxRect rcData) = 0;

protected:
    virtual bool AcceptDataset(Dataset *dataset) = 0;

    DatasetArray m_datasets;
    wxPen m_gridLinesPen;

    wxCoord m_marginMin;
    wxCoord m_marginMax;

    double m_winPos;
    double m_winWidth;
    bool m_useWin;

    FIRE_WITH_THIS(AxisChanged);
    FIRE_WITH_THIS(BoundsChanged);

private:
    AXIS_LOCATION m_location;

    size_t m_shareCount;
};

WX_DECLARE_USER_EXPORTED_OBJARRAY(Axis *, AxisArray, WXDLLIMPEXP_FREECHART);

class WXDLLIMPEXP_FREECHART AxisShare : public Axis
{
public:
    AxisShare(Axis *axis);
    virtual ~AxisShare();

    void SetShareVisible(bool shareVisible);

    //
    // Axis
    //

    virtual void GetDataBounds(double &minValue, double &maxValue) const;

    virtual wxCoord GetExtent(wxDC &dc);

    virtual bool IsVisible(double value);

    virtual double BoundValue(double value);

    virtual wxCoord ToGraphics(wxDC &dc, int minCoord, int gRange, double value);

    virtual double ToData(wxDC &dc, int minCoord, int gRange, wxCoord g);

    virtual void UpdateBounds();

    virtual void Draw(wxDC &dc, wxRect rc);

    virtual void DrawGridLines(wxDC &dc, wxRect rcData);

protected:
    virtual bool AcceptDataset(Dataset *dataset);

private:
    bool m_shareVisible;

    Axis *m_axis;
};

wxCoord ToGraphics(int minCoord, int gRange, double minValue, double maxValue, wxCoord margin, bool vertical, double value);
double ToData(int minCoord, int gRange, double minValue, double maxValue, wxCoord margin, bool vertical, wxCoord g);

#endif /*AXIS_H_*/