OGRE  1.9.0
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.
 
 TimeIndex (Real timePos, uint keyIndex)
 Construct time index object by the given time position and global keyframe index.
 
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.
 
Real mTimePos
 The time position (in relation to the whole animation sequence)
 

Static Protected Attributes

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

Detailed Description

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

Definition at line 50 of file OgreAnimationTrack.h.

Constructor & Destructor Documentation

◆ TimeIndex() [1/2]

Ogre::TimeIndex::TimeIndex ( Real timePos)

Construct time index object by the given time position.

Definition at line 70 of file OgreAnimationTrack.h.

References INVALID_KEY_INDEX, mKeyIndex, and mTimePos.

◆ TimeIndex() [2/2]

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

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.

References mKeyIndex, and mTimePos.

Member Function Documentation

◆ getKeyIndex()

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

Definition at line 97 of file OgreAnimationTrack.h.

References mKeyIndex.

◆ getTimePos()

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

Definition at line 92 of file OgreAnimationTrack.h.

References mTimePos.

◆ hasKeyIndex()

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

Definition at line 87 of file OgreAnimationTrack.h.

References INVALID_KEY_INDEX, and mKeyIndex.

Member Data Documentation

◆ INVALID_KEY_INDEX

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.

Referenced by TimeIndex(), and hasKeyIndex().

◆ mKeyIndex

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.

Referenced by TimeIndex(), TimeIndex(), getKeyIndex(), and hasKeyIndex().

◆ mTimePos

Real Ogre::TimeIndex::mTimePos
protected

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

Definition at line 55 of file OgreAnimationTrack.h.

Referenced by TimeIndex(), TimeIndex(), and getTimePos().


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