<html>
<head>
<title>Cal3D: CalAnimation Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head>
<body bgcolor="#ffffff">
<table width="100%" border="0" cellspacing="0" cellpadding="5" align="center">
<tr>
<td class="md" align="center">
<small>
<b>- Cal3D 0.11 API Reference -</b>
</small>
</td>
</tr>
</table>
<br>
<!-- Generated by Doxygen 1.7.3 -->
<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 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="classes.html"><span>Class Index</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>
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> </div>
<div class="headertitle">
<h1>CalAnimation Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="CalAnimation" --><div class="dynheader">
Inheritance diagram for CalAnimation:</div>
<div class="dyncontent">
<div class="center">
<img src="classCalAnimation.png" usemap="#CalAnimation_map" alt=""/>
<map id="CalAnimation_map" name="CalAnimation_map">
<area href="classCalAnimationAction.html" alt="CalAnimationAction" shape="rect" coords="0,56,122,80"/>
<area href="classCalAnimationCycle.html" alt="CalAnimationCycle" shape="rect" coords="132,56,254,80"/>
</map>
</div></div>
<p><a href="classCalAnimation-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><b>Type</b> { <b>TYPE_NONE</b> = 0,
<b>TYPE_CYCLE</b>,
<b>TYPE_POSE</b>,
<b>TYPE_ACTION</b>
}</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><b>State</b> { <br/>
  <b>STATE_NONE</b> = 0,
<b>STATE_SYNC</b>,
<b>STATE_ASYNC</b>,
<b>STATE_IN</b>,
<br/>
  <b>STATE_STEADY</b>,
<b>STATE_OUT</b>,
<b>STATE_STOPPED</b>
<br/>
}</td></tr>
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCalCoreAnimation.html">CalCoreAnimation</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalAnimation.html#a99307c9fed6acfb885dfb27b8b03e260">getCoreAnimation</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the core animation. <a href="#a99307c9fed6acfb885dfb27b8b03e260"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">State </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalAnimation.html#ac354628a93632bd10e128bb5a2ddce76">getState</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the state. <a href="#ac354628a93632bd10e128bb5a2ddce76"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalAnimation.html#a7455fd118494ff182797e22cf3e981c8">getTime</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the time. <a href="#a7455fd118494ff182797e22cf3e981c8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">Type </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalAnimation.html#a70ca6e25089f167d08288662d387827e">getType</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the type. <a href="#a70ca6e25089f167d08288662d387827e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalAnimation.html#a0bea860b01f07c84c99f6661993c12b7">getWeight</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the weight. <a href="#a0bea860b01f07c84c99f6661993c12b7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalAnimation.html#a09007a6ae75127005733a63ff01ad907">setTime</a> (float time)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the time. <a href="#a09007a6ae75127005733a63ff01ad907"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalAnimation.html#a74c5aa62bb7f12bb5c9d9ea2020bffae">setTimeFactor</a> (float timeFactor)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the time factor. <a href="#a74c5aa62bb7f12bb5c9d9ea2020bffae"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalAnimation.html#aae33069d58a2bced9249a7d8ed69acbb">getTimeFactor</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the time factor. <a href="#aae33069d58a2bced9249a7d8ed69acbb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a644dab3b8488809d139eb228566c0e21"></a><!-- doxytag: member="CalAnimation::checkCallbacks" ref="a644dab3b8488809d139eb228566c0e21" args="(float animationTime, CalModel *model)" -->
void </td><td class="memItemRight" valign="bottom"><b>checkCallbacks</b> (float animationTime, <a class="el" href="classCalModel.html">CalModel</a> *model)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a643060bcd44c82efabc0728fb97027bf"></a><!-- doxytag: member="CalAnimation::completeCallbacks" ref="a643060bcd44c82efabc0728fb97027bf" args="(CalModel *model)" -->
void </td><td class="memItemRight" valign="bottom"><b>completeCallbacks</b> (<a class="el" href="classCalModel.html">CalModel</a> *model)</td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5ab1517e1993c016a44b12467590042a"></a><!-- doxytag: member="CalAnimation::CalAnimation" ref="a5ab1517e1993c016a44b12467590042a" args="(CalCoreAnimation *pCoreAnimation)" -->
 </td><td class="memItemRight" valign="bottom"><b>CalAnimation</b> (<a class="el" href="classCalCoreAnimation.html">CalCoreAnimation</a> *pCoreAnimation)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab06a87b7dd0731eacf04ce4a836c81dc"></a><!-- doxytag: member="CalAnimation::setType" ref="ab06a87b7dd0731eacf04ce4a836c81dc" args="(Type type)" -->
