fsCRollOverButtonComponent.h

Go to the documentation of this file.

/********************************************************************
*
*       Created:        17/3/2014   11:05
*
*       File:           fsCRollOverButtonComponent.h
*
*       Author:         Mick Waites
*
*       Purpose:        Control component for a GUI button entity.
*
*********************************************************************/
 
#ifndef fsCRollOverButtonComponenthdr
#define fsCRollOverButtonComponenthdr
 
#include <fsAppCore/src/components/fsITutorialEnabledComponent.h>
 
#include <fsCore/src/fsCUniqueId.h>
 
#include "../../../../fsIInputManager.h"
#include "../../fsIMessageListenerComponent.h"
 
struct fsPoint;
class fsCResourceName;
class fsIFont;
class gfCSubSceneViewComponent;
class fsCBrush;
 
 
class fsCRollOverButtonComponent : public fsIMessageListenerComponent, public fsITutorialEnabledComponent
{
        friend class gfCLevelSequencerMapComponent;
        friend class fsCComponentFactory;
        friend class gfIAutoTestLevelUserInputComponent;
 
public:
 
        struct fsCRollOverAction
        {
                virtual void update() = 0;
                virtual void start(const fsPoint& pMousePos) = 0;
                virtual void end(const fsPoint& pMousePos) = 0;
                virtual void mouseDown(const fsPoint& pMousePos) = 0;
                virtual void mouseUp(const fsPoint& pMousePos) = 0;
 
                fsCRollOverAction()
                {
                }
 
                virtual ~fsCRollOverAction()
                {
                }
        };
 
        struct sButtonEventMsgParam : public fsIMessageDispatcher::sMessageParameters
        {
                fsStr mStr;
                fsCRollOverButtonComponent* mParent;
        };
 
        void actionSet(fsCRollOverAction* pRollOverAction);
 
        fsCEntity* buttonGuiEntityCreate(const fsStr& pEntityName, const fsCResourceName& pImageFileName,
                                         const fsCResourceName& pDownImageFileName);
 
        static const fsCUniqueId mTypeId;
 
protected:
 
        void tutorialCompletedDo(const fsPoint& pPos) override;
 
        void updateDo(fsS32 pDeltaMs) override;
 
        void listenersRegisterDo() override;
        void listenersDeregisterDo() override;
        fsBool messageProcessDo(const fsCUniqueId& pMessageType,
                                const fsIMessageDispatcher::sMessageParameters& pParam) override;
 
 
        void defaultSpriteSet();
 
        virtual fsBool acceptingInputGet() const;
 
        virtual void onTap(const fsPoint& pTapPos);
 
        static fsIComponent* create(fsCEntity* pParent);
 
        void initialiseFromVariableTableDo(const fsCVariableTable& pVars) override;
 
        fsCRollOverButtonComponent(fsCEntity* pParent);
        virtual ~fsCRollOverButtonComponent();
 
        std::shared_ptr<fsCBrush> mBrush;
        std::shared_ptr<fsCBrush> mOverBrush;
 
        fsCRollOverAction* mActionId;
 
private:
 
        fsBool mOver;
 
        static const fsCUniqueId mActionUnsetId;
 
        fsBool hitTest(const fsPoint& pPos) const;
 
        fsBool pointerMoveProcess(const fsIInputManager::sPointerMsgParam& pParam);
        fsBool pointerDownProcess(const fsIInputManager::sPointerMsgParam& pParam);
        fsBool pointerUpProcess(const fsIInputManager::sPointerMsgParam& pParam);
 
        void spriteInitialise(const fsCVariableTable& pVars);
};
 
#endif