GAFAnimatedObject.h

#pragma once

#ifndef __GAF_ANIMATED_OBJECT_H__
#define __GAF_ANIMATED_OBJECT_H__

#include "GAFAnimation.h"
#include "GAFCollections.h"

#include "GAFDelegates.h"

class GAFAnimation;
class GAFSprite;
class GAFAnimator;
class GAFAnimatedObject;
class GAFAsset;

enum PCAnimationFPSType // Obsolete. Will be removed
{
    kGAFAnimationFPSType_15 = 15,
    kGAFAnimationFPSType_30 = 30,
    kGAFAnimationFPSType_60 = 60
};

enum GAFAnimatedObjectControlFlags
{
    kGAFAnimatedObjectControl_None = 0,
    // If specified, state of controlled object will be changed every frame (like it is by default) and then
    // animatedObject:didDisplayFrameWithSubobject: will be called
    kGAFAnimatedObjectControl_ApplyState = 1 << 0
};


class GAFAnimatedObject : public cocos2d::Layer, public GAFAnimation
{
protected:
    GAFAnimatedObject();
private:
    GAFAsset * _asset;

    SubObjects_t m_subObjects;
    SubObjects_t m_masks;

    int         m_stencilLayer;

    CaptureObjects_t m_capturedObjects;
    bool _animationsSelectorScheduled;
    GAFFramePlayedDelegate * _framePlayedDelegate;
    GAFAnimatedObjectControlDelegate * _controlDelegate;

    cocos2d::SpriteBatchNode* m_batch;

    int numberOfGlobalFramesForOneAnimationFrame();
    int _extraFramesCounter;
    PCAnimationFPSType _FPSType; // Obsolete. Will be removed
    int m_fps;

    void _updateStencilLayer(int newLayer);
public:
    ~GAFAnimatedObject();
    static GAFAnimatedObject * create(GAFAsset * anAsset);
    static GAFAnimatedObject * createAndRun(const std::string& gafPath, bool looped = false);

    bool init(GAFAsset * anAsset);
    void processAnimations(float dt);
    cocos2d::Vect pupilCoordinatesWithXSemiaxis(float anXSemiaxis, float anYSemiaxis, cocos2d::Vect aCenter, cocos2d::Vect anExternalPoint);
    void removeAllSubObjects();
    
    void instantiateObject(const AnimationObjects_t& objs, const AnimationMasks_t& masks);

    void setSubobjectsVisible(bool visible);

    const SubObjects_t& getSubojects() const;
    const SubObjects_t& getMasks() const;

    void animatorDidPlayedFrame(GAFAnimator * anAnimator, int aFrameNo);

    virtual void start();
    virtual void stop();
    virtual void processAnimation();
    bool captureControlOverSubobjectNamed(const char * aName, GAFAnimatedObjectControlFlags aControlFlags);
    void releaseControlOverSubobjectNamed(const char * aName);

    void setFramePlayedDelegate(GAFFramePlayedDelegate * delegate);
    void setControlDelegate(GAFAnimatedObjectControlDelegate * delegate);
    cocos2d::Rect realBoundingBoxForCurrentFrame();

    GAFSprite * subObjectForInnerObjectId(unsigned int anInnerObjectId);
    unsigned int objectIdByObjectName(const std::string& aName);

    cocos2d::Sprite* renderCurrentFrameToTexture(bool usePOTTextures = false);

    void realizeFrame(cocos2d::Node* out, int frameIndex);

    void setStencilLayer(int newLayer);

    void incStencilLayer();

    void decStencilLayer();

    int  getStencilLayer() const;

    void enableBatching(bool value);

}; // GAFAnimatedObject

#endif // __GAF_ANIMATED_OBJECT_H__