GUIKnob.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 _GUIKNOB_H_
#define _GUIKNOB_H_
 
#include "GUIAbstractBar.h"
#include "GUIColorPropertyObserver.h"
 
#include "GUINinePatch.h"
#include "GUIRange.h"
 
#include "GUIPoint.h"
#include "GUIRect.h"
 
#include "GUICommonEnums.h"
#include "GUIImageResource.h"
 
class CGUIKnob : public CGUIAbstractBar, public CGUIColorPropertyObserver
{
public:
    CGUIKnob(
        CGUICompositeObject* const pkParent,
        const eC_Value& vX, const eC_Value& vY,
        const eC_Value& vWidth, const eC_Value& vHeight,
        const eC_Value& vStartAngle,
        const eC_Value& vEndAngle,
        const eC_Int &iValue,
        const eC_Int &iMin,
        const eC_Int &iMax,
        const eC_UInt &uiStepSize,
        const CGUIRange::Base_t& eBase = CGUIRange::BASE_AT_MINIMUM,
        const ObjectHandle_t &eID = NO_HANDLE);
 
    virtual ~CGUIKnob();
 
    void SetStandardImages();
 
    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 DoDraw();
 
    virtual eC_Bool IsHighlightable() const { return false; }
 
    void SetAxisControl(const eC_Bool& bAxisControl);
 
    eC_Bool GetAxisControl() const;
 
    void SetDragOrientation(const CGUICommonEnums::Orientation_t& eOrientation);
 
    CGUICommonEnums::Orientation_t GetDragOrientation() const;
 
    void SetSmoothControl(const eC_Bool& bSmoothControl);
 
    eC_Bool GetSmoothControl() const;
 
    void SetImages(const ImageResource_t &eImageBG, const ImageResource_t &eImageKnob);
 
    void SetImages(
        const ImageResource_t &eKnobBG,
        const ImageResource_t &eKnobNormal,
        const ImageResource_t &eKnobHighlighted,
        const ImageResource_t &eKnobPressed,
        const ImageResource_t &eKnobGrayedOut = DUMMY_IMAGE)
    {
        SetImages(eKnobBG, eKnobNormal);
    }
 
    eC_UInt GetKnobColor() const;
 
    void SetKnobColor(const eC_UInt& uiKnobColor);
 
    void SetKnobColor(const GlobalProperty_t& eKnobColor);
 
    void SetKnobRadius(const eC_Value& vKnobRadius);
 
    eC_Value GetKnobRadius() const;
 
    eC_UInt GetLineColor() const;
 
    void SetLineColor(const eC_UInt& uiLineColor);
 
    void SetLineColor(const GlobalProperty_t& eLineColor);
 
    void SetLineWidth(const eC_Value& vLineWidth);
 
    eC_Value GetLineWidth() const;
 
    void SetLineLength(const eC_Value& vLineLength);
 
    eC_Value GetLineLength() const;
 
    void SetStartAngle(const eC_Value& vStartAngle);
 
    eC_Value GetStartAngle() const;
 
    void SetEndAngle(const eC_Value& vEndAngle);
 
    eC_Value GetEndAngle() const;
 
    virtual eC_Bool SetValue(const CGUIValue& rkValue);
 
    virtual void SetRange(const eC_Int& iMin, const eC_Int& iMax);
 
 
#ifdef GUILIANI_STREAM_GUI
    CGUIKnob();
 
    virtual void ReadFromStream();
#endif
#ifdef GUILIANI_WRITE_GUI
    virtual void WriteToStream(const eC_Bool bWriteClassID = false);
#endif
 
protected:
#ifndef GUILIANI_STREAM_GUI
    CGUIKnob();
#endif
 
private:
    eC_Int GetSliderValue(const eC_Value& vAngle);
 
    void UpdateValue();
 
    void AdjustDrawAngle();
 
    eC_Value GetAngle(const eC_Value& vAbsX, const eC_Value& vAbsY);
 
    void CalculateLinePoints();
 
    void Init(
        const eC_Value& vStartAngle,
        const eC_Value& vEndAngle,
        const eC_Int &iValue,
        const eC_Int &iMin,
        const eC_Int &iMax,
        const eC_UInt &uiStepSize,
        const CGUIRange::Base_t &eBase);
 
    void DeInit();
 
private:
    static const eC_UInt INDEX_KNOBCOLOR;
    static const eC_UInt INDEX_LINECOLOR;
 
    CGUICommonEnums::Orientation_t m_eDragOrientation;
    eC_Bool m_bAxisControl; 
    eC_Bool m_bSmoothControl; 
 
    ImageResource_t m_eImageBG; 
    ImageResource_t m_eImageKnob; 
 
    // stuff which is used if m_eKnob == DUMMY_IMAGE
    eC_UInt m_uiKnobColor; 
    eC_Value m_vKnobRadius; 
    eC_UInt m_uiLineColor; 
    eC_Value m_vLineWidth; 
    eC_Value m_vLineLength; 
 
    eC_Value m_vStartAngle; 
    eC_Value m_vEndAngle; 
 
    eC_Value m_vDrawAngle; 
    eC_Value m_vSmoothAngle; 
    eC_Value m_vLineStartX;
    eC_Value m_vLineEndX;
    eC_Value m_vLineStartY;
    eC_Value m_vLineEndY;
 
    eC_Int m_iImageWidth; 
    eC_Int m_iImageHeight; 
};
#endif