Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

Ogre::AnimationState Class Reference

Represents the state of an animation and the weight of it's influence. More...

#include <OgreAnimationState.h>

Inheritance diagram for Ogre::AnimationState:

Inheritance graph
[legend]
List of all members.

Public Methods

 AnimationState ()
 Default constructor for STL only.

virtual ~AnimationState ()
 Destructor - is here because class has virtual functions and some compilers would whine if it won't exist.

 AnimationState (const String &animName, Real timePos, Real length, Real weight=1.0, bool enabled=false)
 Normal constructor with all params supplied.

const StringgetAnimationName () const
 Gets the name of the animation to which this state applies.

void setAnimationName (const String &name)
 Sets the name of the animation to which this state applies.

Real getTimePosition (void) const
 Gets the time position for this animation.

void setTimePosition (Real timePos)
 Sets the time position for this animation.

Real getLength () const
 Gets the total length of this animation (may be shorter than whole animation).

void setLength (Real len)
 Sets the total length of this animation (may be shorter than whole animation).

Real getWeight (void) const
 Gets the weight (influence) of this animation.

void setWeight (Real weight)
 Sets the weight (influence) of this animation.

void addTime (Real offset)
 Modifies the time position, adjusting for animation length.

bool getEnabled (void) const
 Returns true if this animation is currently enabled.

void setEnabled (bool enabled)
 Sets whether this animation is enabled.

bool operator== (const AnimationState &rhs) const
 Equality operator.

bool operator!= (const AnimationState &rhs) const
Real getValue (void) const
 ControllerValue implementation.

void setValue (Real value)
 ControllerValue implementation.

void setLoop (bool loop)
 Sets whether or not an animation loops at the start and end of the animation if the time continues to be altered.

bool getLoop (void) const
 Gets whether or not this animation loops.

void copyStateFrom (const AnimationState &animState)
 Copies the states from another animation state, preserving the animation name (unlike operator=) but copying everything else.


Protected Attributes

String mAnimationName
Real mTimePos
Real mLength
Real mInvLength
Real mWeight
bool mEnabled
bool mLoop

Detailed Description

Represents the state of an animation and the weight of it's influence.

Remarks:
Other classes can hold instances of this class to store the state of any animations they are using. This class implements the ControllerValue interface to enable automatic update of animation state through controllers.

Definition at line 44 of file OgreAnimationState.h.


Constructor & Destructor Documentation

Ogre::AnimationState::AnimationState  
 

Default constructor for STL only.

Definition at line 34 of file OgreAnimationState.cpp.

References mInvLength, mLength, mLoop, mTimePos, and mWeight.

Ogre::AnimationState::~AnimationState   [virtual]
 

Destructor - is here because class has virtual functions and some compilers would whine if it won't exist.

Definition at line 43 of file OgreAnimationState.cpp.

Ogre::AnimationState::AnimationState const String   animName,
Real    timePos,
Real    length,
Real    weight = 1.0,
bool    enabled = false
 

Normal constructor with all params supplied.

Definition at line 47 of file OgreAnimationState.cpp.

References mLoop, Ogre::Real, setLength(), and Ogre::String.


Member Function Documentation

void Ogre::AnimationState::addTime Real    offset
 

Modifies the time position, adjusting for animation length.

Remarks:
This method loops at the edges if animation looping is enabled.

Definition at line 117 of file OgreAnimationState.cpp.

References mTimePos, Ogre::Real, and setTimePosition().

void Ogre::AnimationState::copyStateFrom const AnimationState &    animState
 

Copies the states from another animation state, preserving the animation name (unlike operator=) but copying everything else.

Parameters:
animState  Reference to animation state which will use as source.

Definition at line 164 of file OgreAnimationState.cpp.

References mEnabled, mInvLength, mLength, mLoop, mTimePos, and mWeight.

const String & Ogre::AnimationState::getAnimationName   const
 

Gets the name of the animation to which this state applies.

Definition at line 54 of file OgreAnimationState.cpp.

References mAnimationName, and Ogre::String.

Referenced by Ogre::Skeleton::setAnimationState().

bool Ogre::AnimationState::getEnabled void    const
 

Returns true if this animation is currently enabled.

Definition at line 122 of file OgreAnimationState.cpp.

References mEnabled.

Referenced by Ogre::Skeleton::setAnimationState().

Real Ogre::AnimationState::getLength   const
 

Gets the total length of this animation (may be shorter than whole animation).

Definition at line 89 of file OgreAnimationState.cpp.

References mLength, and Ogre::Real.

