Public Member Functions | Protected Attributes | List of all members
Ogre::TransformKeyFrame Class Reference

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

#include <OgreKeyFrame.h>

Inheritance diagram for Ogre::TransformKeyFrame:
Inheritance graph
[legend]

Public Member Functions

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

Protected Attributes

const AnimationTrackmParentTrack
 
Quaternion mRotate
 
Vector3 mScale
 
Real mTime
 
Vector3 mTranslate
 

Detailed Description

Specialised KeyFrame which stores a full transform.

Definition at line 103 of file OgreKeyFrame.h.

Constructor & Destructor Documentation

◆ TransformKeyFrame()

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

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

◆ ~TransformKeyFrame()

Ogre::TransformKeyFrame::~TransformKeyFrame ( )

Definition at line 108 of file OgreKeyFrame.h.

Member Function Documentation

◆ _clone()

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

Clone a keyframe (internal use only)

Reimplemented from Ogre::KeyFrame.

◆ getRotation()

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

Gets the rotation applied by this keyframe.

◆ getScale()

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

Gets the scaling factor applied by this keyframe.

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

◆ getTranslate()

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

Gets the translation applied by this keyframe.

◆ 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,
const char ,
int  ,
const char  
)
inherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

◆ operator delete() [3/3]

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

Definition at line 102 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)
inherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

◆ operator new() [2/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() [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)
inherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

◆ operator new[]() [2/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.

◆ setRotation()

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

Sets the rotation applied by this keyframe.

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

◆ setScale()

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
scaleThe vector to scale by (beware of supplying zero values for any component of this vector, it will scale the object to zero dimensions)

◆ setTranslate()

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
transThe vector to translate by

Member Data Documentation

◆ mParentTrack

const AnimationTrack* Ogre::KeyFrame::mParentTrack
protectedinherited

Definition at line 74 of file OgreKeyFrame.h.

◆ mRotate

Quaternion Ogre::TransformKeyFrame::mRotate
protected

Definition at line 144 of file OgreKeyFrame.h.

◆ mScale

Vector3 Ogre::TransformKeyFrame::mScale
protected

Definition at line 143 of file OgreKeyFrame.h.

◆ mTime

Real Ogre::KeyFrame::mTime
protectedinherited

Definition at line 73 of file OgreKeyFrame.h.

◆ mTranslate

Vector3 Ogre::TransformKeyFrame::mTranslate
protected

Definition at line 142 of file OgreKeyFrame.h.


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

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