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
|
<!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: CEGUIRenderEffectManager.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">CEGUIRenderEffectManager.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: CEGUIRenderEffectManager.h</span>
<a name="l00003"></a>00003 <span class="comment"> created: Wed Dec 23 2009</span>
<a name="l00004"></a>00004 <span class="comment"> author: Paul D Turner <paul@cegui.org.uk></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 _CEGUIRenderEffectManager_h_</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span><span class="preprocessor">#define _CEGUIRenderEffectManager_h_</span>
<a name="l00030"></a>00030 <span class="preprocessor"></span>
<a name="l00031"></a>00031 <span class="preprocessor">#include "CEGUISingleton.h"</span>
<a name="l00032"></a>00032 <span class="preprocessor">#include "CEGUIIteratorBase.h"</span>
<a name="l00033"></a>00033 <span class="preprocessor">#include "CEGUILogger.h"</span>
<a name="l00034"></a>00034 <span class="preprocessor">#include "CEGUIExceptions.h"</span>
<a name="l00035"></a>00035 <span class="preprocessor">#include "CEGUIRenderEffectFactory.h"</span>
<a name="l00036"></a>00036 <span class="preprocessor">#include <map></span>
<a name="l00037"></a>00037
<a name="l00038"></a>00038 <span class="preprocessor">#if defined(_MSC_VER)</span>
<a name="l00039"></a>00039 <span class="preprocessor"></span><span class="preprocessor"># pragma warning(push)</span>
<a name="l00040"></a>00040 <span class="preprocessor"></span><span class="preprocessor"># pragma warning(disable : 4251)</span>
<a name="l00041"></a>00041 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00042"></a>00042 <span class="preprocessor"></span>
<a name="l00043"></a>00043 <span class="comment">// Start of CEGUI namespace section</span>
<a name="l00044"></a>00044 <span class="keyword">namespace </span>CEGUI
<a name="l00045"></a>00045 {
<a name="l00051"></a><a class="code" href="classCEGUI_1_1RenderEffectManager.html">00051</a> <span class="keyword">class </span>CEGUIEXPORT <a class="code" href="classCEGUI_1_1RenderEffectManager.html" title="Singleton class that manages creation and destruction of RenderEffect based objects.">RenderEffectManager</a> : <span class="keyword">public</span> <a class="code" href="classCEGUI_1_1Singleton.html">Singleton</a><RenderEffectManager>
<a name="l00052"></a>00052 {
<a name="l00053"></a>00053 <span class="keyword">private</span>:
<a name="l00055"></a>00055 <span class="keyword">typedef</span> std::map<<a class="code" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a>,
<a name="l00056"></a>00056 <a class="code" href="classCEGUI_1_1RenderEffectFactory.html" title="Interface for factory objects that create RenderEffect instances. Currently this interface is intende...">RenderEffectFactory</a>*,
<a name="l00057"></a>00057 <a class="code" href="structCEGUI_1_1String_1_1FastLessCompare.html" title="Functor that can be used as comparator in a std::map with String keys. It's faster than using the def...">String::FastLessCompare</a>> RenderEffectRegistry;
<a name="l00058"></a>00058
<a name="l00060"></a>00060 <span class="keyword">typedef</span> std::map<RenderEffect*, RenderEffectFactory*> EffectCreatorMap;
<a name="l00061"></a>00061
<a name="l00063"></a>00063 RenderEffectRegistry d_effectRegistry;
<a name="l00065"></a>00065 EffectCreatorMap d_effects;
<a name="l00066"></a>00066
<a name="l00067"></a>00067 <span class="keyword">public</span>:
<a name="l00069"></a><a class="code" href="classCEGUI_1_1RenderEffectManager.html#a1cbf503c6ebfaaff9fd2c87ba40dcf46">00069</a> <span class="keyword">typedef</span> <a class="code" href="classCEGUI_1_1ConstBaseIterator.html" title="Base class constant iterator used to offer iteration over various collections within the system...">ConstBaseIterator<RenderEffectRegistry></a> <a class="code" href="classCEGUI_1_1RenderEffectManager.html#a1cbf503c6ebfaaff9fd2c87ba40dcf46" title="Iterator type that iterates over entries in the RenderEffectRegistry.">RenderEffectIterator</a>;
<a name="l00070"></a>00070
<a name="l00072"></a>00072 <a class="code" href="classCEGUI_1_1RenderEffectManager.html" title="Singleton class that manages creation and destruction of RenderEffect based objects.">RenderEffectManager</a>();
<a name="l00073"></a>00073
<a name="l00075"></a>00075 ~<a class="code" href="classCEGUI_1_1RenderEffectManager.html" title="Singleton class that manages creation and destruction of RenderEffect based objects.">RenderEffectManager</a>();
<a name="l00076"></a>00076
<a name="l00097"></a>00097 <span class="keyword">template</span> <<span class="keyword">typename</span> T>
<a name="l00098"></a>00098 <span class="keywordtype">void</span> addEffect(<span class="keyword">const</span> <a class="code" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a>& name);
<a name="l00099"></a>00099
<a name="l00116"></a>00116 <span class="keywordtype">void</span> removeEffect(<span class="keyword">const</span> <a class="code" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a>& name);
<a name="l00117"></a>00117
<a name="l00130"></a>00130 <span class="keywordtype">bool</span> isEffectAvailable(<span class="keyword">const</span> <a class="code" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a>& name) <span class="keyword">const</span>;
<a name="l00131"></a>00131
<a name="l00148"></a>00148 <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>& create(<span class="keyword">const</span> <a class="code" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a>& name);
<a name="l00149"></a>00149
<a name="l00167"></a>00167 <span class="keywordtype">void</span> destroy(<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="l00168"></a>00168 };
<a name="l00169"></a>00169
<a name="l00170"></a>00170 <span class="comment">//---------------------------------------------------------------------------//</span>
<a name="l00171"></a>00171 <span class="keyword">template</span> <<span class="keyword">typename</span> T>
<a name="l00172"></a><a class="code" href="classCEGUI_1_1RenderEffectManager.html#aa51ef62bdd574e475c9390237601a7b1">00172</a> <span class="keywordtype">void</span> <a class="code" href="classCEGUI_1_1RenderEffectManager.html#aa51ef62bdd574e475c9390237601a7b1" title="Register a RenderEffect type with the system and associate it with the identifier name...">RenderEffectManager::addEffect</a>(<span class="keyword">const</span> <a class="code" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a>& name)
<a name="l00173"></a>00173 {
<a name="l00174"></a>00174 <span class="keywordflow">if</span> (<a class="code" href="classCEGUI_1_1RenderEffectManager.html#a23fc24bd446d89e38dd760f4e36be6ed" title="Return whether a RenderEffect has been registered under the specified name.">isEffectAvailable</a>(name))
<a name="l00175"></a>00175 CEGUI_THROW(<a class="code" href="classCEGUI_1_1AlreadyExistsException.html" title="Exception class used when an attempt is made create a named object of a particular type when an objec...">AlreadyExistsException</a>(<span class="stringliteral">"RenderEffectManager::addEffect: "</span>
<a name="l00176"></a>00176 <span class="stringliteral">"A RenderEffect is already registered under the name '"</span> +
<a name="l00177"></a>00177 name + <span class="stringliteral">"'"</span>));
<a name="l00178"></a>00178
<a name="l00179"></a>00179 <span class="comment">// create an instance of a factory to create effects of type T</span>
<a name="l00180"></a>00180 d_effectRegistry[name] = <span class="keyword">new</span> <a class="code" href="classCEGUI_1_1TplRenderEffectFactory.html" title="Templatised RenderEffectFactory subclass used internally by the system.">TplRenderEffectFactory<T></a>;
<a name="l00181"></a>00181
<a name="l00182"></a>00182 Logger::getSingleton().logEvent(
<a name="l00183"></a>00183 <span class="stringliteral">"Registered RenderEffect named '"</span> + name + <span class="stringliteral">"'"</span>);
<a name="l00184"></a>00184 }
<a name="l00185"></a>00185
<a name="l00186"></a>00186 <span class="comment">//---------------------------------------------------------------------------//</span>
<a name="l00187"></a>00187
<a name="l00188"></a>00188
<a name="l00189"></a>00189 } <span class="comment">// End of CEGUI namespace section</span>
<a name="l00190"></a>00190
<a name="l00191"></a>00191 <span class="preprocessor">#if defined(_MSC_VER)</span>
<a name="l00192"></a>00192 <span class="preprocessor"></span><span class="preprocessor"># pragma warning(pop)</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 <span class="preprocessor">#endif // end of guard _CEGUIRenderEffectManager_h_</span>
<a name="l00196"></a>00196 <span class="preprocessor"></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>
|
