<html>
<head>
<title>Ogre::AnimationState 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::AnimationState Class Reference</h1>Represents the state of an animation and the weight of it's influence.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="OgreAnimationState_8h-source.html">OgreAnimationState.h</a>></code>
<p>
Inheritance diagram for Ogre::AnimationState:<p><center><img src="classOgre_1_1AnimationState__inherit__graph.png" border="0" usemap="#Ogre_1_1AnimationState__inherit__map" alt="Inheritance graph"></center>
<map name="Ogre_1_1AnimationState__inherit__map">
<area href="classOgre_1_1ControllerValue.html" shape="rect" coords="7,36,193,17" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for Ogre::AnimationState:<p><center><img src="classOgre_1_1AnimationState__coll__graph.png" border="0" usemap="#Ogre_1_1AnimationState__coll__map" alt="Collaboration graph"></center>
<map name="Ogre_1_1AnimationState__coll__map">
<area href="classOgre_1_1ControllerValue.html" shape="rect" coords="7,36,193,17" alt="">
<area href="classOgre_1_1String.html" shape="rect" coords="217,36,297,17" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classOgre_1_1AnimationState-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<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_1AnimationState.html#Ogre_1_1AnimationStatea0">AnimationState</a> ()</td></tr>
<tr><td> </td><td><font size=-1><em>Default constructor for STL only.</em> <a href="#Ogre_1_1AnimationStatea0"></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_1AnimationState.html#Ogre_1_1AnimationStatea1">~AnimationState</a> ()</td></tr>
<tr><td> </td><td><font size=-1><em>Destructor - is here because class has virtual functions and some compilers would whine if it won't exist.</em> <a href="#Ogre_1_1AnimationStatea1"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classOgre_1_1AnimationState.html#Ogre_1_1AnimationStatea2">AnimationState</a> (const <a class="el" href="classOgre_1_1String.html">String</a> &animName, <a class="el" href="namespaceOgre.html#a349">Real</a> timePos, <a class="el" href="namespaceOgre.html#a349">Real</a> length, <a class="el" href="namespaceOgre.html#a349">Real</a> weight=1.0, bool enabled=false)</td></tr>
<tr><td> </td><td><font size=-1><em>Normal constructor with all params supplied.</em> <a href="#Ogre_1_1AnimationStatea2"></a><em></em></font><br><br></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_1AnimationState.html#Ogre_1_1AnimationStatea3">getAnimationName</a> () const</td></tr>
<tr><td> </td><td><font size=-1><em>Gets the name of the animation to which this state applies.</em> <a href="#Ogre_1_1AnimationStatea3"></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_1AnimationState.html#Ogre_1_1AnimationStatea4">setAnimationName</a> (const <a class="el" href="classOgre_1_1String.html">String</a> &name)</td></tr>
<tr><td> </td><td><font size=-1><em>Sets the name of the animation to which this state applies.</em> <a href="#Ogre_1_1AnimationStatea4"></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_1AnimationState.html#Ogre_1_1AnimationStatea5">getTimePosition</a> (void) const</td></tr>
<tr><td> </td><td><font size=-1><em>Gets the time position for this animation.</em> <a href="#Ogre_1_1AnimationStatea5"></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_1AnimationState.html#Ogre_1_1AnimationStatea6">setTimePosition</a> (<a class="el" href="namespaceOgre.html#a349">Real</a> timePos)</td></tr>
<tr><td> </td><td><font size=-1><em>Sets the time position for this animation.</em> <a href="#Ogre_1_1AnimationStatea6"></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_1AnimationState.html#Ogre_1_1AnimationStatea7">getLength</a> () const</td></tr>
<tr><td> </td><td><font size=-1><em>Gets the total length of this animation (may be shorter than whole animation).</em> <a href="#Ogre_1_1AnimationStatea7"></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_1AnimationState.html#Ogre_1_1AnimationStatea8">setLength</a> (<a class="el" href="namespaceOgre.html#a349">Real</a> len)</td></tr>
<tr><td> </td><td><font size=-1><em>Sets the total length of this animation (may be shorter than whole animation).</em> <a href="#Ogre_1_1AnimationStatea8"></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_1AnimationState.html#Ogre_1_1AnimationStatea9">getWeight</a> (void) const</td></tr>
<tr><td> </td><td><font size=-1><em>Gets the weight (influence) of this animation.</em> <a href="#Ogre_1_1AnimationStatea9"></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_1AnimationState.html#Ogre_1_1AnimationStatea10">setWeight</a> (<a class="el" href="namespaceOgre.html#a349">Real</a> weight)</td></tr>
<tr><td> </td><td><font size=-1><em>Sets the weight (influence) of this animation.</em> <a href="#Ogre_1_1AnimationStatea10"></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_1AnimationState.html#Ogre_1_1AnimationStatea11">addTime</a> (<a class="el" href="namespaceOgre.html#a349">Real</a> offset)</td></tr>
<tr><td> </td><td><font size=-1><em>Modifies the time position, adjusting for animation length.</em> <a href="#Ogre_1_1AnimationStatea11"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classOgre_1_1AnimationState.html#Ogre_1_1AnimationStatea12">getEnabled</a> (void) const</td></tr>
<tr><td> </td><td><font size=-1><em>Returns true if this animation is currently enabled.</em> <a href="#Ogre_1_1AnimationStatea12"></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_1AnimationState.html#Ogre_1_1AnimationStatea13">setEnabled</a> (bool enabled)</td></tr>
<tr><td> </td><td><font size=-1><em>Sets whether this animation is enabled.</em> <a href="#Ogre_1_1AnimationStatea13"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classOgre_1_1AnimationState.html#Ogre_1_1AnimationStatea14">operator==</a> (const AnimationState &rhs) const</td></tr>
<tr><td> </td><td><font size=-1><em>Equality operator.</em> <a href="#Ogre_1_1AnimationStatea14"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classOgre_1_1AnimationState.html#Ogre_1_1AnimationStatea15">operator!=</a> (const AnimationState &rhs) const</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_1AnimationState.html#Ogre_1_1AnimationStatea16">getValue</a> (void) const</td></tr>
<tr><td> </td><td><font size=-1><em><a class="el" href="classOgre_1_1ControllerValue.html">ControllerValue</a> implementation.</em> <a href="#Ogre_1_1AnimationStatea16"></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_1AnimationState.html#Ogre_1_1AnimationStatea17">setValue</a> (<a class="el" href="namespaceOgre.html#a349">Real</a> value)</td></tr>
<tr><td> </td><td><font size=-1><em><a class="el" href="classOgre_1_1ControllerValue.html">ControllerValue</a> implementation.</em> <a href="#Ogre_1_1AnimationStatea17"></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_1String.html">String</a> </td><td valign=bottom><a class="el" href="classOgre_1_1AnimationState.html#Ogre_1_1AnimationStaten0">mAnimationName</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_1AnimationState.html#Ogre_1_1AnimationStaten1">mTimePos</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_1AnimationState.html#Ogre_1_1AnimationStaten2">mLength</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_1AnimationState.html#Ogre_1_1AnimationStaten3">mInvLength</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_1AnimationState.html#Ogre_1_1AnimationStaten4">mWeight</a></td></tr>
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classOgre_1_1AnimationState.html#Ogre_1_1AnimationStaten5">mEnabled</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Represents the state of an animation and the weight of it's influence.
<p>
<dl compact><dt><b>
Remarks: </b><dd>
Other classes can hold instances of this class to store the state of any animations they are using. This class implements the <a class="el" href="classOgre_1_1ControllerValue.html">ControllerValue</a> interface to enable automatic update of animation state through controllers. </dl>
<p>
<p>
Definition at line <a class="el" href="OgreAnimationState_8h-source.html#l00043">43</a> of file <a class="el" href="OgreAnimationState_8h-source.html">OgreAnimationState.h</a>.<hr><h2>Constructor & Destructor Documentation</h2>
<a name="Ogre_1_1AnimationStatea0" doxytag="Ogre::AnimationState::AnimationState"></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::AnimationState::AnimationState </td>
<td class="md" valign="top">( </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>
Default constructor for STL only.
<p>
<p>
Definition at line <a class="el" href="OgreAnimationState_8cpp-source.html#l00033">33</a> of file <a class="el" href="OgreAnimationState_8cpp-source.html">OgreAnimationState.cpp</a>.
<p>
References <a class="el" href="OgreAnimationState_8h-source.html#l00095">mInvLength</a>, <a class="el" href="OgreAnimationState_8h-source.html#l00094">mLength</a>, <a class="el" href="OgreAnimationState_8h-source.html#l00093">mTimePos</a>, and <a class="el" href="OgreAnimationState_8h-source.html#l00096">mWeight</a>. </td>
</tr>
</table>
<a name="Ogre_1_1AnimationStatea1" doxytag="Ogre::AnimationState::~AnimationState"></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::AnimationState::~AnimationState </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>
Destructor - is here because class has virtual functions and some compilers would whine if it won't exist.
<p>
<p>
Definition at line <a class="el" href="OgreAnimationState_8cpp-source.html#l00042">42</a> of file <a class="el" href="OgreAnimationState_8cpp-source.html">OgreAnimationState.cpp</a>. </td>
</tr>
</table>
<a name="Ogre_1_1AnimationStatea2" doxytag="Ogre::AnimationState::AnimationState"></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::AnimationState::AnimationState </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>animName</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>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>length</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>enabled</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>
Normal constructor with all params supplied.
<p>
<p>
Definition at line <a class="el" href="OgreAnimationState_8cpp-source.html#l00046">46</a> of file <a class="el" href="OgreAnimationState_8cpp-source.html">OgreAnimationState.cpp</a>.
<p>
References <a class="el" href="OgrePrerequisites_8h-source.html#l00086">Ogre::Real</a>, and <a class="el" href="OgreAnimationState_8cpp-source.html#l00077">setLength</a>(). </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="Ogre_1_1AnimationStatea11" doxytag="Ogre::AnimationState::addTime"></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::AnimationState::addTime </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="mdname1" valign="top" nowrap> <em>offset</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>
Modifies the time position, adjusting for animation length.
<p>
<p>
Definition at line <a class="el" href="OgreAnimationState_8cpp-source.html#l00100">100</a> of file <a class="el" href="OgreAnimationState_8cpp-source.html">OgreAnimationState.cpp</a>.
<p>
References <a class="el" href="OgreAnimationState_8h-source.html#l00094">mLength</a>, <a class="el" href="OgreAnimationState_8h-source.html#l00093">mTimePos</a>, and <a class="el" href="OgrePrerequisites_8h-source.html#l00086">Ogre::Real</a>. </td>
</tr>
</table>
<a name="Ogre_1_1AnimationStatea3" doxytag="Ogre::AnimationState::getAnimationName"></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::AnimationState::getAnimationName </td>
<td class="md" valign="top">( </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 the animation to which this state applies.
<p>
<p>
Definition at line <a class="el" href="OgreAnimationState_8cpp-source.html#l00052">52</a> of file <a class="el" href="OgreAnimationState_8cpp-source.html">OgreAnimationState.cpp</a>.
<p>
References <a class="el" href="OgreAnimationState_8h-source.html#l00092">mAnimationName</a>.
<p>
Referenced by <a class="el" href="OgreSkeleton_8cpp-source.html#l00214">Ogre::Skeleton::setAnimationState</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1AnimationStatea12" doxytag="Ogre::AnimationState::getEnabled"></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"> bool Ogre::AnimationState::getEnabled </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>
Returns true if this animation is currently enabled.
<p>
<p>
Definition at line <a class="el" href="OgreAnimationState_8cpp-source.html#l00117">117</a> of file <a class="el" href="OgreAnimationState_8cpp-source.html">OgreAnimationState.cpp</a>.
<p>
References <a class="el" href="OgreAnimationState_8h-source.html#l00097">mEnabled</a>.
<p>
Referenced by <a class="el" href="OgreSkeleton_8cpp-source.html#l00214">Ogre::Skeleton::setAnimationState</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1AnimationStatea7" doxytag="Ogre::AnimationState::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::AnimationState::getLength </td>
<td class="md" valign="top">( </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 this animation (may be shorter than whole animation).
<p>
<p>
Definition at line <a class="el" href="OgreAnimationState_8cpp-source.html#l00072">72</a> of file <a class="el" href="OgreAnimationState_8cpp-source.html">OgreAnimationState.cpp</a>.
<p>
References <a class="el" href="OgreAnimationState_8h-source.html#l00094">mLength</a>, and <a class="el" href="OgrePrerequisites_8h-source.html#l00086">Ogre::Real</a>. </td>
</tr>
</table>
<a name="Ogre_1_1AnimationStatea5" doxytag="Ogre::AnimationState::getTimePosition"></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::AnimationState::getTimePosition </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 time position for this animation.
<p>
<p>
Definition at line <a class="el" href="OgreAnimationState_8cpp-source.html#l00062">62</a> of file <a class="el" href="OgreAnimationState_8cpp-source.html">OgreAnimationState.cpp</a>.
<p>
References <a class="el" href="OgreAnimationState_8h-source.html#l00093">mTimePos</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#l00214">Ogre::Skeleton::setAnimationState</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1AnimationStatea16" doxytag="Ogre::AnimationState::getValue"></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::AnimationState::getValue </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<code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<a class="el" href="classOgre_1_1ControllerValue.html">ControllerValue</a> implementation.
<p>
<p>
Implements <a class="el" href="classOgre_1_1ControllerValue.html#Ogre_1_1ControllerValuea0">Ogre::ControllerValue< Real ></a>.
<p>
Definition at line <a class="el" href="OgreAnimationState_8cpp-source.html#l00148">148</a> of file <a class="el" href="OgreAnimationState_8cpp-source.html">OgreAnimationState.cpp</a>.
<p>
References <a class="el" href="OgreAnimationState_8h-source.html#l00095">mInvLength</a>, <a class="el" href="OgreAnimationState_8h-source.html#l00093">mTimePos</a>, and <a class="el" href="OgrePrerequisites_8h-source.html#l00086">Ogre::Real</a>. </td>
</tr>
</table>
<a name="Ogre_1_1AnimationStatea9" doxytag="Ogre::AnimationState::getWeight"></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::AnimationState::getWeight </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 weight (influence) of this animation.
<p>
<p>
Definition at line <a class="el" href="OgreAnimationState_8cpp-source.html#l00090">90</a> of file <a class="el" href="OgreAnimationState_8cpp-source.html">OgreAnimationState.cpp</a>.
<p>
References <a class="el" href="OgreAnimationState_8h-source.html#l00096">mWeight</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#l00214">Ogre::Skeleton::setAnimationState</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1AnimationStatea15" doxytag="Ogre::AnimationState::operator!="></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"> bool Ogre::AnimationState::operator!= </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const AnimationState & </td>
<td class="mdname1" valign="top" nowrap> <em>rhs</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>
<p>
Definition at line <a class="el" href="OgreAnimationState_8cpp-source.html#l00143">143</a> of file <a class="el" href="OgreAnimationState_8cpp-source.html">OgreAnimationState.cpp</a>. </td>
</tr>
</table>
<a name="Ogre_1_1AnimationStatea14" doxytag="Ogre::AnimationState::operator=="></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"> bool Ogre::AnimationState::operator== </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const AnimationState & </td>
<td class="mdname1" valign="top" nowrap> <em>rhs</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>
Equality operator.
<p>
<p>
Definition at line <a class="el" href="OgreAnimationState_8cpp-source.html#l00127">127</a> of file <a class="el" href="OgreAnimationState_8cpp-source.html">OgreAnimationState.cpp</a>.
<p>
References <a class="el" href="OgreAnimationState_8h-source.html#l00092">mAnimationName</a>, <a class="el" href="OgreAnimationState_8h-source.html#l00097">mEnabled</a>, <a class="el" href="OgreAnimationState_8h-source.html#l00094">mLength</a>, <a class="el" href="OgreAnimationState_8h-source.html#l00093">mTimePos</a>, and <a class="el" href="OgreAnimationState_8h-source.html#l00096">mWeight</a>. </td>
</tr>
</table>
<a name="Ogre_1_1AnimationStatea4" doxytag="Ogre::AnimationState::setAnimationName"></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::AnimationState::setAnimationName </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="mdname1" valign="top" nowrap> <em>name</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>
Sets the name of the animation to which this state applies.
<p>
<p>
Definition at line <a class="el" href="OgreAnimationState_8cpp-source.html#l00057">57</a> of file <a class="el" href="OgreAnimationState_8cpp-source.html">OgreAnimationState.cpp</a>.
<p>
References <a class="el" href="OgreAnimationState_8h-source.html#l00092">mAnimationName</a>. </td>
</tr>
</table>
<a name="Ogre_1_1AnimationStatea13" doxytag="Ogre::AnimationState::setEnabled"></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::AnimationState::setEnabled </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">bool </td>
<td class="mdname1" valign="top" nowrap> <em>enabled</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>
Sets whether this animation is enabled.
<p>
<p>
Definition at line <a class="el" href="OgreAnimationState_8cpp-source.html#l00122">122</a> of file <a class="el" href="OgreAnimationState_8cpp-source.html">OgreAnimationState.cpp</a>.
<p>
References <a class="el" href="OgreAnimationState_8h-source.html#l00097">mEnabled</a>. </td>
</tr>
</table>
<a name="Ogre_1_1AnimationStatea8" doxytag="Ogre::AnimationState::setLength"></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::AnimationState::setLength </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="mdname1" valign="top" nowrap> <em>len</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>
Sets the total length of this animation (may be shorter than whole animation).
<p>
<p>
Definition at line <a class="el" href="OgreAnimationState_8cpp-source.html#l00077">77</a> of file <a class="el" href="OgreAnimationState_8cpp-source.html">OgreAnimationState.cpp</a>.
<p>
References <a class="el" href="OgreAnimationState_8h-source.html#l00095">mInvLength</a>, <a class="el" href="OgreAnimationState_8h-source.html#l00094">mLength</a>, and <a class="el" href="OgrePrerequisites_8h-source.html#l00086">Ogre::Real</a>.
<p>
Referenced by <a class="el" href="OgreAnimationState_8cpp-source.html#l00046">AnimationState</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1AnimationStatea6" doxytag="Ogre::AnimationState::setTimePosition"></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::AnimationState::setTimePosition </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="mdname1" valign="top" nowrap> <em>timePos</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>
Sets the time position for this animation.
<p>
<p>
Definition at line <a class="el" href="OgreAnimationState_8cpp-source.html#l00067">67</a> of file <a class="el" href="OgreAnimationState_8cpp-source.html">OgreAnimationState.cpp</a>.
<p>
References <a class="el" href="OgreAnimationState_8h-source.html#l00093">mTimePos</a>, and <a class="el" href="OgrePrerequisites_8h-source.html#l00086">Ogre::Real</a>. </td>
</tr>
</table>
<a name="Ogre_1_1AnimationStatea17" doxytag="Ogre::AnimationState::setValue"></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::AnimationState::setValue </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="mdname1" valign="top" nowrap> <em>value</em> </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>
<a class="el" href="classOgre_1_1ControllerValue.html">ControllerValue</a> implementation.
<p>
<p>
Implements <a class="el" href="classOgre_1_1ControllerValue.html#Ogre_1_1ControllerValuea1">Ogre::ControllerValue< Real ></a>.
<p>
Definition at line <a class="el" href="OgreAnimationState_8cpp-source.html#l00153">153</a> of file <a class="el" href="OgreAnimationState_8cpp-source.html">OgreAnimationState.cpp</a>.
<p>
References <a class="el" href="OgreAnimationState_8h-source.html#l00094">mLength</a>, <a class="el" href="OgreAnimationState_8h-source.html#l00093">mTimePos</a>, and <a class="el" href="OgrePrerequisites_8h-source.html#l00086">Ogre::Real</a>. </td>
</tr>
</table>
<a name="Ogre_1_1AnimationStatea10" doxytag="Ogre::AnimationState::setWeight"></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::AnimationState::setWeight </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="mdname1" valign="top" nowrap> <em>weight</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>
Sets the weight (influence) of this animation.
<p>
<p>
Definition at line <a class="el" href="OgreAnimationState_8cpp-source.html#l00095">95</a> of file <a class="el" href="OgreAnimationState_8cpp-source.html">OgreAnimationState.cpp</a>.
<p>
References <a class="el" href="OgreAnimationState_8h-source.html#l00096">mWeight</a>, and <a class="el" href="OgrePrerequisites_8h-source.html#l00086">Ogre::Real</a>. </td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a name="Ogre_1_1AnimationStaten0" doxytag="Ogre::AnimationState::mAnimationName"></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::AnimationState::mAnimationName<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="OgreAnimationState_8h-source.html#l00092">92</a> of file <a class="el" href="OgreAnimationState_8h-source.html">OgreAnimationState.h</a>.
<p>
Referenced by <a class="el" href="OgreAnimationState_8cpp-source.html#l00052">getAnimationName</a>(), <a class="el" href="OgreAnimationState_8cpp-source.html#l00127">operator==</a>(), and <a class="el" href="OgreAnimationState_8cpp-source.html#l00057">setAnimationName</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1AnimationStaten5" doxytag="Ogre::AnimationState::mEnabled"></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"> bool Ogre::AnimationState::mEnabled<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="OgreAnimationState_8h-source.html#l00097">97</a> of file <a class="el" href="OgreAnimationState_8h-source.html">OgreAnimationState.h</a>.
<p>
Referenced by <a class="el" href="OgreAnimationState_8cpp-source.html#l00117">getEnabled</a>(), <a class="el" href="OgreAnimationState_8cpp-source.html#l00127">operator==</a>(), and <a class="el" href="OgreAnimationState_8cpp-source.html#l00122">setEnabled</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1AnimationStaten3" doxytag="Ogre::AnimationState::mInvLength"></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::AnimationState::mInvLength<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="OgreAnimationState_8h-source.html#l00095">95</a> of file <a class="el" href="OgreAnimationState_8h-source.html">OgreAnimationState.h</a>.
<p>
Referenced by <a class="el" href="OgreAnimationState_8cpp-source.html#l00033">AnimationState</a>(), <a class="el" href="OgreAnimationState_8cpp-source.html#l00148">getValue</a>(), and <a class="el" href="OgreAnimationState_8cpp-source.html#l00077">setLength</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1AnimationStaten2" doxytag="Ogre::AnimationState::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::AnimationState::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="OgreAnimationState_8h-source.html#l00094">94</a> of file <a class="el" href="OgreAnimationState_8h-source.html">OgreAnimationState.h</a>.
<p>
Referenced by <a class="el" href="OgreAnimationState_8cpp-source.html#l00100">addTime</a>(), <a class="el" href="OgreAnimationState_8cpp-source.html#l00033">AnimationState</a>(), <a class="el" href="OgreAnimationState_8cpp-source.html#l00072">getLength</a>(), <a class="el" href="OgreAnimationState_8cpp-source.html#l00127">operator==</a>(), <a class="el" href="OgreAnimationState_8cpp-source.html#l00077">setLength</a>(), and <a class="el" href="OgreAnimationState_8cpp-source.html#l00153">setValue</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1AnimationStaten1" doxytag="Ogre::AnimationState::mTimePos"></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::AnimationState::mTimePos<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="OgreAnimationState_8h-source.html#l00093">93</a> of file <a class="el" href="OgreAnimationState_8h-source.html">OgreAnimationState.h</a>.
<p>
Referenced by <a class="el" href="OgreAnimationState_8cpp-source.html#l00100">addTime</a>(), <a class="el" href="OgreAnimationState_8cpp-source.html#l00033">AnimationState</a>(), <a class="el" href="OgreAnimationState_8cpp-source.html#l00062">getTimePosition</a>(), <a class="el" href="OgreAnimationState_8cpp-source.html#l00148">getValue</a>(), <a class="el" href="OgreAnimationState_8cpp-source.html#l00127">operator==</a>(), <a class="el" href="OgreAnimationState_8cpp-source.html#l00067">setTimePosition</a>(), and <a class="el" href="OgreAnimationState_8cpp-source.html#l00153">setValue</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1AnimationStaten4" doxytag="Ogre::AnimationState::mWeight"></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::AnimationState::mWeight<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="OgreAnimationState_8h-source.html#l00096">96</a> of file <a class="el" href="OgreAnimationState_8h-source.html">OgreAnimationState.h</a>.
<p>
Referenced by <a class="el" href="OgreAnimationState_8cpp-source.html#l00033">AnimationState</a>(), <a class="el" href="OgreAnimationState_8cpp-source.html#l00090">getWeight</a>(), <a class="el" href="OgreAnimationState_8cpp-source.html#l00127">operator==</a>(), and <a class="el" href="OgreAnimationState_8cpp-source.html#l00095">setWeight</a>(). </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="OgreAnimationState_8h-source.html">OgreAnimationState.h</a><li><a class="el" href="OgreAnimationState_8cpp-source.html">OgreAnimationState.cpp</a></ul>
<p>
Copyright © 2002-2003 by The OGRE Team<br />
Last modified Wed Jan 21 00:16:38 2004
</p>
</body>
</html>
