Undo revision 23130 which was a merge with 2.5, a messy one because I did something...
[blender.git] / source / gameengine / GamePlayer / common / GPC_Engine.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 __GPC_ENGINE_H
31 #define __GPC_ENGINE_H
32
33 #include "GPC_Canvas.h"
34 #include "GPC_System.h"
35
36 class GPC_KeyboardDevice;
37 class GPC_MouseDevice;
38
39 class RAS_IRenderTools;
40 class KetsjiPortal;
41 class KX_ISceneConverter;
42 class NG_LoopBackNetworkDeviceInterface;
43 class SND_IAudioDevice;
44 class GPC_RawImage;
45
46
47 class GPC_Engine
48 {
49 //protected:
50 public:
51         /** Engine construction state. */
52         bool m_initialized;
53         /** Engine state. */
54         bool m_running;
55         /** loading state, ie a file is requested and is being loaded. Different
56          *  from initialized and/or running */
57         bool m_loading;
58
59         bool m_customLoadingAnimation;
60
61         /** Last file download progress measurement. */
62         float m_previousProgress;
63
64         /** The game engine's system abstraction. */
65         GPC_System* m_system;
66         /** The game engine's keyboard abstraction. */
67         GPC_KeyboardDevice* m_keyboarddev;
68         /** The game engine's mouse abstraction. */
69         GPC_MouseDevice* m_mousedev;
70         /** The game engine's canvas abstraction. */
71         GPC_Canvas* m_canvas;
72         /** The game engine's platform dependent render tools. */
73         RAS_IRenderTools* m_rendertools;
74         /** The portal used to start the engine. */
75         KetsjiPortal* m_portal;
76         /** Converts Blender data files. */
77         KX_ISceneConverter* m_sceneconverter;
78         /** Network interface. */
79         NG_LoopBackNetworkDeviceInterface* m_networkdev;
80         /** Audiodevice interface */
81         SND_IAudioDevice* m_audiodevice;
82         
83         struct ScrArea *m_curarea;  // for future use, not used yet
84
85         char *m_customLoadingAnimationURL;
86         int m_foregroundColor;
87         int m_backgroundColor;
88         int m_frameRate;
89
90         GPC_RawImage *m_BlenderLogo;
91         GPC_Canvas::TBannerId m_BlenderLogoId;
92         GPC_RawImage *m_Blender3DLogo;
93         GPC_Canvas::TBannerId m_Blender3DLogoId;
94 #if 0
95         GPC_RawImage *m_NaNLogo;
96         GPC_Canvas::TBannerId m_NaNLogoId;
97 #endif
98
99 public:
100         GPC_Engine(char *customLoadingAnimation,
101                         int foregroundColor, int backgroundColor, int frameRate);
102         virtual ~GPC_Engine();
103         // Initialize() functions are not put here since they have
104         // different prototypes for Unix and Windows
105         void StartLoadingAnimation();
106         bool Start(char *filename);  // file-on-disk starter
107         bool Start(unsigned char *blenderDataBuffer,
108                         unsigned int blenderDataBufferSize);  // file-in-memory starter
109
110         void Stop();
111         virtual void Exit();
112
113         bool Initialized(void) {return m_initialized;}
114         bool Loading(void) {return m_loading;}
115         bool Running(void) const {return m_running;}
116
117         virtual float DetermineProgress(void);  // will be platform dependant
118         void UpdateLoadingAnimation(void);
119
120 private:
121         bool StartKetsji(void);
122
123 };
124
125 #endif  // __GPC_ENGINE_H
126