<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.3.6 -->
<div class="qindex"><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">Class 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">Class Members</a> | <a class="qindex" href="globals.html">File Members</a> | <a class="qindex" href="pages.html">Related Pages</a></div>
<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,17,193,36" 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></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="classOgre_1_1AnimationState.html#Ogre_1_1AnimationStatea0">AnimationState</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor for STL only. <a href="#Ogre_1_1AnimationStatea0"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1AnimationState.html#Ogre_1_1AnimationStatea1">~AnimationState</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor - is here because class has virtual functions and some compilers would whine if it won't exist. <a href="#Ogre_1_1AnimationStatea1"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1AnimationState.html#Ogre_1_1AnimationStatea2">AnimationState</a> (const <a class="el" href="namespaceOgre.html#a426">String</a> &animName, <a class="el" href="namespaceOgre.html#a420">Real</a> timePos, <a class="el" href="namespaceOgre.html#a420">Real</a> length, <a class="el" href="namespaceOgre.html#a420">Real</a> weight=1.0, bool enabled=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Normal constructor with all params supplied. <a href="#Ogre_1_1AnimationStatea2"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="namespaceOgre.html#a426">String</a> & </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1AnimationState.html#Ogre_1_1AnimationStatea3">getAnimationName</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the name of the animation to which this state applies. <a href="#Ogre_1_1AnimationStatea3"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1AnimationState.html#Ogre_1_1AnimationStatea4">setAnimationName</a> (const <a class="el" href="namespaceOgre.html#a426">String</a> &name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the name of the animation to which this state applies. <a href="#Ogre_1_1AnimationStatea4"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a420">Real</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1AnimationState.html#Ogre_1_1AnimationStatea5">getTimePosition</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the time position for this animation. <a href="#Ogre_1_1AnimationStatea5"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1AnimationState.html#Ogre_1_1AnimationStatea6">setTimePosition</a> (<a class="el" href="namespaceOgre.html#a420">Real</a> timePos)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the time position for this animation. <a href="#Ogre_1_1AnimationStatea6"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a420">Real</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1AnimationState.html#Ogre_1_1AnimationStatea7">getLength</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the total length of this animation (may be shorter than whole animation). <a href="#Ogre_1_1AnimationStatea7"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1AnimationState.html#Ogre_1_1AnimationStatea8">setLength</a> (<a class="el" href="namespaceOgre.html#a420">Real</a> len)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the total length of this animation (may be shorter than whole animation). <a href="#Ogre_1_1AnimationStatea8"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a420">Real</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1AnimationState.html#Ogre_1_1AnimationStatea9">getWeight</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the weight (influence) of this animation. <a href="#Ogre_1_1AnimationStatea9"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1AnimationState.html#Ogre_1_1AnimationStatea10">setWeight</a> (<a class="el" href="namespaceOgre.html#a420">Real</a> weight)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the weight (influence) of this animation. <a href="#Ogre_1_1AnimationStatea10"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1AnimationState.html#Ogre_1_1AnimationStatea11">addTime</a> (<a class="el" href="namespaceOgre.html#a420">Real</a> offset)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Modifies the time position, adjusting for animation length. <a href="#Ogre_1_1AnimationStatea11"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1AnimationState.html#Ogre_1_1AnimationStatea12">getEnabled</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if this animation is currently enabled. <a href="#Ogre_1_1AnimationStatea12"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1AnimationState.html#Ogre_1_1AnimationStatea13">setEnabled</a> (bool enabled)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets whether this animation is enabled. <a href="#Ogre_1_1AnimationStatea13"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1AnimationState.html#Ogre_1_1AnimationStatea14">operator==</a> (const <a class="el" href="classOgre_1_1AnimationState.html">AnimationState</a> &rhs) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Equality operator. <a href="#Ogre_1_1AnimationStatea14"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1AnimationState.html#Ogre_1_1AnimationStatea15">operator!=</a> (const <a class="el" href="classOgre_1_1AnimationState.html">AnimationState</a> &rhs) const </td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a420">Real</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1AnimationState.html#Ogre_1_1AnimationStatea16">getValue</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classOgre_1_1ControllerValue.html">ControllerValue</a> implementation. <a href="#Ogre_1_1AnimationStatea16"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1AnimationState.html#Ogre_1_1AnimationStatea17">setValue</a> (<a class="el" href="namespaceOgre.html#a420">Real</a> value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classOgre_1_1ControllerValue.html">ControllerValue</a> implementation. <a href="#Ogre_1_1AnimationStatea17"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1AnimationState.html#Ogre_1_1AnimationStatea18">setLoop</a> (bool loop)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets whether or not an animation loops at the start and end of the animation if the time continues to be altered. <a href="#Ogre_1_1AnimationStatea18"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1AnimationState.html#Ogre_1_1AnimationStatea19">getLoop</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets whether or not this animation loops. <a href="#Ogre_1_1AnimationStatea19"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1AnimationState.html#Ogre_1_1AnimationStatea20">copyStateFrom</a> (const <a class="el" href="classOgre_1_1AnimationState.html">AnimationState</a> &animState)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copies the states from another animation state, preserving the animation name (unlike operator=) but copying everything else. <a href="#Ogre_1_1AnimationStatea20"></a><br><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="el" href="namespaceOgre.html#a426">String</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1AnimationState.html#Ogre_1_1AnimationStatep0">mAnimationName</a></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a420">Real</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1AnimationState.html#Ogre_1_1AnimationStatep1">mTimePos</a></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a420">Real</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1AnimationState.html#Ogre_1_1AnimationStatep2">mLength</a></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a420">Real</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1AnimationState.html#Ogre_1_1AnimationStatep3">mInvLength</a></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a420">Real</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1AnimationState.html#Ogre_1_1AnimationStatep4">mWeight</a></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1AnimationState.html#Ogre_1_1AnimationStatep5">mEnabled</a></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1AnimationState.html#Ogre_1_1AnimationStatep6">mLoop</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></dt><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. </dd></dl>
<p>
<p>
Definition at line <a class="el" href="OgreAnimationState_8h-source.html#l00044">44</a> of file <a class="el" href="OgreAnimationState_8h-source.html">OgreAnimationState.h</a>.<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="Ogre_1_1AnimationStatea0" doxytag="Ogre::AnimationState::AnimationState" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<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>
</td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1AnimationStatea1" doxytag="Ogre::AnimationState::~AnimationState" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual Ogre::AnimationState::~<a class="el" href="classOgre_1_1AnimationState.html">AnimationState</a> </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>
</td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1AnimationStatea2" doxytag="Ogre::AnimationState::AnimationState" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<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="namespaceOgre.html#a426">String</a> & </td>
<td class="mdname" nowrap> <em>animName</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap><a class="el" href="namespaceOgre.html#a420">Real</a> </td>
<td class="mdname" nowrap> <em>timePos</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap><a class="el" href="namespaceOgre.html#a420">Real</a> </td>
<td class="mdname" nowrap> <em>length</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap><a class="el" href="namespaceOgre.html#a420">Real</a> </td>
<td class="mdname" nowrap> <em>weight</em> = 1.0, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></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>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="Ogre_1_1AnimationStatea11" doxytag="Ogre::AnimationState::addTime" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<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#a420">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>
<dl compact><dt><b>Remarks:</b></dt><dd>This method loops at the edges if animation looping is enabled. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1AnimationStatea20" doxytag="Ogre::AnimationState::copyStateFrom" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Ogre::AnimationState::copyStateFrom </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1AnimationState.html">AnimationState</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>animState</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>
Copies the states from another animation state, preserving the animation name (unlike operator=) but copying everything else.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>animState</em> </td><td>Reference to animation state which will use as source. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1AnimationStatea3" doxytag="Ogre::AnimationState::getAnimationName" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> const <a class="el" href="namespaceOgre.html#a426">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>
</td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1AnimationStatea12" doxytag="Ogre::AnimationState::getEnabled" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<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>
</td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1AnimationStatea7" doxytag="Ogre::AnimationState::getLength" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a420">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>
</td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1AnimationStatea19" doxytag="Ogre::AnimationState::getLoop" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool Ogre::AnimationState::getLoop </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 whether or not this animation loops.
<p>
<p>
Definition at line <a class="el" href="OgreAnimationState_8h-source.html#l00098">98</a> of file <a class="el" href="OgreAnimationState_8h-source.html">OgreAnimationState.h</a>. </td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1AnimationStatea5" doxytag="Ogre::AnimationState::getTimePosition" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a420">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>
</td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1AnimationStatea16" doxytag="Ogre::AnimationState::getValue" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a420">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_1ControllerValuea1">Ogre::ControllerValue< Real ></a>. </td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1AnimationStatea9" doxytag="Ogre::AnimationState::getWeight" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a420">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>
</td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1AnimationStatea15" doxytag="Ogre::AnimationState::operator!=" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<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 <a class="el" href="classOgre_1_1AnimationState.html">AnimationState</a> & </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>
</td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1AnimationStatea14" doxytag="Ogre::AnimationState::operator==" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<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 <a class="el" href="classOgre_1_1AnimationState.html">AnimationState</a> & </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>
</td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1AnimationStatea4" doxytag="Ogre::AnimationState::setAnimationName" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<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="namespaceOgre.html#a426">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>
</td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1AnimationStatea13" doxytag="Ogre::AnimationState::setEnabled" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<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>
</td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1AnimationStatea8" doxytag="Ogre::AnimationState::setLength" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<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#a420">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>
</td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1AnimationStatea18" doxytag="Ogre::AnimationState::setLoop" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Ogre::AnimationState::setLoop </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">bool </td>
<td class="mdname1" valign="top" nowrap> <em>loop</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 or not an animation loops at the start and end of the animation if the time continues to be altered.
<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>. </td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1AnimationStatea6" doxytag="Ogre::AnimationState::setTimePosition" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<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#a420">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>
</td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1AnimationStatea17" doxytag="Ogre::AnimationState::setValue" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<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#a420">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_1ControllerValuea2">Ogre::ControllerValue< Real ></a>. </td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1AnimationStatea10" doxytag="Ogre::AnimationState::setWeight" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<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#a420">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>
</td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="Ogre_1_1AnimationStatep0" doxytag="Ogre::AnimationState::mAnimationName" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a426">String</a> <a class="el" href="classOgre_1_1AnimationState.html#Ogre_1_1AnimationStatep0">Ogre::AnimationState::mAnimationName</a><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#l00107">107</a> of file <a class="el" href="OgreAnimationState_8h-source.html">OgreAnimationState.h</a>. </td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1AnimationStatep5" doxytag="Ogre::AnimationState::mEnabled" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool <a class="el" href="classOgre_1_1AnimationState.html#Ogre_1_1AnimationStatep5">Ogre::AnimationState::mEnabled</a><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#l00112">112</a> of file <a class="el" href="OgreAnimationState_8h-source.html">OgreAnimationState.h</a>. </td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1AnimationStatep3" doxytag="Ogre::AnimationState::mInvLength" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a420">Real</a> <a class="el" href="classOgre_1_1AnimationState.html#Ogre_1_1AnimationStatep3">Ogre::AnimationState::mInvLength</a><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#l00110">110</a> of file <a class="el" href="OgreAnimationState_8h-source.html">OgreAnimationState.h</a>. </td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1AnimationStatep2" doxytag="Ogre::AnimationState::mLength" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a420">Real</a> <a class="el" href="classOgre_1_1AnimationState.html#Ogre_1_1AnimationStatep2">Ogre::AnimationState::mLength</a><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#l00109">109</a> of file <a class="el" href="OgreAnimationState_8h-source.html">OgreAnimationState.h</a>. </td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1AnimationStatep6" doxytag="Ogre::AnimationState::mLoop" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool <a class="el" href="classOgre_1_1AnimationState.html#Ogre_1_1AnimationStatep6">Ogre::AnimationState::mLoop</a><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#l00113">113</a> of file <a class="el" href="OgreAnimationState_8h-source.html">OgreAnimationState.h</a>. </td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1AnimationStatep1" doxytag="Ogre::AnimationState::mTimePos" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a420">Real</a> <a class="el" href="classOgre_1_1AnimationState.html#Ogre_1_1AnimationStatep1">Ogre::AnimationState::mTimePos</a><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#l00108">108</a> of file <a class="el" href="OgreAnimationState_8h-source.html">OgreAnimationState.h</a>. </td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1AnimationStatep4" doxytag="Ogre::AnimationState::mWeight" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a420">Real</a> <a class="el" href="classOgre_1_1AnimationState.html#Ogre_1_1AnimationStatep4">Ogre::AnimationState::mWeight</a><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#l00111">111</a> of file <a class="el" href="OgreAnimationState_8h-source.html">OgreAnimationState.h</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="OgreAnimationState_8h-source.html">OgreAnimationState.h</a></ul>
<p>
Copyright © 2000-2005 by The OGRE Team<br />
Last modified Wed Feb 23 00:19:26 2005
</p>
</body>
</html>
distrib
>
Mandriva
>
10.2
>
i586
>
media
>
contrib
>
by-pkgid
>
04e5d8c10ae76748689b4e7f48e0fa33
>
files
>
1021
