GUIAnimationHandler.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 GUIANIMATIONHANDLER__H_
#define GUIANIMATIONHANDLER__H_
 
#include "GUIComponentManager.h"
 
#define GETANIMATIONHDL CGUIComponentManager::GetInstance().GetAnimationHandler()
 
#include "eC_Types.h"
 
#ifdef GUILIANI_ANIMATION_ACTIVE
 
#include "GUIAnimationResource.h"
#include "GUIAnimation.h"
#include "eC_TList_doubleLinked.h"
 
class CGUIObject;
class CGUIAnimationObserver;
class CGUIAnimationChain;
 
const eC_Int ANIMATIONS_FILE_VERSION = 1;
 
class CGUIAnimationHandler
{
    friend class CGUIAnimation; 
    friend class CGUIAnimationChain; 
    friend class CGUILoadAnimationsCmd; 
    friend class CGUIComponentManager; 
 
public:
    enum DeletionPolicy_t
    {
        DP_STOP, 
        DP_REMOVE 
    };
 
    typedef eC_TListDoubleLinked<CGUIAnimation*> AnimationPtrList;
 
    typedef eC_TListDoubleLinked<CGUIAnimationChain*> AnimationChainPtrList;
 
public:
    static void CreateInstance();
 
    static void DeleteInstance();
 
    void DeInit();
 
    void NotifyOfDestruction(CGUIObject* pkDeletedObject);
 
    void NotifyOfDestruction(CGUIAnimation* pkAnimation);
 
    void NotifyOfDestruction(CGUIAnimationChain* pkAnimationChain);
 
    void NotifyOfDestruction(CGUIAnimationObserver* pkObserver);
 
    CGUIAnimation* GetAnimation(eC_UInt uiID) const;
 
    AnimationPtrList GetAnimationsOfObject(const CGUIObject* pkObject);
 
    CGUIAnimationChain* GetAnimationChain(eC_UInt uiID) const;
 
    const AnimationChainPtrList* GetAnimationChains(void) const;
 
    eC_Bool ObjHasAnimations(const CGUIObject* pkObjToCheck) const;
 
    AnimationPtrList GetAnimations(const CGUIObject* pkObjToCheck) const;
 
    void StartAnimationChain(const eC_UInt& uiID);
 
    void StartAllAnimationChains();
 
    void StopAnimationChain(const eC_UInt& uiID);
 
    void StopAllAnimationChains();
 
    void StopAllAnimations(CGUIObject* pkAnimatedObject);
 
    void StopAllAnimations();
 
    void SetDeletionPolicy(const DeletionPolicy_t& eDeletionPolicy);
 
    DeletionPolicy_t GetDeletionPolicy() const;
 
    void SetDefaultSteptime(const eC_UInt& uiDefaultStepTime);
 
    eC_UInt GetDefaultStepTime() const;
 
    void AssignNewId(CGUIAnimation* pkAnimation);
 
    void AssignNewId(CGUIAnimationChain* pkAnimationChain);
 
    void SetID(CGUIAnimation* pkAnimation, const eC_UInt& uiID);
 
    void SetID(CGUIAnimationChain* pkAnimationChain, const eC_UInt& uiID);
 
    eC_Bool RemoveAnimation(const AnimationHandle_t& eAnimation);
 
#ifdef GUILIANI_STREAM_GUI
    eC_Bool ReadAnimationsFromFile(const eC_String& rkPath);
 
    void ReadFromStream();
#endif
 
#ifdef GUILIANI_WRITE_GUI
    eC_Bool WriteAnimationsToFile(const eC_String& rkPath);
 
    void WriteToStream();
#endif
 
private:
    CGUIAnimationHandler();
 
    ~CGUIAnimationHandler();
 
    eC_UInt AddAnimation(CGUIAnimation* pkNewAnimation);
 
    eC_UInt GenerateAnimationId();
 
    eC_UInt GenerateAnimationChainId();
 
    void AddAnimationInternal(CGUIAnimation* pkNewAnimation);
 
    eC_UInt AddAnimationChain(CGUIAnimationChain* pkAnimationChain);
 
    void AddAnimationChainInternal(CGUIAnimationChain* pkAnimationChain);
 
    eC_Bool RemoveAnimation(CGUIAnimation* pkAnimationToRemove);
 
    eC_Bool RemoveAnimationChain(CGUIAnimationChain* pkAnimationChainToRemove);
 
    void RemoveAllAnimations(CGUIObject* pkAnimatedObject);
 
    void RemoveAllAnimations();
 
    void RemoveAllAnimationChains();
 
private:
    AnimationPtrList m_kAnimations; 
    AnimationChainPtrList m_kAnimationChains; 
    DeletionPolicy_t m_eDeletionPolicy; 
    eC_UInt m_uiDefaultStepTime; 
};
 
#else
 
class CGUIObject;
class CGUIAnimation;
class CGUIAnimationChain;
class CGUIAnimationObserver;
 
// minimum implementation
class CGUIAnimationHandler
{
public:
    static void CreateInstance();
 
    static void DeleteInstance();
 
    void DeInit() {}
 
    void NotifyOfDestruction(CGUIObject* pkDeletedObject) {}
    void NotifyOfDestruction(CGUIAnimation* pkAnimation) {}
    void NotifyOfDestruction(CGUIAnimationChain* pkAnimationChain) {}
    void NotifyOfDestruction(CGUIAnimationObserver* pkObserver) {}
 
    void StartAnimationChain(const eC_UInt& uiID) {}
    void StartAllAnimationChains() {}
    void StopAnimationChain(const eC_UInt& uiID) {}
    void StopAllAnimationChains() {}
    void StopAllAnimations(CGUIObject* pkAnimatedObject) {}
    void StopAllAnimations() {}
 
private:
    CGUIAnimationHandler() {}
};
#endif
 
#endif