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
|
<!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: CEGUIRenderingWindow.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">CEGUIRenderingWindow.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: CEGUIRenderingWindow.h</span>
<a name="l00003"></a>00003 <span class="comment"> created: Mon Jan 12 2009</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">/***************************************************************************</span>
<a name="l00007"></a>00007 <span class="comment"> * Copyright (C) 2004 - 2009 Paul D Turner & The CEGUI Development Team</span>
<a name="l00008"></a>00008 <span class="comment"> *</span>
<a name="l00009"></a>00009 <span class="comment"> * Permission is hereby granted, free of charge, to any person obtaining</span>
<a name="l00010"></a>00010 <span class="comment"> * a copy of this software and associated documentation files (the</span>
<a name="l00011"></a>00011 <span class="comment"> * "Software"), to deal in the Software without restriction, including</span>
<a name="l00012"></a>00012 <span class="comment"> * without limitation the rights to use, copy, modify, merge, publish,</span>
<a name="l00013"></a>00013 <span class="comment"> * distribute, sublicense, and/or sell copies of the Software, and to</span>
<a name="l00014"></a>00014 <span class="comment"> * permit persons to whom the Software is furnished to do so, subject to</span>
<a name="l00015"></a>00015 <span class="comment"> * the following conditions:</span>
<a name="l00016"></a>00016 <span class="comment"> *</span>
<a name="l00017"></a>00017 <span class="comment"> * The above copyright notice and this permission notice shall be</span>
<a name="l00018"></a>00018 <span class="comment"> * included in all copies or substantial portions of the Software.</span>
<a name="l00019"></a>00019 <span class="comment"> *</span>
<a name="l00020"></a>00020 <span class="comment"> * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,</span>
<a name="l00021"></a>00021 <span class="comment"> * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF</span>
<a name="l00022"></a>00022 <span class="comment"> * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.</span>
<a name="l00023"></a>00023 <span class="comment"> * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR</span>
<a name="l00024"></a>00024 <span class="comment"> * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,</span>
<a name="l00025"></a>00025 <span class="comment"> * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR</span>
<a name="l00026"></a>00026 <span class="comment"> * OTHER DEALINGS IN THE SOFTWARE.</span>
<a name="l00027"></a>00027 <span class="comment"> ***************************************************************************/</span>
<a name="l00028"></a>00028 <span class="preprocessor">#ifndef _CEGUIRenderingWindow_h_</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span><span class="preprocessor">#define _CEGUIRenderingWindow_h_</span>
<a name="l00030"></a>00030 <span class="preprocessor"></span>
<a name="l00031"></a>00031 <span class="preprocessor">#include "CEGUIRenderingSurface.h"</span>
<a name="l00032"></a>00032 <span class="preprocessor">#include "CEGUIVector.h"</span>
<a name="l00033"></a>00033 <span class="preprocessor">#include "CEGUISize.h"</span>
<a name="l00034"></a>00034
<a name="l00035"></a>00035 <span class="comment">// Start of CEGUI namespace section</span>
<a name="l00036"></a>00036 <span class="keyword">namespace </span>CEGUI
<a name="l00037"></a>00037 {
<a name="l00044"></a><a class="code" href="classCEGUI_1_1RenderingWindow.html">00044</a> <span class="keyword">class </span>CEGUIEXPORT <a class="code" href="classCEGUI_1_1RenderingWindow.html" title="RenderingWindow is a RenderingSurface that can be "drawn back" onto another RenderingSurface and is p...">RenderingWindow</a> : <span class="keyword">public</span> <a class="code" href="classCEGUI_1_1RenderingSurface.html" title="Class that represents a surface that can have geometry based imagery drawn to it.">RenderingSurface</a>
<a name="l00045"></a>00045 {
<a name="l00046"></a>00046 <span class="keyword">public</span>:
<a name="l00064"></a>00064 <a class="code" href="classCEGUI_1_1RenderingWindow.html" title="RenderingWindow is a RenderingSurface that can be "drawn back" onto another RenderingSurface and is p...">RenderingWindow</a>(<a class="code" href="classCEGUI_1_1TextureTarget.html" title="Specialisation of RenderTarget interface that should be used as the base class for RenderTargets that...">TextureTarget</a>& target, <a class="code" href="classCEGUI_1_1RenderingSurface.html" title="Class that represents a surface that can have geometry based imagery drawn to it.">RenderingSurface</a>& owner);
<a name="l00065"></a>00065
<a name="l00067"></a>00067 ~<a class="code" href="classCEGUI_1_1RenderingWindow.html" title="RenderingWindow is a RenderingSurface that can be "drawn back" onto another RenderingSurface and is p...">RenderingWindow</a>();
<a name="l00068"></a>00068
<a name="l00088"></a>00088 <span class="keywordtype">void</span> setClippingRegion(<span class="keyword">const</span> <a class="code" href="classCEGUI_1_1Rect.html" title="Class encapsulating operations on a Rectangle.">Rect</a>& region);
<a name="l00089"></a>00089
<a name="l00104"></a>00104 <span class="keywordtype">void</span> setPosition(<span class="keyword">const</span> <a class="code" href="classCEGUI_1_1Vector2.html" title="Class used as a two dimensional vector (aka a Point)">Vector2</a>& position);
<a name="l00105"></a>00105
<a name="l00114"></a>00114 <span class="keywordtype">void</span> setSize(<span class="keyword">const</span> <a class="code" href="classCEGUI_1_1Size.html" title="Class that holds the size (width & height) of something.">Size</a>& size);
<a name="l00115"></a>00115
<a name="l00125"></a>00125 <span class="keywordtype">void</span> setRotation(<span class="keyword">const</span> <a class="code" href="classCEGUI_1_1Vector3.html" title="Class used as a three dimensional vector.">Vector3</a>& rotation);
<a name="l00126"></a>00126
<a name="l00136"></a>00136 <span class="keywordtype">void</span> setPivot(<span class="keyword">const</span> <a class="code" href="classCEGUI_1_1Vector3.html" title="Class used as a three dimensional vector.">Vector3</a>& pivot);
<a name="l00137"></a>00137
<a name="l00151"></a>00151 <span class="keyword">const</span> <a class="code" href="classCEGUI_1_1Vector2.html" title="Class used as a two dimensional vector (aka a Point)">Vector2</a>& getPosition() <span class="keyword">const</span>;
<a name="l00152"></a>00152
<a name="l00160"></a>00160 <span class="keyword">const</span> <a class="code" href="classCEGUI_1_1Size.html" title="Class that holds the size (width & height) of something.">Size</a>& getSize() <span class="keyword">const</span>;
<a name="l00161"></a>00161
<a name="l00170"></a>00170 <span class="keyword">const</span> <a class="code" href="classCEGUI_1_1Vector3.html" title="Class used as a three dimensional vector.">Vector3</a>& getRotation()<span class="keyword">const</span>;
<a name="l00171"></a>00171
<a name="l00180"></a>00180 <span class="keyword">const</span> <a class="code" href="classCEGUI_1_1Vector3.html" title="Class used as a three dimensional vector.">Vector3</a>& getPivot() <span class="keyword">const</span>;
<a name="l00181"></a>00181
<a name="l00192"></a>00192 <span class="keyword">const</span> <a class="code" href="classCEGUI_1_1TextureTarget.html" title="Specialisation of RenderTarget interface that should be used as the base class for RenderTargets that...">TextureTarget</a>& getTextureTarget() <span class="keyword">const</span>;
<a name="l00193"></a>00193 <a class="code" href="classCEGUI_1_1TextureTarget.html" title="Specialisation of RenderTarget interface that should be used as the base class for RenderTargets that...">TextureTarget</a>& getTextureTarget();
<a name="l00194"></a>00194
<a name="l00207"></a>00207 <span class="keywordtype">void</span> update(<span class="keyword">const</span> <span class="keywordtype">float</span> elapsed);
<a name="l00208"></a>00208
<a name="l00219"></a>00219 <span class="keywordtype">void</span> setRenderEffect(<a class="code" href="classCEGUI_1_1RenderEffect.html" title="Interface for objects that hook into RenderingWindow to affect the rendering process, thus allowing various effects to be achieved.">RenderEffect</a>* effect);
<a name="l00220"></a>00220
<a name="l00231"></a>00231 <a class="code" href="classCEGUI_1_1RenderEffect.html" title="Interface for objects that hook into RenderingWindow to affect the rendering process, thus allowing various effects to be achieved.">RenderEffect</a>* getRenderEffect();
<a name="l00232"></a>00232
<a name="l00243"></a>00243 <span class="keywordtype">void</span> realiseGeometry();
<a name="l00244"></a>00244
<a name="l00255"></a>00255 <span class="keywordtype">void</span> invalidateGeometry();
<a name="l00256"></a>00256
<a name="l00267"></a>00267 <span class="keyword">const</span> <a class="code" href="classCEGUI_1_1RenderingSurface.html" title="Class that represents a surface that can have geometry based imagery drawn to it.">RenderingSurface</a>& getOwner() <span class="keyword">const</span>;
<a name="l00268"></a>00268 <a class="code" href="classCEGUI_1_1RenderingSurface.html" title="Class that represents a surface that can have geometry based imagery drawn to it.">RenderingSurface</a>& getOwner();
<a name="l00269"></a>00269
<a name="l00275"></a>00275 <span class="keywordtype">void</span> unprojectPoint(<span class="keyword">const</span> <a class="code" href="classCEGUI_1_1Vector2.html" title="Class used as a two dimensional vector (aka a Point)">Vector2</a>& p_in, <a class="code" href="classCEGUI_1_1Vector2.html" title="Class used as a two dimensional vector (aka a Point)">Vector2</a>& p_out);
<a name="l00276"></a>00276
<a name="l00277"></a>00277 <span class="comment">// overrides from base</span>
<a name="l00278"></a>00278 <span class="keywordtype">void</span> draw();
<a name="l00279"></a>00279 <span class="keywordtype">void</span> invalidate();
<a name="l00280"></a>00280 <span class="keywordtype">bool</span> isRenderingWindow() <span class="keyword">const</span>;
<a name="l00281"></a>00281
<a name="l00282"></a>00282 <span class="keyword">protected</span>:
<a name="l00284"></a>00284 <span class="keyword">virtual</span> <span class="keywordtype">void</span> realiseGeometry_impl();
<a name="l00285"></a>00285
<a name="l00287"></a>00287 <span class="keywordtype">void</span> setOwner(<a class="code" href="classCEGUI_1_1RenderingSurface.html" title="Class that represents a surface that can have geometry based imagery drawn to it.">RenderingSurface</a>& owner);
<a name="l00288"></a>00288 <span class="comment">// friend is so that RenderingSurface can call setOwner to xfer ownership.</span>
<a name="l00289"></a>00289 <span class="keyword">friend</span> <span class="keywordtype">void</span> <a class="code" href="classCEGUI_1_1RenderingSurface.html#a6541e6e27178ab80400d9a8943dc7fd8" title="transfer ownership of the RenderingWindow to this RenderingSurface.">RenderingSurface::transferRenderingWindow</a>(<a class="code" href="classCEGUI_1_1RenderingWindow.html" title="RenderingWindow is a RenderingSurface that can be "drawn back" onto another RenderingSurface and is p...">RenderingWindow</a>&);
<a name="l00290"></a>00290
<a name="l00292"></a><a class="code" href="classCEGUI_1_1RenderingWindow.html#a19b63e1adfba4140cd79acd2150dcf42">00292</a> <a class="code" href="classCEGUI_1_1Renderer.html" title="Abstract class defining the basic required interface for Renderer objects.">Renderer</a>& <a class="code" href="classCEGUI_1_1RenderingWindow.html#a19b63e1adfba4140cd79acd2150dcf42" title="holds ref to renderer">d_renderer</a>;
<a name="l00294"></a><a class="code" href="classCEGUI_1_1RenderingWindow.html#ad620a6825bdd0ad13750d1f3bb3d380c">00294</a> <a class="code" href="classCEGUI_1_1TextureTarget.html" title="Specialisation of RenderTarget interface that should be used as the base class for RenderTargets that...">TextureTarget</a>& <a class="code" href="classCEGUI_1_1RenderingWindow.html#ad620a6825bdd0ad13750d1f3bb3d380c" title="TextureTarget to draw to. Like d_target in base, but avoiding downcasts.">d_textarget</a>;
<a name="l00296"></a><a class="code" href="classCEGUI_1_1RenderingWindow.html#a76d73f1ca0ddbca6bce1e9b130a38b00">00296</a> <a class="code" href="classCEGUI_1_1RenderingSurface.html" title="Class that represents a surface that can have geometry based imagery drawn to it.">RenderingSurface</a>* <a class="code" href="classCEGUI_1_1RenderingWindow.html#a76d73f1ca0ddbca6bce1e9b130a38b00" title="RenderingSurface that owns this object, we render back to this object.">d_owner</a>;
<a name="l00298"></a><a class="code" href="classCEGUI_1_1RenderingWindow.html#a7febdae729d5c790b616de04351c8a97">00298</a> <a class="code" href="classCEGUI_1_1GeometryBuffer.html" title="Abstract class defining the interface for objects that buffer geometry for later rendering.">GeometryBuffer</a>* <a class="code" href="classCEGUI_1_1RenderingWindow.html#a7febdae729d5c790b616de04351c8a97" title="GeometryBuffer that holds geometry for drawing this window.">d_geometry</a>;
<a name="l00300"></a><a class="code" href="classCEGUI_1_1RenderingWindow.html#ae7ea01d388fd9a2587f24c7a486fee03">00300</a> <span class="keywordtype">bool</span> <a class="code" href="classCEGUI_1_1RenderingWindow.html#ae7ea01d388fd9a2587f24c7a486fee03" title="indicates whether data in GeometryBuffer is up-to-date">d_geometryValid</a>;
<a name="l00302"></a><a class="code" href="classCEGUI_1_1RenderingWindow.html#a31162bcf39e3bf2e6262264b71a009f9">00302</a> <a class="code" href="classCEGUI_1_1Vector2.html" title="Class used as a two dimensional vector (aka a Point)">Vector2</a> <a class="code" href="classCEGUI_1_1RenderingWindow.html#a31162bcf39e3bf2e6262264b71a009f9" title="Position of this RenderingWindow.">d_position</a>;
<a name="l00304"></a><a class="code" href="classCEGUI_1_1RenderingWindow.html#ada9fcbbe328d690a360d88c395667c5a">00304</a> <a class="code" href="classCEGUI_1_1Size.html" title="Class that holds the size (width & height) of something.">Size</a> <a class="code" href="classCEGUI_1_1RenderingWindow.html#ada9fcbbe328d690a360d88c395667c5a" title="Size of this RenderingWindow.">d_size</a>;
<a name="l00306"></a><a class="code" href="classCEGUI_1_1RenderingWindow.html#aff88b5117d832280de4288392d8e3e32">00306</a> <a class="code" href="classCEGUI_1_1Vector3.html" title="Class used as a three dimensional vector.">Vector3</a> <a class="code" href="classCEGUI_1_1RenderingWindow.html#aff88b5117d832280de4288392d8e3e32" title="Rotaions for this RenderingWindow.">d_rotation</a>;
<a name="l00308"></a><a class="code" href="classCEGUI_1_1RenderingWindow.html#aaa493e3c79792c9545b7189851a62aca">00308</a> <a class="code" href="classCEGUI_1_1Vector3.html" title="Class used as a three dimensional vector.">Vector3</a> <a class="code" href="classCEGUI_1_1RenderingWindow.html#aaa493e3c79792c9545b7189851a62aca" title="Pivot point used for the rotation.">d_pivot</a>;
<a name="l00309"></a>00309 };
<a name="l00310"></a>00310
<a name="l00311"></a>00311 } <span class="comment">// End of CEGUI namespace section</span>
<a name="l00312"></a>00312
<a name="l00313"></a>00313 <span class="preprocessor">#endif // end of guard _CEGUIRenderingWindow_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>
|
