GUIAnimatedImage.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 GUIANIMATEDIMAGE__H_
#define GUIANIMATEDIMAGE__H_
 
// necessary includes
#include "GUIImage.h"
#include "GUIImageResource.h"
 
// @guiliani_doxygen toplevel_control Animated Image
// @endguiliani_doxygen
class CGUIAnimatedImage : public CGUIImage
{
public:
    CGUIAnimatedImage(
        CGUICompositeObject* const pkParent,
        const eC_Value& vX,
        const eC_Value& vY,
        const eC_Value& vWidth,
        const eC_Value& vHeight,
        const eC_Bool& bStretchBlit = true,
        const eC_UInt uiMs = 100,
        const ObjectHandle_t& eID = NO_HANDLE);
 
    CGUIAnimatedImage(
        CGUICompositeObject* const pkParent,
        const CGUIRect& kRect,
        const eC_Bool& bStretchBlit = true,
        const eC_UInt uiMs = 100,
        const ObjectHandle_t& eID = NO_HANDLE);
 
    CGUIAnimatedImage();
 
    virtual ~CGUIAnimatedImage();
 
    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 SetAutoStart(const eC_Bool& bAutoStart);
 
    eC_Bool GetAutoStart() const;
 
    void SetRepeat(const eC_Bool& bRepeat);
 
    eC_Bool GetRepeat() const;
 
    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;
 
    void SetToggle(const eC_Bool& bToggle);
 
    eC_Bool GetToggle() const;
 
#ifdef GUILIANI_STREAM_GUI
    virtual void ReadFromStream();
#endif
#ifdef GUILIANI_WRITE_GUI
    virtual void WriteToStream(const eC_Bool bWriteClassID = false);
#endif
 
protected:
    eC_TArray<ImageResource_t>  m_aImageIDs;
 
    eC_Bool m_bRepeat;
 
    eC_Bool m_bAutoStart;
 
    eC_UInt m_uiFrameDelay;
 
    eC_UInt m_uiVisibleImageIndex;
 
    eC_Bool m_bToggle;
 
    eC_Bool m_bForward;
 
private:
    void Init();
 
    void DeInit();
};
 
#endif