1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
|
/***********************************************************************
created: 24/9/2004
author: Paul D Turner
*************************************************************************/
/***************************************************************************
* Copyright (C) 2004 - 2006 Paul D Turner & The CEGUI Development Team
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
* IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
* OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
* ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
* OTHER DEALINGS IN THE SOFTWARE.
***************************************************************************/
#ifndef _SamplesFrameworkBase_h_
#define _SamplesFrameworkBase_h_
// forward declarations
class CEGuiBaseApplication;
class CEGuiRendererSelector;
#include "CEGUI/InputEvent.h"
#include "CEGUI/Exceptions.h"
/*!
\brief
This is a base class that is intended to be used for all sample applications.
Here we take care of common things such the renderer selection and application
startup.
*/
class SamplesFrameworkBase
{
public:
/*!
\brief
Constructor.
*/
SamplesFrameworkBase();
/*!
\brief
Destructor.
*/
virtual ~SamplesFrameworkBase();
/*!
\brief
Application entry point.
\return
code to be returned by the application.
*/
int run(const CEGUI::String& dataPathPrefixOverride);
/*!
\brief
Initialises the sample system, this includes asking the user for a render to use and
the subsequent creation of the required systems to support that renderer.
\return
false if anything went wrong.
*/
virtual bool initialise(const CEGUI::String& logFile,
const CEGUI::String& dataPathPrefixOverride);
virtual void cleanup();
/*!
\brief
Update function called before rendering
*/
virtual void update(float passedTime) = 0;
/*!
\brief
Update function for window size changes
*/
virtual void handleNewWindowSize(float width, float height) = 0;
void renderSingleFrame(float elapsed);
/*!
\brief
Draw function to draw GUIContexts
*/
virtual void renderGUIContexts() = 0;
/*!
\brief
Function to inject key down to GUIContexts
\return
true if event was handled.
*/
virtual bool injectKeyDown(const CEGUI::Key::Scan& ceguiKey) = 0;
/*!
\brief
Function to inject key up to GUIContexts
\return
true if event was handled.
*/
virtual bool injectKeyUp(const CEGUI::Key::Scan& ceguiKey) = 0;
/*!
\brief
Function to inject characters to GUIContexts
\return
true if event was handled.
*/
virtual bool injectChar(int character) = 0;
/*!
\brief
Function to inject mouse button down to GUIContexts
\return
true if event was handled.
*/
virtual bool injectMouseButtonDown(const CEGUI::MouseButton& ceguiMouseButton) = 0;
/*!
\brief
Function to inject mouse button up to GUIContexts
\return
true if event was handled.
*/
virtual bool injectMouseButtonUp(const CEGUI::MouseButton& ceguiMouseButton) = 0;
/*!
\brief
Function to inject mouse wheel changes to GUIContexts
\return
true if event was handled.
*/
virtual bool injectMouseWheelChange(float position) = 0;
/*!
\brief
Function to inject the mouse position to GUIContexts
\return
true if event was handled.
*/
virtual bool injectMousePosition(float x, float y) = 0;
/*!
\brief
Function to set the bool defining if the application should quit as soon as possible
*/
virtual void setQuitting(bool quit);
/*!
\brief
Function returning if the application should quit as soon as possible
\return
true if should quit.
*/
bool isQuitting();
/*!
\brief
Function setting the application window's size
*/
void setApplicationWindowSize(int width, int height);
/*!
\brief
Output a message to the user in some OS independant way.
*/
void outputExceptionMessage(const char* message);
protected:
/*************************************************************************
Data fields
*************************************************************************/
CEGuiRendererSelector* d_rendererSelector; //!< Points to the renderer selector object.
CEGuiBaseApplication* d_baseApp; //!< Pointer to the base application object.
bool d_quitting; //!< Bool defining if application should quit.
int d_appWindowWidth; //!< Int defining the application window's width.
int d_appWindowHeight; //!< Int defining the application window's height.
};
#endif // end of guard _SamplesFrameworkBase_h_
|
