<html>
<head>
<title>Cal3D: CalCoreKeyframe 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.5.9 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<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 class="tabs">
<ul>
<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="contents">
<h1>CalCoreKeyframe Class Reference</h1><!-- doxytag: class="CalCoreKeyframe" -->The core keyframe class.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="corekeyframe_8h_source.html">corekeyframe.h</a>></code>
<p>
<p>
<a href="classCalCoreKeyframe-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalCoreKeyframe.html#a2dadc26cfb0f8ded36b99dd1866513e">CalCoreKeyframe</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructs the core keyframe instance. <a href="#a2dadc26cfb0f8ded36b99dd1866513e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalCoreKeyframe.html#ed8d41bd49a8f2cb90e445db698a7b79">~CalCoreKeyframe</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructs the core keyframe instance. <a href="#ed8d41bd49a8f2cb90e445db698a7b79"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalCoreKeyframe.html#b9bf52835657e39ad90ce4266a8319e8">create</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates the core keyframe instance. <a href="#b9bf52835657e39ad90ce4266a8319e8"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalCoreKeyframe.html#5fd3856cc1b3be2fe580c7b680648189">destroy</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroys the core keyframe instance. <a href="#5fd3856cc1b3be2fe580c7b680648189"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classCalQuaternion.html">CalQuaternion</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalCoreKeyframe.html#14dfeba0e2ee110a14a83574e2a2ee83">getRotation</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the rotation. <a href="#14dfeba0e2ee110a14a83574e2a2ee83"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalCoreKeyframe.html#982d8f7e3a3417ee72b9fa1316e5e6ae">getTime</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the time. <a href="#982d8f7e3a3417ee72b9fa1316e5e6ae"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classCalVector.html">CalVector</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalCoreKeyframe.html#7225229f26cb5fceee97285b40706271">getTranslation</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the translation. <a href="#7225229f26cb5fceee97285b40706271"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalCoreKeyframe.html#906d8d42e386643458bb43ce9576b7b2">setRotation</a> (const <a class="el" href="classCalQuaternion.html">CalQuaternion</a> &rotation)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the rotation. <a href="#906d8d42e386643458bb43ce9576b7b2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalCoreKeyframe.html#39eea9df619c6f456e0888da652f1baf">setTime</a> (float time)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the time. <a href="#39eea9df619c6f456e0888da652f1baf"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalCoreKeyframe.html#48d7194f5363c42543d84aa52f728a8b">setTranslation</a> (const <a class="el" href="classCalVector.html">CalVector</a> &translation)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the translation. <a href="#48d7194f5363c42543d84aa52f728a8b"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2fbc1bb178bdebfdfc9f12ece953caec"></a><!-- doxytag: member="CalCoreKeyframe::m_time" ref="2fbc1bb178bdebfdfc9f12ece953caec" args="" -->
float </td><td class="memItemRight" valign="bottom"><b>m_time</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0f7cd04ec3251375a13823926e220701"></a><!-- doxytag: member="CalCoreKeyframe::m_translation" ref="0f7cd04ec3251375a13823926e220701" args="" -->
<a class="el" href="classCalVector.html">CalVector</a> </td><td class="memItemRight" valign="bottom"><b>m_translation</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0ed853e370a3694b42444d8d54202722"></a><!-- doxytag: member="CalCoreKeyframe::m_rotation" ref="0ed853e370a3694b42444d8d54202722" args="" -->
<a class="el" href="classCalQuaternion.html">CalQuaternion</a> </td><td class="memItemRight" valign="bottom"><b>m_rotation</b></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The core keyframe class. <hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="a2dadc26cfb0f8ded36b99dd1866513e"></a><!-- doxytag: member="CalCoreKeyframe::CalCoreKeyframe" ref="a2dadc26cfb0f8ded36b99dd1866513e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CalCoreKeyframe::CalCoreKeyframe </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructs the core keyframe instance.
<p>
This function is the default constructor of the core keyframe instance.
</div>
</div><p>
<a class="anchor" name="ed8d41bd49a8f2cb90e445db698a7b79"></a><!-- doxytag: member="CalCoreKeyframe::~CalCoreKeyframe" ref="ed8d41bd49a8f2cb90e445db698a7b79" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CalCoreKeyframe::~CalCoreKeyframe </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructs the core keyframe instance.
<p>
This function is the destructor of the core keyframe instance.
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="b9bf52835657e39ad90ce4266a8319e8"></a><!-- doxytag: member="CalCoreKeyframe::create" ref="b9bf52835657e39ad90ce4266a8319e8" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CalCoreKeyframe::create </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Creates the core keyframe instance.
<p>
This function creates the core keyframe instance.<p>
<dl class="return" compact><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><p>
<a class="anchor" name="5fd3856cc1b3be2fe580c7b680648189"></a><!-- doxytag: member="CalCoreKeyframe::destroy" ref="5fd3856cc1b3be2fe580c7b680648189" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CalCoreKeyframe::destroy </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destroys the core keyframe instance.
<p>
This function destroys all data stored in the core keyframe instance and frees all allocated memory.
</div>
</div><p>
<a class="anchor" name="14dfeba0e2ee110a14a83574e2a2ee83"></a><!-- doxytag: member="CalCoreKeyframe::getRotation" ref="14dfeba0e2ee110a14a83574e2a2ee83" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classCalQuaternion.html">CalQuaternion</a> & CalCoreKeyframe::getRotation </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the rotation.
<p>
This function returns the rotation of the core keyframe instance.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The rotation as quaternion. </dd></dl>
</div>
</div><p>
<a class="anchor" name="982d8f7e3a3417ee72b9fa1316e5e6ae"></a><!-- doxytag: member="CalCoreKeyframe::getTime" ref="982d8f7e3a3417ee72b9fa1316e5e6ae" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float CalCoreKeyframe::getTime </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the time.
<p>
This function returns the time of the core keyframe instance.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The time in seconds. </dd></dl>
</div>
</div><p>
<a class="anchor" name="7225229f26cb5fceee97285b40706271"></a><!-- doxytag: member="CalCoreKeyframe::getTranslation" ref="7225229f26cb5fceee97285b40706271" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classCalVector.html">CalVector</a> & CalCoreKeyframe::getTranslation </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the translation.
<p>
This function returns the translation of the core keyframe instance.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The translation as vector. </dd></dl>
</div>
</div><p>
<a class="anchor" name="906d8d42e386643458bb43ce9576b7b2"></a><!-- doxytag: member="CalCoreKeyframe::setRotation" ref="906d8d42e386643458bb43ce9576b7b2" args="(const CalQuaternion &rotation)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CalCoreKeyframe::setRotation </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCalQuaternion.html">CalQuaternion</a> & </td>
<td class="paramname"> <em>rotation</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the rotation.
<p>
This function sets the rotation of the core keyframe instance.<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>rotation</em> </td><td>The rotation as quaternion. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="39eea9df619c6f456e0888da652f1baf"></a><!-- doxytag: member="CalCoreKeyframe::setTime" ref="39eea9df619c6f456e0888da652f1baf" args="(float time)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CalCoreKeyframe::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>
Sets the time.
<p>
This function sets the time of the core keyframe instance.<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>rotation</em> </td><td>The time in seconds. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="48d7194f5363c42543d84aa52f728a8b"></a><!-- doxytag: member="CalCoreKeyframe::setTranslation" ref="48d7194f5363c42543d84aa52f728a8b" args="(const CalVector &translation)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CalCoreKeyframe::setTranslation </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCalVector.html">CalVector</a> & </td>
<td class="paramname"> <em>translation</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the translation.
<p>
This function sets the translation of the core keyframe instance.<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>rotation</em> </td><td>The translation as vector. </td></tr>
</table>
</dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="corekeyframe_8h_source.html">corekeyframe.h</a><li>corekeyframe.cpp</ul>
</div>
<hr>
<center>
<small>
Generated at Fri Jul 24 21:14:57 2009 by
<a href="http://gna.org/projects/cal3d/">The Cal3D Team</a>
with
<a href="http://www.doxygen.org/index.html">
Doxygen 1.5.9
</a>
</small>
</center>
</body>
</html>
