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