aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/src/others/irrlicht-1.8.1/doc/html/classirr_1_1gui_1_1_i_g_u_i_in_out_fader.html
diff options
context:
space:
mode:
Diffstat (limited to 'src/others/irrlicht-1.8.1/doc/html/classirr_1_1gui_1_1_i_g_u_i_in_out_fader.html')
-rw-r--r--src/others/irrlicht-1.8.1/doc/html/classirr_1_1gui_1_1_i_g_u_i_in_out_fader.html352
1 files changed, 352 insertions, 0 deletions
diff --git a/src/others/irrlicht-1.8.1/doc/html/classirr_1_1gui_1_1_i_g_u_i_in_out_fader.html b/src/others/irrlicht-1.8.1/doc/html/classirr_1_1gui_1_1_i_g_u_i_in_out_fader.html
new file mode 100644
index 0000000..4960c6b
--- /dev/null
+++ b/src/others/irrlicht-1.8.1/doc/html/classirr_1_1gui_1_1_i_g_u_i_in_out_fader.html
@@ -0,0 +1,352 @@
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml">
3<head>
4<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5<title>Irrlicht 3D Engine: irr::gui::IGUIInOutFader Class Reference</title>
6
7<link href="tabs.css" rel="stylesheet" type="text/css"/>
8<link href="doxygen.css" rel="stylesheet" type="text/css" />
9<link href="navtree.css" rel="stylesheet" type="text/css"/>
10<script type="text/javascript" src="jquery.js"></script>
11<script type="text/javascript" src="resize.js"></script>
12<script type="text/javascript" src="navtree.js"></script>
13<script type="text/javascript">
14 $(document).ready(initResizable);
15</script>
16<link href="search/search.css" rel="stylesheet" type="text/css"/>
17<script type="text/javascript" src="search/search.js"></script>
18<script type="text/javascript">
19 $(document).ready(function() { searchBox.OnSelectItem(0); });
20</script>
21
22</head>
23<body>
24<div id="top"><!-- do not remove this div! -->
25
26
27<div id="titlearea">
28<table cellspacing="0" cellpadding="0">
29 <tbody>
30 <tr style="height: 56px;">
31
32 <td id="projectlogo"><img alt="Logo" src="irrlichtlogo.png"/></td>
33
34
35 <td style="padding-left: 0.5em;">
36 <div id="projectname">Irrlicht 3D Engine
37
38 </div>
39
40 </td>
41
42
43
44
45 <td> <div id="MSearchBox" class="MSearchBoxInactive">
46 <span class="left">
47 <img id="MSearchSelect" src="search/mag_sel.png"
48 onmouseover="return searchBox.OnSearchSelectShow()"
49 onmouseout="return searchBox.OnSearchSelectHide()"
50 alt=""/>
51 <input type="text" id="MSearchField" value="Search" accesskey="S"
52 onfocus="searchBox.OnSearchFieldFocus(true)"
53 onblur="searchBox.OnSearchFieldFocus(false)"
54 onkeyup="searchBox.OnSearchFieldChange(event)"/>
55 </span><span class="right">
56 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
57 </span>
58 </div>
59</td>
60
61
62 </tr>
63 </tbody>
64</table>
65</div>
66
67<!-- Generated by Doxygen 1.7.5.1 -->
68<script type="text/javascript">
69var searchBox = new SearchBox("searchBox", "search",false,'Search');
70</script>
71<script type="text/javascript" src="dynsections.js"></script>
72</div>
73<div id="side-nav" class="ui-resizable side-nav-resizable">
74 <div id="nav-tree">
75 <div id="nav-tree-contents">
76 </div>
77 </div>
78 <div id="splitbar" style="-moz-user-select:none;"
79 class="ui-resizable-handle">
80 </div>
81</div>
82<script type="text/javascript">
83 initNavTree('classirr_1_1gui_1_1_i_g_u_i_in_out_fader.html','');
84</script>
85<div id="doc-content">
86<div class="header">
87 <div class="summary">
88<a href="#pub-methods">Public Member Functions</a> </div>
89 <div class="headertitle">
90<div class="title">irr::gui::IGUIInOutFader Class Reference</div> </div>
91</div>
92<div class="contents">
93<!-- doxytag: class="irr::gui::IGUIInOutFader" --><!-- doxytag: inherits="irr::gui::IGUIElement" -->
94<p>Element for fading out or in.
95 <a href="classirr_1_1gui_1_1_i_g_u_i_in_out_fader.html#details">More...</a></p>
96
97<p><code>#include &lt;<a class="el" href="_i_g_u_i_in_out_fader_8h_source.html">IGUIInOutFader.h</a>&gt;</code></p>
98<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
99 <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for irr::gui::IGUIInOutFader:</div>
100<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
101</div>
102<div id="dynsection-0-content" class="dyncontent" style="display:none;">
103 <div class="center">
104 <img src="classirr_1_1gui_1_1_i_g_u_i_in_out_fader.png" usemap="#irr::gui::IGUIInOutFader_map" alt=""/>
105 <map id="irr::gui::IGUIInOutFader_map" name="irr::gui::IGUIInOutFader_map">
106<area href="classirr_1_1gui_1_1_i_g_u_i_element.html" title="Base class of all GUI elements." alt="irr::gui::IGUIElement" shape="rect" coords="105,112,305,136"/>
107<area href="classirr_1_1io_1_1_i_attribute_exchanging_object.html" title="An object which is able to serialize and deserialize its attributes into an attributes object..." alt="irr::io::IAttributeExchangingObject" shape="rect" coords="0,56,200,80"/>
108<area href="classirr_1_1_i_event_receiver.html" title="Interface of an object which can receive events." alt="irr::IEventReceiver" shape="rect" coords="210,56,410,80"/>
109<area href="classirr_1_1_i_reference_counted.html" title="Base class of most objects of the Irrlicht Engine." alt="irr::IReferenceCounted" shape="rect" coords="0,0,200,24"/>
110</map>
111 </div></div>
112
113<p><a href="classirr_1_1gui_1_1_i_g_u_i_in_out_fader-members.html">List of all members.</a></p>
114<h2><a name="pub-methods"></a>
115Public Member Functions</h2>
116<ul>
117<li><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_in_out_fader.html#ad839c9be778846aa0fba823c7dd30c69">IGUIInOutFader</a> (<a class="el" href="classirr_1_1gui_1_1_i_g_u_i_environment.html">IGUIEnvironment</a> *environment, <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_element.html">IGUIElement</a> *parent, <a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> id, <a class="el" href="classirr_1_1core_1_1rect.html">core::rect</a>&lt; <a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> &gt; rectangle)
118<dl class="el"><dd class="mdescRight">constructor <a href="#ad839c9be778846aa0fba823c7dd30c69"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_in_out_fader.html#a407edab8f7e349612d62c39accc159e2">fadeIn</a> (<a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> time)=0
119<dl class="el"><dd class="mdescRight">Starts the fade in process. <a href="#a407edab8f7e349612d62c39accc159e2"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_in_out_fader.html#a5006c28699050d73be11b15ffc7ba993">fadeOut</a> (<a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> time)=0
120<dl class="el"><dd class="mdescRight">Starts the fade out process. <a href="#a5006c28699050d73be11b15ffc7ba993"></a><br/></dl><li>virtual <a class="el" href="classirr_1_1video_1_1_s_color.html">video::SColor</a> <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_in_out_fader.html#adeed9c5ffd4b9ab6180cba40596742b9">getColor</a> () const =0
121<dl class="el"><dd class="mdescRight">Gets the color to fade out to or to fade in from. <a href="#adeed9c5ffd4b9ab6180cba40596742b9"></a><br/></dl><li>virtual bool <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_in_out_fader.html#a8a917f7c5c74ff0bdb2ba844f1953387">isReady</a> () const =0
122<dl class="el"><dd class="mdescRight">Returns if the fade in or out process is done. <a href="#a8a917f7c5c74ff0bdb2ba844f1953387"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_in_out_fader.html#aba1cdb4928662a2340aa6600850e03d1">setColor</a> (<a class="el" href="classirr_1_1video_1_1_s_color.html">video::SColor</a> color)=0
123<dl class="el"><dd class="mdescRight">Sets the color to fade out to or to fade in from. <a href="#aba1cdb4928662a2340aa6600850e03d1"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1gui_1_1_i_g_u_i_in_out_fader.html#a8921fcc159f144a31d67b78561e58906">setColor</a> (<a class="el" href="classirr_1_1video_1_1_s_color.html">video::SColor</a> source, <a class="el" href="classirr_1_1video_1_1_s_color.html">video::SColor</a> dest)=0
124</ul>
125<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
126<div class="textblock"><p>Element for fading out or in. </p>
127<p>Here is a small example on how the class is used. In this example we fade in from a total red screen in the beginning. As you can see, the fader is not only useful for dramatic in and out fading, but also to show that the player is hit in a first person shooter game for example. </p>
128<div class="fragment"><pre class="fragment"> gui::IGUIInOutFader* fader = device-&gt;getGUIEnvironment()-&gt;addInOutFader();
129 fader-&gt;setColor(video::SColor(0,255,0,0));
130 fader-&gt;fadeIn(4000);
131</pre></div>
132<p>Definition at line <a class="el" href="_i_g_u_i_in_out_fader_8h_source.html#l00027">27</a> of file <a class="el" href="_i_g_u_i_in_out_fader_8h_source.html">IGUIInOutFader.h</a>.</p>
133</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
134<a class="anchor" id="ad839c9be778846aa0fba823c7dd30c69"></a><!-- doxytag: member="irr::gui::IGUIInOutFader::IGUIInOutFader" ref="ad839c9be778846aa0fba823c7dd30c69" args="(IGUIEnvironment *environment, IGUIElement *parent, s32 id, core::rect&lt; s32 &gt; rectangle)" -->
135<div class="memitem">
136<div class="memproto">
137 <table class="memname">
138 <tr>
139 <td class="memname">irr::gui::IGUIInOutFader::IGUIInOutFader </td>
140 <td>(</td>
141 <td class="paramtype"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_environment.html">IGUIEnvironment</a> *&#160;</td>
142 <td class="paramname"><em>environment</em>, </td>
143 </tr>
144 <tr>
145 <td class="paramkey"></td>
146 <td></td>
147 <td class="paramtype"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_element.html">IGUIElement</a> *&#160;</td>
148 <td class="paramname"><em>parent</em>, </td>
149 </tr>
150 <tr>
151 <td class="paramkey"></td>
152 <td></td>
153 <td class="paramtype"><a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a>&#160;</td>
154 <td class="paramname"><em>id</em>, </td>
155 </tr>
156 <tr>
157 <td class="paramkey"></td>
158 <td></td>
159 <td class="paramtype"><a class="el" href="classirr_1_1core_1_1rect.html">core::rect</a>&lt; <a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> &gt;&#160;</td>
160 <td class="paramname"><em>rectangle</em>&#160;</td>
161 </tr>
162 <tr>
163 <td></td>
164 <td>)</td>
165 <td></td><td><code> [inline]</code></td>
166 </tr>
167 </table>
168</div>
169<div class="memdoc">
170
171<p>constructor </p>
172
173<p>Definition at line <a class="el" href="_i_g_u_i_in_out_fader_8h_source.html#l00032">32</a> of file <a class="el" href="_i_g_u_i_in_out_fader_8h_source.html">IGUIInOutFader.h</a>.</p>
174
175</div>
176</div>
177<hr/><h2>Member Function Documentation</h2>
178<a class="anchor" id="a407edab8f7e349612d62c39accc159e2"></a><!-- doxytag: member="irr::gui::IGUIInOutFader::fadeIn" ref="a407edab8f7e349612d62c39accc159e2" args="(u32 time)=0" -->
179<div class="memitem">
180<div class="memproto">
181 <table class="memname">
182 <tr>
183 <td class="memname">virtual void irr::gui::IGUIInOutFader::fadeIn </td>
184 <td>(</td>
185 <td class="paramtype"><a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a>&#160;</td>
186 <td class="paramname"><em>time</em></td><td>)</td>
187 <td><code> [pure virtual]</code></td>
188 </tr>
189 </table>
190</div>
191<div class="memdoc">
192
193<p>Starts the fade in process. </p>
194<p>In the beginning the whole rect is drawn by the set color (black by default) and at the end of the overgiven time the color has faded out. </p>
195<dl><dt><b>Parameters:</b></dt><dd>
196 <table class="params">
197 <tr><td class="paramname">time,:</td><td>Time specifying how long it should need to fade in, in milliseconds. </td></tr>
198 </table>
199 </dd>
200</dl>
201
202</div>
203</div>
204<a class="anchor" id="a5006c28699050d73be11b15ffc7ba993"></a><!-- doxytag: member="irr::gui::IGUIInOutFader::fadeOut" ref="a5006c28699050d73be11b15ffc7ba993" args="(u32 time)=0" -->
205<div class="memitem">
206<div class="memproto">
207 <table class="memname">
208 <tr>
209 <td class="memname">virtual void irr::gui::IGUIInOutFader::fadeOut </td>
210 <td>(</td>
211 <td class="paramtype"><a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a>&#160;</td>
212 <td class="paramname"><em>time</em></td><td>)</td>
213 <td><code> [pure virtual]</code></td>
214 </tr>
215 </table>
216</div>
217<div class="memdoc">
218
219<p>Starts the fade out process. </p>
220<p>In the beginning everything is visible, and at the end of the time only the set color (black by the fault) will be drawn. </p>
221<dl><dt><b>Parameters:</b></dt><dd>
222 <table class="params">
223 <tr><td class="paramname">time,:</td><td>Time specifying how long it should need to fade out, in milliseconds. </td></tr>
224 </table>
225 </dd>
226</dl>
227
228</div>
229</div>
230<a class="anchor" id="adeed9c5ffd4b9ab6180cba40596742b9"></a><!-- doxytag: member="irr::gui::IGUIInOutFader::getColor" ref="adeed9c5ffd4b9ab6180cba40596742b9" args="() const =0" -->
231<div class="memitem">
232<div class="memproto">
233 <table class="memname">
234 <tr>
235 <td class="memname">virtual <a class="el" href="classirr_1_1video_1_1_s_color.html">video::SColor</a> irr::gui::IGUIInOutFader::getColor </td>
236 <td>(</td>
237 <td class="paramname"></td><td>)</td>
238 <td> const<code> [pure virtual]</code></td>
239 </tr>
240 </table>
241</div>
242<div class="memdoc">
243
244<p>Gets the color to fade out to or to fade in from. </p>
245
246</div>
247</div>
248<a class="anchor" id="a8a917f7c5c74ff0bdb2ba844f1953387"></a><!-- doxytag: member="irr::gui::IGUIInOutFader::isReady" ref="a8a917f7c5c74ff0bdb2ba844f1953387" args="() const =0" -->
249<div class="memitem">
250<div class="memproto">
251 <table class="memname">
252 <tr>
253 <td class="memname">virtual bool irr::gui::IGUIInOutFader::isReady </td>
254 <td>(</td>
255 <td class="paramname"></td><td>)</td>
256 <td> const<code> [pure virtual]</code></td>
257 </tr>
258 </table>
259</div>
260<div class="memdoc">
261
262<p>Returns if the fade in or out process is done. </p>
263
264</div>
265</div>
266<a class="anchor" id="aba1cdb4928662a2340aa6600850e03d1"></a><!-- doxytag: member="irr::gui::IGUIInOutFader::setColor" ref="aba1cdb4928662a2340aa6600850e03d1" args="(video::SColor color)=0" -->
267<div class="memitem">
268<div class="memproto">
269 <table class="memname">
270 <tr>
271 <td class="memname">virtual void irr::gui::IGUIInOutFader::setColor </td>
272 <td>(</td>
273 <td class="paramtype"><a class="el" href="classirr_1_1video_1_1_s_color.html">video::SColor</a>&#160;</td>
274 <td class="paramname"><em>color</em></td><td>)</td>
275 <td><code> [pure virtual]</code></td>
276 </tr>
277 </table>
278</div>
279<div class="memdoc">
280
281<p>Sets the color to fade out to or to fade in from. </p>
282<dl><dt><b>Parameters:</b></dt><dd>
283 <table class="params">
284 <tr><td class="paramname">color,:</td><td>Color to where it is faded out od from it is faded in. </td></tr>
285 </table>
286 </dd>
287</dl>
288
289</div>
290</div>
291<a class="anchor" id="a8921fcc159f144a31d67b78561e58906"></a><!-- doxytag: member="irr::gui::IGUIInOutFader::setColor" ref="a8921fcc159f144a31d67b78561e58906" args="(video::SColor source, video::SColor dest)=0" -->
292<div class="memitem">
293<div class="memproto">
294 <table class="memname">
295 <tr>
296 <td class="memname">virtual void irr::gui::IGUIInOutFader::setColor </td>
297 <td>(</td>
298 <td class="paramtype"><a class="el" href="classirr_1_1video_1_1_s_color.html">video::SColor</a>&#160;</td>
299 <td class="paramname"><em>source</em>, </td>
300 </tr>
301 <tr>
302 <td class="paramkey"></td>
303 <td></td>
304 <td class="paramtype"><a class="el" href="classirr_1_1video_1_1_s_color.html">video::SColor</a>&#160;</td>
305 <td class="paramname"><em>dest</em>&#160;</td>
306 </tr>
307 <tr>
308 <td></td>
309 <td>)</td>
310 <td></td><td><code> [pure virtual]</code></td>
311 </tr>
312 </table>
313</div>
314<div class="memdoc">
315
316</div>
317</div>
318<hr/>The documentation for this class was generated from the following file:<ul>
319<li><a class="el" href="_i_g_u_i_in_out_fader_8h_source.html">IGUIInOutFader.h</a></li>
320</ul>
321</div>
322</div>
323 <div id="nav-path" class="navpath">
324 <ul>
325 <li class="navelem"><a class="el" href="namespaceirr.html">irr</a> </li>
326 <li class="navelem"><a class="el" href="namespaceirr_1_1gui.html">gui</a> </li>
327 <li class="navelem"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_in_out_fader.html">IGUIInOutFader</a> </li>
328<!-- window showing the filter options -->
329<div id="MSearchSelectWindow"
330 onmouseover="return searchBox.OnSearchSelectShow()"
331 onmouseout="return searchBox.OnSearchSelectHide()"
332 onkeydown="return searchBox.OnSearchSelectKey(event)">
333<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Defines</a></div>
334
335<!-- iframe showing the search results (closed by default) -->
336<div id="MSearchResultsWindow">
337<iframe src="javascript:void(0)" frameborder="0"
338 name="MSearchResults" id="MSearchResults">
339</iframe>
340</div>
341
342
343 <li class="footer">
344<a href="http://irrlicht.sourceforge.net" target="_blank">Irrlicht
345Engine</a> Documentation &copy; 2003-2012 by Nikolaus Gebhardt. Generated on Sun Nov 17 2013 20:18:44 for Irrlicht 3D Engine by
346<a href="http://www.doxygen.org/index.html" target="_blank">Doxygen</a> 1.7.5.1 </li>
347 </ul>
348 </div>
349
350
351</body>
352</html>
generated by cgit v1.1 at 2024-06-27 09:25:35 +0000