gfCPickListGui.h

Go to the documentation of this file.

/********************************************************************
*
*       File:           fsCPickListGui.h
*
*       Purpose:        Selects and displays entities required for collection.
*                               Controls PickListEntry children.
*
*********************************************************************/
 
#ifndef gfCPickListGuihdr
#define gfCPickListGuihdr
 
#include <vector>
 
#include <fsCore/src/fsCUniqueId.h>
#include <fsAppCore/src/components/gui/fsIMessageListenerGuiComponent.h>
 
class gfIPickListEntryGui;
class gfCTaskComponent;
 
 
class gfCPickListGui : public fsIMessageListenerGuiComponent
{
        friend class fsCComponentFactory;
 
public:
 
        const std::vector<gfIPickListEntryGui*> entriesGet() const;
 
        gfIPickListEntryGui* entryLocate(const fsStr& pLocalisedEntName) const;
 
        static const fsCUniqueId mTypeId;
 
        virtual ~gfCPickListGui() = default;
 
protected:
 
        void serialiseDo() override;
        void deserialiseDo() override;
        void postLoadDo() override;
 
        void listenersDeregisterDo() override;
        void listenersRegisterDo() override;
        fsBool messageProcessDo(const fsCUniqueId& pMessageType,
                                const fsIMessageDispatcher::sMessageParameters& pParam) override;
        void initialiseFromVariableTableDo(const fsCVariableTable& pVars) override;
 
        static fsIComponent* create(fsCEntity* pParent);
 
        gfCPickListGui(fsCEntity* pParent);
 
private:
 
        class fsSEntityTypes
        {
        public:
                void tagAdd(fsStr const& pTag);
                void typeAdd(const std::type_info* pType);
 
                std::vector<fsCEntity*> entitiesGet() const;
        
        private:
 
                std::vector<const std::type_info*> mEntityTypes;
                std::vector<fsStr> mTags;
        };
 
        void levelDataInitialise(const fsCVariableTable& pLevelSettings);
 
        void totEntitiesToCollectSet(fsS32 pTotEntities);
        void repeatedHOGItemCollectionCountSet(fsS32 pSize) { mRepeatedHOGItemCount = pSize; }
 
        void updateDo(fsS32 pDeltaMs) override;
 
        void reset();
 
        static void chooseEntsWithMatchingNameAndStripFromCollectableCollection(
                std::vector<fsCEntity*>& pCollectableCollection,
                std::vector<fsCEntity*>& pChosenEntities, std::vector<fsCEntity*>::iterator& pEntIt, const fsStr& pMatch);
 
        void entitiesRelinkWithGuiSlots();
        std::vector<fsCEntity*> collectableEntitesGet() const;
 
        fsS32 allEntitiesCountGet() const;
        static fsS32 numUniqueEntityNamesGet(const std::vector<fsCEntity*>& pEnts);
 
        void itemCountUpdate() const;
 
        fsBool hintActivate();
        std::vector<fsCEntity*> hintableEntitiesGet() const;
        std::vector<fsCEntity*> draggableEntitiesGet() const;
 
        void completionRequirementClear() const;
        void completionRequirementRegister() const;
 
        void listCompleteProcess();
        void updateCollectionCount();
 
        void slotsGather();
        void entityTypesGather(fsSEntityTypes& pTypes, fsStr pEntsStr);
 
        fsU32 availableSlotsCount() const;
 
        void entityAddToList();
 
        std::vector<fsCEntity*> entityOfTypesGet(fsSEntityTypes const& pTypes) const;
        static void collectedEntitiesRemove(std::vector<fsCEntity*>& pCandidateEntities);
        static void nonCollectableEntitiesRemove(std::vector<fsCEntity*>& pCandidateEntities);
        static void entitiesWithSameTextGet(std::vector<fsCEntity*>& pChosenEntities,
                                            const std::vector<fsCEntity*>& pShuffledEntities);
 
        gfIPickListEntryGui* randomAvailableSlotGet() const;
 
        void taskEntityRegisterWithRollOver(gfCTaskComponent* pTaskComponent, fsCEntity* pSlot);
 
        void listSetupHandle();
        void listCompletedHandle();
 
 
        std::vector<gfIPickListEntryGui*> mEntries;
 
        fsSEntityTypes mPriorityEntityTypes;
        fsSEntityTypes mRandomEntityTypes;
 
        fsS32 mNextNewEntryDelay;
 
        fsS32 mRepeatedHOGItemCount;
        fsS32 mTotEntitiesToCollect;
        fsS32 mTotEntitiesAddedToList;
        fsBool mGroupEntitiesByName;
        fsBool mRequiredForActCompletion;
 
        fsS32 mNumEntitiesCollected;
 
        fsBool mOrdered;
 
        fsBool mHideWhenDone;
        fsBool mLevelSkipped;
#if !defined fsRELEASE
        fsBool mWarnedAboutLackOfItems;
#endif
};
 
#endif