GUIChart.h

/*
* Copyright (C) TES Electronic Solutions GmbH,
* All Rights Reserved.
* Contact: info@guiliani.de
*
* This file is part of the Guiliani HMI framework
* for the development of graphical user interfaces on embedded systems.
*/
 
#ifndef _GUICHART_H_
#define _GUICHART_H_
 
#include "GUIObject.h"
#include "GUIColorPropertyObserver.h"
 
#include "GUIImageResource.h"
#include "GUIFontResource.h"
#include "GUIPropertyResource.h"
 
#include "eC_TArray.h"
 
#include "GUICommonEnums.h"
 
class CGUIChart : public CGUIObject, CGUIColorPropertyObserver
{
public:
    enum DataRepresentation_t
    {
        POINTS, 
        POINTS_AND_LINES, 
        LINES, 
        BARS, 
        PIE, 
        RING, 
        STACKED_LINES, 
        STACKED_BARS, 
    };
 
    enum AxisRepresentation_t
    {
        NONE, 
        LINE, 
        LINE_AND_SCALING, 
        LINE_SCALING_AND_TEXT, 
    };
 
    struct Data_t
    {
        eC_Value vData; 
        eC_Value vOffset; 
        eC_Int iNumberForLabel; 
    };
 
    CGUIChart(
        CGUICompositeObject* const pkParent,
        const eC_Value& vX,
        const eC_Value& vY,
        const eC_Value& vWidth,
        const eC_Value& vHeight,
        eC_UInt iAxisColor, eC_UInt TextLabelColor, eC_UInt DrawLineColor, eC_UInt DrawPointColor, eC_UInt BarColor,
        eC_Value AxisLineWidth, eC_Value DrawLineWidth, eC_Value vScaleLength, eC_Value vPointSize,
        eC_UInt uiScalingXAxis, eC_UInt uiScalingYAxis,
        eC_Value vMaxShownNumberY, eC_Value vMinShownNumberY,
        eC_Value vZoomFactorY, eC_UInt uiZoomFactorX,
        const ObjectHandle_t& eID = NO_HANDLE);
 
    CGUIChart(
        CGUICompositeObject* const pkParent,
        const eC_Value& vX,
        const eC_Value& vY,
        const eC_Value& vWidth,
        const eC_Value& vHeight,
        const ObjectHandle_t& eID = NO_HANDLE);
 
    CGUIChart(
        CGUICompositeObject* const pkParent,
        const eC_Value& vX,
        const eC_Value& vY,
        const eC_Value& vWidth,
        const eC_Value& vHeight,
        eC_Int iScalingXAxis, eC_Int iScalingYAxis,
        eC_Value vMaxShownNumberY, eC_Value vMinShownNumberY,
        const ObjectHandle_t& eID = NO_HANDLE);
 
    virtual ~CGUIChart();
 
    virtual eC_Bool DoDraw();
 
    virtual eC_Bool DoDragEnd(const eC_Value& vAbsX, const eC_Value& vAbsY);
 
    virtual eC_Bool DoDrag(const eC_Value& vDeltaX, const eC_Value& vDeltaY, const eC_Value& vAbsX, const eC_Value& vAbsY);
 
    virtual eC_Bool DoButtonDown(const eC_Value& vAbsX, const eC_Value& vAbsY);
 
    virtual eC_Bool DoClick(const eC_Value& vAbsX, const eC_Value& vAbsY);
 
    virtual void SetWidth(const eC_Value& vX);
 
    virtual void SetHeight(const eC_Value& vY);
 
    virtual eC_Bool IsHighlightable() const { return false; }
 
#ifndef GUILIANI_NO_DATAPOOL
    virtual eC_Bool SetValue(CDataPoolEntry& rkValue);
#endif
 
    // data
    void AddData(eC_Value vDataValue, eC_UInt uiDimension = 0);
 
    // sets all images to standart images
    void SetStandardImages();
    // set images
 
    void SetImages(const ImageResource_t &eImageBG);
 
    void SetFont(const FontResource_t& eFontId);
 
    // potentially public methods
    void ZoomInY();
 
    void ZoomOutY();
 
