<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>edelib: AnimateBox Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">edelib
 <span id="projectnumber">2.0.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.6.1 -->
<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="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceedelib.html">edelib</a> </li>
<li class="navelem"><a class="el" href="classedelib_1_1AnimateBox.html">AnimateBox</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">AnimateBox Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="edelib::AnimateBox" -->
<p>Animate list of images inside box.
<a href="classedelib_1_1AnimateBox.html#details">More...</a></p>
<p><code>#include <<a class="el" href="AnimateBox_8h_source.html">edelib/AnimateBox.h</a>></code></p>
<p><a href="classedelib_1_1AnimateBox-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1AnimateBox.html#a31cce128abc94a5a1f0f3a520a1072ac">AnimateBox</a> (int X, int Y, int W, int H, const char *l=0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1AnimateBox.html#a039e5951a6cb3af8cff2144ec5917221">~AnimateBox</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1AnimateBox.html#aae517f420f5ea33724cbd2e7cfe622d9">append</a> (Fl_Image *img)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1AnimateBox.html#a7528791cca637e335a8dcfd4b52c3701">append</a> (const char *path)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1AnimateBox.html#ab5f2cf4299f20543e2834d2aad6fb7a3">rate</a> (float r)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1AnimateBox.html#a26566ba8cbac8c75c1bc90ff99261fca">rate</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1AnimateBox.html#a03718a6e02cf410ac564c01af5fb18b4">next_image</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1AnimateBox.html#a96e3363757479639eee24534fc112070">start_animation</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1AnimateBox.html#a5925ac86f3d214a4dea9440ea7449223">stop_animation</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1AnimateBox.html#ab6d4819b357924235f1245201d3eca8c">rollover</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1AnimateBox.html#a303d61573dbd96797a73ae6e22a3a2c8">animate_on_show</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classedelib_1_1AnimateBox.html#ae8c8a4da41bd04ab09e3d7d04dd2d162">handle</a> (int e)</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Animate list of images inside box. </p>
<p>Load a list of images (any type FLTK supports) and display animation in loaded order. The images will be shown as is, without any transition between the images, so for fluid animation, make sure to use larger number of images.</p>
<p>Inspired from <a href="http://seriss.com/people/erco/fltk/#Animate">Erco's animate example</a>. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a31cce128abc94a5a1f0f3a520a1072ac"></a><!-- doxytag: member="edelib::AnimateBox::AnimateBox" ref="a31cce128abc94a5a1f0f3a520a1072ac" args="(int X, int Y, int W, int H, const char *l=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classedelib_1_1AnimateBox.html">AnimateBox</a> </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>X</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>Y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>W</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>H</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>l</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor. </p>
</div>
</div>
<a class="anchor" id="a039e5951a6cb3af8cff2144ec5917221"></a><!-- doxytag: member="edelib::AnimateBox::~AnimateBox" ref="a039e5951a6cb3af8cff2144ec5917221" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">~<a class="el" href="classedelib_1_1AnimateBox.html">AnimateBox</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Clean loaded images. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a303d61573dbd96797a73ae6e22a3a2c8"></a><!-- doxytag: member="edelib::AnimateBox::animate_on_show" ref="a303d61573dbd96797a73ae6e22a3a2c8" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classedelib_1_1AnimateBox.html#a303d61573dbd96797a73ae6e22a3a2c8">animate_on_show</a> </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Widget will perform animation as soon is shown. </p>
</div>
</div>
<a class="anchor" id="aae517f420f5ea33724cbd2e7cfe622d9"></a><!-- doxytag: member="edelib::AnimateBox::append" ref="aae517f420f5ea33724cbd2e7cfe622d9" args="(Fl_Image *img)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classedelib_1_1AnimateBox.html#aae517f420f5ea33724cbd2e7cfe622d9">append</a> </td>
<td>(</td>
<td class="paramtype">Fl_Image * </td>
<td class="paramname"><em>img</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Append image. </p>
</div>
</div>
<a class="anchor" id="a7528791cca637e335a8dcfd4b52c3701"></a><!-- doxytag: member="edelib::AnimateBox::append" ref="a7528791cca637e335a8dcfd4b52c3701" args="(const char *path)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classedelib_1_1AnimateBox.html#aae517f420f5ea33724cbd2e7cfe622d9">append</a> </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>path</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Load image from given path and add it. If path or image is unreadable, returns false. </p>
</div>
</div>
<a class="anchor" id="ae8c8a4da41bd04ab09e3d7d04dd2d162"></a><!-- doxytag: member="edelib::AnimateBox::handle" ref="ae8c8a4da41bd04ab09e3d7d04dd2d162" args="(int e)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="classedelib_1_1AnimateBox.html#ae8c8a4da41bd04ab09e3d7d04dd2d162">handle</a> </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>e</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Event handler. </p>
</div>
</div>
<a class="anchor" id="a03718a6e02cf410ac564c01af5fb18b4"></a><!-- doxytag: member="edelib::AnimateBox::next_image" ref="a03718a6e02cf410ac564c01af5fb18b4" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classedelib_1_1AnimateBox.html#a03718a6e02cf410ac564c01af5fb18b4">next_image</a> </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Draw next image. Should not be used directly, as <a class="el" href="classedelib_1_1AnimateBox.html" title="Animate list of images inside box.">AnimateBox</a> uses it in internally. </p>
</div>
</div>
<a class="anchor" id="ab5f2cf4299f20543e2834d2aad6fb7a3"></a><!-- doxytag: member="edelib::AnimateBox::rate" ref="ab5f2cf4299f20543e2834d2aad6fb7a3" args="(float r)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classedelib_1_1AnimateBox.html#ab5f2cf4299f20543e2834d2aad6fb7a3">rate</a> </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>r</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set draw rate (how long to show single image). </p>
</div>
</div>
<a class="anchor" id="a26566ba8cbac8c75c1bc90ff99261fca"></a><!-- doxytag: member="edelib::AnimateBox::rate" ref="a26566ba8cbac8c75c1bc90ff99261fca" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float <a class="el" href="classedelib_1_1AnimateBox.html#ab5f2cf4299f20543e2834d2aad6fb7a3">rate</a> </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get draw rate. </p>
</div>
</div>
<a class="anchor" id="ab6d4819b357924235f1245201d3eca8c"></a><!-- doxytag: member="edelib::AnimateBox::rollover" ref="ab6d4819b357924235f1245201d3eca8c" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classedelib_1_1AnimateBox.html#ab6d4819b357924235f1245201d3eca8c">rollover</a> </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Force animation starts from first frame. </p>
</div>
</div>
<a class="anchor" id="a96e3363757479639eee24534fc112070"></a><!-- doxytag: member="edelib::AnimateBox::start_animation" ref="a96e3363757479639eee24534fc112070" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classedelib_1_1AnimateBox.html#a96e3363757479639eee24534fc112070">start_animation</a> </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Start animation. </p>
</div>
</div>
<a class="anchor" id="a5925ac86f3d214a4dea9440ea7449223"></a><!-- doxytag: member="edelib::AnimateBox::stop_animation" ref="a5925ac86f3d214a4dea9440ea7449223" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classedelib_1_1AnimateBox.html#a5925ac86f3d214a4dea9440ea7449223">stop_animation</a> </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Stop animation. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>edelib/<a class="el" href="AnimateBox_8h_source.html">AnimateBox.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Jun 5 2012 17:49:02 for edelib by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.6.1
</small></address>
</body>
</html>
