<html>
<head>
<title>Ogre::Animation class Reference - OGRE Documentation</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<link type="text/css" rel="stylesheet" href="style.css">
</head>
<body>
<!-- Generated by Doxygen 1.2.16 -->
<center>
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="namespacemembers.html">Namespace Members</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> <a class="qindex" href="pages.html">Related Pages</a> </center>
<hr><h1>Ogre::Animation Class Reference</h1>An animation sequence.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="OgreAnimation_8h-source.html">OgreAnimation.h</a>></code>
<p>
Collaboration diagram for Ogre::Animation:<p><center><img src="classOgre_1_1Animation__coll__graph.png" border="0" usemap="#Ogre_1_1Animation__coll__map" alt="Collaboration graph"></center>
<map name="Ogre_1_1Animation__coll__map">
<area href="classOgre_1_1String.html" shape="rect" coords="19,36,99,17" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classOgre_1_1Animation-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Public Types</h2></td></tr>
<tr><td nowrap align=right valign=top>typedef std::map< unsigned <br>
short, <a class="el" href="classOgre_1_1AnimationTrack.html">AnimationTrack</a> * > </td><td valign=bottom><a class="el" href="classOgre_1_1Animation.html#Ogre_1_1Animations0">TrackList</a></td></tr>
<tr><td nowrap align=right valign=top>enum </td><td valign=bottom><a class="el" href="classOgre_1_1Animation.html#Ogre_1_1Animations3">InterpolationMode</a> { <a class="el" href="classOgre_1_1Animation.html#Ogre_1_1Animations3Ogre_1_1Animations1">IM_LINEAR</a>,
<a class="el" href="classOgre_1_1Animation.html#Ogre_1_1Animations3Ogre_1_1Animations2">IM_SPLINE</a>
}</td></tr>
<tr><td> </td><td><font size=-1><em>The types of animation interpolation available.</em> <a href="#Ogre_1_1Animations3">More...</a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classOgre_1_1Animation.html#Ogre_1_1Animationa0">Animation</a> (const <a class="el" href="classOgre_1_1String.html">String</a> &name, <a class="el" href="namespaceOgre.html#a349">Real</a> length)</td></tr>
<tr><td> </td><td><font size=-1><em>You should not use this constructor directly, use the parent object such as <a class="el" href="classOgre_1_1Skeleton.html">Skeleton</a> instead.</em> <a href="#Ogre_1_1Animationa0"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual </td><td valign=bottom><a class="el" href="classOgre_1_1Animation.html#Ogre_1_1Animationa1">~Animation</a> ()</td></tr>
<tr><td nowrap align=right valign=top>const <a class="el" href="classOgre_1_1String.html">String</a> & </td><td valign=bottom><a class="el" href="classOgre_1_1Animation.html#Ogre_1_1Animationa2">getName</a> (void) const</td></tr>
<tr><td> </td><td><font size=-1><em>Gets the name of this animation.</em> <a href="#Ogre_1_1Animationa2"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a349">Real</a> </td><td valign=bottom><a class="el" href="classOgre_1_1Animation.html#Ogre_1_1Animationa3">getLength</a> (void) const</td></tr>
<tr><td> </td><td><font size=-1><em>Gets the total length of the animation.</em> <a href="#Ogre_1_1Animationa3"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="classOgre_1_1AnimationTrack.html">AnimationTrack</a> * </td><td valign=bottom><a class="el" href="classOgre_1_1Animation.html#Ogre_1_1Animationa4">createTrack</a> (unsigned short handle)</td></tr>
<tr><td> </td><td><font size=-1><em>Creates an <a class="el" href="classOgre_1_1AnimationTrack.html">AnimationTrack</a>.</em> <a href="#Ogre_1_1Animationa4"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="classOgre_1_1AnimationTrack.html">AnimationTrack</a> * </td><td valign=bottom><a class="el" href="classOgre_1_1Animation.html#Ogre_1_1Animationa5">createTrack</a> (unsigned short handle, <a class="el" href="classOgre_1_1Node.html">Node</a> *node)</td></tr>
<tr><td> </td><td><font size=-1><em>Creates a new <a class="el" href="classOgre_1_1AnimationTrack.html">AnimationTrack</a> automatically associated with a <a class="el" href="classOgre_1_1Node.html">Node</a>.</em> <a href="#Ogre_1_1Animationa5"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>unsigned short </td><td valign=bottom><a class="el" href="classOgre_1_1Animation.html#Ogre_1_1Animationa6">getNumTracks</a> (void) const</td></tr>
<tr><td> </td><td><font size=-1><em>Gets the number of <a class="el" href="classOgre_1_1AnimationTrack.html">AnimationTrack</a> objects which make up this animation.</em> <a href="#Ogre_1_1Animationa6"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="classOgre_1_1AnimationTrack.html">AnimationTrack</a> * </td><td valign=bottom><a class="el" href="classOgre_1_1Animation.html#Ogre_1_1Animationa7">getTrack</a> (unsigned short handle) const</td></tr>
<tr><td> </td><td><font size=-1><em>Gets a track by it's handle.</em> <a href="#Ogre_1_1Animationa7"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classOgre_1_1Animation.html#Ogre_1_1Animationa8">destroyTrack</a> (unsigned short handle)</td></tr>
<tr><td> </td><td><font size=-1><em>Destroys the track with the given handle.</em> <a href="#Ogre_1_1Animationa8"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classOgre_1_1Animation.html#Ogre_1_1Animationa9">destroyAllTracks</a> (void)</td></tr>
<tr><td> </td><td><font size=-1><em>Removes and destroys all tracks making up this animation.</em> <a href="#Ogre_1_1Animationa9"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classOgre_1_1Animation.html#Ogre_1_1Animationa10">apply</a> (<a class="el" href="namespaceOgre.html#a349">Real</a> timePos, <a class="el" href="namespaceOgre.html#a349">Real</a> weight=1.0, bool accumulate=false)</td></tr>
<tr><td> </td><td><font size=-1><em>Applies an animation given a specific time point and weight.</em> <a href="#Ogre_1_1Animationa10"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classOgre_1_1Animation.html#Ogre_1_1Animationa11">setInterpolationMode</a> (<a class="el" href="classOgre_1_1Animation.html#Ogre_1_1Animations3">InterpolationMode</a> im)</td></tr>
<tr><td> </td><td><font size=-1><em>Tells the animation how to interpolate between keyframes.</em> <a href="#Ogre_1_1Animationa11"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="classOgre_1_1Animation.html#Ogre_1_1Animations3">InterpolationMode</a> </td><td valign=bottom><a class="el" href="classOgre_1_1Animation.html#Ogre_1_1Animationa12">getInterpolationMode</a> (void) const</td></tr>
<tr><td> </td><td><font size=-1><em>Gets the current interpolation mode of this animation.</em> <a href="#Ogre_1_1Animationa12"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>const <a class="el" href="classOgre_1_1Animation.html#Ogre_1_1Animations0">TrackList</a> & </td><td valign=bottom><a class="el" href="classOgre_1_1Animation.html#Ogre_1_1Animationa13">_getTrackList</a> (void) const</td></tr>
<tr><td> </td><td><font size=-1><em>Fast access to NON-UPDATEABLE track list.</em> <a href="#Ogre_1_1Animationa13"></a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Static Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classOgre_1_1Animation.html#Ogre_1_1Animationd0">setDefaultInterpolationMode</a> (<a class="el" href="classOgre_1_1Animation.html#Ogre_1_1Animations3">InterpolationMode</a> im)</td></tr>
<tr><td> </td><td><font size=-1><em>Sets the default animation interpolation mode.</em> <a href="#Ogre_1_1Animationd0"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="classOgre_1_1Animation.html#Ogre_1_1Animations3">InterpolationMode</a> </td><td valign=bottom><a class="el" href="classOgre_1_1Animation.html#Ogre_1_1Animationd1">getDefaultInterpolationMode</a> (void)</td></tr>
<tr><td> </td><td><font size=-1><em>Gets the default interpolation mode for all animations.</em> <a href="#Ogre_1_1Animationd1"></a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="classOgre_1_1Animation.html#Ogre_1_1Animations0">TrackList</a> </td><td valign=bottom><a class="el" href="classOgre_1_1Animation.html#Ogre_1_1Animationn0">mTrackList</a></td></tr>
<tr><td> </td><td><font size=-1><em>Tracks, indexed by handle.</em> <a href="#Ogre_1_1Animationn0"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="classOgre_1_1String.html">String</a> </td><td valign=bottom><a class="el" href="classOgre_1_1Animation.html#Ogre_1_1Animationn1">mName</a></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a349">Real</a> </td><td valign=bottom><a class="el" href="classOgre_1_1Animation.html#Ogre_1_1Animationn2">mLength</a></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="classOgre_1_1Animation.html#Ogre_1_1Animations3">InterpolationMode</a> </td><td valign=bottom><a class="el" href="classOgre_1_1Animation.html#Ogre_1_1Animationn3">mInterpolationMode</a></td></tr>
<tr><td colspan=2><br><h2>Static Protected Attributes</h2></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="classOgre_1_1Animation.html#Ogre_1_1Animations3">InterpolationMode</a> </td><td valign=bottom><a class="el" href="classOgre_1_1Animation.html#Ogre_1_1Animationq0">msDefaultInterpolationMode</a> = Animation::IM_LINEAR</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
An animation sequence.
<p>
<dl compact><dt><b>
Remarks: </b><dd>
This class defines the interface for a sequence of animation, whether that be animation of a mesh, a path along a spline, or possibly more than one type of animation in one. An animation is made up of many 'tracks', which are the more specific types of animation.
<p>
You should not create these animations directly. They will be created via a parent object which owns the animation, e.g. <a class="el" href="classOgre_1_1Skeleton.html">Skeleton</a>. </dl>
<p>
<p>
Definition at line <a class="el" href="OgreAnimation_8h-source.html#l00044">44</a> of file <a class="el" href="OgreAnimation_8h-source.html">OgreAnimation.h</a>.<hr><h2>Member Typedef Documentation</h2>
<a name="Ogre_1_1Animations0" doxytag="Ogre::Animation::TrackList"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> typedef std::map<unsigned short, <a class="el" href="classOgre_1_1AnimationTrack.html">AnimationTrack</a>*> Ogre::Animation::TrackList
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="OgreAnimation_8h-source.html#l00143">143</a> of file <a class="el" href="OgreAnimation_8h-source.html">OgreAnimation.h</a>. </td>
</tr>
</table>
<hr><h2>Member Enumeration Documentation</h2>
<a name="Ogre_1_1Animations3" doxytag="Ogre::Animation::InterpolationMode"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> enum Ogre::Animation::InterpolationMode
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
The types of animation interpolation available.
<p>
<dl compact><dt><b>
Enumeration values:</b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em><a name="Ogre_1_1Animations3Ogre_1_1Animations1" doxytag="IM_LINEAR"></a><em>IM_LINEAR</em></em> </td><td>
Values are interpolated along straight lines.</td></tr>
<tr><td valign=top><em><a name="Ogre_1_1Animations3Ogre_1_1Animations2" doxytag="IM_SPLINE"></a><em>IM_SPLINE</em></em> </td><td>
Values are interpolated along a spline, resulting in smoother changes in direction.</td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="OgreAnimation_8h-source.html#l00049">49</a> of file <a class="el" href="OgreAnimation_8h-source.html">OgreAnimation.h</a>. </td>
</tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a name="Ogre_1_1Animationa0" doxytag="Ogre::Animation::Animation"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> Ogre::Animation::Animation </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1String.html">String</a> & </td>
<td class="mdname" nowrap> <em>name</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="namespaceOgre.html#a349">Real</a> </td>
<td class="mdname" nowrap> <em>length</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
You should not use this constructor directly, use the parent object such as <a class="el" href="classOgre_1_1Skeleton.html">Skeleton</a> instead.
<p>
<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>name</em> </td><td>
The name of the animation, should be unique within it's parent (e.g. <a class="el" href="classOgre_1_1Skeleton.html">Skeleton</a>) </td></tr>
<tr><td valign=top><em>length</em> </td><td>
The length of the animation in seconds. </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="OgreAnimation_8cpp-source.html#l00035">35</a> of file <a class="el" href="OgreAnimation_8cpp-source.html">OgreAnimation.cpp</a>.
<p>
References <a class="el" href="OgreAnimation_8h-source.html#l00157">mInterpolationMode</a>, and <a class="el" href="OgrePrerequisites_8h-source.html#l00086">Ogre::Real</a>. </td>
</tr>
</table>
<a name="Ogre_1_1Animationa1" doxytag="Ogre::Animation::~Animation"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> Ogre::Animation::~Animation </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="OgreAnimation_8cpp-source.html#l00040">40</a> of file <a class="el" href="OgreAnimation_8cpp-source.html">OgreAnimation.cpp</a>.
<p>
References <a class="el" href="OgreAnimation_8cpp-source.html#l00098">destroyAllTracks</a>(). </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="Ogre_1_1Animationa13" doxytag="Ogre::Animation::_getTrackList"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> const <a class="el" href="classOgre_1_1Animation.html#Ogre_1_1Animations0">Animation::TrackList</a> & Ogre::Animation::_getTrackList </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Fast access to NON-UPDATEABLE track list.
<p>
<p>
Definition at line <a class="el" href="OgreAnimation_8cpp-source.html#l00144">144</a> of file <a class="el" href="OgreAnimation_8cpp-source.html">OgreAnimation.cpp</a>.
<p>
References <a class="el" href="OgreAnimation_8h-source.html#l00152">mTrackList</a>.
<p>
Referenced by <a class="el" href="OgreSceneManager_8cpp-source.html#l01574">Ogre::SceneManager::_applySceneAnimations</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1Animationa10" doxytag="Ogre::Animation::apply"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Ogre::Animation::apply </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a349">Real</a> </td>
<td class="mdname" nowrap> <em>timePos</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="namespaceOgre.html#a349">Real</a> </td>
<td class="mdname" nowrap> <em>weight</em> = 1.0, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>accumulate</em> = false</td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Applies an animation given a specific time point and weight.
<p>
<dl compact><dt><b>
Remarks: </b><dd>
Where you have associated animation tracks with <a class="el" href="classOgre_1_1Node.html">Node</a> objects, you can eaily apply an animation to those nodes by calling this method. </dl><dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>timePos</em> </td><td>
The time position in the animation to apply. </td></tr>
<tr><td valign=top><em>weight</em> </td><td>
The influence to give to this track, 1.0 for full influence, less to blend with other animations. </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="OgreAnimation_8cpp-source.html#l00113">113</a> of file <a class="el" href="OgreAnimation_8cpp-source.html">OgreAnimation.cpp</a>.
<p>
References <a class="el" href="OgreAnimation_8h-source.html#l00152">mTrackList</a>, and <a class="el" href="OgrePrerequisites_8h-source.html#l00086">Ogre::Real</a>.
<p>
Referenced by <a class="el" href="OgreSceneManager_8cpp-source.html#l01574">Ogre::SceneManager::_applySceneAnimations</a>(), and <a class="el" href="OgreSkeleton_8cpp-source.html#l00214">Ogre::Skeleton::setAnimationState</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1Animationa5" doxytag="Ogre::Animation::createTrack"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1AnimationTrack.html">AnimationTrack</a> * Ogre::Animation::createTrack </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">unsigned short </td>
<td class="mdname" nowrap> <em>handle</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="classOgre_1_1Node.html">Node</a> * </td>
<td class="mdname" nowrap> <em>node</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Creates a new <a class="el" href="classOgre_1_1AnimationTrack.html">AnimationTrack</a> automatically associated with a <a class="el" href="classOgre_1_1Node.html">Node</a>.
<p>
<dl compact><dt><b>
Remarks: </b><dd>
This method creates a standard <a class="el" href="classOgre_1_1AnimationTrack.html">AnimationTrack</a>, but also associates it with a target <a class="el" href="classOgre_1_1Node.html">Node</a> which will receive all keyframe effects. </dl><dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>handle</em> </td><td>
Numeric handle to give the track, used for accessing the track later. Must be unique within this <a class="el" href="classOgre_1_1Animation.html">Animation</a>. </td></tr>
<tr><td valign=top><em>node</em> </td><td>
A pointer to the <a class="el" href="classOgre_1_1Node.html">Node</a> object which will be affected by this track </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="OgreAnimation_8cpp-source.html#l00060">60</a> of file <a class="el" href="OgreAnimation_8cpp-source.html">OgreAnimation.cpp</a>.
<p>
References <a class="el" href="OgreAnimation_8cpp-source.html#l00050">createTrack</a>(), and <a class="el" href="OgreAnimationTrack_8cpp-source.html#l00280">Ogre::AnimationTrack::setAssociatedNode</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1Animationa4" doxytag="Ogre::Animation::createTrack"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1AnimationTrack.html">AnimationTrack</a> * Ogre::Animation::createTrack </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">unsigned short </td>
<td class="mdname1" valign="top" nowrap> <em>handle</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Creates an <a class="el" href="classOgre_1_1AnimationTrack.html">AnimationTrack</a>.
<p>
<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>handle</em> </td><td>
Numeric handle to give the track, used for accessing the track later. Must be unique within this <a class="el" href="classOgre_1_1Animation.html">Animation</a>. </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="OgreAnimation_8cpp-source.html#l00050">50</a> of file <a class="el" href="OgreAnimation_8cpp-source.html">OgreAnimation.cpp</a>.
<p>
References <a class="el" href="OgreAnimation_8h-source.html#l00152">mTrackList</a>.
<p>
Referenced by <a class="el" href="OgreAnimation_8cpp-source.html#l00060">createTrack</a>(), and <a class="el" href="OgreSkeletonSerializer_8cpp-source.html#l00375">Ogre::SkeletonSerializer::readAnimationTrack</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1Animationa9" doxytag="Ogre::Animation::destroyAllTracks"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Ogre::Animation::destroyAllTracks </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Removes and destroys all tracks making up this animation.
<p>
<p>
Definition at line <a class="el" href="OgreAnimation_8cpp-source.html#l00098">98</a> of file <a class="el" href="OgreAnimation_8cpp-source.html">OgreAnimation.cpp</a>.
<p>
References <a class="el" href="OgreAnimation_8h-source.html#l00152">mTrackList</a>.
<p>
Referenced by <a class="el" href="OgreAnimation_8cpp-source.html#l00040">~Animation</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1Animationa8" doxytag="Ogre::Animation::destroyTrack"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Ogre::Animation::destroyTrack </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">unsigned short </td>
<td class="mdname1" valign="top" nowrap> <em>handle</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Destroys the track with the given handle.
<p>
<p>
Definition at line <a class="el" href="OgreAnimation_8cpp-source.html#l00089">89</a> of file <a class="el" href="OgreAnimation_8cpp-source.html">OgreAnimation.cpp</a>.
<p>
References <a class="el" href="OgreAnimation_8h-source.html#l00152">mTrackList</a>. </td>
</tr>
</table>
<a name="Ogre_1_1Animationd1" doxytag="Ogre::Animation::getDefaultInterpolationMode"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1Animation.html#Ogre_1_1Animations3">Animation::InterpolationMode</a> Ogre::Animation::getDefaultInterpolationMode </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap><code> [static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Gets the default interpolation mode for all animations.
<p>
<p>
Definition at line <a class="el" href="OgreAnimation_8cpp-source.html#l00139">139</a> of file <a class="el" href="OgreAnimation_8cpp-source.html">OgreAnimation.cpp</a>.
<p>
References <a class="el" href="OgreAnimation_8cpp-source.html#l00033">msDefaultInterpolationMode</a>. </td>
</tr>
</table>
<a name="Ogre_1_1Animationa12" doxytag="Ogre::Animation::getInterpolationMode"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1Animation.html#Ogre_1_1Animations3">Animation::InterpolationMode</a> Ogre::Animation::getInterpolationMode </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Gets the current interpolation mode of this animation.
<p>
<dl compact><dt><b>
Remarks: </b><dd>
See setInterpolationMode for more info. </dl>
<p>
Definition at line <a class="el" href="OgreAnimation_8cpp-source.html#l00129">129</a> of file <a class="el" href="OgreAnimation_8cpp-source.html">OgreAnimation.cpp</a>.
<p>
References <a class="el" href="OgreAnimation_8h-source.html#l00157">mInterpolationMode</a>.
<p>
Referenced by <a class="el" href="OgreAnimationTrack_8cpp-source.html#l00200">Ogre::AnimationTrack::getInterpolatedKeyFrame</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1Animationa3" doxytag="Ogre::Animation::getLength"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a349">Real</a> Ogre::Animation::getLength </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Gets the total length of the animation.
<p>
<p>
Definition at line <a class="el" href="OgreAnimation_8cpp-source.html#l00045">45</a> of file <a class="el" href="OgreAnimation_8cpp-source.html">OgreAnimation.cpp</a>.
<p>
References <a class="el" href="OgreAnimation_8h-source.html#l00155">mLength</a>, and <a class="el" href="OgrePrerequisites_8h-source.html#l00086">Ogre::Real</a>.
<p>
Referenced by <a class="el" href="OgreSkeleton_8cpp-source.html#l00457">Ogre::Skeleton::_dumpContents</a>(), <a class="el" href="OgreSkeleton_8cpp-source.html#l00341">Ogre::Skeleton::_initAnimationState</a>(), <a class="el" href="OgreSceneManager_8cpp-source.html#l01501">Ogre::SceneManager::createAnimationState</a>(), <a class="el" href="OgreAnimationTrack_8cpp-source.html#l00075">Ogre::AnimationTrack::getKeyFramesAtTime</a>(), and <a class="el" href="OgreSkeletonSerializer_8cpp-source.html#l00166">Ogre::SkeletonSerializer::writeAnimation</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1Animationa2" doxytag="Ogre::Animation::getName"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> const <a class="el" href="classOgre_1_1String.html">String</a> & Ogre::Animation::getName </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Gets the name of this animation.
<p>
<p>
Definition at line <a class="el" href="OgreAnimation_8cpp-source.html#l00108">108</a> of file <a class="el" href="OgreAnimation_8cpp-source.html">OgreAnimation.cpp</a>.
<p>
References <a class="el" href="OgreAnimation_8h-source.html#l00153">mName</a>.
<p>
Referenced by <a class="el" href="OgreSkeleton_8cpp-source.html#l00457">Ogre::Skeleton::_dumpContents</a>(), <a class="el" href="OgreSkeleton_8cpp-source.html#l00341">Ogre::Skeleton::_initAnimationState</a>(), <a class="el" href="OgreSkeletonSerializer_8cpp-source.html#l00246">Ogre::SkeletonSerializer::calcAnimationSize</a>(), <a class="el" href="OgreSkeletonSerializer_8cpp-source.html#l00056">Ogre::SkeletonSerializer::exportSkeleton</a>(), and <a class="el" href="OgreSkeletonSerializer_8cpp-source.html#l00166">Ogre::SkeletonSerializer::writeAnimation</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1Animationa6" doxytag="Ogre::Animation::getNumTracks"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> unsigned short Ogre::Animation::getNumTracks </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Gets the number of <a class="el" href="classOgre_1_1AnimationTrack.html">AnimationTrack</a> objects which make up this animation.
<p>
<p>
Definition at line <a class="el" href="OgreAnimation_8cpp-source.html#l00069">69</a> of file <a class="el" href="OgreAnimation_8cpp-source.html">OgreAnimation.cpp</a>.
<p>
References <a class="el" href="OgreAnimation_8h-source.html#l00152">mTrackList</a>.
<p>
Referenced by <a class="el" href="OgreSkeleton_8cpp-source.html#l00457">Ogre::Skeleton::_dumpContents</a>(), <a class="el" href="OgreSkeletonSerializer_8cpp-source.html#l00246">Ogre::SkeletonSerializer::calcAnimationSize</a>(), and <a class="el" href="OgreSkeletonSerializer_8cpp-source.html#l00166">Ogre::SkeletonSerializer::writeAnimation</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1Animationa7" doxytag="Ogre::Animation::getTrack"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1AnimationTrack.html">AnimationTrack</a> * Ogre::Animation::getTrack </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">unsigned short </td>
<td class="mdname1" valign="top" nowrap> <em>handle</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Gets a track by it's handle.
<p>
<p>
Definition at line <a class="el" href="OgreAnimation_8cpp-source.html#l00074">74</a> of file <a class="el" href="OgreAnimation_8cpp-source.html">OgreAnimation.cpp</a>.
<p>
References <a class="el" href="OgreException_8h-source.html#l00033">Except</a>, and <a class="el" href="OgreAnimation_8h-source.html#l00152">mTrackList</a>.
<p>
Referenced by <a class="el" href="OgreSkeleton_8cpp-source.html#l00457">Ogre::Skeleton::_dumpContents</a>(), <a class="el" href="OgreSkeletonSerializer_8cpp-source.html#l00246">Ogre::SkeletonSerializer::calcAnimationSize</a>(), and <a class="el" href="OgreSkeletonSerializer_8cpp-source.html#l00166">Ogre::SkeletonSerializer::writeAnimation</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1Animationd0" doxytag="Ogre::Animation::setDefaultInterpolationMode"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Ogre::Animation::setDefaultInterpolationMode </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1Animation.html#Ogre_1_1Animations3">InterpolationMode</a> </td>
<td class="mdname1" valign="top" nowrap> <em>im</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap><code> [static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Sets the default animation interpolation mode.
<p>
<dl compact><dt><b>
Remarks: </b><dd>
Every animation created after this option is set will have the new interpolation mode specified. You can also change the mode per animation by calling the setInterpolationMode method on the instance in question. </dl>
<p>
Definition at line <a class="el" href="OgreAnimation_8cpp-source.html#l00134">134</a> of file <a class="el" href="OgreAnimation_8cpp-source.html">OgreAnimation.cpp</a>.
<p>
References <a class="el" href="OgreAnimation_8cpp-source.html#l00033">msDefaultInterpolationMode</a>. </td>
</tr>
</table>
<a name="Ogre_1_1Animationa11" doxytag="Ogre::Animation::setInterpolationMode"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Ogre::Animation::setInterpolationMode </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1Animation.html#Ogre_1_1Animations3">InterpolationMode</a> </td>
<td class="mdname1" valign="top" nowrap> <em>im</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Tells the animation how to interpolate between keyframes.
<p>
<dl compact><dt><b>
Remarks: </b><dd>
By default, animations normally interpolate linearly between keyframes. This is fast, but when animations include quick changes in direction it can look a little unnatural because directions change instantly at keyframes. An alternative is to tell the animation to interpolate along a spline, which is more expensive in terms of calculation time, but looks smoother because major changes in direction are distributed around the keyframes rather than just at the keyframe.
<p>
You can also change the default animation behaviour by calling <a class="el" href="classOgre_1_1Animation.html#Ogre_1_1Animationd0">Animation::setDefaultInterpolationMode</a>. </dl>
<p>
Definition at line <a class="el" href="OgreAnimation_8cpp-source.html#l00124">124</a> of file <a class="el" href="OgreAnimation_8cpp-source.html">OgreAnimation.cpp</a>.
<p>
References <a class="el" href="OgreAnimation_8h-source.html#l00157">mInterpolationMode</a>. </td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a name="Ogre_1_1Animationn3" doxytag="Ogre::Animation::mInterpolationMode"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1Animation.html#Ogre_1_1Animations3">InterpolationMode</a> Ogre::Animation::mInterpolationMode<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="OgreAnimation_8h-source.html#l00157">157</a> of file <a class="el" href="OgreAnimation_8h-source.html">OgreAnimation.h</a>.
<p>
Referenced by <a class="el" href="OgreAnimation_8cpp-source.html#l00035">Animation</a>(), <a class="el" href="OgreAnimation_8cpp-source.html#l00129">getInterpolationMode</a>(), and <a class="el" href="OgreAnimation_8cpp-source.html#l00124">setInterpolationMode</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1Animationn2" doxytag="Ogre::Animation::mLength"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a349">Real</a> Ogre::Animation::mLength<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="OgreAnimation_8h-source.html#l00155">155</a> of file <a class="el" href="OgreAnimation_8h-source.html">OgreAnimation.h</a>.
<p>
Referenced by <a class="el" href="OgreAnimation_8cpp-source.html#l00045">getLength</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1Animationn1" doxytag="Ogre::Animation::mName"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1String.html">String</a> Ogre::Animation::mName<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="OgreAnimation_8h-source.html#l00153">153</a> of file <a class="el" href="OgreAnimation_8h-source.html">OgreAnimation.h</a>.
<p>
Referenced by <a class="el" href="OgreAnimation_8cpp-source.html#l00108">getName</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1Animationq0" doxytag="Ogre::Animation::msDefaultInterpolationMode"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1Animation.html#Ogre_1_1Animations3">Animation::InterpolationMode</a> Ogre::Animation::msDefaultInterpolationMode = Animation::IM_LINEAR<code> [static, protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="OgreAnimation_8cpp-source.html#l00033">33</a> of file <a class="el" href="OgreAnimation_8cpp-source.html">OgreAnimation.cpp</a>.
<p>
Referenced by <a class="el" href="OgreAnimation_8cpp-source.html#l00139">getDefaultInterpolationMode</a>(), and <a class="el" href="OgreAnimation_8cpp-source.html#l00134">setDefaultInterpolationMode</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1Animationn0" doxytag="Ogre::Animation::mTrackList"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1Animation.html#Ogre_1_1Animations0">TrackList</a> Ogre::Animation::mTrackList<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Tracks, indexed by handle.
<p>
<p>
Definition at line <a class="el" href="OgreAnimation_8h-source.html#l00152">152</a> of file <a class="el" href="OgreAnimation_8h-source.html">OgreAnimation.h</a>.
<p>
Referenced by <a class="el" href="OgreAnimation_8cpp-source.html#l00144">_getTrackList</a>(), <a class="el" href="OgreAnimation_8cpp-source.html#l00113">apply</a>(), <a class="el" href="OgreAnimation_8cpp-source.html#l00050">createTrack</a>(), <a class="el" href="OgreAnimation_8cpp-source.html#l00098">destroyAllTracks</a>(), <a class="el" href="OgreAnimation_8cpp-source.html#l00089">destroyTrack</a>(), <a class="el" href="OgreAnimation_8cpp-source.html#l00069">getNumTracks</a>(), and <a class="el" href="OgreAnimation_8cpp-source.html#l00074">getTrack</a>(). </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="OgreAnimation_8h-source.html">OgreAnimation.h</a><li><a class="el" href="OgreAnimation_8cpp-source.html">OgreAnimation.cpp</a></ul>
<p>
Copyright © 2002-2003 by The OGRE Team<br />
Last modified Wed Jan 21 00:16:38 2004
</p>
</body>
</html>
distrib
>
Mandriva
>
10.0
>
i586
>
media
>
contrib
>
by-pkgid
>
06719cf03808e17ae6f0852ca1052dc2
>
files
>
1481
