GUIGauge.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 GUIGAUGE__H_
#define GUIGAUGE__H_
 
#include "GUIAbstractBar.h"
#include "GUIImageResource.h"
#include "GUIColorPropertyObserver.h"
#include "GUIPropertyResource.h"
 
// @guiliani_doxygen toplevel_control Gauge
// @endguiliani_doxygen
class CGUIGauge : public CGUIAbstractBar, public CGUIColorPropertyObserver
{
public:
    CGUIGauge(
        CGUICompositeObject* const pkParent,
        const eC_Value& vX, const eC_Value& vY,
        const eC_Value& vWidth, const eC_Value& vHeight,
        const eC_Int iMin, const eC_Int iMax,
        const eC_Value vMinAngle, const eC_Value vMaxAngle,
        const ImageResource_t eGaugeImage,
        const eC_Value& vNeedleLength,
        const ObjectHandle_t &eID = NO_HANDLE);
 
    CGUIGauge(
        CGUICompositeObject* const pkParent,
        const eC_Value& vX, const eC_Value& vY,
        const eC_Value& vWidth, const eC_Value& vHeight,
        const eC_Int iMin, const eC_Int iMax,
        const eC_Value vMinAngle, const eC_Value vMaxAngle,
        const ImageResource_t eGaugeImage,
        const ImageResource_t eNeedleImage,
        const ObjectHandle_t &eID = NO_HANDLE);
 
    virtual ~CGUIGauge();
 
    virtual eC_Bool DoDraw();
 
    void SetMinAngle(const eC_Value vMinAngle);
 
    eC_Value GetMinAngle() const;
 
    void SetMaxAngle(const eC_Value vMaxAngle);
 
    eC_Value GetMaxAngle() const;
 
    void SetSimulate(const eC_Bool bSimulate);
 
    virtual void DoAnimate(const eC_Value& vTimes = eC_FromInt(1));
 
    void SetNeedleLength(const eC_Value vLength);
 
    eC_Value GetNeedleLength() const;
 
    void SetNeedleWidth(const eC_Value vWidth);
 
    eC_Value GetNeedleWidth() const;
 
    void SetNeedleImage(const ImageResource_t eNeedleImageID);
 
    ImageResource_t GetNeedleImage() const;
 
    void SetNeedleColor(const eC_UInt& uiNeedleColor);
 
    void SetNeedleColor(const GlobalProperty_t& eNeedleColor);
 
    eC_UInt GetNeedleColor() const;
 
    void SetShadowColor(const eC_UInt& uiShadowColor);
 
    void SetShadowColor(const GlobalProperty_t& eShadowColor);
 
    eC_UInt GetShadowColor() const;
 
    void SetGaugeImage(const ImageResource_t eGaugeImageID);
 
    ImageResource_t GetGaugeImage() const;
 
    virtual eC_Bool IsHighlightable() const { return false; }
 
#ifdef GUILIANI_WRITE_GUI
    virtual void WriteToStream(const eC_Bool bWriteClassID);
#endif
#ifdef GUILIANI_STREAM_GUI
    CGUIGauge();
    virtual void ReadFromStream();
#endif
 
protected:
    void Init(const eC_Int iMin, const eC_Int iMax, const eC_Value vMinAngle, const eC_Value vMaxAngle, const ImageResource_t eGaugeImage);
 
    virtual eC_Bool OnValueChange();
 
    virtual void DrawGauge();
 
    virtual void DrawNeedle();
 
    void SmartInvalidation();
 
    void CalculateEndpoint();
 
    void UpdateNeedleAngle();
 
private:
    static const eC_UInt INDEX_COLOR_NEEDLE;
    static const eC_UInt INDEX_COLOR_SHADOW;
 
    eC_Value m_vMinAngle;
    eC_Value m_vMaxAngle;
    eC_Value m_vAngle;
    eC_Value m_vEndX;
    eC_Value m_vEndY;
    eC_Value m_vNeedleLength;
    eC_Value m_vNeedleWidth;
    ImageResource_t m_eGaugeImage;
    ImageResource_t m_eNeedleImage;
    eC_Bool m_bSimulate;
};
 
#endif