Patch to change license to GPL only, from GSR.
[blender.git] / source / gameengine / Ketsji / KX_KetsjiEngine.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program 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
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
19  *
20  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): none yet.
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  *
29  */
30 #ifndef __KX_KETSJI_ENGINE
31 #define __KX_KETSJI_ENGINE
32
33 #include "MT_CmMatrix4x4.h"
34 #include "MT_Matrix4x4.h"
35 #include "STR_String.h"
36 #include "KX_ISystem.h"
37 #include "KX_Scene.h"
38 #include "KX_Python.h"
39 #include "KX_WorldInfo.h"
40 #include <vector>
41 #include <set>
42
43 class KX_TimeCategoryLogger;
44
45 #define LEFT_EYE  1
46 #define RIGHT_EYE 2
47
48 enum KX_ExitRequestMode
49 {
50         KX_EXIT_REQUEST_NO_REQUEST = 0,
51         KX_EXIT_REQUEST_QUIT_GAME,
52         KX_EXIT_REQUEST_RESTART_GAME,
53         KX_EXIT_REQUEST_START_OTHER_GAME,
54         KX_EXIT_REQUEST_NO_SCENES_LEFT,
55         KX_EXIT_REQUEST_BLENDER_ESC,
56         KX_EXIT_REQUEST_OUTSIDE,
57         KX_EXIT_REQUEST_MAX
58 };
59
60 /**
61  * KX_KetsjiEngine is the core game engine class.
62  */
63 class KX_KetsjiEngine
64 {
65
66 private:
67         class RAS_ICanvas*                              m_canvas; // 2D Canvas (2D Rendering Device Context)
68         class RAS_IRasterizer*                          m_rasterizer;  // 3D Rasterizer (3D Rendering)
69         class KX_ISystem*                               m_kxsystem;
70         class RAS_IRenderTools*                         m_rendertools;
71         class KX_ISceneConverter*                       m_sceneconverter;
72         class NG_NetworkDeviceInterface*                m_networkdevice;
73         class SND_IAudioDevice*                         m_audiodevice;
74         PyObject*                                       m_pythondictionary;
75         class SCA_IInputDevice*                         m_keyboarddevice;
76         class SCA_IInputDevice*                         m_mousedevice;
77
78         /** Lists of scenes scheduled to be removed at the end of the frame. */
79         std::set<STR_String> m_removingScenes;
80         /** Lists of overley scenes scheduled to be added at the end of the frame. */
81         std::set<STR_String> m_addingOverlayScenes;
82         /** Lists of background scenes scheduled to be added at the end of the frame. */
83         std::set<STR_String> m_addingBackgroundScenes;
84         /** Lists of scenes scheduled to be replaced at the end of the frame. */
85         std::set<std::pair<STR_String,STR_String> >     m_replace_scenes;
86
87         /* The current list of scenes. */
88         KX_SceneList            m_scenes;
89         /* State variable recording the presence of object debug info in the current scene list. */
90         bool                            m_propertiesPresent;    
91
92         bool                            m_bInitialized;
93         int                                     m_activecam;
94         bool                            m_bFixedTime;
95         
96         
97         bool                            m_firstframe;
98         int                                     m_currentFrame;
99
100         double                          m_frameTime;//discrete timestamp of the 'game logic frame'
101         double                          m_clockTime;//current time
102         double                          m_previousClockTime;//previous clock time
103         double                          m_remainingTime;
104
105         static double                   m_ticrate;
106
107         static double                   m_suspendedtime;
108         static double                   m_suspendeddelta;
109
110         int                                     m_exitcode;
111         STR_String                      m_exitstring;
112                 /**
113                  * Some drawing parameters, the drawing mode
114                  * (wire/flat/texture), and the camera zoom
115                  * factor.
116                  */
117         int                             m_drawingmode;
118         float                   m_cameraZoom;
119         
120         bool                    m_overrideCam;  
121         STR_String              m_overrideSceneName;
122         
123         bool                    m_overrideCamUseOrtho;
124         MT_CmMatrix4x4  m_overrideCamProjMat;
125         MT_CmMatrix4x4  m_overrideCamViewMat;
126
127         bool m_stereo;
128         int m_curreye;
129
130         /** Categories for profiling display. */
131         typedef enum
132         {
133                 tc_first = 0,
134                 tc_physics = 0,
135                 tc_logic,
136                 tc_network,
137                 tc_scenegraph,
138                 tc_sound,
139                 tc_rasterizer,
140                 tc_services,    // time spend in miscelaneous activities
141                 tc_overhead,    // profile info drawing overhead
142                 tc_outside,             // time spend outside main loop
143                 tc_numCategories
144         } KX_TimeCategory;
145
146         /** Time logger. */
147         KX_TimeCategoryLogger*  m_logger;
148         
149         /** Labels for profiling display. */
150         static const char               m_profileLabels[tc_numCategories][15];
151         /** Show the framerate on the game display? */
152         bool                                    m_show_framerate;
153         /** Show profiling info on the game display? */
154         bool                                    m_show_profile;
155         /** Show any debug (scene) object properties on the game display? */
156         bool                                    m_showProperties;
157         /** Show background behind text for readability? */
158         bool                                    m_showBackground;
159
160         bool                                    m_show_debug_properties;
161
162         /** record physics into keyframes */
163         bool                                    m_game2ipo;
164
165         /** Hide cursor every frame? */
166         bool                                    m_hideCursor;
167
168         /** Override framing bars color? */
169         bool                                    m_overrideFrameColor;
170         /** Red component of framing bar color. */
171         float                                   m_overrideFrameColorR;
172         /** Green component of framing bar color. */
173         float                                   m_overrideFrameColorG;
174         /** Blue component of framing bar color. */
175         float                                   m_overrideFrameColorB;
176
177         void                                    SetupRenderFrame(KX_Scene *scene, KX_Camera* cam);
178         void                                    RenderFrame(KX_Scene* scene, KX_Camera* cam);
179         void                                    RenderDebugProperties();
180         void                                    SetBackGround(KX_WorldInfo* worldinfo);
181         void                                    SetWorldSettings(KX_WorldInfo* worldinfo);
182         void                                    DoSound(KX_Scene* scene);
183
184 public:
185
186         KX_KetsjiEngine(class KX_ISystem* system);
187         virtual ~KX_KetsjiEngine();
188
189         // set the devices and stuff. the client must take care of creating these
190         void                    SetKeyboardDevice(SCA_IInputDevice* keyboarddevice);
191         void                    SetMouseDevice(SCA_IInputDevice* mousedevice);
192         void                    SetNetworkDevice(NG_NetworkDeviceInterface* networkdevice);
193         void                    SetAudioDevice(SND_IAudioDevice* audiodevice);
194         void                    SetCanvas(RAS_ICanvas* canvas);
195         void                    SetRenderTools(RAS_IRenderTools* rendertools);
196         void                    SetRasterizer(RAS_IRasterizer* rasterizer);
197         void                    SetPythonDictionary(PyObject* pythondictionary);
198         void                    SetSceneConverter(KX_ISceneConverter* sceneconverter);
199         void                    SetGame2IpoMode(bool game2ipo,int startFrame);
200
201         ///returns true if an update happened to indicate -> Render
202         bool                    NextFrame();
203         void                    Render();
204         
205         void                    StartEngine(bool clearIpo);
206         void                    StopEngine();
207         void                    Export(const STR_String& filename);
208
209         void                    RequestExit(int exitrequestmode);
210         void                    SetNameNextGame(const STR_String& nextgame);
211         int                             GetExitCode();
212         const STR_String&       GetExitString();
213
214         KX_SceneList*   CurrentScenes();
215         KX_Scene*       FindScene(const STR_String& scenename);
216         void                    AddScene(class KX_Scene* scene);
217         void                    ConvertAndAddScene(const STR_String& scenename,bool overlay);
218
219         void                    RemoveScene(const STR_String& scenename);
220         void                    ReplaceScene(const STR_String& oldscene,const STR_String& newscene);
221         void                    SuspendScene(const STR_String& scenename);
222         void                    ResumeScene(const STR_String& scenename);
223
224         void SetDrawType(int drawingtype);
225         void SetCameraZoom(float camzoom);
226         
227         void EnableCameraOverride(const STR_String& forscene);
228         
229         void SetCameraOverrideUseOrtho(bool useOrtho);
230         void SetCameraOverrideProjectionMatrix(const MT_CmMatrix4x4& mat);
231         void SetCameraOverrideViewMatrix(const MT_CmMatrix4x4& mat);
232         
233         /**
234          * Sets display of all frames.
235          * @param bUseFixedTime New setting for display all frames.
236          */ 
237         void SetUseFixedTime(bool bUseFixedTime);
238
239         /**
240          * Returns display of all frames.
241          * @return Current setting for display all frames.
242          */ 
243         bool GetUseFixedTime(void) const;
244
245         /**
246          * Returns the difference between the local time of the scene (when it
247          * was running and not suspended) and the "curtime"
248          */
249         static double GetSuspendedDelta();
250
251         /**
252          * Gets the number of logic updates per second.
253          */
254         static double GetTicRate();
255         /**
256          * Sets the number of logic updates per second.
257          */
258         static void SetTicRate(double ticrate);
259
260         /**
261          * Activates or deactivates timing information display.
262          * @param frameRate             Display for frame rate on or off.
263          * @param profile               Display for individual components on or off.
264          * @param properties    Display of scene object debug properties on or off.
265          */ 
266         void SetTimingDisplay(bool frameRate, bool profile, bool properties);
267
268         /**
269          * Returns status of timing information display.
270          * @param frameRate             Display for frame rate on or off.
271          * @param profile               Display for individual components on or off.
272          * @param properties    Display of scene object debug properties on or off.
273          */ 
274         void GetTimingDisplay(bool& frameRate, bool& profile, bool& properties) const;
275
276         /** 
277          * Sets cursor hiding on every frame.
278          * @param hideCursor Turns hiding on or off.
279          */
280         void SetHideCursor(bool hideCursor);
281
282         /** 
283          * Returns the current setting for cursor hiding.
284          * @return The current setting for cursor hiding.
285          */
286         bool GetHideCursor(void) const;
287
288         /** 
289          * Enables/disables the use of the framing bar color of the Blender file's scenes.
290          * @param overrideFrameColor The new setting.
291          */
292         void SetUseOverrideFrameColor(bool overrideFrameColor);
293
294         /** 
295          * Enables/disables the use of the framing bar color of the Blender file's scenes.
296          * @param useSceneFrameColor The new setting.
297          */
298         bool GetUseOverrideFrameColor(void) const; 
299
300         /** 
301          * Set the color used for framing bar color instead of the one in the Blender file's scenes.
302          * @param r Red component of the override color.
303          * @param g Green component of the override color.
304          * @param b Blue component of the override color.
305          */
306         void SetOverrideFrameColor(float r, float g, float b);
307
308         /** 
309          * Returns the color used for framing bar color instead of the one in the Blender file's scenes.
310          * @param r Red component of the override color.
311          * @param g Green component of the override color.
312          * @param b Blue component of the override color.
313          */
314         void GetOverrideFrameColor(float& r, float& g, float& b) const;
315         
316 protected:
317         /**
318          * Processes all scheduled scene activity.
319          * At the end, if the scene lists have changed,
320          * SceneListsChanged(void) is called.
321          * @see SceneListsChanged(void).
322          */
323         void                    ProcessScheduledScenes(void);
324
325         /**
326          * This method is invoked when the scene lists have changed.
327          */
328         void                    SceneListsChanged(void);
329
330         void                    RemoveScheduledScenes(void);
331         void                    AddScheduledScenes(void);
332         void                    ReplaceScheduledScenes(void);
333         void                    PostProcessScene(class KX_Scene* scene);
334         KX_Scene*               CreateScene(const STR_String& scenename);
335         
336         bool                    BeginFrame();
337         void                    EndFrame();
338 };
339
340 #endif //__KX_KETSJI_ENGINE
341