Ogre::VertexPoseKeyFrame Class Reference
Core » Animation

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:
[legend]

## 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. More...
| ~VertexPoseKeyFrame ()
void | _applyBaseKeyFrame (const VertexPoseKeyFrame *base)
KeyFrame * | _clone (AnimationTrack *newParent) const
| Clone a keyframe (internal use only) More...
void | addPoseReference (ushort poseIndex, Real influence)
| Add a new pose reference. More...
PoseRefIterator | getPoseReferenceIterator (void)
| Get an iterator over the pose references. More...
ConstPoseRefIterator | getPoseReferenceIterator (void) const
| Get a const iterator over the pose references. More...
const PoseRefList & | getPoseReferences (void) const
| Get a const reference to the list of pose references. More...
Real | getTime (void) const
| Gets the time of this keyframe in the animation sequence. More...
void | operator delete (void *ptr)
void | operator delete (void *ptr, void *)
void | operator delete (void *ptr, const char *, int, const char *)
void | operator delete[] (void *ptr)
void | operator delete[] (void *ptr, const char *, int, const char *)
void * | operator new (size_t sz, const char *file, int line, const char *func)
| operator new, with debug line info More...
void * | operator new (size_t sz)
void * | operator new (size_t sz, void *ptr)
| placement operator new More...
void * | operator new[] (size_t sz, const char *file, int line, const char *func)
| array operator new, with debug line info More...
void * | operator new[] (size_t sz)
void | removeAllPoseReferences (void)
| Remove all pose references. More...
void | removePoseReference (ushort poseIndex)
| Remove reference to a given pose. More...
void | updatePoseReference (ushort poseIndex, Real influence)
| Update the influence of a pose reference. More...

## 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.

## ~VertexPoseKeyFrame()

Ogre::VertexPoseKeyFrame::~VertexPoseKeyFrame | ( |  | ) |

Definition at line 189 of file OgreKeyFrame.h.

## Member Function Documentation

## _applyBaseKeyFrame()

void Ogre::VertexPoseKeyFrame::_applyBaseKeyFrame | ( | const VertexPoseKeyFrame * | base | ) |

## _clone()

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

virtual

Clone a keyframe (internal use only)

Reimplemented from Ogre::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.

## operator delete() [1/3]

template<class Alloc >

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

inherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

## operator delete() [2/3]

template<class Alloc >

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

inherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

## operator delete() [3/3]

template<class Alloc >

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

inherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

## operator delete[]() [1/2]

template<class Alloc >

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

inherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

## operator delete[]() [2/2]

template<class Alloc >

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

inherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

## operator new() [1/3]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::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() [2/3]

template<class Alloc >

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

inherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

## operator new() [3/3]

template<class Alloc >

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

inherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

## operator new[]() [1/2]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::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.

## operator new[]() [2/2]

template<class Alloc >

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

inherited

Definition at line 91 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

protected inherited

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

protected inherited

Definition at line 73 of file OgreKeyFrame.h.

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

- OgreKeyFrame.h

Copyright © 2012 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.