Ogre::TransformKeyFrame Class Reference

Specialised KeyFrame which stores a full transform. More...

#include <OgreKeyFrame.h>

Inheritance diagram for Ogre::TransformKeyFrame:

Inheritance graph
[legend]

List of all members.

Public Member Functions

 TransformKeyFrame (const AnimationTrack *parent, Real time)
 Default constructor, you should not call this but use AnimationTrack::createKeyFrame instead.
 ~TransformKeyFrame ()
virtual void setTranslate (const Vector3 &trans)
 Sets the translation associated with this keyframe.
const Vector3getTranslate (void) const
 Gets the translation applied by this keyframe.
virtual void setScale (const Vector3 &scale)
 Sets the scaling factor applied by this keyframe to the animable object at it's time index.
virtual const Vector3getScale (void) const
 Gets the scaling factor applied by this keyframe.
virtual void setRotation (const Quaternion &rot)
 Sets the rotation applied by this keyframe.
virtual const QuaterniongetRotation (void) const
 Gets the rotation applied by this keyframe.
KeyFrame_clone (AnimationTrack *newParent) const
 Clone a keyframe (internal use only).
Real getTime (void) const
 Gets the time of this keyframe in the animation sequence.
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 * operator new (size_t sz, void *ptr)
 placement operator new
void * operator new[] (size_t sz, const char *file, int line, const char *func)
 array operator new, with debug line info
void * operator new[] (size_t sz)
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 *)

Protected Attributes

Vector3 mTranslate
Vector3 mScale
Quaternion mRotate
Real mTime
const AnimationTrackmParentTrack


Detailed Description

Specialised KeyFrame which stores a full transform.

Definition at line 97 of file OgreKeyFrame.h.


Constructor & Destructor Documentation

Ogre::TransformKeyFrame::TransformKeyFrame ( const AnimationTrack parent,
Real  time 
)

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

Ogre::TransformKeyFrame::~TransformKeyFrame (  ) 

Definition at line 102 of file OgreKeyFrame.h.


Member Function Documentation

virtual void Ogre::TransformKeyFrame::setTranslate ( const Vector3 trans  )  [virtual]

Sets the translation associated with this keyframe.

Remarks:
The translation factor affects how much the keyframe translates (moves) it's animable object at it's time index.
Parameters:
trans The vector to translate by

const Vector3& Ogre::TransformKeyFrame::getTranslate ( void   )  const

Gets the translation applied by this keyframe.

virtual void Ogre::TransformKeyFrame::setScale ( const Vector3 scale  )  [virtual]

Sets the scaling factor applied by this keyframe to the animable object at it's time index.

Parameters:
scale The vector to scale by (beware of supplying zero values for any component of this vector, it will scale the object to zero dimensions)

virtual const Vector3& Ogre::TransformKeyFrame::getScale ( void   )  const [virtual]

Gets the scaling factor applied by this keyframe.

virtual void Ogre::TransformKeyFrame::setRotation ( const Quaternion rot  )  [virtual]

Sets the rotation applied by this keyframe.

Parameters:
rot The rotation applied; use Quaternion methods to convert from angle/axis or Matrix3 if you don't like using Quaternions directly.

virtual const Quaternion& Ogre::TransformKeyFrame::getRotation ( void   )  const [virtual]

Gets the rotation applied by this keyframe.

KeyFrame* Ogre::TransformKeyFrame::_clone ( AnimationTrack newParent  )  const [virtual]

Clone a keyframe (internal use only).

Reimplemented from Ogre::KeyFrame.

Real Ogre::KeyFrame::getTime ( void   )  const [inherited]

Gets the time of this keyframe in the animation sequence.

Definition at line 60 of file OgreKeyFrame.h.

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 62 of file OgreMemoryAllocatedObject.h.

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

Definition at line 67 of file OgreMemoryAllocatedObject.h.

template<class Alloc>
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
void *  ptr 
) [inherited]

placement operator new

Definition at line 73 of file OgreMemoryAllocatedObject.h.

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 79 of file OgreMemoryAllocatedObject.h.

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

Definition at line 84 of file OgreMemoryAllocatedObject.h.

template<class Alloc>
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr  )  [inherited]

Definition at line 89 of file OgreMemoryAllocatedObject.h.

template<class Alloc>
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
void *   
) [inherited]

Definition at line 95 of file OgreMemoryAllocatedObject.h.

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

Definition at line 101 of file OgreMemoryAllocatedObject.h.

template<class Alloc>
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr  )  [inherited]

Definition at line 106 of file OgreMemoryAllocatedObject.h.

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

Definition at line 112 of file OgreMemoryAllocatedObject.h.


Member Data Documentation

Definition at line 136 of file OgreKeyFrame.h.

Definition at line 137 of file OgreKeyFrame.h.

Definition at line 138 of file OgreKeyFrame.h.

Real Ogre::KeyFrame::mTime [protected, inherited]

Definition at line 67 of file OgreKeyFrame.h.

const AnimationTrack* Ogre::KeyFrame::mParentTrack [protected, inherited]

Definition at line 68 of file OgreKeyFrame.h.


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

Copyright © 2008 Torus Knot Software Ltd
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Sep 27 22:03:52 2009