<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Irrlicht Engine: irr::gui::IGUIInOutFader Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<table class="irrlicht" >
<tr valign="middle">
<td><font size="2"><a class="qindex" href="index.html"><font color="#FFFFFF">Home</font></a>
| <a class="qindex" href="namespaces.html"><font color="#FFFFFF">Namespaces</font></a>
| <a class="qindex" href="hierarchy.html"><font color="#FFFFFF">Hierarchy</font></a>
| <a class="qindex" href="classes.html"><font color="#FFFFFF">Alphabetical
List</font></a> | <a class="qindex" href="annotated.html"><font color="#FFFFFF">
Class list</font></a> | <a class="qindex" href="files.html"><font color="#FFFFFF">Files</font></a>
| <a class="qindex" href="namespacemembers.html"><font color="#FFFFFF">
Namespace Members</font></a> | <a class="qindex" href="functions.html"><font color="#FFFFFF">Class
members</font></a> | <a class="qindex" href="globals.html"><font color="#FFFFFF">File
members</font></a> | <a class="qindex" href="pages.html"><font color="#FFFFFF">Tutorials</font></a></font> </td>
</tr>
</table>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navpath"><a class="el" href="namespaceirr.html">irr</a>::<a class="el" href="namespaceirr_1_1gui.html">gui</a>::<a class="el" href="classirr_1_1gui_1_1_i_g_u_i_in_out_fader.html">IGUIInOutFader</a>
</div>
<div class="contents">
<h1>irr::gui::IGUIInOutFader Class Reference</h1><!-- doxytag: class="irr::gui::IGUIInOutFader" --><!-- doxytag: inherits="irr::gui::IGUIElement" -->Element for fading out or in.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="_i_g_u_i_in_out_fader_8h-source.html">IGUIInOutFader.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for irr::gui::IGUIInOutFader:</div>
<div class="dynsection">
<p><center><img src="classirr_1_1gui_1_1_i_g_u_i_in_out_fader.png" usemap="#irr::gui::IGUIInOutFader_map" border="0" alt=""></center>
<map name="irr::gui::IGUIInOutFader_map">
<area href="classirr_1_1gui_1_1_i_g_u_i_element.html" alt="irr::gui::IGUIElement" shape="rect" coords="105,112,305,136">
<area href="classirr_1_1io_1_1_i_attribute_exchanging_object.html" alt="irr::io::IAttributeExchangingObject" shape="rect" coords="0,56,200,80">
<area href="classirr_1_1_i_event_receiver.html" alt="irr::IEventReceiver" shape="rect" coords="210,56,410,80">
<area href="classirr_1_1_i_reference_counted.html" alt="irr::IReferenceCounted" shape="rect" coords="0,0,200,24">
</map>
</div>
<p>
<a href="classirr_1_1gui_1_1_i_g_u_i_in_out_fader-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_in_out_fader.html#407edab8f7e349612d62c39accc159e2">fadeIn</a> (<a class="el" href="namespaceirr.html#0416a53257075833e7002efd0a18e804">u32</a> time)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Starts the fade in process. <a href="#407edab8f7e349612d62c39accc159e2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_in_out_fader.html#5006c28699050d73be11b15ffc7ba993">fadeOut</a> (<a class="el" href="namespaceirr.html#0416a53257075833e7002efd0a18e804">u32</a> time)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Starts the fade out process. <a href="#5006c28699050d73be11b15ffc7ba993"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classirr_1_1video_1_1_s_color.html">video::SColor</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_in_out_fader.html#deed9c5ffd4b9ab6180cba40596742b9">getColor</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the color to fade out to or to fade in from. <a href="#deed9c5ffd4b9ab6180cba40596742b9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_in_out_fader.html#d839c9be778846aa0fba823c7dd30c69">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#c66849b7a6ed16e30ebede579f9b47c6">s32</a> id, <a class="el" href="classirr_1_1core_1_1rect.html">core::rect</a>< <a class="el" href="namespaceirr.html#c66849b7a6ed16e30ebede579f9b47c6">s32</a> > rectangle)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">constructor <a href="#d839c9be778846aa0fba823c7dd30c69"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_in_out_fader.html#8a917f7c5c74ff0bdb2ba844f1953387">isReady</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns if the fade in or out process is done. <a href="#8a917f7c5c74ff0bdb2ba844f1953387"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_in_out_fader.html#8921fcc159f144a31d67b78561e58906">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</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_in_out_fader.html#ba1cdb4928662a2340aa6600850e03d1">setColor</a> (<a class="el" href="classirr_1_1video_1_1_s_color.html">video::SColor</a> color)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the color to fade out to or to fade in from. <a href="#ba1cdb4928662a2340aa6600850e03d1"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Element for fading out or in.
<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. <div class="fragment"><pre class="fragment"> gui::IGUIInOutFader* fader = device->getGUIEnvironment()->addInOutFader();
fader->setColor(video::SColor(0,255,0,0));
fader->fadeIn(4000);
</pre></div>
<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>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="d839c9be778846aa0fba823c7dd30c69"></a><!-- doxytag: member="irr::gui::IGUIInOutFader::IGUIInOutFader" ref="d839c9be778846aa0fba823c7dd30c69" args="(IGUIEnvironment *environment, IGUIElement *parent, s32 id, core::rect< s32 > rectangle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">irr::gui::IGUIInOutFader::IGUIInOutFader </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_environment.html">IGUIEnvironment</a> * </td>
<td class="paramname"> <em>environment</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classirr_1_1gui_1_1_i_g_u_i_element.html">IGUIElement</a> * </td>
<td class="paramname"> <em>parent</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceirr.html#c66849b7a6ed16e30ebede579f9b47c6">s32</a> </td>
<td class="paramname"> <em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classirr_1_1core_1_1rect.html">core::rect</a>< <a class="el" href="namespaceirr.html#c66849b7a6ed16e30ebede579f9b47c6">s32</a> > </td>
<td class="paramname"> <em>rectangle</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
constructor
<p>
<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>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="407edab8f7e349612d62c39accc159e2"></a><!-- doxytag: member="irr::gui::IGUIInOutFader::fadeIn" ref="407edab8f7e349612d62c39accc159e2" args="(u32 time)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void irr::gui::IGUIInOutFader::fadeIn </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceirr.html#0416a53257075833e7002efd0a18e804">u32</a> </td>
<td class="paramname"> <em>time</em> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Starts the fade in process.
<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. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>time,:</em> </td><td>Time specifing how long it should need to fade in, in milliseconds. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="5006c28699050d73be11b15ffc7ba993"></a><!-- doxytag: member="irr::gui::IGUIInOutFader::fadeOut" ref="5006c28699050d73be11b15ffc7ba993" args="(u32 time)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void irr::gui::IGUIInOutFader::fadeOut </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceirr.html#0416a53257075833e7002efd0a18e804">u32</a> </td>
<td class="paramname"> <em>time</em> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Starts the fade out process.
<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. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>time,:</em> </td><td>Time specifing how long it should need to fade out, in milliseconds. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="deed9c5ffd4b9ab6180cba40596742b9"></a><!-- doxytag: member="irr::gui::IGUIInOutFader::getColor" ref="deed9c5ffd4b9ab6180cba40596742b9" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classirr_1_1video_1_1_s_color.html">video::SColor</a> irr::gui::IGUIInOutFader::getColor </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Gets the color to fade out to or to fade in from.
<p>
</div>
</div><p>
<a class="anchor" name="8a917f7c5c74ff0bdb2ba844f1953387"></a><!-- doxytag: member="irr::gui::IGUIInOutFader::isReady" ref="8a917f7c5c74ff0bdb2ba844f1953387" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool irr::gui::IGUIInOutFader::isReady </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns if the fade in or out process is done.
<p>
</div>
</div><p>
<a class="anchor" name="8921fcc159f144a31d67b78561e58906"></a><!-- doxytag: member="irr::gui::IGUIInOutFader::setColor" ref="8921fcc159f144a31d67b78561e58906" args="(video::SColor source, video::SColor dest)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void irr::gui::IGUIInOutFader::setColor </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classirr_1_1video_1_1_s_color.html">video::SColor</a> </td>
<td class="paramname"> <em>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classirr_1_1video_1_1_s_color.html">video::SColor</a> </td>
<td class="paramname"> <em>dest</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="ba1cdb4928662a2340aa6600850e03d1"></a><!-- doxytag: member="irr::gui::IGUIInOutFader::setColor" ref="ba1cdb4928662a2340aa6600850e03d1" args="(video::SColor color)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void irr::gui::IGUIInOutFader::setColor </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classirr_1_1video_1_1_s_color.html">video::SColor</a> </td>
<td class="paramname"> <em>color</em> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the color to fade out to or to fade in from.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>color,:</em> </td><td>Color to where it is faded out od from it is faded in. </td></tr>
</table>
</dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="_i_g_u_i_in_out_fader_8h-source.html">IGUIInOutFader.h</a></ul>
</div>
<hr size="1">
<address style="align: right;">
<small> </small>
</address>
<table width="100%" border="0" cellspacing="0" cellpadding="2">
<tr>
<td width="0"> <div align="left"><small><a href="http://irrlicht.sourceforge.net" target="_blank"><img src="irrlicht.png" alt="The Irrlicht Engine" align="middle" border=0 width=88 height=31></a></small></div></td>
<td> <div align="left"><small><em><font size="2">The <a href="http://irrlicht.sourceforge.net" target="_blank">Irrlicht
Engine</a> Documentation © 2003-2009 by Nikolaus Gebhardt. Generated
on Sun Jan 10 09:24:11 2010 by <a href="http://www.doxygen.org" target="_blank">Doxygen</a>
(1.5.6)</font></em></small></div></td>
</tr>
</table>
<address style="align: right;">
</address>
</body>
</html>
distrib
>
Mandriva
>
2010.1
>
x86_64
>
media
>
contrib-release
>
by-pkgid
>
58828b263d8f56d90ac336dea07a4586
>
files
>
432
