gfCParkClearComponent.h

Go to the documentation of this file.

/********************************************************************
*
*       File:           gfCParkClearComponent.h
*
*       Purpose:        Transient "clear forest" tool. Lives on its own short-lived
*                               entity, spawned by gfCParkHudGui when the player arms the clear
*                               tool. A tile-sized marker follows the pointer, snapping to the
*                               hovered grid cell and tinted green over clearable forest / red
*                               otherwise. A valid tap clears that forest cell (charging coins
*                               via gfCParkLevelComponent::forestClearAt) and stays armed so the
*                               player can clear a run of tiles, until the HUD toggles it off.
*
*********************************************************************/
 
#ifndef gfCParkClearComponenthdr
#define gfCParkClearComponenthdr
 
#include <fsCore/src/fsCUniqueId.h>
 
#include <fsAppCore/src/components/fsIMessageListenerComponent.h>
 
class fsCEntity;
struct fsPoint;
 
 
class gfCParkClearComponent : public fsIMessageListenerComponent
{
        friend class fsCComponentFactory;
 
public:
 
        static const fsCUniqueId mTypeId;
 
        // Arm the tool and show the hover marker. Called right after componentAdd.
        void clearBegin();
 
        // Cancel the tool when the HUD clear toggle is switched off. Destroys the
        // marker and this component's host entity - clearing already persisted per tap.
        void clearEnd();
 
        virtual ~gfCParkClearComponent();
 
protected:
 
        void listenersRegisterDo() override;
        void listenersDeregisterDo() override;
        fsBool messageProcessDo(const fsCUniqueId& pMessageType,
                                const fsIMessageDispatcher::sMessageParameters& pParam) override;
 
        static fsIComponent* const create(fsCEntity* const pParent);
        gfCParkClearComponent(fsCEntity* const pParent);
 
private:
 
        void previewCreate();
        void previewDestroy();
        // Recompute the hovered cell and marker colour for a screen position. Returns
        // true when that cell is a clearable forest tile the player can afford.
        fsBool previewUpdate(const fsPoint& pScreenPos);
 
        fsCEntity* mPreviewEntity;
        fsS32 mHoverCol;
        fsS32 mHoverRow;
        fsBool mHoverValid;
};
 
#endif