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