bool Ogre::AnimationState::getLoop void    const
 

Gets whether or not this animation loops.

Definition at line 98 of file OgreAnimationState.h.

Real Ogre::AnimationState::getTimePosition void    const
 

Gets the time position for this animation.

Definition at line 64 of file OgreAnimationState.cpp.

References mTimePos, and Ogre::Real.

Referenced by Ogre::Skeleton::setAnimationState().

Real Ogre::AnimationState::getValue void    const [virtual]
 

ControllerValue implementation.

Implements Ogre::ControllerValue< Real >.

Definition at line 154 of file OgreAnimationState.cpp.

References mInvLength, mTimePos, and Ogre::Real.

Real Ogre::AnimationState::getWeight void    const
 

Gets the weight (influence) of this animation.

Definition at line 107 of file OgreAnimationState.cpp.

References mWeight, and Ogre::Real.

Referenced by Ogre::Skeleton::setAnimationState().

bool Ogre::AnimationState::operator!= const AnimationState &    rhs const
 

Definition at line 149 of file OgreAnimationState.cpp.

bool Ogre::AnimationState::operator== const AnimationState &    rhs const
 

Equality operator.

Definition at line 132 of file OgreAnimationState.cpp.

References mAnimationName, mEnabled, mLength, mLoop, mTimePos, and mWeight.

void Ogre::AnimationState::setAnimationName const String   name
 

Sets the name of the animation to which this state applies.

Definition at line 59 of file OgreAnimationState.cpp.

References mAnimationName, and Ogre::String.

void Ogre::AnimationState::setEnabled bool    enabled
 

Sets whether this animation is enabled.

Definition at line 127 of file OgreAnimationState.cpp.

References mEnabled.

void Ogre::AnimationState::setLength Real    len
 

Sets the total length of this animation (may be shorter than whole animation).

Definition at line 94 of file OgreAnimationState.cpp.

References mInvLength, mLength, and Ogre::Real.

Referenced by AnimationState().

void Ogre::AnimationState::setLoop bool    loop
 

Sets whether or not an animation loops at the start and end of the animation if the time continues to be altered.

Definition at line 96 of file OgreAnimationState.h.

void Ogre::AnimationState::setTimePosition Real    timePos
 

Sets the time position for this animation.

Definition at line 69 of file OgreAnimationState.cpp.

References mLength, mTimePos, and Ogre::Real.

Referenced by addTime().

void Ogre::AnimationState::setValue Real    value [virtual]
 

ControllerValue implementation.

Implements Ogre::ControllerValue< Real >.

Definition at line 159 of file OgreAnimationState.cpp.

References mLength, mTimePos, and Ogre::Real.

void Ogre::AnimationState::setWeight Real    weight
 

Sets the weight (influence) of this animation.

Definition at line 112 of file OgreAnimationState.cpp.

References mWeight, and Ogre::Real.


Member Data Documentation

String Ogre::AnimationState::mAnimationName [protected]
 

Definition at line 107 of file OgreAnimationState.h.

Referenced by getAnimationName(), operator==(), and setAnimationName().

bool Ogre::AnimationState::mEnabled [protected]
 

Definition at line 112 of file OgreAnimationState.h.

Referenced by copyStateFrom(), getEnabled(), operator==(), and setEnabled().

Real Ogre::AnimationState::mInvLength [protected]
 

Definition at line 110 of file OgreAnimationState.h.

Referenced by AnimationState(), copyStateFrom(), getValue(), and setLength().

Real Ogre::AnimationState::mLength [protected]
 

Definition at line 109 of file OgreAnimationState.h.

Referenced by AnimationState(), copyStateFrom(), getLength(), operator==(), setLength(), setTimePosition(), and setValue().

bool Ogre::AnimationState::mLoop [protected]
 

Definition at line 113 of file OgreAnimationState.h.

Referenced by AnimationState(), copyStateFrom(), and operator==().

Real Ogre::AnimationState::mTimePos [protected]
 

Definition at line 108 of file OgreAnimationState.h.

Referenced by addTime(), AnimationState(), copyStateFrom(), getTimePosition(), getValue(), operator==(), setTimePosition(), and setValue().

Real Ogre::AnimationState::mWeight [protected]
 

Definition at line 111 of file OgreAnimationState.h.

Referenced by AnimationState(), copyStateFrom(), getWeight(), operator==(), and setWeight().


The documentation for this class was generated from the following files:

Copyright © 2002-2003 by The OGRE Team
Last modified Sun Nov 28 19:50:46 2004