GUIClock.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 _GUICLOCK_H_
#define _GUICLOCK_H_
 
#include "GUIObject.h"
#include "GUIColorPropertyObserver.h"
#include "GUIImageResource.h"
 
class CGUIClock : public CGUIObject, public CGUIColorPropertyObserver
{
public:
 
    CGUIClock(
        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);
 
    CGUIClock(
        CGUICompositeObject* const pkParent,
        const eC_Value& vX,
        const eC_Value& vY,
        const eC_Value& vWidth,
        const eC_Value& vHeight,
        const eC_UByte& ubHours,
        const eC_UByte& ubMinutes,
        const eC_UByte& ubSeconds,
        const ObjectHandle_t& eID = NO_HANDLE);
 
    CGUIClock(
        CGUICompositeObject* const pkParent,
        const eC_Value& vX,
        const eC_Value& vY,
        const eC_Value& vWidth,
        const eC_Value& vHeight,
        const eC_UByte& ubHours,
        const eC_UByte& ubMinutes,
        const eC_UByte& ubSeconds,
        const eC_UInt& uiHourHandleColor, 
        const eC_UInt& uiMinuteHandleColor, 
        const eC_UInt& uiSecondHandleColor,
        const ObjectHandle_t& eID = NO_HANDLE);
 
    CGUIClock(
        CGUICompositeObject* const pkParent,
        const eC_Value& vX,
        const eC_Value& vY,
        const eC_Value& vWidth,
        const eC_Value& vHeight,
        const eC_UByte& ubHours,
        const eC_UByte& ubMinutes,
        const eC_UByte& ubSeconds,
        const eC_UInt& uiHourHandleColor,
        const eC_UInt& uiMinuteHandleColor,
        const eC_UInt& uiSecondHandleColor,
        const eC_Value& vHourNeedleLength, 
        const eC_Value& vMinuteNeedleLength, 
        const eC_Value& vSecondNeedleLength,
        const ObjectHandle_t& eID = NO_HANDLE);
 
    CGUIClock(
        CGUICompositeObject* const pkParent,
        const eC_Value& vX,
        const eC_Value& vY,
        const eC_Value& vWidth,
        const eC_Value& vHeight,
        const eC_UByte& ubHours,
        const eC_UByte& ubMinutes,
        const eC_UByte& ubSeconds,
        const eC_UInt& uiHourHandleColor,
        const eC_UInt& uiMinuteHandleColor,
        const eC_UInt& uiSecondHandleColor,
        const eC_Value& vHourNeedleLength,
        const eC_Value& vMinuteNeedleLength,
        const eC_Value& vSecondNeedleLength,
        const eC_Value& vHourNeedleWidth, 
        const eC_Value& vMinuteNeedleWidth, 
        const eC_Value& vSecondNeedleWidth,
        const ObjectHandle_t& eID = NO_HANDLE);
 
    virtual ~CGUIClock();
 
    virtual eC_Bool DoDraw();
 
    virtual void DoAnimate(const eC_Value& vTimes);
 
    virtual eC_Bool IsHighlightable() const { return false; }
 
    void SetImages(
        const ImageResource_t& eImageBG,
        const ImageResource_t& eImageHour,
        const ImageResource_t& eImageMinute,
        const ImageResource_t& eImageSecond);
 
    void GetImages(
        ImageResource_t& eImageBG,
        ImageResource_t& eImageHour,
        ImageResource_t& eImageMinute,
        ImageResource_t& eImageSecond) const;
 
    void SetStandardImages();
 
    // needle color
    void SetHourNeedleColor(const eC_UInt& uiNeedleColor);
 
    void SetHourNeedleColor(const GlobalProperty_t& eNeedleColor);
 
    eC_UInt GetHourNeedleColor() const;
 
    void SetMinuteNeedleColor(const eC_UInt& uiNeedleColor);
 
    void SetMinuteNeedleColor(const GlobalProperty_t& eNeedleColor);
 
    eC_UInt GetMinuteNeedleColor() const;
 
    void SetSecondNeedleColor(const eC_UInt& uiNeedleColor);
 
    void SetSecondNeedleColor(const GlobalProperty_t& eNeedleColor);
 
    eC_UInt GetSecondNeedleColor() const;
 
    void SetHourNeedleLength(const eC_Value& vNeedleLength);
 
    eC_Value GetHourNeedleLength() const;
 
    void SetMinuteNeedleLength(const eC_Value& vNeedleLength);
 
    eC_Value GetMinuteNeedleLength() const;
 
    void SetSecondNeedleLength(const eC_Value& vNeedleLength);
 
    eC_Value GetSecondNeedleLength() const;
 
    void SetHourNeedleWidth(const eC_Value& vNeedleWidth);
 
    eC_Value GetHourNeedleWidth() const;
 
