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