GUIAnimation.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 GUIANIMATION__H_
#define GUIANIMATION__H_
 
#include "GUIObject.h"
#include "GUIStreamableObject.h"
 
#include "GUIAnimatedAttribute.h"
 
class CGUIAnimationObserver;
class CGUIAnimationHandler;
class CGUIObject;
 
// @guiliani_doxygen toplevel_module Animations
// @endguiliani_doxygen
class CGUIAnimation : public CGUIAnimatable, public CGUIStreamableObject
{
    friend class CGUIAnimationHandler; 
 
public:
    enum AnimationStatus_t
    {
        ANIMATION_RUNNING,  
        ANIMATION_PAUSED,   
        ANIMATION_STOPPED,  
        ANIMATION_FINISHED, 
        ANIMATION_DELETED,  
    };
 
public:
    virtual void DoAnimate(const eC_Value& vTimes = eC_FromInt(1));
 
    virtual void ApplyAnimation(eC_UInt uiElapsedTime) = 0;
 
    void StartAnimation();
 
    virtual void InitAttributes() {}
 
    void StopAnimation();
 
    void PauseAnimation();
 
    void ContinueAnimation();
 
    eC_Bool IsPaused() const
    {
        return (m_uiExpiredTime != 0);
    }
 
    void SetAnimatedObject(CGUIObject* pkObject) { m_pkAnimatedObject = pkObject; }
 
    void SetAnimatedObjectID(const ObjectHandle_t& eObject) { m_eAnimatedObject = eObject; }
 
    CGUIObject* GetAnimatedObject() const { return m_pkAnimatedObject; }
 
    ObjectHandle_t GetAnimatedObjectID() const { return m_eAnimatedObject; }
 
    eC_UInt GetDuration() const;
 
    void SetDuration(eC_UInt uiDuration);
 
    eC_UInt GetStepTime() const { return m_uiStepTime; }
 
    eC_UInt GetID() const { return m_uiID; }
 
    eC_Bool IsDeletedAfterFinish() const { return m_bDeletedAfterFinish; }
 
    void SetDeletedAfterFinish(const eC_Bool bDeletedAfterFinish)
    {
        m_bDeletedAfterFinish = bDeletedAfterFinish;
    }
 
    void SetAnimationObserver(CGUIAnimationObserver* pkObserver)
    {
        m_kAnimationObserver.RemoveAll();
        m_kAnimationObserver.AddAtEnd(pkObserver);
    }
 
    void AddAnimationObserver(CGUIAnimationObserver* pkObserver)
    {
        m_kAnimationObserver.AddUnique(pkObserver);
    }
 
    void RemoveAnimationObserver(CGUIAnimationObserver* pkObserver)
    {
        m_kAnimationObserver.Remove(pkObserver);
    }
 
    eC_TListDoubleLinked<CGUIAnimatedAttribute>* GetAnimatedAttributes()
    {
        return m_pkAnimatedAttributes;
    }
 
#if defined(GUILIANI_STREAM_GUI) || defined(GUILIANI_WRITE_GUI)
    static const eC_Char XMLTAG_ANIMATIONCLASSID[];
 
    static const eC_Char XMLTAG_ANIMATIONID[];
 
    static const eC_Char XMLTAG_ANIMATIONSTARTTAG[];
 
    static const eC_Char XMLTAG_ANIMATIONENDTAG[];
#endif
 
#ifdef GUILIANI_STREAM_GUI
    void ReadFromStream();
#endif
 
#ifdef GUILIANI_WRITE_GUI
    void WriteToStream(const eC_Bool bWriteClassID = false);
#endif
 
    virtual ~CGUIAnimation();
 
    void UpdateAnimatedObjectPointer();
 
protected:
    CGUIAnimation();
 
    CGUIAnimation(
        CGUIObject* pkAnimatedObject,
        eC_UInt uiDuration,
        eC_UInt uiStepTime = 25,
        eC_Bool bDeletedAfterFinish = false);
 
    virtual void OnStatusChanged(AnimationStatus_t eStatus);
 
    void AddAnimatedAttribute(CGUIAnimatedAttribute kAnimatedAttribute);
 
    void RemoveAnimatedAttributes();
 
    CGUIAnimatedAttribute& GetAnimatedAttribute(const eC_UInt& uiAttributeIndex) const;
 
    eC_TListDoubleLinked<CGUIAnimatedAttribute>* m_pkAnimatedAttributes; 
 
private:
    void Init();
 
    void SetID(const eC_UInt& uiID);
 
private:
    eC_UInt m_uiID;        
    eC_UInt m_uiDuration;  
    eC_UInt m_uiStepTime;  
    eC_UInt m_uiStartTime; 
    eC_UInt m_uiExpiredTime; 
 
    ObjectHandle_t m_eAnimatedObject; 
    CGUIObject* m_pkAnimatedObject;    
 
    eC_TListDoubleLinked<CGUIAnimationObserver*> m_kAnimationObserver; 
 
    eC_Bool m_bDeletedAfterFinish; 
};
 
#endif