Fission FSN
Loading...
Searching...
No Matches
gfIPickListEntryGui.h
Go to the documentation of this file.
1/********************************************************************
2*
3* Created: 8/4/2014 17:26
4*
5* File: fsIPickListEntryGui.h
6*
7* Author: Mick Waites
8*
9* Purpose: Base for the different pick list gui entry types.
10*
11*********************************************************************/
12
13#ifndef fsIPickListEntryGuihdr
14#define fsIPickListEntryGuihdr
15
16#include <vector>
18
20
21
23{
24public:
25
27
28 fsCEntity* const firstEntityGet() const;
29
30
31 void postLoadRelink(const std::vector<fsCEntity*>& pMyEntities);
32 fsBool entityNameMatchGet(const fsStr& pMatch) const;
34
35 void uncollectedEntitiesInSubSceneAddToVec(std::vector<fsCEntity*>& pVec, fsS32 pSubSceneIndex) const;
36
37 void deactivate();
38 void activate(const std::vector<fsCEntity*>& pMyEntities, fsS32 pTotalEntitiesToCollect);
39 fsBool isActiveGet() const;
41
42protected:
43
44 const std::vector<fsCEntity*>& myEntitiesGet() const { return mMyEntities; }
45
46 enum
47 {
53 };
54
55 std::vector<fsCEntity*> entitiesGet() const;
56 void stateSet(fsS32);
57 fsS32 stateGet() const;
58 void numberToCollectSet(fsS32 pNumToCollect);
60
61 void updateDo(fsS32 pDeltaMs) override;
62 void serialiseDo() override;
63 void deserialiseDo() override;
64 void resetDo() override;
65
66 void listenersRegisterDo() override;
67 void listenersDeregisterDo() override;
68 fsBool messageProcessDo(const fsCUniqueId& pMessageType,
69 const fsIMessageDispatcher::sMessageParameters& pParam) override;
70
72 virtual ~gfIPickListEntryGui();
73
74
75private:
76
77 virtual void uncollectedEntitiesInSubSceneAddToVecDo(std::vector<fsCEntity*>& pVec, fsS32 pSubSceneIndex) const
78 {
79 };
80
81 virtual void activateDo(std::vector<fsCEntity*> pMyEntities) = 0;
82 // After a load has linked the entities back up.
83 virtual void relinkedDo() {}
84 virtual void deactivateDo() = 0;
85 virtual fsBool transitionOnUpdate(fsS32 pDeltaMs) = 0;
86 virtual fsBool transitionOffUpdate(fsS32 pDeltaMs) = 0;
87 virtual fsBool entityCollectedHandle() = 0;
88
89 virtual void entitiesMakeCollectableDo(fsS32 pTotalEntitiesToCollect)
90 {
91 }
92
93 void entitiesMakeCollectable(fsS32 pTotalEntitiesToCollect);
94
95 std::vector<fsCEntity*> mMyEntities;
96
97 fsS32 mNumToCollect;
98 fsStr mEntityLocalisedName;
99 // What gets saved; a found word's entry has no entities after a load, so it can't be read back from them.
100 fsStr mEntitySaveName;
101
102 fsS32 mState;
103};
104
105#endif
Definition fsCEntity.h:39
Definition fsCUniqueId.h:21
fsIMessageListenerGuiComponent(fsCEntity *pParent, fsS32 pPriority)
Definition fsIMessageListenerGuiComponent.cpp:4
Definition fsITextSpriteComponent.h:22
Definition fsStr.h:23
fsCEntity *const firstEntityGet() const
Definition gfIPickListEntryGui.cpp:15
static const fsCUniqueId mAddedEntryToPickListdMsg
Definition gfIPickListEntryGui.h:26
void listenersRegisterDo() override
Definition gfIPickListEntryGui.cpp:164
void uncollectedEntitiesInSubSceneAddToVec(std::vector< fsCEntity * > &pVec, fsS32 pSubSceneIndex) const
Definition gfIPickListEntryGui.cpp:85
void resetDo() override
Definition gfIPickListEntryGui.cpp:45
void deserialiseDo() override
Definition gfIPickListEntryGui.cpp:63
std::vector< fsCEntity * > entitiesGet() const
Definition gfIPickListEntryGui.cpp:40
fsBool messageProcessDo(const fsCUniqueId &pMessageType, const fsIMessageDispatcher::sMessageParameters &pParam) override
Definition gfIPickListEntryGui.cpp:170
void postLoadRelink(const std::vector< fsCEntity * > &pMyEntities)
Definition gfIPickListEntryGui.cpp:50
fsS32 numberToCollectGet() const
Definition gfIPickListEntryGui.cpp:35
void activate(const std::vector< fsCEntity * > &pMyEntities, fsS32 pTotalEntitiesToCollect)
Definition gfIPickListEntryGui.cpp:105
void listenersDeregisterDo() override
Definition gfIPickListEntryGui.cpp:158
void serialiseDo() override
Definition gfIPickListEntryGui.cpp:56
fsBool isActiveGet() const
Definition gfIPickListEntryGui.cpp:91
void numberToCollectSet(fsS32 pNumToCollect)
Definition gfIPickListEntryGui.cpp:30
fsStr entityLocalisedNameGet() const
Definition gfIPickListEntryGui.cpp:80
@ eSTATE_WAITING_FOR_COLLECTION
Definition gfIPickListEntryGui.h:50
@ eSTATE_COLLECTION_COMPLETE
Definition gfIPickListEntryGui.h:52
@ eSTATE_COLLECTED_TRANSITION_OFF
Definition gfIPickListEntryGui.h:51
@ eSTATE_TRANSITION_ON
Definition gfIPickListEntryGui.h:49
@ eSTATE_INACTIVE
Definition gfIPickListEntryGui.h:48
void updateDo(fsS32 pDeltaMs) override
Definition gfIPickListEntryGui.cpp:146
virtual ~gfIPickListEntryGui()
Definition gfIPickListEntryGui.cpp:196
const std::vector< fsCEntity * > & myEntitiesGet() const
Definition gfIPickListEntryGui.h:44
fsBool entityNameMatchGet(const fsStr &pMatch) const
Definition gfIPickListEntryGui.cpp:75
fsBool collectionCompleteGetAndReset()
Definition gfIPickListEntryGui.cpp:125
void deactivate()
Definition gfIPickListEntryGui.cpp:96
void stateSet(fsS32)
Definition gfIPickListEntryGui.cpp:20
gfIPickListEntryGui(fsCEntity *pParent)
Definition gfIPickListEntryGui.cpp:189
fsS32 stateGet() const
Definition gfIPickListEntryGui.cpp:25
bool fsBool
Definition fsBaseTypes.h:26
int fsS32
Definition fsBaseTypes.h:20
Definition fsIMessageDispatcher.h:32