Fission FSN
Loading...
Searching...
No Matches
fsCAppCoreMain.h
Go to the documentation of this file.
1/********************************************************************
2*
3* File: fsCAppCoreMain.h
4*
5* Purpose: Main for an app
6*
7*********************************************************************/
8
9#ifndef fsCAppCoreMainhdr
10#define fsCAppCoreMainhdr
11
12#include <functional>
13#include <memory>
14#include <vector>
15
16#include <fsCore/fsBaseTypes.h>
17#include <fsCore/fsStr.h>
18
20
21class fsINode;
22class fsStr;
23class fsIScene;
24class fsIDisplay;
25class fsCEntity;
28class fsCResourceName;
29class fsCAppSettings;
30class fsIHardware;
33class fsCScreenFade;
34class fsCAppTimer;
36class fsICursor;
37class fsRect;
38struct fsVec2d;
39struct fsPoint;
40
41#if defined fsReview
42 class gfCNagManager;
43#endif
44
45#if defined fsCloudSave
46class fsCCloudSave;
47#endif
48
50{
51public:
52
53#if defined fsScreenTextureEffect
54 fsCRenderTexture* mLevelRenderTarget = nullptr; // not smart pointer due to include cycles?
55 #ifdef fsDEBUG
56 fsBool mTargetClearedThisFrame = false;
57 #endif
58#endif
59
60
61 static const fsStr mRootEntityName;
63#if defined fsScreenTextureEffect
64 void renderTargetResize();
65 void renderTargetShadersCreate(const fsStr& pVertex, const fsStr& pFragment);
66 void renderTargetScreenEffectParamsSet(const fsPoint& pFocusPos, fsF32 pRadius);
67 void renderTargetScreenEffectParamsClear();
68 void renderTargetCaptureRegionSaveRequest(const fsRect& pCaptureRect, const fsPoint& pOutputDimensions, const fsCResourceName& pFilename);
69 void renderTargetCaptureFocusRegionSaveRequest(const fsPoint& pFocusPos, fsF32 pRadius, const fsPoint& pOutputDimensions, const fsCResourceName& pFilename);
70 #if defined fsScreenShot
71 void screenshotRequest(const fsStr& pSceneName);
72 #endif
73#endif
74
75 void setRenderToTexture();
77
78 // Runs once at the start of the next render pass, before the frame is drawn: offscreen work
79 // such as share cards.
80 void preRenderJobAdd(std::function<void()> pJob);
81
82#if defined fsReview
83 gfCNagManager* nagManagerGet() const;
84#endif
85
87 void stateSave();
88
89 void fadeIn();
90 void fadeOut();
91 // Hold the fade-in while a level finishes deferred setup.
92 void fadeInHoldAcquire();
93 void fadeInHoldRelease();
94 // An auto test is driving - fades and waits meant for a watching player shorten.
95 void autoTestSpeedUpSet(fsBool pSet);
96 fsBool autoTestSpeedUpGet() const { return mAutoTestSpeedUp; }
97
102 fsIHardware* hardwareGet() const;
103
104 fsBool update(fsS32 pDeltaMs);
105 void render();
106
107 static fsCAppCoreMain* instanceGet();
108 static void create();
109 static void destroy();
110
112 void timeStepSet(fsF32 pVal);
113
114 fsCEntity* sceneRootGet() const;
115 fsIScene* sceneGet() const;
117 fsIDisplay* displayGet() const;
118 fsCEntity* appOverlayEntityNamed(const fsStr& pName) const;
119
120 void quitTheAppSet(fsBool pQuit);
121
122 void childAddToAppScene(fsINode* pChild);
123 void childAddToAppOverlay(fsINode* pChild);
124 void splashScreenShow();
125 void cursorPosSet(const fsVec2d& pPos);
128
129protected:
130
131 virtual void profileManagerCreateDo();
132
133 void componentFactorySet(std::shared_ptr<fsCComponentFactory>);
134 void entityFactorySet(std::shared_ptr<fsCEntityFactory> pEntityFactory);
135
136 virtual void factoriesCreateDo();
137
139
141
142 virtual void preInitialiseDo() {}
143
144 virtual void initialiseDo() {}
145
146 virtual void postInitialiseDo();
147
148 virtual void preUninitialiseDo() {}
149
150 virtual void uninitialiseDo() {}
151
152 virtual void postUninitialiseDo() {}
153
154 virtual void updateDo(fsS32 pDeltaMs);
155
156 virtual void stateSaveDo() {}
157
159 virtual fsBool launcherRunningDo() { return false; }
160
161 void initialise();
162 void uninitialise();
163
164 void appSceneCreate();
165
166 virtual void debugGuiCreate(){};
167
168 // Delete copy operations
171 // Declare move operations
174
176 virtual ~fsCAppCoreMain();
177
179
180private:
181
183
184 void profileManagerCreate();
185
186 void screenFadeCreate();
187
188 void factoriesCreate();
189
190 void messageDispatchersDestroy();
191 void messageDispatchersCreate();
192
193 void preInitialise();
194 void postInitialise();
195
196 void preUninitialise();
197 void postUninitialise();
198
199 void renderTargetCreate();
200 void renderTargetCaptureRequestExecute();
201
202 fsCScreenFade* mScreenFade; // ptr as added to display and will be cleaned up
203 fsBool mAutoTestSpeedUp;
204
205 fsIDisplay* mAppDisplay;
206 fsIScene* mAppScene;
207 fsIScene* mAppOverlayScene;
208 fsICursor* mCursor;
209
210 fsStr mLocaleStr;
211
212 fsBool mQuitTheApp;
213
214#if defined fsReview
215 std::shared_ptr<gfCNagManager> mNagManager;
216#endif
217
218 std::shared_ptr<fsCEntityFactory> mEntityFactory;
219 std::shared_ptr<fsCComponentFactory> mComponentFactory;
220
221 std::unique_ptr<fsCAppSettings> mAppSettings;
222 std::unique_ptr<fsIHardware> mHardware;
223
224 std::unique_ptr<fsCParticleDataManager> mParticleManager;
225 std::unique_ptr<fsCAnimationDataManager> mAnimationManager;
226
227 std::unique_ptr<fsCAppTimer> mApptimer;
228 std::unique_ptr<fsCLocaleOptions> mLocale;
229 std::unique_ptr<fsSPendingRenderTargetCaptureRequest> mPendingRenderTargetCaptureRequest;
230 std::vector<std::function<void()>> mPreRenderJobs;
231
232#if defined fsCloudSave
233 std::unique_ptr<fsCCloudSave> mCloudSave;
234#endif
235
236};
237
238#endif
Definition fsCAnimationDataManager.h:29
Definition fsCAppCoreMain.h:50
void splashScreenShow()
Definition fsCAppCoreMain.cpp:687
fsCAnimationDataManager * animationManagerGet() const
Definition fsCAppCoreMain.cpp:253
virtual void profileManagerCreateDo()
Definition fsCAppCoreMain.cpp:470
static void destroy()
Definition fsCAppCoreMain.cpp:656
fsCAppCoreMain(fsCAppCoreMain &&)
fsCParticleDataManager * particleDataManagerGet() const
Definition fsCAppCoreMain.cpp:258
fsIScene * appOverlaySceneGet() const
Definition fsCAppCoreMain.cpp:310
void stateSave()
Definition fsCAppCoreMain.cpp:199
void childAddToAppOverlay(fsINode *pChild)
Definition fsCAppCoreMain.cpp:682
void autoTestSpeedUpSet(fsBool pSet)
Definition fsCAppCoreMain.cpp:212
static fsCAppCoreMain * mInstance
Definition fsCAppCoreMain.h:178
void timeStepSet(fsF32 pVal)
Definition fsCAppCoreMain.cpp:320
void fadeOut()
Definition fsCAppCoreMain.cpp:223
fsCLocaleOptions * localeGet()
Definition fsCAppCoreMain.cpp:194
void fadeInHoldAcquire()
Definition fsCAppCoreMain.cpp:228
virtual void postUninitialiseDo()
Definition fsCAppCoreMain.h:152
fsCEntityFactory * entityFactoryGet() const
Definition fsCAppCoreMain.cpp:290
static fsCAppCoreMain * instanceGet()
Definition fsCAppCoreMain.cpp:651
fsCAppCoreMain(const fsCAppCoreMain &)=delete
void fadeIn()
Definition fsCAppCoreMain.cpp:218
fsCAppCoreMain & operator=(fsCAppCoreMain &&)
virtual ~fsCAppCoreMain()
Definition fsCAppCoreMain.cpp:794
fsBool autoTestSpeedUpGet() const
Definition fsCAppCoreMain.h:96
static const fsStr mRootEntityName
Definition fsCAppCoreMain.h:62
fsCEntity * sceneRootGet() const
Definition fsCAppCoreMain.cpp:300
virtual void preInitialiseDo()
Definition fsCAppCoreMain.h:142
void cursorPosSet(const fsVec2d &pPos)
Definition fsCAppCoreMain.cpp:698
fsF32 timeStepGet()
Definition fsCAppCoreMain.cpp:315
fsCComponentFactory * componentFactoryGet() const
Definition fsCAppCoreMain.cpp:279
virtual void updateDo(fsS32 pDeltaMs)
Definition fsCAppCoreMain.cpp:743
virtual void messageDispatchersDestroyDo()
Definition fsCAppCoreMain.h:138
fsCAppSettings * settingsGet() const
Definition fsCAppCoreMain.cpp:268
void fadeInHoldRelease()
Definition fsCAppCoreMain.cpp:233
virtual void stateSaveDo()
Definition fsCAppCoreMain.h:156
virtual void messageDispatchersCreateDo()
Definition fsCAppCoreMain.h:140
fsBool update(fsS32 pDeltaMs)
Definition fsCAppCoreMain.cpp:706
void preRenderJobAdd(std::function< void()> pJob)
Definition fsCAppCoreMain.cpp:747
void uninitialise()
Definition fsCAppCoreMain.cpp:561
virtual fsBool launcherRunningDo()
Definition fsCAppCoreMain.h:159
virtual void factoriesCreateDo()
Definition fsCAppCoreMain.cpp:556
static void create()
Definition fsCAppCoreMain.cpp:639
void setRenderToTexture()
Definition fsCAppCoreMain.cpp:166
fsCAppCoreMain & operator=(const fsCAppCoreMain &)=delete
void appSceneCreate()
Definition fsCAppCoreMain.cpp:495
fsCEntity * appOverlayEntityNamed(const fsStr &pName) const
Definition fsCAppCoreMain.cpp:693
fsS32 appRunningTimeGet() const
Definition fsCAppCoreMain.cpp:241
void childAddToAppScene(fsINode *pChild)
Definition fsCAppCoreMain.cpp:677
fsIScene * sceneGet() const
Definition fsCAppCoreMain.cpp:305
void initialise()
Definition fsCAppCoreMain.cpp:335
virtual void postInitialiseDo()
Definition fsCAppCoreMain.cpp:529
void quitTheAppSet(fsBool pQuit)
Definition fsCAppCoreMain.cpp:672
fsCAppCoreMain()
Definition fsCAppCoreMain.cpp:775
virtual void initialiseDo()
Definition fsCAppCoreMain.h:144
virtual void uninitialiseDo()
Definition fsCAppCoreMain.h:150
virtual void preUninitialiseDo()
Definition fsCAppCoreMain.h:148
fsIDisplay * displayGet() const
Definition fsCAppCoreMain.cpp:295
void entityFactorySet(std::shared_ptr< fsCEntityFactory > pEntityFactory)
Definition fsCAppCoreMain.cpp:284
fsIHardware * hardwareGet() const
Definition fsCAppCoreMain.cpp:263
void componentFactorySet(std::shared_ptr< fsCComponentFactory >)
Definition fsCAppCoreMain.cpp:273
void clearRenderToTexture()
Definition fsCAppCoreMain.cpp:177
fsBool launcherRunning()
Definition fsCAppCoreMain.cpp:326
virtual void debugGuiCreate()
Definition fsCAppCoreMain.h:166
void render()
Definition fsCAppCoreMain.cpp:752
Definition fsCAppSettings.h:22
Definition fsCAppTimer.h:15
Definition fsCComponentFactory.h:26
Definition fsCEntityFactory.h:25
Definition fsCEntity.h:39
Definition fsCLocaleOptions.h:20
Definition fsCParticleDataManager.h:25
Definition fsCRenderTexture.h:24
Definition fsCResourceName.h:32
Definition fsCScreenFade.h:25
Definition fsICursor.h:20
Definition fsIDisplay.h:31
Definition fsIHardware.h:26
Definition fsINode.h:30
Definition fsIScene.h:18
Definition fsRect.h:16
Definition fsStr.h:23
bool fsBool
Definition fsBaseTypes.h:26
int fsS32
Definition fsBaseTypes.h:20
float fsF32
Definition fsBaseTypes.h:28
Definition fsPoint.h:17
Definition fsVec2d.h:16