    // increase/decrease x
 
    void ZoomInX();
 
    void ZoomOutX();
 
    void SetDataRepresentation(const DataRepresentation_t& eDataRepresentation);
 
    DataRepresentation_t GetDataRepresentation() const;
 
    void SetRepresentationXAxis(const AxisRepresentation_t& eXAxis);
 
    AxisRepresentation_t GetRepresentationXAxis() const;
 
    void SetRepresentationYAxis(const AxisRepresentation_t& eYAxis);
 
    AxisRepresentation_t GetRepresentationYAxis() const;
 
    void SetHelperLineRepresentation(const CGUICommonEnums::AxisAlignment_t& eRepresentation);
 
    CGUICommonEnums::AxisAlignment_t GetHelperLineRepresentation() const;
 
    void SetHorizontalHelperLineColor(const eC_UInt& uiColor);
 
    void SetHorizontalHelperLineColor(const GlobalProperty_t& eColor);
 
    eC_UInt GetHorizontalHelperLineColor() const;
 
    void SetVerticalHelperLineColor(const eC_UInt& uiColor);
 
    void SetVerticalHelperLineColor(const GlobalProperty_t& eColor);
 
    eC_UInt GetVerticalHelperLineColor() const;
 
    void SetShowBarData(const eC_Bool& bShowBarData);
 
    eC_Bool GetShowBarData() const;
 
    void SetAxisColor(const eC_UInt& uiAxisColor);
 
    void SetAxisColor(const GlobalProperty_t& eAxisColor);
 
    eC_UInt GetAxisColor() const;
 
    void SetTextLabelColor(const eC_UInt& uiTextLabelColor);
 
    void SetTextLabelColor(const GlobalProperty_t& eTextLabelColor);
 
    eC_UInt GetTextLabelColor() const;
 
    void SetLineColor(const eC_UInt& uiIndex, const eC_UInt& uiLineColor);
 
    void SetLineColor(const eC_UInt& uiIndex, const GlobalProperty_t& eLineColor);
 
    eC_UInt GetLineColor(const eC_UInt& uiIndex) const;
 
    void SetPointColor(const eC_UInt& uiIndex, const eC_UInt& uiPointColor);
 
    void SetPointColor(const eC_UInt& uiIndex, const GlobalProperty_t& ePointColor);
 
    eC_UInt GetPointColor(const eC_UInt& uiIndex) const;
 
    void SetBarColor(const eC_UInt& uiIndex, const eC_UInt& uiBarColor);
 
    void SetBarColor(const eC_UInt& uiIndex, const GlobalProperty_t& eBarColor);
 
    eC_UInt GetBarColor(const eC_UInt& uiIndex) const;
 
    void SetSelectionColor(const eC_UInt& uiSelectionColor);
 
    void SetSelectionColor(const GlobalProperty_t& eSelectionColor);
 
    eC_UInt GetSelectionColor() const;
 
    void SetZoomFactorX(const eC_Value& vZoomFactorX);
 
    eC_Value GetZoomFactorX() const;
 
    void SetZoomFactorY(const eC_Value& vZoomFactorY);
 
    eC_Value GetZoomFactorY() const;
 
    void SetScalingXAxis(const eC_UInt& uiScalingXAxis);
 
    eC_UInt GetScalingXAxis() const;
 
    void SetScalingYAxis(const eC_UInt& uiScalingYAxis);
 
    eC_UInt GetScalingYAxis() const;
 
    void SetAxisLineWidth(const eC_Value& vAxisLineWidth);
 
    eC_Value GetAxisLineWidth() const;
 
    void SetDrawLineWidth(const eC_Value& vDrawLineWidth);
 
    eC_Value GetDrawLineWidth() const;
 
    void SetScaleLength(const eC_Value& vScaleLength);
 
    eC_Value GetScaleLength() const;
 
    void SetPointSize(const eC_Value& vPointSize);
 
    eC_Value GetPointSize() const;
 
    void SetStartLabelValue(const eC_Int& iStartValue);
 
    eC_Int GetStartLabelValue() const;
 
    void SetMinValueY(const eC_Value& vMinNumber);
 
