gfCTutorialSequencerComponent.h

Go to the documentation of this file.

/********************************************************************
*
*       Created:        14/7/2014   9:20
*
*       File:           gfCTutorialSequencerComponent.h
*
*       Author:         Martin P. King
*       
*       Purpose:        Sequence the lessons and steal input
*
*********************************************************************/
 
#ifndef gfCTutorialSequencerComponenthdr
#define gfCTutorialSequencerComponenthdr
 
#include <fsAppCore/src/components/fsIMessageListenerComponent.h>
 
struct fsPoint;
class gfCHotComponent;
 
 
class gfCTutorialSequencerComponent : public fsIMessageListenerComponent
{
        friend class fsCComponentFactory;
 
public:
 
        fsBool tutorialComplete(fsCEntity* pAssociatedEnt, const fsPoint& pPos);
 
        // While this holds, messageProcessDo() consumes every pointer message, so
        // nothing else in the scene can be tapped or dragged.
        fsBool inputStealingGet() const { return !mTutorialEntities.empty(); }
        void deferredTutorialEntityEnable(fsCEntity* pEnt);
        void bringToForeground();
 
        static const fsCUniqueId mTypeId;
        virtual ~gfCTutorialSequencerComponent();
 
protected:
 
        void listenersRegisterDo() override;
        void listenersDeregisterDo() override;
        fsBool messageProcessDo(const fsCUniqueId& pMessageType,
                                const fsIMessageDispatcher::sMessageParameters& pParam) override;
 
        void updateDo(fsS32 pDeltaMs) override;
        void postLoadDo() override;
 
        static fsIComponent* create(fsCEntity* pParent);
        gfCTutorialSequencerComponent(fsCEntity* pParent);
 
private:
 
        void tutorialsForceCollect();
        gfCHotComponent* const hotComponentGet(fsCEntity* pAssociatedEntity) const;
 
        void deferredTutorialsActivate();
 
        fsCEntity* const tutorialDialogueCreate(const fsStr& pTutKey) const;
        void tutorialDialogueDestroy() const;
 
        static fsStr animFilenameGet(fsCEntity* pEnt);
        static fsStr particleFilenameGet(fsCEntity* pEnt);
 
        void tutorialEntitiesClearDeferred();
        void tutorialEntitiesClearCollected();
        static fsBool draggableComponent(fsCEntity* pEnt);
 
        void advance();
        void nextTutorialActivate();
 
        void tutorialImageSet(fsCEntity* pDialogueEnt, fsCEntity* pEnt) const;
        fsCEntity* const tutorialTextSet(fsCEntity* pEnt) const;
        static fsStr associatedEntityNameGet(fsCEntity* pEnt);
 
        fsBool targetEntityHitCheck(fsCEntity* pEnt, const fsPoint& pPos);
        fsBool nextTutorialAnimationLoad(fsCEntity* pDialogEnt, fsCEntity* pEnt);
        fsBool nextTutorialParticleEffectLoad(fsCEntity* pDialogEnt, fsCEntity* pEnt);
 
        void tutorialEntitiesActivate();
        void tutorialEntitiesCollate();
 
        std::vector<fsCEntity*> mTutorialEntities;
        std::vector<fsCEntity*> mDeferredTutorialEntities;
};
 
#endif