    void SetMinuteNeedleWidth(const eC_Value& vNeedleWidth);
 
    eC_Value GetMinuteNeedleWidth() const;
 
    void SetSecondNeedleWidth(const eC_Value& vNeedleWidth);
 
    eC_Value GetSecondNeedleWidth() const;
 
    void ShowShadows(const eC_Bool& bShowShadow);
 
    eC_Bool ShowShadows() const;
 
    void SetShadowColor(const eC_UInt& uiShadowColor);
 
    void SetShadowColor(const GlobalProperty_t& eShadowColor);
 
    eC_UInt GetShadowColor() const;
 
    void ShowSecondHandle(const eC_Bool& bShowSecondHandle);
 
    eC_Bool ShowSecondHandle() const;
 
    void SetAutoStart(const eC_Bool& bAutoStart);
 
    eC_Bool GetAutoStart() const;
 
    virtual eC_Bool SetValue(const CGUIValue& rkValue);
 
    void SetTimeInSeconds(const eC_UInt& uiTimeInSeconds);
 
    eC_UInt GetTimeInSeconds() const;
 
    void SetTime(const eC_UByte& ubHours, const eC_UByte& ubMinutes, const eC_UByte& ubSeconds);
 
    void GetTime(eC_UByte& ubHours, eC_UByte& ubMinutes, eC_UByte& ubSeconds) const;
 
    void SetHour(const eC_UByte& uiHour);
 
    eC_UByte GetHour() const;
 
    void SetMinute(const eC_UByte& uiMinute);
 
    eC_UByte GetMinute() const;
 
    void SetSecond(const eC_UByte& uiSecond);
 
    eC_UByte GetSecond() const;
 
#ifdef GUILIANI_STREAM_GUI
    CGUIClock();
 
    virtual void ReadFromStream();
#endif
 
#ifdef GUILIANI_WRITE_GUI
    virtual void WriteToStream(const eC_Bool bWriteClassID = false);
#endif
 
protected:
#ifndef GUILIANI_STREAM_GUI
    CGUIClock();
#endif
 
private:
    void Init(
        const eC_UByte& ubHours, const eC_UByte& ubMinutes, const eC_UByte& ubSeconds,
        const eC_UInt& uiHourHandleColor, const eC_UInt& uiMinuteHandleColor, const eC_UInt& uiSecondHandleColor,
        const eC_Value& vHourNeedlelength, const eC_Value& vMinuteNeedlelength, const eC_Value& vSecondNeedlelength,
        const eC_Value& vHourNeedleWidth, const eC_Value& vMinuteNeedleWidth, const eC_Value& vSecondNeedleWidth
   );
 
    void DeInit();
 
    eC_Value GetHourAngle() const;
    eC_Value GetMinuteAngle() const;
    eC_Value GetSecondAngle() const;
 
    void DrawNeedle(eC_Value vAngle, eC_Value vWidth, eC_Value vlength, eC_UInt uiColor, eC_UInt uiShadowColor, ImageResource_t m_eImage);
 
    void CalculateEndpoint(eC_Value vAngle, eC_Value vlength);
    void RecalculateAngles();
 
private:
    static const eC_UInt INDEX_COLOR_HOUR;
    static const eC_UInt INDEX_COLOR_MINUTE;
    static const eC_UInt INDEX_COLOR_SECOND;
    static const eC_UInt INDEX_COLOR_SHADOW;
 
    //Clock backgroung
    ImageResource_t m_eImageBackground;              
    //Handle Images
    ImageResource_t m_eImageHourHandle;              
    ImageResource_t m_eImageMinuteHandle;            
    ImageResource_t m_eImageSecondHandle;            
 
    //time
    eC_UByte m_ubHour;
    eC_UByte m_ubMinute;
    eC_UByte m_ubSecond;
 
    eC_UByte m_ubStartHours;
    eC_UByte m_ubStartMinutes;
    eC_UByte m_ubStartSeconds;
 
    //angles
    eC_Value m_vHourAngle;
    eC_Value m_vMinuteAngle;
    eC_Value m_vSecondAngle;
 
    eC_Value m_vExactSeconds;
 
    // ------------NEEDLES------------
    // End of the needle to be drawn
    eC_Value m_vEndX;
    eC_Value m_vEndY;
 
    // Shadows
    eC_Bool m_bShowShadows;
 
    // lengths
    eC_Value m_vHourNeedleLength;
    eC_Value m_vMinuteNeedleLength;
    eC_Value m_vSecondNeedleLength;
 
    // Widths
    eC_Value m_vHourNeedleWidth;
    eC_Value m_vMinuteNeedleWidth;
    eC_Value m_vSecondNeedleWidth;
 
    eC_Bool m_bShowSecondHandle;
 
    eC_Bool m_bAutoStart;
};
#endif // _GUICLOCK_H_