Ogre::TimeIndex Class Reference

Time index object used to search keyframe at the given position. More...

#include <OgreAnimationTrack.h>

Public Member Functions
	TimeIndex (Real timePos)
	Construct time index object by the given time position. More...
	TimeIndex (Real timePos, uint keyIndex)
	Construct time index object by the given time position and global keyframe index. More...
uint	getKeyIndex (void) const
Real	getTimePos (void) const
bool	hasKeyIndex (void) const

Protected Attributes
uint	mKeyIndex
	The global keyframe index (in relation to the whole animation sequence) that used to convert to local keyframe index, or INVALID_KEY_INDEX which means global keyframe index unavailable, and then slight slow method will used to search local keyframe index. More...
Real	mTimePos
	The time position (in relation to the whole animation sequence) More...

Static Protected Attributes
static const uint	INVALID_KEY_INDEX = (uint)-1
	Indicate it's an invalid global keyframe index. More...

Detailed Description

Time index object used to search keyframe at the given position.

Definition at line 50 of file OgreAnimationTrack.h.

Constructor & Destructor Documentation

Ogre::TimeIndex::TimeIndex ( Real  timePos )

inline

Construct time index object by the given time position.

Definition at line 70 of file OgreAnimationTrack.h.

Ogre::TimeIndex::TimeIndex ( Real  timePos, uint  keyIndex  )

inline

Construct time index object by the given time position and global keyframe index.

Note

In normally, you don't need to use this constructor directly, use Animation::_getTimeIndex instead.

Definition at line 81 of file OgreAnimationTrack.h.

Member Function Documentation

uint Ogre::TimeIndex::getKeyIndex ( void  ) const

inline

Definition at line 97 of file OgreAnimationTrack.h.

Real Ogre::TimeIndex::getTimePos ( void  ) const

inline

Definition at line 92 of file OgreAnimationTrack.h.

bool Ogre::TimeIndex::hasKeyIndex ( void  ) const

inline

Definition at line 87 of file OgreAnimationTrack.h.

Member Data Documentation

const uint Ogre::TimeIndex::INVALID_KEY_INDEX = (uint)-1

staticprotected

Indicate it's an invalid global keyframe index.

Definition at line 65 of file OgreAnimationTrack.h.

uint Ogre::TimeIndex::mKeyIndex

protected

The global keyframe index (in relation to the whole animation sequence) that used to convert to local keyframe index, or INVALID_KEY_INDEX which means global keyframe index unavailable, and then slight slow method will used to search local keyframe index.

Definition at line 61 of file OgreAnimationTrack.h.

Real Ogre::TimeIndex::mTimePos

protected

The time position (in relation to the whole animation sequence)

Definition at line 55 of file OgreAnimationTrack.h.

---

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

• OgreAnimationTrack.h