Initial revision
[blender.git] / source / gameengine / GamePlayer / ghost / GPG_Application.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  * GHOST Blender Player application declaration file.
32  */
33
34 #include "GHOST_IEventConsumer.h"
35
36 #include "STR_String.h"
37
38 class KX_KetsjiEngine;
39 class KX_ISceneConverter;
40 class NG_LoopBackNetworkDeviceInterface;
41 class SND_IAudioDevice;
42 class RAS_IRasterizer;
43 class GHOST_IEvent;
44 class GHOST_ISystem;
45 class GHOST_ITimerTask;
46 class GHOST_IWindow;
47 class GPC_MouseDevice;
48 class GPC_RenderTools;
49 class GPG_Canvas;
50 class GPG_KeyboardDevice;
51 class GPG_System;
52 struct Main;
53
54 class GPG_Application : public GHOST_IEventConsumer
55 {
56 public:
57         GPG_Application(GHOST_ISystem* system, struct Main *maggie, STR_String startSceneName);
58         ~GPG_Application(void);
59
60                         bool SetGameEngineData(struct Main *maggie, STR_String startSceneName);
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         virtual bool processEvent(GHOST_IEvent* event);
65                         int getExitRequested(void);
66                         const STR_String& getExitString(void);
67                         bool StartGameEngine(int stereoMode);
68                         void StopGameEngine();
69
70 protected:
71         bool    handleButton(GHOST_IEvent* event, bool isDown);
72         bool    handleCursorMove(GHOST_IEvent* event);
73         bool    handleKey(GHOST_IEvent* event, bool isDown);
74
75         /**
76          * Initializes the game engine.
77          */
78         bool initEngine(GHOST_IWindow* window, int stereoMode);
79
80         /**
81          * Starts the game engine.
82          */
83         bool startEngine(void);
84
85         /**
86          * Stop the game engine.
87          */
88         void stopEngine(void);
89
90         /**
91          * Shuts the game engine down.
92          */
93         void exitEngine(void);
94
95         /* The game data */
96         STR_String                              m_startSceneName;
97         struct Main*                    m_maggie;
98
99         /* Exit state. */
100         int                                             m_exitRequested;
101         STR_String                              m_exitString;
102         /* GHOST system abstraction. */
103         GHOST_ISystem*                  m_system;
104         /* Main window. */
105         GHOST_IWindow*                  m_mainWindow;
106         /* Timer to advance frames. */
107         GHOST_ITimerTask*               m_frameTimer;
108         /* The cursor shape displayed. */
109         GHOST_TStandardCursor   m_cursor;
110
111         /** Engine construction state. */
112         bool m_engineInitialized;
113         /** Engine state. */
114         bool m_engineRunning;
115
116         /** the gameengine itself */
117         KX_KetsjiEngine* m_ketsjiengine;
118         /** The game engine's system abstraction. */
119         GPG_System* m_kxsystem;
120         /** The game engine's keyboard abstraction. */
121         GPG_KeyboardDevice* m_keyboard;
122         /** The game engine's mouse abstraction. */
123         GPC_MouseDevice* m_mouse;
124         /** The game engine's canvas abstraction. */
125         GPG_Canvas* m_canvas;
126         /** The game engine's platform dependent render tools. */
127         GPC_RenderTools* m_rendertools;
128         /** the rasterizer */
129         RAS_IRasterizer* m_rasterizer;
130         /** Converts Blender data files. */
131         KX_ISceneConverter* m_sceneconverter;
132         /** Network interface. */
133         NG_LoopBackNetworkDeviceInterface* m_networkdevice;
134         /** Sound device. */
135         SND_IAudioDevice* m_audiodevice;
136 };
137
138