void </td><td class="memItemRight" valign="bottom"><b>setType</b> (Type type)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a21bbf3e2b84c9a1a15bc2eb0dd5d0c5c"></a><!-- doxytag: member="CalAnimation::setState" ref="a21bbf3e2b84c9a1a15bc2eb0dd5d0c5c" args="(State state)" -->
void </td><td class="memItemRight" valign="bottom"><b>setState</b> (State state)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a278079e68d9626decf63d4d227871c2b"></a><!-- doxytag: member="CalAnimation::setWeight" ref="a278079e68d9626decf63d4d227871c2b" args="(float weight)" -->
void </td><td class="memItemRight" valign="bottom"><b>setWeight</b> (float weight)</td></tr>
</table>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a99307c9fed6acfb885dfb27b8b03e260"></a><!-- doxytag: member="CalAnimation::getCoreAnimation" ref="a99307c9fed6acfb885dfb27b8b03e260" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCalCoreAnimation.html">CalCoreAnimation</a> * CalAnimation::getCoreAnimation </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Provides access to the core animation. </p>
<p>This function returns the core animation on which this animation instance is based on.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>One of the following values: <ul>
<li>a pointer to the core animation </li>
<li><b>0</b> if an error happend </li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="ac354628a93632bd10e128bb5a2ddce76"></a><!-- doxytag: member="CalAnimation::getState" ref="ac354628a93632bd10e128bb5a2ddce76" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CalAnimation::State CalAnimation::getState </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the state. </p>
<p>This function returns the state of the animation instance.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>One of the following states: <ul>
<li><b>STATE_NONE</b> </li>
<li><b>STATE_SYNC</b> </li>
<li><b>STATE_ASYNC</b> </li>
<li><b>STATE_IN</b> </li>
<li><b>STATE_STEADY</b> </li>
<li><b>STATE_OUT</b> </li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="a7455fd118494ff182797e22cf3e981c8"></a><!-- doxytag: member="CalAnimation::getTime" ref="a7455fd118494ff182797e22cf3e981c8" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float CalAnimation::getTime </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the time. </p>
<p>This function returns the time of the animation instance.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The time in seconds. </dd></dl>
</div>
</div>
<a class="anchor" id="aae33069d58a2bced9249a7d8ed69acbb"></a><!-- doxytag: member="CalAnimation::getTimeFactor" ref="aae33069d58a2bced9249a7d8ed69acbb" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float CalAnimation::getTimeFactor </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the time factor. </p>
<p>This function return the time factor of the animation instance. </p>
</div>
</div>
<a class="anchor" id="a70ca6e25089f167d08288662d387827e"></a><!-- doxytag: member="CalAnimation::getType" ref="a70ca6e25089f167d08288662d387827e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CalAnimation::Type CalAnimation::getType </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the type. </p>
<p>This function returns the type of the animation instance.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>One of the following types: <ul>
<li><b>TYPE_NONE</b> </li>
<li><b>TYPE_CYCLE</b> </li>
<li><b>TYPE_POSE</b> </li>
<li><b>TYPE_ACTION</b> </li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="a0bea860b01f07c84c99f6661993c12b7"></a><!-- doxytag: member="CalAnimation::getWeight" ref="a0bea860b01f07c84c99f6661993c12b7" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float CalAnimation::getWeight </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the weight. </p>
<p>This function returns the weight of the animation instance.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The weight. </dd></dl>
</div>
</div>
<a class="anchor" id="a09007a6ae75127005733a63ff01ad907"></a><!-- doxytag: member="CalAnimation::setTime" ref="a09007a6ae75127005733a63ff01ad907" args="(float time)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CalAnimation::setTime </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>time</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the time. </p>
<p>This function set the time of the animation instance. </p>
</div>
</div>
<a class="anchor" id="a74c5aa62bb7f12bb5c9d9ea2020bffae"></a><!-- doxytag: member="CalAnimation::setTimeFactor" ref="a74c5aa62bb7f12bb5c9d9ea2020bffae" args="(float timeFactor)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CalAnimation::setTimeFactor </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>timeFactor</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the time factor. </p>
<p>This function sets the time factor of the animation instance. this time factor affect only sync animation </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="animation_8h_source.html">animation.h</a></li>
<li>animation.cpp</li>
</ul>
</div>
<hr>
<center>
<small>
Generated at Tue Feb 8 2011 08:51:45 by
<a href="http://gna.org/projects/cal3d/">The Cal3D Team</a>
with
<a href="http://www.doxygen.org/index.html">
Doxygen 1.7.3
</a>
</small>
</center>
</body>
</html>
