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