gfCDraggableKeyComponent.h

Go to the documentation of this file.

/********************************************************************
*
*       File:           gfCDraggableKeyComponent.h
*
*       Purpose:        Inventory item which is not collected, only used by
*                               dragging directly onto a lock in the scene.
*
*********************************************************************/
 
#ifndef gfCDraggableKeyComponenthdr
#define gfCDraggableKeyComponenthdr
 
#include <fsCore/src/fsCUniqueId.h>
 
#include <fsAppCore/src/components/fsIMessageListenerComponent.h>
#include <fsAppCore/src/components/fsCDragDropComponent.h>
 
struct fsPoint;
class fsCBrush;
 
 
class gfCDraggableKeyComponent : public fsIMessageListenerComponent
{
        friend class fsCComponentFactory;
 
public:
 
        static const fsCUniqueId mTypeId;
        static const fsStr mEntityPrefix;
 
        static fsStr useInventoryIconNameGet(const fsStr& pEntityName);
        static fsStr inventoryIconNameGet(const fsStr& pEntityName);
 
        fsBool toolGet() const { return mTool; }
        void toolSet() { mTool = true; }
        void consume();
 
protected:
 
        void resetDo() override;
 
        void serialiseDo() override;
        void deserialiseDo() override;
 
        void listenersRegisterDo() override;
        void listenersDeregisterDo() override;
        fsBool messageProcessDo(const fsCUniqueId& pMessageType,
                                const fsIMessageDispatcher::sMessageParameters& pParam) override;
 
        static fsIComponent* create(fsCEntity* pParent);
 
        gfCDraggableKeyComponent(fsCEntity* pParent);
        virtual ~gfCDraggableKeyComponent();
 
private:
 
        void sfxPlay() const;
 
        fsPoint offsetGet() const;
 
        static fsStr inventoryIconNameGet(const fsStr& pEntityName, const fsStr& pSuffix);
 
        static const fsStr mUseSuffix;
        static const fsStr mInventoryIconSuffix;
 
        static std::shared_ptr<fsCBrush> useInventoryIconGet(fsCEntity* pParentEntity);
        static std::shared_ptr<fsCBrush> inventoryIconGet(fsCEntity* pParentEntity, const fsStr& pSuffix);
 
        fsCEntity* const dragDropEntGet() const;
        fsBool hotEntUnderCheck() const;
 
        fsBool startDragEventIfHit(const fsIMessageDispatcher::sMessageParameters& pParam);
        void dragEndHandle();
        fsStr dragDropEntNameGet() const;
        void inventoryDelegateApply(std::shared_ptr<fsCBrush> pBrush) const;
 
        fsBool mBeingUsed;
        fsBool mTool;
        fsBool mDepthOrderLocks;
 
        static const fsStr mIconFolder;
 
#ifdef COLLISION_DEBUG_MESSAGES
        void checkLocks();
#endif
 
};
 
#endif