    void SetMaxValueY(const eC_Value& vMaxNumber);
 
    void SetRangeX(const eC_Int& iMinNumber, const eC_Int& iMaxNumber);
 
    void GetRangeX(eC_Int& iMinNumber, eC_Int& iMaxNumber) const;
 
    void SetRangeY(const eC_Value& vMinValue, const eC_Value& vMaxValue);
 
    void GetRangeY(eC_Value& vMinValue, eC_Value& vMaxValue) const;
 
    CGUIRect GetFocusArea() const;
 
    void JumpToDataPoint(const eC_Int& iMinShownData);
 
    //Data managment
    void JumpToTheEnd();
 
    void WipeAllData();
 
    void KeepLastXElemenets(const eC_UInt& uiDataAmountToKepp);
 
private:
    void Init(eC_UInt iAxisColor, eC_UInt TextLabelColor, eC_UInt DrawLineColor, eC_UInt DrawPointColor, eC_UInt BarColor,
        eC_Value AxisLineWidth, eC_Value DrawLineWidth, eC_Value vScaleLength, eC_Value vPointSize,
        eC_UInt uiScalingXAxis, eC_UInt uiScalingYAxis,
        eC_Value vMaxShownNumberY, eC_Value vMinShownNumberY,
        eC_Value vZoomFactorY, eC_UInt uiZoomFactorX);
 
    void DeInit();
 
    // add colors
    void AddDrawLineColor(const eC_UInt& uiDrawLineColor);
 
    void AddDrawPointColor(const eC_UInt& uiDrawPointColor);
 
    void AddBarColor(const eC_UInt& uiBarColor);
 
    void DrawAllCharts();
 
    void DrawLineChart(const eC_UInt& uiChartIndex);
 
    void DrawStackedLineChart(const eC_UInt& uiChartIndex);
 
    void DrawPointChart(const eC_UInt& uiChartIndex);
 
    void DrawStackedPointChart(const eC_UInt& uiChartIndex);
 
    void DrawBarChart(const eC_UInt& uiChartIndex);
 
    void DrawStackedBarChart(const eC_UInt& uiChartIndex);
 
    eC_UInt GetChartColor(const eC_UInt& uiChartIndex, const eC_TArray<eC_UInt>& kColors);
 
    void Zoom(const eC_Value& vZoomFactorX, const eC_Value& vZoomFactorY);
 
    void DrawXAxis();
 
    eC_Value CalculateYLabelStepSizeInData();
 
    eC_Value CalculateYLabelStepSizeInPixel();
 
    void DrawYAxis();
 
    eC_Value TranslateRelXPosToDataPos(const eC_Value& vXPos);
 
    eC_Value TranslateRelYPosToDataPos(const eC_Value& vYPos);
 
    eC_Value TranslateDataPosToAbsXPos(const eC_Value& vXPos);
 
    eC_Value TranslateDataPosToAbsYPos(const eC_Value& vYPos);
 
    // labeling data
    void DrawYLabel(
        const eC_Value& vXPos,
        const eC_Value& vYPos,
        const eC_String& kLabel,
        const eC_UInt& uiPreviousColor);
 
    void DrawXLabel(
        const eC_Value& vXPos,
        const eC_Value& vYPos,
        const eC_String& kLabel,
        const eC_UInt& uiPreviousColor);
 
    void DrawSelectionLabel();
 
    // formats the long float string into something more readable
    void FormatString(eC_String &vStringToFormat);
 
    void RecalculateChartArea();
 
    void RecalculateChartOffsets();
 
    eC_Bool DetectDataEntry(
        const eC_Value& vXAbsPos,
        const eC_Value& vYAbsPos,
        eC_UInt& uiChartIndex,
        eC_UInt& uiValueIndex);
 
    void GetPointRect(
        const eC_UInt& uiChartIndex,
        const eC_UInt& uiValueIndex,
        const eC_Value& vPointSize,
        CGUIRect& pkRect);
 
    void GetStackedPointRect(
        const eC_UInt& uiChartIndex,
        const eC_UInt& uiValueIndex,
        const eC_Value& vPointSize,
        CGUIRect& pkRect);
 
