Ogre::VertexPoseKeyFrame Class Reference

Specialised KeyFrame which references a Mesh::Pose at a certain influence level, which stores offsets for a subset of the vertices in a buffer to provide a blendable pose. More...

#include <OgreKeyFrame.h>

Inheritance diagram for Ogre::VertexPoseKeyFrame:

Classes
struct	PoseRef
	Reference to a pose at a given influence level. More...

Public Types
typedef ConstVectorIterator< PoseRefList >	ConstPoseRefIterator
typedef VectorIterator< PoseRefList >	PoseRefIterator
typedef vector< PoseRef >::type	PoseRefList

Public Member Functions
	VertexPoseKeyFrame (const AnimationTrack *parent, Real time)
	Default constructor, you should not call this but use AnimationTrack::createKeyFrame instead.
	~VertexPoseKeyFrame ()
void	_applyBaseKeyFrame (const VertexPoseKeyFrame *base)
KeyFrame *	_clone (AnimationTrack *newParent) const
	Clone a keyframe (internal use only).
void	addPoseReference (ushort poseIndex, Real influence)
	Add a new pose reference.
PoseRefIterator	getPoseReferenceIterator (void)
	Get an iterator over the pose references.
ConstPoseRefIterator	getPoseReferenceIterator (void) const
	Get a const iterator over the pose references.
const PoseRefList &	getPoseReferences (void) const
	Get a const reference to the list of pose references.
Real	getTime (void) const
	Gets the time of this keyframe in the animation sequence.
void	operator delete (void *ptr)
void	operator delete (void *ptr, const char *, int, const char *)
void	operator delete (void *ptr, void *)
void	operator delete[] (void *ptr)
void	operator delete[] (void *ptr, const char *, int, const char *)
void *	operator new (size_t sz)
void *	operator new (size_t sz, const char *file, int line, const char *func)
	operator new, with debug line info
void *	operator new (size_t sz, void *ptr)
	placement operator new
void *	operator new[] (size_t sz)
void *	operator new[] (size_t sz, const char *file, int line, const char *func)
	array operator new, with debug line info
void	removeAllPoseReferences (void)
	Remove all pose references.
void	removePoseReference (ushort poseIndex)
	Remove reference to a given pose.
void	updatePoseReference (ushort poseIndex, Real influence)
	Update the influence of a pose reference.

Protected Attributes
const AnimationTrack *	mParentTrack
PoseRefList	mPoseRefs
Real	mTime

Detailed Description

Specialised KeyFrame which references a Mesh::Pose at a certain influence level, which stores offsets for a subset of the vertices in a buffer to provide a blendable pose.

Definition at line 184 of file OgreKeyFrame.h.

Member Typedef Documentation

ConstPoseRefIterator

typedef ConstVectorIterator<PoseRefList> Ogre::VertexPoseKeyFrame::ConstPoseRefIterator

Definition at line 234 of file OgreKeyFrame.h.

PoseRefIterator

typedef VectorIterator<PoseRefList> Ogre::VertexPoseKeyFrame::PoseRefIterator

Definition at line 233 of file OgreKeyFrame.h.

PoseRefList

typedef vector<PoseRef>::type Ogre::VertexPoseKeyFrame::PoseRefList

Definition at line 212 of file OgreKeyFrame.h.

Constructor & Destructor Documentation

VertexPoseKeyFrame()

Ogre::VertexPoseKeyFrame::VertexPoseKeyFrame	(	const AnimationTrack *	parent,
		Real	time )

Default constructor, you should not call this but use AnimationTrack::createKeyFrame instead.

Referenced by _applyBaseKeyFrame().

~VertexPoseKeyFrame()

Ogre::VertexPoseKeyFrame::~VertexPoseKeyFrame

(

)

Definition at line 189 of file OgreKeyFrame.h.

Member Function Documentation

_applyBaseKeyFrame()

void Ogre::VertexPoseKeyFrame::_applyBaseKeyFrame

