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