ZFAniForFrame.h

Go to the documentation of this file.

 
#ifndef _ZFI_ZFAniForFrame_h_
#define _ZFI_ZFAniForFrame_h_
 
#include "ZFAnimation.h"
ZF_NAMESPACE_GLOBAL_BEGIN

#define ZFSerializableKeyword_ZFAniForFrame_frames "frames"
 
// ============================================================
zfclassFwd _ZFP_ZFAniForFramePrivate;
zfclass ZFLIB_ZFUtility ZFAniForFrame : zfextend ZFAnimation {
    ZFOBJECT_DECLARE(ZFAniForFrame, ZFAnimation)
 
public:
    // ============================================================
    // event
    ZFEVENT(AniFrameOnUpdate)
 
    // ============================================================
    // animation setting
public:
    ZFMETHOD_DECLARE_1(void, frame
            , ZFMP_IN(zftimet, duration)
            )
    ZFMETHOD_DECLARE_1(void, frames
            , ZFMP_IN(const ZFCoreArray<zftimet> &, frames)
            )

    ZFMETHOD_DECLARE_0(zfindex, frameCount)
    ZFMETHOD_DECLARE_1(zftimet, frameAt
            , ZFMP_IN(zfindex, index)
            )
    ZFMETHOD_DECLARE_1(void, frameRemoveAt
            , ZFMP_IN(zfindex, index)
            )
    ZFMETHOD_DECLARE_0(void, frameRemoveAll)

    ZFMETHOD_DECLARE_0(zfindex, frameIndex)
 
    // ============================================================
    // property
public:
    ZFPROPERTY_ASSIGN(zfbool, useGlobalTimer, zftrue)
 
    // ============================================================
    // object
protected:
    zfoverride
    virtual void objectOnInit(void);
    zfoverride
    virtual void objectOnDealloc(void);
    zfoverride
    virtual ZFCompareResult objectCompareValueImpl(ZF_IN ZFObject *anotherObj) {
        if(this == anotherObj) {return ZFCompareEqual;}
        zfself *another = zfcast(zfself *, anotherObj);
        if(another == zfnull) {return ZFCompareUncomparable;}
        if(this->frameCount() != another->frameCount()
                || this->useGlobalTimer() != another->useGlobalTimer()
                ) {
            return ZFCompareUncomparable;
        }
        for(zfindex i = 0; i < this->frameCount(); ++i) {
            if(this->frameAt(i) != another->frameAt(i)) {
                return ZFCompareUncomparable;
            }
        }
        return ZFCompareEqual;
    }
 
    zfoverride
    virtual zfbool serializableOnSerializeFromData(
            ZF_IN const ZFSerializableData &serializableData
            , ZF_OUT_OPT zfstring *outErrorHint = zfnull
            , ZF_OUT_OPT ZFSerializableData *outErrorPos = zfnull
            );
    zfoverride
    virtual zfbool serializableOnSerializeToData(
            ZF_IN_OUT ZFSerializableData &serializableData
            , ZF_OUT_OPT zfstring *outErrorHint = zfnull
            , ZF_IN_OPT ZFSerializable *refOwner = zfnull
            );
 
    // ============================================================
    // start stop
public:
    zfoverride
    virtual zftimet durationFixed(void);
 
protected:
    zfoverride
    virtual void aniImplStart(void);
    zfoverride
    virtual void aniImplStop(void);
 
protected:
    virtual void aniFrameOnUpdate(ZF_IN zfindex frameIndex);
 
private:
    _ZFP_ZFAniForFramePrivate *d;
    friend zfclassFwd _ZFP_ZFAniForFramePrivate;
};
 
ZF_NAMESPACE_GLOBAL_END
#endif // #ifndef _ZFI_ZFAniForFrame_h_