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
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Crazy Eddies GUI System: CEGUIBase.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.4 -->
<script type="text/javascript">
function hasClass(ele,cls) {
return ele.className.match(new RegExp('(\\s|^)'+cls+'(\\s|$)'));
}
function addClass(ele,cls) {
if (!this.hasClass(ele,cls)) ele.className += " "+cls;
}
function removeClass(ele,cls) {
if (hasClass(ele,cls)) {
var reg = new RegExp('(\\s|^)'+cls+'(\\s|$)');
ele.className=ele.className.replace(reg,' ');
}
}
function toggleVisibility(linkObj) {
var base = linkObj.getAttribute('id');
var summary = document.getElementById(base + '-summary');
var content = document.getElementById(base + '-content');
var trigger = document.getElementById(base + '-trigger');
if ( hasClass(linkObj,'closed') ) {
summary.style.display = 'none';
content.style.display = 'block';
trigger.src = 'open.png';
removeClass(linkObj,'closed');
addClass(linkObj,'opened');
} else if ( hasClass(linkObj,'opened') ) {
summary.style.display = 'block';
content.style.display = 'none';
trigger.src = 'closed.png';
removeClass(linkObj,'opened');
addClass(linkObj,'closed');
}
return false;
}
</script>
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Crazy Eddies GUI System <span id="projectnumber">0.7.6</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
</ul>
</div>
<div class="header">
<div class="headertitle">
<div class="title">CEGUIBase.h</div> </div>
</div>
<div class="contents">
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/***********************************************************************</span>
<a name="l00002"></a>00002 <span class="comment"> filename: CEGUIBase.h</span>
<a name="l00003"></a>00003 <span class="comment"> created: 20/2/2004</span>
<a name="l00004"></a>00004 <span class="comment"> author: Paul D Turner</span>
<a name="l00005"></a>00005 <span class="comment"></span>
<a name="l00006"></a>00006 <span class="comment"> purpose: Base include used within the system</span>
<a name="l00007"></a>00007 <span class="comment"> This contains various lower level bits required</span>
<a name="l00008"></a>00008 <span class="comment"> by other parts of the system. All other library</span>
<a name="l00009"></a>00009 <span class="comment"> headers will include this file.</span>
<a name="l00010"></a>00010 <span class="comment">*************************************************************************/</span>
<a name="l00011"></a>00011 <span class="comment">/***************************************************************************</span>
<a name="l00012"></a>00012 <span class="comment"> * Copyright (C) 2004 - 2006 Paul D Turner & The CEGUI Development Team</span>
<a name="l00013"></a>00013 <span class="comment"> *</span>
<a name="l00014"></a>00014 <span class="comment"> * Permission is hereby granted, free of charge, to any person obtaining</span>
<a name="l00015"></a>00015 <span class="comment"> * a copy of this software and associated documentation files (the</span>
<a name="l00016"></a>00016 <span class="comment"> * "Software"), to deal in the Software without restriction, including</span>
<a name="l00017"></a>00017 <span class="comment"> * without limitation the rights to use, copy, modify, merge, publish,</span>
<a name="l00018"></a>00018 <span class="comment"> * distribute, sublicense, and/or sell copies of the Software, and to</span>
<a name="l00019"></a>00019 <span class="comment"> * permit persons to whom the Software is furnished to do so, subject to</span>
<a name="l00020"></a>00020 <span class="comment"> * the following conditions:</span>
<a name="l00021"></a>00021 <span class="comment"> *</span>
<a name="l00022"></a>00022 <span class="comment"> * The above copyright notice and this permission notice shall be</span>
<a name="l00023"></a>00023 <span class="comment"> * included in all copies or substantial portions of the Software.</span>
<a name="l00024"></a>00024 <span class="comment"> *</span>
<a name="l00025"></a>00025 <span class="comment"> * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,</span>
<a name="l00026"></a>00026 <span class="comment"> * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF</span>
<a name="l00027"></a>00027 <span class="comment"> * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.</span>
<a name="l00028"></a>00028 <span class="comment"> * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR</span>
<a name="l00029"></a>00029 <span class="comment"> * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,</span>
<a name="l00030"></a>00030 <span class="comment"> * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR</span>
<a name="l00031"></a>00031 <span class="comment"> * OTHER DEALINGS IN THE SOFTWARE.</span>
<a name="l00032"></a>00032 <span class="comment"> ***************************************************************************/</span>
<a name="l00033"></a>00033 <span class="preprocessor">#ifndef _CEGUIBase_h_</span>
<a name="l00034"></a>00034 <span class="preprocessor"></span><span class="preprocessor">#define _CEGUIBase_h_</span>
<a name="l00035"></a>00035 <span class="preprocessor"></span>
<a name="l00036"></a>00036 <span class="preprocessor">#include <cassert></span>
<a name="l00037"></a>00037
<a name="l00038"></a>00038 <span class="comment">// bring in configuration options</span>
<a name="l00039"></a>00039 <span class="preprocessor">#include "CEGUIConfig.h"</span>
<a name="l00040"></a>00040
<a name="l00041"></a>00041 <span class="comment">// add CEGUI version defines</span>
<a name="l00042"></a>00042 <span class="preprocessor">#include "CEGUIVersion.h"</span>
<a name="l00043"></a>00043
<a name="l00044"></a>00044 <span class="comment">/*************************************************************************</span>
<a name="l00045"></a>00045 <span class="comment"> Dynamic Library import / export control conditional</span>
<a name="l00046"></a>00046 <span class="comment"> (Define CEGUIBASE_EXPORTS to export symbols, else they are imported)</span>
<a name="l00047"></a>00047 <span class="comment">*************************************************************************/</span>
<a name="l00048"></a>00048 <span class="preprocessor">#if (defined( __WIN32__ ) || defined( _WIN32 )) && !defined(CEGUI_STATIC)</span>
<a name="l00049"></a>00049 <span class="preprocessor"></span><span class="preprocessor"># ifdef CEGUIBASE_EXPORTS</span>
<a name="l00050"></a>00050 <span class="preprocessor"></span><span class="preprocessor"># define CEGUIEXPORT __declspec(dllexport)</span>
<a name="l00051"></a>00051 <span class="preprocessor"></span><span class="preprocessor"># else</span>
<a name="l00052"></a>00052 <span class="preprocessor"></span><span class="preprocessor"># define CEGUIEXPORT __declspec(dllimport)</span>
<a name="l00053"></a>00053 <span class="preprocessor"></span><span class="preprocessor"># endif</span>
<a name="l00054"></a>00054 <span class="preprocessor"></span><span class="preprocessor"># define CEGUIPRIVATE</span>
<a name="l00055"></a>00055 <span class="preprocessor"></span><span class="preprocessor">#else</span>
<a name="l00056"></a>00056 <span class="preprocessor"></span><span class="preprocessor"># define CEGUIEXPORT</span>
<a name="l00057"></a>00057 <span class="preprocessor"></span><span class="preprocessor"># define CEGUIPRIVATE</span>
<a name="l00058"></a>00058 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00059"></a>00059 <span class="preprocessor"></span>
<a name="l00060"></a>00060
<a name="l00061"></a>00061 <span class="comment">// totally kill this warning (debug info truncated to 255 chars etc...) on <= VC6</span>
<a name="l00062"></a>00062 <span class="preprocessor">#if defined(_MSC_VER) && (_MSC_VER <= 1200)</span>
<a name="l00063"></a>00063 <span class="preprocessor"></span><span class="preprocessor"># pragma warning(disable : 4786)</span>
<a name="l00064"></a>00064 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00065"></a>00065 <span class="preprocessor"></span>
<a name="l00066"></a>00066
<a name="l00067"></a>00067 <span class="comment">// Detect macros for min / max and undefine (with a warning where possible)</span>
<a name="l00068"></a>00068 <span class="preprocessor">#if defined(max)</span>
<a name="l00069"></a>00069 <span class="preprocessor"></span><span class="preprocessor"># if defined(_MSC_VER)</span>
<a name="l00070"></a>00070 <span class="preprocessor"></span><span class="preprocessor"># pragma message("Macro definition of max detected - undefining")</span>
<a name="l00071"></a>00071 <span class="preprocessor"></span><span class="preprocessor"># elif defined (__GNUC__)</span>
<a name="l00072"></a>00072 <span class="preprocessor"></span><span class="preprocessor"># warning ("Macro definition of max detected - undefining")</span>
<a name="l00073"></a>00073 <span class="preprocessor"></span><span class="preprocessor"># endif</span>
<a name="l00074"></a>00074 <span class="preprocessor"></span><span class="preprocessor"># undef max</span>
<a name="l00075"></a>00075 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00076"></a>00076 <span class="preprocessor"></span><span class="preprocessor">#if defined(min)</span>
<a name="l00077"></a>00077 <span class="preprocessor"></span><span class="preprocessor"># if defined(_MSC_VER)</span>
<a name="l00078"></a>00078 <span class="preprocessor"></span><span class="preprocessor"># pragma message("Macro definition of min detected - undefining")</span>
<a name="l00079"></a>00079 <span class="preprocessor"></span><span class="preprocessor"># elif defined (__GNUC__)</span>
<a name="l00080"></a>00080 <span class="preprocessor"></span><span class="preprocessor"># warning ("Macro definition of min detected - undefining")</span>
<a name="l00081"></a>00081 <span class="preprocessor"></span><span class="preprocessor"># endif</span>
<a name="l00082"></a>00082 <span class="preprocessor"></span><span class="preprocessor"># undef min</span>
<a name="l00083"></a>00083 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00084"></a>00084 <span class="preprocessor"></span>
<a name="l00085"></a>00085
<a name="l00086"></a>00086 <span class="comment">// include this to see if it defines _STLPORT_VERION</span>
<a name="l00087"></a>00087 <span class="preprocessor"># include <string></span>
<a name="l00088"></a>00088
<a name="l00089"></a>00089 <span class="comment">// fix to undefine _STLP_DEBUG if STLport is not actually being used</span>
<a name="l00090"></a>00090 <span class="comment">// (resolves some unresolved externals concerning boost)</span>
<a name="l00091"></a>00091 <span class="preprocessor">#if defined(_STLP_DEBUG) && defined(_MSC_VER) && (_MSC_VER >= 1200)</span>
<a name="l00092"></a>00092 <span class="preprocessor"></span><span class="preprocessor"># if !defined(_STLPORT_VERSION)</span>
<a name="l00093"></a>00093 <span class="preprocessor"></span><span class="preprocessor"># undef _STLP_DEBUG</span>
<a name="l00094"></a>00094 <span class="preprocessor"></span><span class="preprocessor"># endif</span>
<a name="l00095"></a>00095 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00096"></a>00096 <span class="preprocessor"></span>
<a name="l00097"></a>00097
<a name="l00098"></a>00098 <span class="comment">// The following defines macros used within CEGUI for std::min/std::max</span>
<a name="l00099"></a>00099 <span class="comment">// usage, and is done as a compatibility measure for VC6 with native STL.</span>
<a name="l00100"></a>00100 <span class="preprocessor">#if defined(_MSC_VER) && (_MSC_VER <= 1200) && !defined(_STLPORT_VERSION)</span>
<a name="l00101"></a>00101 <span class="preprocessor"></span><span class="preprocessor"># define ceguimin std::_cpp_min</span>
<a name="l00102"></a>00102 <span class="preprocessor"></span><span class="preprocessor"># define ceguimax std::_cpp_max</span>
<a name="l00103"></a>00103 <span class="preprocessor"></span><span class="preprocessor">#else</span>
<a name="l00104"></a>00104 <span class="preprocessor"></span><span class="preprocessor"># define ceguimin std::min</span>
<a name="l00105"></a>00105 <span class="preprocessor"></span><span class="preprocessor"># define ceguimax std::max</span>
<a name="l00106"></a>00106 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00107"></a>00107 <span class="preprocessor"></span>
<a name="l00108"></a>00108 <span class="comment">// CEGUI's Exception macros</span>
<a name="l00109"></a>00109 <span class="comment">// This provides a mechanism to override how exception handling is used. Note</span>
<a name="l00110"></a>00110 <span class="comment">// that in general this facility _should not be used_. Attempts to use this</span>
<a name="l00111"></a>00111 <span class="comment">// to disable exceptions to 'make things easier' are doomed to failure. CEGUI</span>
<a name="l00112"></a>00112 <span class="comment">// becomes less robust without exceptions (because they are used internally by</span>
<a name="l00113"></a>00113 <span class="comment">// CEGUI). In addition, overriding the exception mechanism will also cause</span>
<a name="l00114"></a>00114 <span class="comment">// memory leaks in various places. This is your only warning about such things,</span>
<a name="l00115"></a>00115 <span class="comment">// if you decide to continue anyway you hereby waive any right to complain :-p</span>
<a name="l00116"></a>00116 <span class="preprocessor">#ifndef CEGUI_TRY</span>
<a name="l00117"></a>00117 <span class="preprocessor"></span><span class="preprocessor"># define CEGUI_TRY try</span>
<a name="l00118"></a>00118 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00119"></a>00119 <span class="preprocessor"></span><span class="preprocessor">#ifndef CEGUI_CATCH</span>
<a name="l00120"></a>00120 <span class="preprocessor"></span><span class="preprocessor"># define CEGUI_CATCH(e) catch (e)</span>
<a name="l00121"></a>00121 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00122"></a>00122 <span class="preprocessor"></span><span class="preprocessor">#ifndef CEGUI_THROW</span>
<a name="l00123"></a>00123 <span class="preprocessor"></span><span class="preprocessor"># define CEGUI_THROW(e) throw e</span>
<a name="l00124"></a>00124 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00125"></a>00125 <span class="preprocessor"></span><span class="preprocessor">#ifndef CEGUI_RETHROW</span>
<a name="l00126"></a>00126 <span class="preprocessor"></span><span class="preprocessor"># define CEGUI_RETHROW throw</span>
<a name="l00127"></a>00127 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00128"></a>00128 <span class="preprocessor"></span>
<a name="l00129"></a>00129 <span class="comment">/*************************************************************************</span>
<a name="l00130"></a>00130 <span class="comment"> Documentation for the CEGUI namespace itself</span>
<a name="l00131"></a>00131 <span class="comment">*************************************************************************/</span>
<a name="l00139"></a>00139 <span class="keyword">namespace </span>CEGUI
<a name="l00140"></a>00140 {
<a name="l00141"></a>00141
<a name="l00142"></a>00142 <span class="comment">/*************************************************************************</span>
<a name="l00143"></a>00143 <span class="comment"> Simplification of some 'unsigned' types</span>
<a name="l00144"></a>00144 <span class="comment">*************************************************************************/</span>
<a name="l00145"></a>00145 <span class="keyword">typedef</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> ulong;
<a name="l00146"></a>00146 <span class="keyword">typedef</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> ushort;
<a name="l00147"></a>00147 <span class="keyword">typedef</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> uint;
<a name="l00148"></a>00148 <span class="keyword">typedef</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> uchar;
<a name="l00149"></a>00149
<a name="l00150"></a>00150 <span class="keyword">typedef</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> uint32;
<a name="l00151"></a>00151 <span class="keyword">typedef</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> uint16;
<a name="l00152"></a>00152 <span class="keyword">typedef</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> uint8;
<a name="l00153"></a>00153
<a name="l00154"></a>00154
<a name="l00155"></a>00155 <span class="comment">/*************************************************************************</span>
<a name="l00156"></a>00156 <span class="comment"> System wide constants</span>
<a name="l00157"></a>00157 <span class="comment">*************************************************************************/</span>
<a name="l00158"></a><a class="code" href="namespaceCEGUI.html#a54cdae5a4e02f35c670c5b9de5e559f0">00158</a> <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">float</span> <a class="code" href="namespaceCEGUI.html#a54cdae5a4e02f35c670c5b9de5e559f0" title="Default native horizontal resolution (for fonts and imagesets)">DefaultNativeHorzRes</a> = 640.0f;
<a name="l00159"></a><a class="code" href="namespaceCEGUI.html#a2cf69a3e820905cc185610a44b0a89dd">00159</a> <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">float</span> <a class="code" href="namespaceCEGUI.html#a2cf69a3e820905cc185610a44b0a89dd" title="Default native vertical resolution (for fonts and imagesets)">DefaultNativeVertRes</a> = 480.0f;
<a name="l00160"></a>00160
<a name="l00161"></a>00161
<a name="l00162"></a>00162 <span class="comment">/*************************************************************************</span>
<a name="l00163"></a>00163 <span class="comment"> Additional typedefs</span>
<a name="l00164"></a>00164 <span class="comment">*************************************************************************/</span>
<a name="l00165"></a><a class="code" href="namespaceCEGUI.html#ac2f7aaf6a0965b83cb35e0b1298c70b9">00165</a> <span class="keyword">typedef</span> std::ostream <a class="code" href="namespaceCEGUI.html#ac2f7aaf6a0965b83cb35e0b1298c70b9" title="Output stream class.">OutStream</a>;
<a name="l00166"></a>00166 } <span class="comment">// end of CEGUI namespace section</span>
<a name="l00167"></a>00167
<a name="l00168"></a>00168
<a name="l00170"></a>00170 <span class="comment">// Comment this line to remove the alignment of elements to pixel</span>
<a name="l00171"></a>00171 <span class="comment">// boundaries. This may give you a performance boost at the expense</span>
<a name="l00172"></a>00172 <span class="comment">// of visual quality</span>
<a name="l00174"></a>00174 <span class="comment"></span><span class="preprocessor">#define CEGUI_ALIGN_ELEMENTS_TO_PIXELS 1</span>
<a name="l00175"></a>00175 <span class="preprocessor"></span>
<a name="l00189"></a>00189 <span class="preprocessor">#if defined(CEGUI_ALIGN_ELEMENTS_TO_PIXELS)</span>
<a name="l00190"></a>00190 <span class="preprocessor"></span><span class="preprocessor"># define PixelAligned(x) ( (float)(int)(( x ) + (( x ) > 0.0f ? 0.5f : -0.5f)) )</span>
<a name="l00191"></a>00191 <span class="preprocessor"></span><span class="preprocessor">#else</span>
<a name="l00192"></a>00192 <span class="preprocessor"></span><span class="preprocessor"># define PixelAligned(x) ( x )</span>
<a name="l00193"></a>00193 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00194"></a>00194 <span class="preprocessor"></span>
<a name="l00195"></a>00195
<a name="l00196"></a>00196 <span class="comment">/*************************************************************************</span>
<a name="l00197"></a>00197 <span class="comment"> Bring in forward references to all GUI base system classes</span>
<a name="l00198"></a>00198 <span class="comment">*************************************************************************/</span>
<a name="l00199"></a>00199 <span class="preprocessor">#include "CEGUIForwardRefs.h"</span>
<a name="l00200"></a>00200
<a name="l00201"></a>00201
<a name="l00202"></a>00202 <span class="preprocessor">#endif // end of guard _CEGUIBase_h_</span>
</pre></div></div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Sun Jan 22 2012 16:07:39 for Crazy Eddies GUI System by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>
|
