GUIImageStack.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.
*/

#if !defined(GUI_IMAGE_STACK_H)
#define GUI_IMAGE_STACK_H

#include "GUIAnimatedImage.h"

// @guiliani_doxygen toplevel_control Image Stack
// @endguiliani_doxygen
class CGUIImageStack : public CGUIImage
{
public:
    CGUIImageStack(
        CGUICompositeObject* const pkParent,
        const eC_Value& vX, const eC_Value& vY,
        const eC_Value& vWidth, const eC_Value& vHeight,
        const eC_UInt& uiFrameDelay,
        const ObjectHandle_t &eID = NO_HANDLE);

    CGUIImageStack(
        CGUICompositeObject* const pkParent,
        const CGUIRect& kRect,
        const eC_UInt& uiFrameDelay,
        const ObjectHandle_t &eID = NO_HANDLE);

    CGUIImageStack();

    virtual ~CGUIImageStack();

    void ShowNext();

    void ShowPrevious();

    virtual eC_Bool SetValue(const CGUIValue& rkValue)
    {
        // Show image at index given by value
        SetAnimationIndex(rkValue.ToInt());
        CGUIObject::SetValue(rkValue);
        return true;
    }

    virtual eC_Bool DoDraw();

    void StopAnimation();

    void StartAnimation();

    virtual void DoAnimate(const eC_Value& vTimes = eC_FromInt(1));

    void SetImages(eC_TArray<ImageResource_t> &aImages);

    void SetFrameDelay(const eC_UInt& uiMs);

    eC_UInt GetFrameDelay() const;

    void SetAnimationIndex(const eC_UInt& uiIndex);

    ImageResource_t GetImage(const eC_UInt& uiIndex) const;

    eC_UInt GetIndexOfVisibleImage() const;

    eC_UInt GetNumberOfImages() const;

    eC_Bool DoKeyDown(
        const GUIKeyIdentifier_t& eKeyID,
        const eC_UInt& uiModifiers);

    eC_Bool DoDrag(const eC_Value& vDeltaX, const eC_Value& vDeltaY, const eC_Value& vAbsX, const eC_Value& vAbsY);

    eC_Bool DoButtonDown(const eC_Value& vAbsX, const eC_Value& vAbsY);

    inline void SetMaximumZoomFactor(eC_Value vMaxFactor) { m_vMaxScale = vMaxFactor; }

    inline void SetMinimumZoomFactor(eC_Value vMinFactor) { m_vMinScale = vMinFactor; }

    inline void SetStaticZoomFactor(eC_Value vStaticFactor) { m_vStaticScale = vStaticFactor; InvalidateArea(); }

    inline eC_Value GetMaximumZoomFactor() const { return m_vMaxScale; }

    inline eC_Value GetMinimumZoomFactor() const { return m_vMinScale; }

    inline eC_Value GetStaticZoomFactor() const { return m_vStaticScale; }

#if defined(GUILIANI_STREAM_GUI)

    virtual void ReadFromStream();
#endif

#if defined(GUILIANI_WRITE_GUI)

    virtual void WriteToStream(const eC_Bool bWriteClassID = false);
#endif

protected:
    void BlitScaledImage(ImageResource_t eID, eC_Value vScale, eC_Value vYOffset, eC_UByte ubAlpha);

    enum AnimationDirection
    {
        AD_NONE, 
        AD_IN,   
        AD_OUT   
    };

    AnimationDirection m_eDirection;

    eC_Value m_vAnimationPercentage;

    eC_TArray<ImageResource_t>  m_aImageIDs;

    eC_UInt m_uiFrameDelay;

    eC_UInt m_uiVisibleImageIndex;

    eC_Value m_vMaxScale;

    eC_Value m_vMinScale;

    eC_Value m_vStaticScale;

    eC_Value m_vDragStartY;

private:
    void Init();

    void DeInit();
};

#endif // GUI_IMAGE_STACK_H