cc9b9198db7851363ab831b69919b4a345bc5c9d
[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 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
132         bool m_stereo;
133         int m_curreye;
134
135         /** Categories for profiling display. */
136         typedef enum
137         {
138                 tc_first = 0,
139                 tc_physics = 0,
140                 tc_logic,
141                 tc_network,
142                 tc_scenegraph,
143                 tc_sound,
144                 tc_rasterizer,
145                 tc_services,    // time spend in miscelaneous activities
146                 tc_overhead,    // profile info drawing overhead
147                 tc_outside,             // time spend outside main loop
148                 tc_numCategories
149         } KX_TimeCategory;
150
151         /** Time logger. */
152         KX_TimeCategoryLogger*  m_logger;
153         
154         /** Labels for profiling display. */
155         static const char               m_profileLabels[tc_numCategories][15];
156         /** Last estimated framerate */
157         static double                   m_average_framerate;
158         /** Show the framerate on the game display? */
159         bool                                    m_show_framerate;
160         /** Show profiling info on the game display? */
161         bool                                    m_show_profile;
162         /** Show any debug (scene) object properties on the game display? */
163         bool                                    m_showProperties;
164         /** Show background behind text for readability? */
165         bool                                    m_showBackground;
166
167         bool                                    m_show_debug_properties;
168
169         /** record physics into keyframes */
170         bool                                    m_game2ipo;
171
172         /** Hide cursor every frame? */
173         bool                                    m_hideCursor;
174
175         /** Override framing bars color? */
176         bool                                    m_overrideFrameColor;
177         /** Red component of framing bar color. */
178         float                                   m_overrideFrameColorR;
179         /** Green component of framing bar color. */
180         float                                   m_overrideFrameColorG;
181         /** Blue component of framing bar color. */
182         float                                   m_overrideFrameColorB;
183
184         void                                    RenderFrame(KX_Scene* scene, KX_Camera* cam);
185         void                                    PostRenderFrame();
186         void                                    RenderDebugProperties();
187         void                                    RenderShadowBuffers(KX_Scene *scene);
188         void                                    SetBackGround(KX_WorldInfo* worldinfo);
189         void                                    DoSound(KX_Scene* scene);
190
191 public:
192
193         KX_KetsjiEngine(class KX_ISystem* system);
194         virtual ~KX_KetsjiEngine();
195
196         // set the devices and stuff. the client must take care of creating these
197         void                    SetWorldSettings(KX_WorldInfo* worldinfo);
198         void                    SetKeyboardDevice(SCA_IInputDevice* keyboarddevice);
199         void                    SetMouseDevice(SCA_IInputDevice* mousedevice);
200         void                    SetNetworkDevice(NG_NetworkDeviceInterface* networkdevice);
201         void                    SetAudioDevice(SND_IAudioDevice* audiodevice);
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         
256         /**
257          * Sets display of all frames.
258          * @param bUseFixedTime New setting for display all frames.
259          */ 
260         void SetUseFixedTime(bool bUseFixedTime);
261
262         /**
263          * Returns display of all frames.
264          * @return Current setting for display all frames.
265          */ 
266         bool GetUseFixedTime(void) const;
267
268         /**
269          * Returns current render frame clock time
270          */
271         double GetClockTime(void) const;
272
273         /**
274          * Returns the difference between the local time of the scene (when it
275          * was running and not suspended) and the "curtime"
276          */
277         static double GetSuspendedDelta();
278
279         /**
280          * Gets the number of logic updates per second.
281          */
282         static double GetTicRate();
283         /**
284          * Sets the number of logic updates per second.
285          */
286         static void SetTicRate(double ticrate);
287         /**
288          * Gets the maximum number of logic frame before render frame
289          */
290         static int GetMaxLogicFrame();
291         /**
292          * Sets the maximum number of logic frame before render frame
293          */
294         static void SetMaxLogicFrame(int frame);
295
296         /**
297          * Gets the framerate for playing animations. (actions and ipos)
298          */
299         static double GetAnimFrameRate();
300         /**
301          * Sets the framerate for playing animations. (actions and ipos)
302          */
303         static void SetAnimFrameRate(double framerate);
304
305         /**
306          * Gets the last estimated average framerate
307          */
308         static double GetAverageFrameRate();
309
310         /**
311          * Activates or deactivates timing information display.
312          * @param frameRate             Display for frame rate on or off.
313          * @param profile               Display for individual components on or off.
314          * @param properties    Display of scene object debug properties on or off.
315          */ 
316         void SetTimingDisplay(bool frameRate, bool profile, bool properties);
317
318         /**
319          * Returns status of timing information display.
320          * @param frameRate             Display for frame rate on or off.
321          * @param profile               Display for individual components on or off.
322          * @param properties    Display of scene object debug properties on or off.
323          */ 
324         void GetTimingDisplay(bool& frameRate, bool& profile, bool& properties) const;
325
326         /** 
327          * Sets cursor hiding on every frame.
328          * @param hideCursor Turns hiding on or off.
329          */
330         void SetHideCursor(bool hideCursor);
331
332         /** 
333          * Returns the current setting for cursor hiding.
334          * @return The current setting for cursor hiding.
335          */
336         bool GetHideCursor(void) const;
337
338         /** 
339          * Enables/disables the use of the framing bar color of the Blender file's scenes.
340          * @param overrideFrameColor The new setting.
341          */
342         void SetUseOverrideFrameColor(bool overrideFrameColor);
343
344         /** 
345          * Enables/disables the use of the framing bar color of the Blender file's scenes.
346          * @param useSceneFrameColor The new setting.
347          */
348         bool GetUseOverrideFrameColor(void) const; 
349
350         /** 
351          * Set the color used for framing bar color instead of the one in the Blender file's scenes.
352          * @param r Red component of the override color.
353          * @param g Green component of the override color.
354          * @param b Blue component of the override color.
355          */
356         void SetOverrideFrameColor(float r, float g, float b);
357
358         /** 
359          * Returns the color used for framing bar color instead of the one in the Blender file's scenes.
360          * @param r Red component of the override color.
361          * @param g Green component of the override color.
362          * @param b Blue component of the override color.
363          */
364         void GetOverrideFrameColor(float& r, float& g, float& b) const;
365         
366 protected:
367         /**
368          * Processes all scheduled scene activity.
369          * At the end, if the scene lists have changed,
370          * SceneListsChanged(void) is called.
371          * @see SceneListsChanged(void).
372          */
373         void                    ProcessScheduledScenes(void);
374
375         /**
376          * This method is invoked when the scene lists have changed.
377          */
378         void                    SceneListsChanged(void);
379
380         void                    RemoveScheduledScenes(void);
381         void                    AddScheduledScenes(void);
382         void                    ReplaceScheduledScenes(void);
383         void                    PostProcessScene(class KX_Scene* scene);
384         KX_Scene*               CreateScene(const STR_String& scenename);
385         
386         bool                    BeginFrame();
387         void                    ClearFrame();
388         void                    EndFrame();
389 };
390
391 #endif //__KX_KETSJI_ENGINE
392
393