Merge with -r 22620:23107.
[blender.git] / source / gameengine / GamePlayer / ghost / GPG_Application.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  * GHOST Blender Player application declaration file.
29  */
30
31 #include "GHOST_IEventConsumer.h"
32 #include "STR_String.h"
33
34 #ifdef WIN32
35 #include <wtypes.h>
36 #endif
37
38 class KX_KetsjiEngine;
39 class KX_ISceneConverter;
40 class NG_LoopBackNetworkDeviceInterface;
41 class RAS_IRasterizer;
42 class GHOST_IEvent;
43 class GHOST_ISystem;
44 class GHOST_ITimerTask;
45 class GHOST_IWindow;
46 class GPC_MouseDevice;
47 class GPC_RenderTools;
48 class GPG_Canvas;
49 class GPG_KeyboardDevice;
50 class GPG_System;
51 struct Main;
52 struct Scene;
53
54 class GPG_Application : public GHOST_IEventConsumer
55 {
56 public:
57         GPG_Application(GHOST_ISystem* system);
58         ~GPG_Application(void);
59
60                         bool SetGameEngineData(struct Main* maggie, struct Scene* scene, int argc, char** argv);
61                         bool startWindow(STR_String& title, int windowLeft, int windowTop, int windowWidth, int windowHeight,
62                         const bool stereoVisual, const int stereoMode);
63                         bool startFullScreen(int width, int height, int bpp, int frequency, const bool stereoVisual, const int stereoMode);
64                         bool startEmbeddedWindow(STR_String& title, const GHOST_TEmbedderWindowID parent_window, const bool stereoVisual, const int stereoMode);
65 #ifdef WIN32
66                         bool startScreenSaverFullScreen(int width, int height, int bpp, int frequency, const bool stereoVisual, const int stereoMode);
67                         bool startScreenSaverPreview(HWND parentWindow, const bool stereoVisual, const int stereoMode);
68 #endif
69
70         virtual bool processEvent(GHOST_IEvent* event);
71                         int getExitRequested(void);
72                         const STR_String& getExitString(void);
73                         bool StartGameEngine(int stereoMode);
74                         void StopGameEngine();
75
76 protected:
77         bool    handleWheel(GHOST_IEvent* event);
78         bool    handleButton(GHOST_IEvent* event, bool isDown);
79         bool    handleCursorMove(GHOST_IEvent* event);
80         bool    handleKey(GHOST_IEvent* event, bool isDown);
81
82         /**
83          * Initializes the game engine.
84          */
85         bool initEngine(GHOST_IWindow* window, int stereoMode);
86
87         /**
88          * Starts the game engine.
89          */
90         bool startEngine(void);
91
92         /**
93          * Stop the game engine.
94          */
95         void stopEngine(void);
96
97         /**
98          * Shuts the game engine down.
99          */
100         void exitEngine(void);
101
102         /* The game data */
103         STR_String                              m_startSceneName;
104         struct Scene*                   m_startScene;
105         struct Main*                    m_maggie;
106
107         /* Exit state. */
108         int                                             m_exitRequested;
109         STR_String                              m_exitString;
110         /* GHOST system abstraction. */
111         GHOST_ISystem*                  m_system;
112         /* Main window. */
113         GHOST_IWindow*                  m_mainWindow;
114         /* Timer to advance frames. */
115         GHOST_ITimerTask*               m_frameTimer;
116         /* The cursor shape displayed. */
117         GHOST_TStandardCursor   m_cursor;
118
119         /** Engine construction state. */
120         bool m_engineInitialized;
121         /** Engine state. */
122         bool m_engineRunning;
123         /** Running on embedded window */
124         bool m_isEmbedded;
125
126         /** the gameengine itself */
127         KX_KetsjiEngine* m_ketsjiengine;
128         /** The game engine's system abstraction. */
129         GPG_System* m_kxsystem;
130         /** The game engine's keyboard abstraction. */
131         GPG_KeyboardDevice* m_keyboard;
132         /** The game engine's mouse abstraction. */
133         GPC_MouseDevice* m_mouse;
134         /** The game engine's canvas abstraction. */
135         GPG_Canvas* m_canvas;
136         /** The game engine's platform dependent render tools. */
137         GPC_RenderTools* m_rendertools;
138         /** the rasterizer */
139         RAS_IRasterizer* m_rasterizer;
140         /** Converts Blender data files. */
141         KX_ISceneConverter* m_sceneconverter;
142         /** Network interface. */
143         NG_LoopBackNetworkDeviceInterface* m_networkdevice;
144
145         bool m_blendermat;
146         bool m_blenderglslmat;
147         
148         /*
149          * GameLogic.globalDict as a string so that loading new blend files can use the same dict.
150          * Do this because python starts/stops when loading blend files.
151          */
152         char* m_pyGlobalDictString;
153         int m_pyGlobalDictString_Length;
154         
155         /* argc and argv need to be passed on to python */
156         int             m_argc;
157         char**  m_argv;
158 };
159