FIFE  2008.0
 All Classes Namespaces Functions Variables Enumerations Enumerator Pages
engine.h
1 /***************************************************************************
2  * Copyright (C) 2005-2008 by the FIFE team *
3  * http://www.fifengine.de *
4  * This file is part of FIFE. *
5  * *
6  * FIFE is free software; you can redistribute it and/or *
7  * modify it under the terms of the GNU Lesser General Public *
8  * License as published by the Free Software Foundation; either *
9  * version 2.1 of the License, or (at your option) any later version. *
10  * *
11  * This library is distributed in the hope that it will be useful, *
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of *
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
14  * Lesser General Public License for more details. *
15  * *
16  * You should have received a copy of the GNU Lesser General Public *
17  * License along with this library; if not, write to the *
18  * Free Software Foundation, Inc., *
19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA *
20  ***************************************************************************/
21 
22 #ifndef FIFE_ENGINE_H
23 #define FIFE_ENGINE_H
24 
25 // Standard C++ library includes
26 #include <map>
27 #include <string>
28 #include <vector>
29 
30 // Platform specific includes
31 #ifdef USE_COCOA
32 #include <objc/runtime.h>
33 #endif
34 
35 // 3rd party library includes
36 #include <SDL.h>
37 
38 // FIFE includes
39 // These includes are split up in two parts, separated by one empty line
40 // First block: files included from the FIFE root src directory
41 // Second block: files included from the same folder
42 #include "enginesettings.h"
43 #include "video/devicecaps.h"
44 
45 namespace FIFE {
46 
47  class SoundManager;
48  class RenderBackend;
49  class IGUIManager;
50  class VFS;
51  class VFSSourceFactory;
52  class EventManager;
53  class TimeManager;
54  class Model;
55  class LogManager;
56  class Cursor;
57  class RendererBase;
58  class Image;
59  class ImageManager;
60  class SoundClipManager;
61  class OffRenderer;
62  class TargetRenderer;
63 
64  class IEngineChangeListener {
65  public:
66  virtual ~IEngineChangeListener() {}
67 
70  virtual void onScreenModeChanged(const ScreenMode& newmode) = 0;
71  };
72 
79  class Engine {
80  public:
83  Engine();
84 
87  virtual ~Engine();
88 
92 
95  const DeviceCaps& getDeviceCaps() const;
96 
104  void changeScreenMode(const ScreenMode& mode);
105 
108  void init();
109 
112  void destroy();
113 
117  void initializePumping();
118 
123  void finalizePumping();
124 
127  void pump();
128 
131  SoundManager* getSoundManager() const { return m_soundmanager; }
132 
135  EventManager* getEventManager() const { return m_eventmanager; }
136 
139  TimeManager* getTimeManager() const { return m_timemanager; }
140 
141 
145  void setGuiManager(IGUIManager* guimanager) { m_guimanager = guimanager; }
146 
149  IGUIManager* getGuiManager() const { return m_guimanager; }
150 
153  ImageManager* getImageManager() const { return m_imagemanager; }
154 
157  SoundClipManager* getSoundClipManager() const { return m_soundclipmanager; }
158 
161  RenderBackend* getRenderBackend() const { return m_renderbackend; }
162 
165  Model* getModel() const { return m_model; }
166 
169  LogManager* getLogManager() const { return m_logmanager; }
170 
173  VFS* getVFS() const { return m_vfs; }
174 
177  Cursor* getCursor() const { return m_cursor; }
178 
181  OffRenderer* getOffRenderer() const { return m_offrenderer; }
182 
185  TargetRenderer* getTargetRenderer() const { return m_targetrenderer; }
186 
190  void addChangeListener(IEngineChangeListener* listener);
191 
195  void removeChangeListener(IEngineChangeListener* listener);
196 
197  private:
198  RenderBackend* m_renderbackend;
199  IGUIManager* m_guimanager;
200  EventManager* m_eventmanager;
201  SoundManager* m_soundmanager;
202  TimeManager* m_timemanager;
203  ImageManager* m_imagemanager;
204  SoundClipManager* m_soundclipmanager;
205 
206  VFS* m_vfs;
207  Model* m_model;
208  LogManager* m_logmanager;
209 
210  Cursor* m_cursor;
211  bool m_destroyed;
212 
213  EngineSettings m_settings;
214  DeviceCaps m_devcaps;
215 
216  ScreenMode m_screenMode;
217 
218  OffRenderer* m_offrenderer;
219  TargetRenderer* m_targetrenderer;
220  std::vector<RendererBase*> m_renderers;
221 
222  std::vector<IEngineChangeListener*> m_changelisteners;
223 
224 #ifdef USE_COCOA
225  objc_object *m_autoreleasePool;
226 #endif
227 
228  };
229 
230 }//FIFE
231 
232 #endif