2.5: Sound branch merge!
[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         PyObject*                                       m_pythondictionary;
74         class SCA_IInputDevice*                         m_keyboarddevice;
75         class SCA_IInputDevice*                         m_mousedevice;
76         class KX_Dome*                                          m_dome; // dome stereo mode
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 int                              m_maxLogicFrame;        /* maximum number of consecutive logic frame */
106         static int                              m_maxPhysicsFrame;      /* maximum number of consecutive physics frame */
107         static double                   m_ticrate;
108         static double                   m_anim_framerate; /* for animation playback only - ipo and action */
109
110         static double                   m_suspendedtime;
111         static double                   m_suspendeddelta;
112
113         int                                     m_exitcode;
114         STR_String                      m_exitstring;
115                 /**
116                  * Some drawing parameters, the drawing mode
117                  * (wire/flat/texture), and the camera zoom
118                  * factor.
119                  */
120         int                             m_drawingmode;
121         float                   m_cameraZoom;
122         
123         bool                    m_overrideCam;  
124         STR_String              m_overrideSceneName;
125         
126         bool                    m_overrideCamUseOrtho;
127         MT_CmMatrix4x4  m_overrideCamProjMat;
128         MT_CmMatrix4x4  m_overrideCamViewMat;
129         float                   m_overrideCamNear;
130         float                   m_overrideCamFar;
131         float                   m_overrideCamLens;
132
133         bool m_stereo;
134         int m_curreye;
135
136         /** Categories for profiling display. */
137         typedef enum
138         {
139                 tc_first = 0,
140                 tc_physics = 0,
141                 tc_logic,
142                 tc_network,
143                 tc_scenegraph,
144                 tc_sound,
145                 tc_rasterizer,
146                 tc_services,    // time spend in miscelaneous activities
147                 tc_overhead,    // profile info drawing overhead
148                 tc_outside,             // time spend outside main loop
149                 tc_numCategories
150         } KX_TimeCategory;
151
152         /** Time logger. */
153         KX_TimeCategoryLogger*  m_logger;
154         
155         /** Labels for profiling display. */
156         static const char               m_profileLabels[tc_numCategories][15];
157         /** Last estimated framerate */
158         static double                   m_average_framerate;
159         /** Show the framerate on the game display? */
160         bool                                    m_show_framerate;
161         /** Show profiling info on the game display? */
162         bool                                    m_show_profile;
163         /** Show any debug (scene) object properties on the game display? */
164         bool                                    m_showProperties;
165         /** Show background behind text for readability? */
166         bool                                    m_showBackground;
167
168         bool                                    m_show_debug_properties;
169
170         /** record physics into keyframes */
171         bool                                    m_game2ipo;
172
173         /** Hide cursor every frame? */
174         bool                                    m_hideCursor;
175
176         /** Override framing bars color? */
177         bool                                    m_overrideFrameColor;
178         /** Red component of framing bar color. */
179         float                                   m_overrideFrameColorR;
180         /** Green component of framing bar color. */
181         float                                   m_overrideFrameColorG;
182         /** Blue component of framing bar color. */
183         float                                   m_overrideFrameColorB;
184
185         void                                    RenderFrame(KX_Scene* scene, KX_Camera* cam);
186         void                                    PostRenderFrame();
187         void                                    RenderDebugProperties();
188         void                                    RenderShadowBuffers(KX_Scene *scene);
189         void                                    SetBackGround(KX_WorldInfo* worldinfo);
190         void                                    DoSound(KX_Scene* scene);
191
192 public:
193
194         KX_KetsjiEngine(class KX_ISystem* system);
195         virtual ~KX_KetsjiEngine();
196
197         // set the devices and stuff. the client must take care of creating these
198         void                    SetWorldSettings(KX_WorldInfo* worldinfo);
199         void                    SetKeyboardDevice(SCA_IInputDevice* keyboarddevice);
200         void                    SetMouseDevice(SCA_IInputDevice* mousedevice);
201         void                    SetNetworkDevice(NG_NetworkDeviceInterface* networkdevice);
202         void                    SetCanvas(RAS_ICanvas* canvas);
203         void                    SetRenderTools(RAS_IRenderTools* rendertools);
204         void                    SetRasterizer(RAS_IRasterizer* rasterizer);
205         void                    SetPythonDictionary(PyObject* pythondictionary);
206         void                    SetSceneConverter(KX_ISceneConverter* sceneconverter);
207         void                    SetGame2IpoMode(bool game2ipo,int startFrame);
208
209         RAS_IRasterizer*                GetRasterizer(){return m_rasterizer;};
210         RAS_ICanvas*                GetCanvas(){return m_canvas;};
211         RAS_IRenderTools*           GetRenderTools(){return m_rendertools;};
212
213         /// Dome functions
214         void                    InitDome(short res, short mode, short angle, float resbuf, short tilt, struct Text* text); 
215         void                    EndDome();
216         void                    RenderDome();
217         bool                    m_usedome;
218
219         ///returns true if an update happened to indicate -> Render
220         bool                    NextFrame();
221         void                    Render();
222         
223         void                    StartEngine(bool clearIpo);
224         void                    StopEngine();
225         void                    Export(const STR_String& filename);
226
227         void                    RequestExit(int exitrequestmode);
228         void                    SetNameNextGame(const STR_String& nextgame);
229         int                             GetExitCode();
230         const STR_String&       GetExitString();
231
232         KX_SceneList*   CurrentScenes();
233         KX_Scene*       FindScene(const STR_String& scenename);
234         void                    AddScene(class KX_Scene* scene);
235         void                    ConvertAndAddScene(const STR_String& scenename,bool overlay);
236
237         void                    RemoveScene(const STR_String& scenename);
238         void                    ReplaceScene(const STR_String& oldscene,const STR_String& newscene);
239         void                    SuspendScene(const STR_String& scenename);
240         void                    ResumeScene(const STR_String& scenename);
241
242         void                    GetSceneViewport(KX_Scene* scene, KX_Camera* cam, RAS_Rect& area, RAS_Rect& viewport);
243
244         void SetDrawType(int drawingtype);
245         int  GetDrawType(){return m_drawingmode;};
246
247         void SetCameraZoom(float camzoom);
248         
249         void EnableCameraOverride(const STR_String& forscene);
250         
251         void SetCameraOverrideUseOrtho(bool useOrtho);
252         void SetCameraOverrideProjectionMatrix(const MT_CmMatrix4x4& mat);
253         void SetCameraOverrideViewMatrix(const MT_CmMatrix4x4& mat);
254         void SetCameraOverrideClipping(float near, float far);
255         void SetCameraOverrideLens(float lens);
256         
257         /**
258          * Sets display of all frames.
259          * @param bUseFixedTime New setting for display all frames.
260          */ 
261         void SetUseFixedTime(bool bUseFixedTime);
262
263         /**
264          * Returns display of all frames.
265          * @return Current setting for display all frames.
266          */ 
267         bool GetUseFixedTime(void) const;
268
269         /**
270          * Returns current render frame clock time
271          */
272         double GetClockTime(void) const;
273
274         double GetRealTime(void) const;
275         /**
276          * Returns the difference between the local time of the scene (when it
277          * was running and not suspended) and the "curtime"
278          */
279         static double GetSuspendedDelta();
280
281         /**
282          * Gets the number of logic updates per second.
283          */
284         static double GetTicRate();
285         /**
286          * Sets the number of logic updates per second.
287          */
288         static void SetTicRate(double ticrate);
289         /**
290          * Gets the maximum number of logic frame before render frame
291          */
292         static int GetMaxLogicFrame();
293         /**
294          * Sets the maximum number of logic frame before render frame
295          */
296         static void SetMaxLogicFrame(int frame);
297         /**
298          * Gets the maximum number of physics frame before render frame
299          */
300         static int GetMaxPhysicsFrame();
301         /**
302          * Sets the maximum number of physics frame before render frame
303          */
304         static void SetMaxPhysicsFrame(int frame);
305
306         /**
307          * Gets the framerate for playing animations. (actions and ipos)
308          */
309         static double GetAnimFrameRate();
310         /**
311          * Sets the framerate for playing animations. (actions and ipos)
312          */
313         static void SetAnimFrameRate(double framerate);
314
315         /**
316          * Gets the last estimated average framerate
317          */
318         static double GetAverageFrameRate();
319
320         /**
321          * Activates or deactivates timing information display.
322          * @param frameRate             Display for frame rate on or off.
323          * @param profile               Display for individual components on or off.
324          * @param properties    Display of scene object debug properties on or off.
325          */ 
326         void SetTimingDisplay(bool frameRate, bool profile, bool properties);
327
328         /**
329          * Returns status of timing information display.
330          * @param frameRate             Display for frame rate on or off.
331          * @param profile               Display for individual components on or off.
332          * @param properties    Display of scene object debug properties on or off.
333          */ 
334         void GetTimingDisplay(bool& frameRate, bool& profile, bool& properties) const;
335
336         /** 
337          * Sets cursor hiding on every frame.
338          * @param hideCursor Turns hiding on or off.
339          */
340         void SetHideCursor(bool hideCursor);
341
342         /** 
343          * Returns the current setting for cursor hiding.
344          * @return The current setting for cursor hiding.
345          */
346         bool GetHideCursor(void) const;
347
348         /** 
349          * Enables/disables the use of the framing bar color of the Blender file's scenes.
350          * @param overrideFrameColor The new setting.
351          */
352         void SetUseOverrideFrameColor(bool overrideFrameColor);
353
354         /** 
355          * Enables/disables the use of the framing bar color of the Blender file's scenes.
356          * @param useSceneFrameColor The new setting.
357          */
358         bool GetUseOverrideFrameColor(void) const; 
359
360         /** 
361          * Set the color used for framing bar color instead of the one in the Blender file's scenes.
362          * @param r Red component of the override color.
363          * @param g Green component of the override color.
364          * @param b Blue component of the override color.
365          */
366         void SetOverrideFrameColor(float r, float g, float b);
367
368         /** 
369          * Returns the color used for framing bar color instead of the one in the Blender file's scenes.
370          * @param r Red component of the override color.
371          * @param g Green component of the override color.
372          * @param b Blue component of the override color.
373          */
374         void GetOverrideFrameColor(float& r, float& g, float& b) const;
375         
376 protected:
377         /**
378          * Processes all scheduled scene activity.
379          * At the end, if the scene lists have changed,
380          * SceneListsChanged(void) is called.
381          * @see SceneListsChanged(void).
382          */
383         void                    ProcessScheduledScenes(void);
384
385         /**
386          * This method is invoked when the scene lists have changed.
387          */
388         void                    SceneListsChanged(void);
389
390         void                    RemoveScheduledScenes(void);
391         void                    AddScheduledScenes(void);
392         void                    ReplaceScheduledScenes(void);
393         void                    PostProcessScene(class KX_Scene* scene);
394         KX_Scene*               CreateScene(const STR_String& scenename);
395         
396         bool                    BeginFrame();
397         void                    ClearFrame();
398         void                    EndFrame();
399 };
400
401 #endif //__KX_KETSJI_ENGINE
402
403