GUIAnimationChain.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_CHAIN__H_
#define GUIANIMATION_CHAIN__H_
 
 
#include "GUIAnimatable.h"
#include "GUIAnimationObserver.h"
#include "GUIStreamableObject.h"
#include "eC_TList_doubleLinked.h"
 
class CGUIAnimation;
 
class CGUIAnimationChain : public CGUIAnimatable, public CGUIAnimationObserver, public CGUIStreamableObject
{
    friend class CGUIAnimationHandler; 
public:
    enum AnimationChain_t
    {
        PARALLEL_ANIMATION, 
        CHAINED_ANIMATION, 
    };
 
    struct AnimationInfo_t
    {
        AnimationInfo_t() :
            m_pkAnimation(NULL),
            m_uiOffset(0)
        {}
 
        bool operator==(const AnimationInfo_t& rhs) const
        {
            return (m_pkAnimation == rhs.m_pkAnimation);
        }
 
        CGUIAnimation* m_pkAnimation; 
        eC_UInt m_uiOffset; 
    };
 
    typedef eC_TListDoubleLinked<AnimationInfo_t> AnimationList_t;
 
    CGUIAnimationChain(const AnimationChain_t eType, const eC_Bool bCyclic = false);
 
    virtual ~CGUIAnimationChain();
 
    void AddAnimation(CGUIAnimation* pkAnimation, eC_UInt uiTimeOffset = 0);
 
    void RemoveAnimation(CGUIAnimation* pkAnimation);
 
    void RemoveAllAnimations();
 
    void StartAnimation();
 
    void StopAnimation();
 
    void PauseAnimation();
 
    void ContinueAnimation();
 
    eC_Bool IsPaused() const;
 
    virtual eC_Bool IsAnimating() const;
 
    virtual void DoAnimate(const eC_Value& vTimes = eC_FromInt(1));
 
    void SetCyclicAnimation(const eC_Bool bCyclicAnimation) { m_bCyclic = bCyclicAnimation; }
 
    eC_Bool GetCyclicAnimation() const { return m_bCyclic; }
 
    void OnStatusChanged(
        CGUIAnimation::AnimationStatus_t eStatus,
        CGUIAnimation* pAnimation);
 
    eC_UInt GetID() { return m_uiID; }
 
    AnimationChain_t GetChainType() { return m_eChainType; }
 
    const CGUIAnimation* GetAnimation(eC_UInt uiID);
 
    const AnimationList_t* GetAnimations() { return &m_kAnimationList; }
 
#if defined(GUILIANI_STREAM_GUI) || defined(GUILIANI_WRITE_GUI)
    static const eC_UInt ANIMATION_CHAIN_CLASS_VERSION; 
#endif
 
#ifdef GUILIANI_STREAM_GUI
    void ReadFromStream();
 
    CGUIAnimationChain();
#endif
 
#ifdef GUILIANI_WRITE_GUI
    void WriteToStream(const eC_Bool bWriteClassID = false);
 
#endif
 
private:
    void Init();
 
    void StartNextAnimation();
 
    eC_Bool GetNextAnimationStartOffset(eC_UInt& uiNextStartOfset);
 
    eC_Bool GetNextAnimationsForOffset(const eC_UInt& uiOffset);
 
    eC_UInt GetDuration();
 
    void GetNextParallelAnimation();
 
    void ResetAnimation();
 
    void SetID(const eC_UInt& uiID);
 
private:
    AnimationList_t m_kAnimationList;
 
    AnimationList_t::SafeIterator m_kNextChainedAnimation;
 
    AnimationList_t m_kNextParallelAnimations;
 
    AnimationChain_t m_eChainType;
 
    eC_UInt m_uiStartTime;
 
    eC_UInt m_uiExpiredTime;
 
    eC_UInt m_uiOffsetSave;
 
    eC_UInt m_uiOffsetRemaining;
 
    eC_UInt m_uiCurrentStartOffset;
 
    eC_Bool m_bCyclic;
 
    eC_UInt m_uiID;
 
    eC_Bool m_bLastAnimationOfChain;
};
 
#endif