DigitalSpaces::DIOGREAnimationState Struct Reference
[Ogre]

#include <OGREInterfaces.h>

Inherits DigitalSpaces::DIObjectBase.


Public Member Functions

const char * GetAnimationName ()
 Gets the name of the animation to which this state applies.
float GetTimePosition (void)
 Gets the time position for this animation.
void SetTimePosition (float timePos)
 Sets the time position for this animation.
float GetLength ()
 Gets the total length of this animation (may be shorter than whole animation).
void SetLength (float len)
 Sets the total length of this animation (may be shorter than whole animation).
float GetWeight (void)
 Gets the weight (influence) of this animation.
void SetWeight (float weight)
 Sets the weight (influence) of this animation.
void AddTime (float offset)
 Modifies the time position, adjusting for animation length.
bool GetEnabled (void)
 Returns true if this animation is currently enabled.
void SetEnabled (bool enabled)
 Sets whether this animation is enabled.
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)
 Gets whether or not this animation loops.

Member Function Documentation

const char* DigitalSpaces::DIOGREAnimationState::GetAnimationName (  ) 

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

float DigitalSpaces::DIOGREAnimationState::GetTimePosition ( void   ) 

Gets the time position for this animation.

void DigitalSpaces::DIOGREAnimationState::SetTimePosition ( float  timePos  ) 

Sets the time position for this animation.

float DigitalSpaces::DIOGREAnimationState::GetLength (  ) 

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

void DigitalSpaces::DIOGREAnimationState::SetLength ( float  len  ) 

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

float DigitalSpaces::DIOGREAnimationState::GetWeight ( void   ) 

Gets the weight (influence) of this animation.

void DigitalSpaces::DIOGREAnimationState::SetWeight ( float  weight  ) 

Sets the weight (influence) of this animation.

void DigitalSpaces::DIOGREAnimationState::AddTime ( float  offset  ) 

Modifies the time position, adjusting for animation length.

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

bool DigitalSpaces::DIOGREAnimationState::GetEnabled ( void   ) 

Returns true if this animation is currently enabled.

void DigitalSpaces::DIOGREAnimationState::SetEnabled ( bool  enabled  ) 

Sets whether this animation is enabled.

void DigitalSpaces::DIOGREAnimationState::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 DigitalSpaces::DIOGREAnimationState::GetLoop ( void   ) 

Gets whether or not this animation loops.


The documentation for this struct was generated from the following file:

Generated on Sun Aug 31 17:46:32 2008 for Digital Spaces by  doxygen 1.5.6