<html>
<head>
<title>Cal3D: CalAnimationAction 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-methods">Public Member Functions</a> </div>
<div class="headertitle">
<h1>CalAnimationAction Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="CalAnimationAction" --><!-- doxytag: inherits="CalAnimation" --><div class="dynheader">
Inheritance diagram for CalAnimationAction:</div>
<div class="dyncontent">
<div class="center">
<img src="classCalAnimationAction.png" usemap="#CalAnimationAction_map" alt=""/>
<map id="CalAnimationAction_map" name="CalAnimationAction_map">
<area href="classCalAnimation.html" alt="CalAnimation" shape="rect" coords="0,0,122,24"/>
</map>
</div></div>
<p><a href="classCalAnimationAction-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="classCalAnimationAction.html#a42cb2f8cd0a2fb0b4a5ddb9d09ec5a6e">CalAnimationAction</a> (<a class="el" href="classCalCoreAnimation.html">CalCoreAnimation</a> *pCoreAnimation)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructs the animation action instance. <a href="#a42cb2f8cd0a2fb0b4a5ddb9d09ec5a6e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalAnimationAction.html#a237839d99fa91c59c3c1aa62cc755565">execute</a> (float delayIn, float delayOut, float weightTarget=1.0f, bool autoLock=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Executes the animation action instance. <a href="#a237839d99fa91c59c3c1aa62cc755565"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalAnimationAction.html#a5c9a054def1415ccc8e925a18ecfba1a">update</a> (float deltaTime)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Updates the animation action instance. <a href="#a5c9a054def1415ccc8e925a18ecfba1a"></a><br/></td></tr>
</table>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a42cb2f8cd0a2fb0b4a5ddb9d09ec5a6e"></a><!-- doxytag: member="CalAnimationAction::CalAnimationAction" ref="a42cb2f8cd0a2fb0b4a5ddb9d09ec5a6e" args="(CalCoreAnimation *pCoreAnimation)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CalAnimationAction::CalAnimationAction </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCalCoreAnimation.html">CalCoreAnimation</a> * </td>
<td class="paramname"><em>pCoreAnimation</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructs the animation action instance. </p>
<p>This function is the default constructor of the animation action instance. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a237839d99fa91c59c3c1aa62cc755565"></a><!-- doxytag: member="CalAnimationAction::execute" ref="a237839d99fa91c59c3c1aa62cc755565" args="(float delayIn, float delayOut, float weightTarget=1.0f, bool autoLock=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CalAnimationAction::execute </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>delayIn</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>delayOut</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>weightTarget</em> = <code>1.0f</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>autoLock</em> = <code>false</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Executes the animation action instance. </p>
<p>This function executes the animation action instance.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">delayIn</td><td>The time in seconds until the animation action instance reaches the full weight from the beginning of its execution. </td></tr>
<tr><td class="paramname">delayOut</td><td>The time in seconds in which the animation action instance reaches zero weight at the end of its execution. </td></tr>
<tr><td class="paramname">weightTarget</td><td>No doxygen comment for this. FIXME. </td></tr>
<tr><td class="paramname">autoLock</td><td>This prevents the Action from being reset and removed on the last keyframe if true.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>One of the following values: <ul>
<li><b>true</b> if successful </li>
<li><b>false</b> if an error happend </li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="a5c9a054def1415ccc8e925a18ecfba1a"></a><!-- doxytag: member="CalAnimationAction::update" ref="a5c9a054def1415ccc8e925a18ecfba1a" args="(float deltaTime)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CalAnimationAction::update </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>deltaTime</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Updates the animation action instance. </p>
<p>This function updates the animation action instance for a given amount of time.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">deltaTime</td><td>The elapsed time in seconds since the last update.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>One of the following values: <ul>
<li><b>true</b> if the animation action instance is still active </li>
<li><b>false</b> if the execution of the animation action instance has ended </li>
</ul>
</dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="animation__action_8h_source.html">animation_action.h</a></li>
<li>animation_action.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>