    void GetLineRect(
        const eC_UInt& uiChartIndex,
        const eC_UInt& uiValueIndex,
        CGUIRect& pkRect);
 
    void GetStackedLineRect(
        const eC_UInt& uiChartIndex,
        const eC_UInt& uiValueIndex,
        CGUIRect& pkRect);
 
    void GetBarRect(
        const eC_UInt& uiChartIndex,
        const eC_UInt& uiValueIndex,
        CGUIRect& pkRect);
 
    void GetStackedBarRect(
        const eC_UInt& uiChartIndex,
        const eC_UInt& uiValueIndex,
        CGUIRect& pkRect);
 
    void CalculateOffsets();
 
    eC_UInt GetStartValue();
 
    eC_UInt GetEndValue(const eC_UInt& uiMaxValue);
 
    void UpdateFocussedData();
 
public:
#ifdef GUILIANI_STREAM_GUI
    CGUIChart();
 
    virtual void ReadFromStream();
#endif
#ifdef GUILIANI_WRITE_GUI
    virtual void WriteToStream(const eC_Bool bWriteClassID = false);
#endif
 
protected:
#ifndef GUILIANI_STREAM_GUI
    CGUIChart();
#endif
 
private:
    void UpdateDataArea();
 
 
private:
    static const eC_UInt INDEX_AXISCOLOR;
    static const eC_UInt INDEX_TEXTCOLOR;
    static const eC_UInt INDEX_SELECTIONCOLOR;
    static const eC_UInt INDEX_HELPERHORCOLOR;
    static const eC_UInt INDEX_HELPERVERCOLOR;
    static const eC_UInt INDEX_POINTCOLOR;
    static const eC_UInt INDEX_LINECOLOR;
    static const eC_UInt INDEX_BARCOLOR;
 
    eC_UInt m_uiNumberPointColors;
    eC_UInt m_uiNumberLineColors;
    eC_UInt m_uiNumberBarColors;
 
    ImageResource_t m_eImageBackground;
 
    CGUIRect m_kChartArea;
 
    eC_Bool m_bRestrictNavigation;
 
    CGUIRect m_kFocusDataArea;
 
    CGUIRect m_kDataBoundingBox;
 
    eC_Bool m_bIsDataAreaDirty;
 
    FontResource_t m_eFont;
 
    eC_TArray<eC_TArray<Data_t> > m_kAllData;
 
    //enums
    DataRepresentation_t m_eDataRepresentation;
    AxisRepresentation_t m_eXAxisRepresentation;
    AxisRepresentation_t m_eYAxisRepresentation;
 
    eC_Bool m_bDraggingMode;
 
    CGUICommonEnums::AxisAlignment_t m_eHelperLinesRepresentation;
 
    eC_Bool m_bEnableSelection;
 
    //in how many parts is axis cut
    eC_UInt m_uiScalingXAxis;
    eC_UInt m_uiScalingYAxis;
    // points of data so far
    eC_Int m_iPointsOfData;
 
    // points drawn
    eC_Int m_iPointsAvailible;
 
    // X zoom related
    eC_Value m_vZoomFactorX;
    eC_Value m_vZoomFactorY;
 
    eC_Int m_iStartingNumber;
 
    eC_Value m_vAxisLineWidth;
 
    eC_Value m_vDrawLineWidth;
 
    eC_Value m_vScaleLineLength;
 
    eC_Value m_vBorderSize;
 
    eC_Value m_vChartOffsetX;
 
    eC_Value m_vChartOffsetY;
 
    eC_Value m_vPointSize;
 
    eC_Value m_vPointSelectionTolerance;
 
    eC_Value m_vBarWidth;
 
    eC_Value m_vXUnitWidthInPx;
 
    eC_UInt m_uiSelectedChartIndex;
 
    eC_UInt m_uiSelectedDataIndex;
 
    eC_Bool m_bShowSelection;
 
    eC_Value m_vMinYStepSize;
 
    eC_Value m_vMinX;
    eC_Value m_vMaxX;
    eC_Value m_vMinY;
    eC_Value m_vMaxY;
};
 
#endif // _GUICHART_H_