(

const VertexPoseKeyFrame *

base

)

References VertexPoseKeyFrame().

_clone()

KeyFrame * Ogre::VertexPoseKeyFrame::_clone ( AnimationTrack * newParent ) const

virtual

Clone a keyframe (internal use only).

Reimplemented from Ogre::KeyFrame.

References Ogre::KeyFrame::KeyFrame().

addPoseReference()

void Ogre::VertexPoseKeyFrame::addPoseReference	(	ushort	poseIndex,
		Real	influence )

Add a new pose reference.

See also

PoseRef

getPoseReferenceIterator() [1/2]

PoseRefIterator Ogre::VertexPoseKeyFrame::getPoseReferenceIterator

(

void

)

Get an iterator over the pose references.

getPoseReferenceIterator() [2/2]

ConstPoseRefIterator Ogre::VertexPoseKeyFrame::getPoseReferenceIterator

(

void

)

const

Get a const iterator over the pose references.

getPoseReferences()

const PoseRefList & Ogre::VertexPoseKeyFrame::getPoseReferences

(

void

)

const

Get a const reference to the list of pose references.

getTime()

Real Ogre::KeyFrame::getTime ( void ) const

inherited

Gets the time of this keyframe in the animation sequence.

Definition at line 66 of file OgreKeyFrame.h.

References mTime.

operator delete() [1/3]

void Ogre::AllocatedObject< AnimationAllocPolicy >::operator delete ( void * ptr )

inherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

operator delete() [2/3]

void Ogre::AllocatedObject< AnimationAllocPolicy >::operator delete ( void * ptr, const char * , int , const char *  )

inherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

operator delete() [3/3]

void Ogre::AllocatedObject< AnimationAllocPolicy >::operator delete ( void * ptr, void *  )

inherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

operator delete[]() [1/2]

void Ogre::AllocatedObject< AnimationAllocPolicy >::operator delete[] ( void * ptr )

inherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

operator delete[]() [2/2]

void Ogre::AllocatedObject< AnimationAllocPolicy >::operator delete[] ( void * ptr, const char * , int , const char *  )

inherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

operator new() [1/3]

void * Ogre::AllocatedObject< AnimationAllocPolicy >::operator new ( size_t sz )

inherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

operator new() [2/3]

void * Ogre::AllocatedObject< AnimationAllocPolicy >::operator new ( size_t sz, const char * file, int line, const char * func )

inherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

operator new() [3/3]

void * Ogre::AllocatedObject< AnimationAllocPolicy >::operator new ( size_t sz, void * ptr )

inherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

operator new[]() [1/2]

void * Ogre::AllocatedObject< AnimationAllocPolicy >::operator new[] ( size_t sz )

inherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

operator new[]() [2/2]

void * Ogre::AllocatedObject< AnimationAllocPolicy >::operator new[] ( size_t sz, const char * file, int line, const char * func )

inherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

removeAllPoseReferences()

void Ogre::VertexPoseKeyFrame::removeAllPoseReferences

(

void

)

Remove all pose references.

removePoseReference()

void Ogre::VertexPoseKeyFrame::removePoseReference

(

ushort

poseIndex

)

Remove reference to a given pose.

Parameters

poseIndex

The pose index (not the index of the reference)

updatePoseReference()

void Ogre::VertexPoseKeyFrame::updatePoseReference	(	ushort	poseIndex,
		Real	influence )

Update the influence of a pose reference.

See also

PoseRef

Member Data Documentation

mParentTrack

const AnimationTrack* Ogre::KeyFrame::mParentTrack

protectedinherited

Definition at line 74 of file OgreKeyFrame.h.

mPoseRefs

PoseRefList Ogre::VertexPoseKeyFrame::mPoseRefs

protected

Definition at line 248 of file OgreKeyFrame.h.

mTime

Real Ogre::KeyFrame::mTime

protectedinherited

Definition at line 73 of file OgreKeyFrame.h.

Referenced by getTime().

---

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

• OgreKeyFrame.h