<html>
<head>
<title>Ogre::KeyFrame class Reference - OGRE Documentation</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<link type="text/css" rel="stylesheet" href="style.css">
</head>
<body>
<!-- Generated by Doxygen 1.3.6 -->
<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="namespacemembers.html">Namespace Members</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a> | <a class="qindex" href="pages.html">Related Pages</a></div>
<h1>Ogre::KeyFrame Class Reference</h1>A key frame in an animation sequence defined by an <a class="el" href="classOgre_1_1AnimationTrack.html">AnimationTrack</a>.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="OgreKeyFrame_8h-source.html">OgreKeyFrame.h</a>></code>
<p>
<a href="classOgre_1_1KeyFrame-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1KeyFrame.html#Ogre_1_1KeyFramea0">KeyFrame</a> (const <a class="el" href="classOgre_1_1AnimationTrack.html">AnimationTrack</a> *parent, <a class="el" href="namespaceOgre.html#a420">Real</a> time)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor, you should not call this but use <a class="el" href="classOgre_1_1AnimationTrack.html#Ogre_1_1AnimationTracka6">AnimationTrack::createKeyFrame</a> instead. <a href="#Ogre_1_1KeyFramea0"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a420">Real</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1KeyFrame.html#Ogre_1_1KeyFramea1">getTime</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the time of this keyframe in the animation sequence. <a href="#Ogre_1_1KeyFramea1"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1KeyFrame.html#Ogre_1_1KeyFramea2">setTranslate</a> (const <a class="el" href="classOgre_1_1Vector3.html">Vector3</a> &trans)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the translation associated with this keyframe. <a href="#Ogre_1_1KeyFramea2"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="classOgre_1_1Vector3.html">Vector3</a> & </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1KeyFrame.html#Ogre_1_1KeyFramea3">getTranslate</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the translation applied by this keyframe. <a href="#Ogre_1_1KeyFramea3"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1KeyFrame.html#Ogre_1_1KeyFramea4">setScale</a> (const <a class="el" href="classOgre_1_1Vector3.html">Vector3</a> &scale)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the scaling factor applied by this keyframe to the animable object at it's time index. <a href="#Ogre_1_1KeyFramea4"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="classOgre_1_1Vector3.html">Vector3</a> & </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1KeyFrame.html#Ogre_1_1KeyFramea5">getScale</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the scaling factor applied by this keyframe. <a href="#Ogre_1_1KeyFramea5"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1KeyFrame.html#Ogre_1_1KeyFramea6">setRotation</a> (const <a class="el" href="classOgre_1_1Quaternion.html">Quaternion</a> &rot)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the rotation applied by this keyframe. <a href="#Ogre_1_1KeyFramea6"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="classOgre_1_1Quaternion.html">Quaternion</a> & </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1KeyFrame.html#Ogre_1_1KeyFramea7">getRotation</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the rotation applied by this keyframe. <a href="#Ogre_1_1KeyFramea7"></a><br><br></td></tr>
<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a420">Real</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1KeyFrame.html#Ogre_1_1KeyFramep0">mTime</a></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1Vector3.html">Vector3</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1KeyFrame.html#Ogre_1_1KeyFramep1">mTranslate</a></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1Vector3.html">Vector3</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1KeyFrame.html#Ogre_1_1KeyFramep2">mScale</a></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1Quaternion.html">Quaternion</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1KeyFrame.html#Ogre_1_1KeyFramep3">mRotate</a></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="classOgre_1_1AnimationTrack.html">AnimationTrack</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1KeyFrame.html#Ogre_1_1KeyFramep4">mParentTrack</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A key frame in an animation sequence defined by an <a class="el" href="classOgre_1_1AnimationTrack.html">AnimationTrack</a>.
<p>
<dl compact><dt><b>Remarks:</b></dt><dd>This class can be used as a basis for all kinds of key frames. The unifying principle is that multiple KeyFrames define an animation sequence, with the exact state of the animation being an interpolation between these key frames. </dd></dl>
<p>
<p>
Definition at line <a class="el" href="OgreKeyFrame_8h-source.html#l00043">43</a> of file <a class="el" href="OgreKeyFrame_8h-source.html">OgreKeyFrame.h</a>.<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="Ogre_1_1KeyFramea0" doxytag="Ogre::KeyFrame::KeyFrame" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> Ogre::KeyFrame::KeyFrame </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1AnimationTrack.html">AnimationTrack</a> * </td>
<td class="mdname" nowrap> <em>parent</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap><a class="el" href="namespaceOgre.html#a420">Real</a> </td>
<td class="mdname" nowrap> <em>time</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Default constructor, you should not call this but use <a class="el" href="classOgre_1_1AnimationTrack.html#Ogre_1_1AnimationTracka6">AnimationTrack::createKeyFrame</a> instead.
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="Ogre_1_1KeyFramea7" doxytag="Ogre::KeyFrame::getRotation" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> const <a class="el" href="classOgre_1_1Quaternion.html">Quaternion</a>& Ogre::KeyFrame::getRotation </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Gets the rotation applied by this keyframe.
<p>
</td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1KeyFramea5" doxytag="Ogre::KeyFrame::getScale" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> const <a class="el" href="classOgre_1_1Vector3.html">Vector3</a>& Ogre::KeyFrame::getScale </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Gets the scaling factor applied by this keyframe.
<p>
</td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1KeyFramea1" doxytag="Ogre::KeyFrame::getTime" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a420">Real</a> Ogre::KeyFrame::getTime </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Gets the time of this keyframe in the animation sequence.
<p>
</td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1KeyFramea3" doxytag="Ogre::KeyFrame::getTranslate" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> const <a class="el" href="classOgre_1_1Vector3.html">Vector3</a>& Ogre::KeyFrame::getTranslate </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Gets the translation applied by this keyframe.
<p>
</td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1KeyFramea6" doxytag="Ogre::KeyFrame::setRotation" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Ogre::KeyFrame::setRotation </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1Quaternion.html">Quaternion</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>rot</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Sets the rotation applied by this keyframe.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>rot</em> </td><td>The rotation applied; use <a class="el" href="classOgre_1_1Quaternion.html">Quaternion</a> methods to convert from angle/axis or <a class="el" href="classOgre_1_1Matrix3.html">Matrix3</a> if you don't like using Quaternions directly. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1KeyFramea4" doxytag="Ogre::KeyFrame::setScale" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Ogre::KeyFrame::setScale </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1Vector3.html">Vector3</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>scale</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Sets the scaling factor applied by this keyframe to the animable object at it's time index.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>scale</em> </td><td>The vector to scale by (beware of supplying zero values for any component of this vector, it will scale the object to zero dimensions) </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1KeyFramea2" doxytag="Ogre::KeyFrame::setTranslate" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Ogre::KeyFrame::setTranslate </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1Vector3.html">Vector3</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>trans</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Sets the translation associated with this keyframe.
<p>
<dl compact><dt><b>Remarks:</b></dt><dd>The translation factor affects how much the keyframe translates (moves) it's animable object at it's time index. </dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>trans</em> </td><td>The vector to translate by </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="Ogre_1_1KeyFramep4" doxytag="Ogre::KeyFrame::mParentTrack" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> const <a class="el" href="classOgre_1_1AnimationTrack.html">AnimationTrack</a>* <a class="el" href="classOgre_1_1KeyFrame.html#Ogre_1_1KeyFramep4">Ogre::KeyFrame::mParentTrack</a><code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="OgreKeyFrame_8h-source.html#l00088">88</a> of file <a class="el" href="OgreKeyFrame_8h-source.html">OgreKeyFrame.h</a>. </td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1KeyFramep3" doxytag="Ogre::KeyFrame::mRotate" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1Quaternion.html">Quaternion</a> <a class="el" href="classOgre_1_1KeyFrame.html#Ogre_1_1KeyFramep3">Ogre::KeyFrame::mRotate</a><code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="OgreKeyFrame_8h-source.html#l00087">87</a> of file <a class="el" href="OgreKeyFrame_8h-source.html">OgreKeyFrame.h</a>. </td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1KeyFramep2" doxytag="Ogre::KeyFrame::mScale" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1Vector3.html">Vector3</a> <a class="el" href="classOgre_1_1KeyFrame.html#Ogre_1_1KeyFramep2">Ogre::KeyFrame::mScale</a><code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="OgreKeyFrame_8h-source.html#l00086">86</a> of file <a class="el" href="OgreKeyFrame_8h-source.html">OgreKeyFrame.h</a>. </td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1KeyFramep0" doxytag="Ogre::KeyFrame::mTime" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a420">Real</a> <a class="el" href="classOgre_1_1KeyFrame.html#Ogre_1_1KeyFramep0">Ogre::KeyFrame::mTime</a><code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="OgreKeyFrame_8h-source.html#l00084">84</a> of file <a class="el" href="OgreKeyFrame_8h-source.html">OgreKeyFrame.h</a>. </td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1KeyFramep1" doxytag="Ogre::KeyFrame::mTranslate" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1Vector3.html">Vector3</a> <a class="el" href="classOgre_1_1KeyFrame.html#Ogre_1_1KeyFramep1">Ogre::KeyFrame::mTranslate</a><code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="OgreKeyFrame_8h-source.html#l00085">85</a> of file <a class="el" href="OgreKeyFrame_8h-source.html">OgreKeyFrame.h</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="OgreKeyFrame_8h-source.html">OgreKeyFrame.h</a></ul>
<p>
Copyright © 2000-2005 by The OGRE Team<br />
Last modified Wed Feb 23 00:20:33 2005
</p>
</body>
</html>
distrib
>
Mandriva
>
10.2
>
i586
>
media
>
contrib
>
by-pkgid
>
04e5d8c10ae76748689b4e7f48e0fa33
>
files
>
2270
