source: OGRE/trunk/ogrenew/Docs/api/html/classOgre_1_1KeyFrame.html @ 692

Revision 692, 11.0 KB checked in by mattausch, 19 years ago (diff)

adding ogre 1.2 and dependencies
Line 
1<html>
2<head>
3<title>Ogre::KeyFrame class Reference - OGRE Documentation</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
4<link type="text/css" rel="stylesheet" href="style.css">
5</head>
6
7<body>
8<!-- Generated by Doxygen 1.3.6 -->
9<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a></div>
10<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>. 
11<a href="#_details">More...</a>
12<p>
13<code>#include &lt;<a class="el" href="OgreKeyFrame_8h-source.html">OgreKeyFrame.h</a>&gt;</code>
14<p>
15<p>Inheritance diagram for Ogre::KeyFrame:
16<p><center><img src="classOgre_1_1KeyFrame.png" usemap="#Ogre::KeyFrame_map" border="0" alt=""></center>
17<map name="Ogre::KeyFrame_map">
18<area href="classOgre_1_1NumericKeyFrame.html" alt="Ogre::NumericKeyFrame" shape="rect" coords="0,56,179,80">
19<area href="classOgre_1_1TransformKeyFrame.html" alt="Ogre::TransformKeyFrame" shape="rect" coords="189,56,368,80">
20<area href="classOgre_1_1VertexMorphKeyFrame.html" alt="Ogre::VertexMorphKeyFrame" shape="rect" coords="378,56,557,80">
21<area href="classOgre_1_1VertexPoseKeyFrame.html" alt="Ogre::VertexPoseKeyFrame" shape="rect" coords="567,56,746,80">
22</map>
23<a href="classOgre_1_1KeyFrame-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
24<tr><td></td></tr>
25<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
26<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</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#a465">Real</a> time)</td></tr>
27
28<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor, you should not call this but use <a class="el" href="classOgre_1_1AnimationTrack.html#Ogre_1_1VertexAnimationTracka20">AnimationTrack::createKeyFrame</a> instead.  <a href="#Ogre_1_1KeyFramea0"></a><br><br></td></tr>
29<tr><td class="memItemLeft" nowrap align=right valign=top>virtual&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1KeyFrame.html#Ogre_1_1KeyFramea1">~KeyFrame</a> ()</td></tr>
30
31<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="namespaceOgre.html#a465">Real</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1KeyFrame.html#Ogre_1_1VertexPoseKeyFramea9">getTime</a> (void) const </td></tr>
32
33<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the time of this keyframe in the animation sequence.  <a href="#Ogre_1_1VertexPoseKeyFramea9"></a><br><br></td></tr>
34<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
35<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a465">Real</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1KeyFrame.html#Ogre_1_1VertexPoseKeyFramep1">mTime</a></td></tr>
36
37<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="classOgre_1_1AnimationTrack.html">AnimationTrack</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1KeyFrame.html#Ogre_1_1VertexPoseKeyFramep2">mParentTrack</a></td></tr>
38
39</table>
40<hr><a name="_details"></a><h2>Detailed Description</h2>
41A key frame in an animation sequence defined by an <a class="el" href="classOgre_1_1AnimationTrack.html">AnimationTrack</a>.
42<p>
43<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>
44
45<p>
46
47<p>
48Definition at line <a class="el" href="OgreKeyFrame_8h-source.html#l00046">46</a> of file <a class="el" href="OgreKeyFrame_8h-source.html">OgreKeyFrame.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
49<a class="anchor" name="Ogre_1_1KeyFramea0" doxytag="Ogre::KeyFrame::KeyFrame" ></a><p>
50<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
51  <tr>
52    <td class="mdRow">
53      <table cellpadding="0" cellspacing="0" border="0">
54        <tr>
55          <td class="md" nowrap valign="top"> Ogre::KeyFrame::KeyFrame </td>
56          <td class="md" valign="top">(&nbsp;</td>
57          <td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1AnimationTrack.html">AnimationTrack</a> *&nbsp;</td>
58          <td class="mdname" nowrap> <em>parent</em>, </td>
59        </tr>
60        <tr>
61          <td class="md" nowrap align="right"></td>
62          <td></td>
63          <td class="md" nowrap><a class="el" href="namespaceOgre.html#a465">Real</a>&nbsp;</td>
64          <td class="mdname" nowrap> <em>time</em></td>
65        </tr>
66        <tr>
67          <td></td>
68          <td class="md">)&nbsp;</td>
69          <td class="md" colspan="2"></td>
70        </tr>
71
72      </table>
73    </td>
74  </tr>
75</table>
76<table cellspacing=5 cellpadding=0 border=0>
77  <tr>
78    <td>
79      &nbsp;
80    </td>
81    <td>
82
83<p>
84Default constructor, you should not call this but use <a class="el" href="classOgre_1_1AnimationTrack.html#Ogre_1_1VertexAnimationTracka20">AnimationTrack::createKeyFrame</a> instead.
85<p>
86    </td>
87  </tr>
88</table>
89<a class="anchor" name="Ogre_1_1KeyFramea1" doxytag="Ogre::KeyFrame::~KeyFrame" ></a><p>
90<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
91  <tr>
92    <td class="mdRow">
93      <table cellpadding="0" cellspacing="0" border="0">
94        <tr>
95          <td class="md" nowrap valign="top"> virtual Ogre::KeyFrame::~<a class="el" href="classOgre_1_1KeyFrame.html">KeyFrame</a> </td>
96          <td class="md" valign="top">(&nbsp;</td>
97          <td class="mdname1" valign="top" nowrap>          </td>
98          <td class="md" valign="top">&nbsp;)&nbsp;</td>
99          <td class="md" nowrap><code> [virtual]</code></td>
100        </tr>
101
102      </table>
103    </td>
104  </tr>
105</table>
106<table cellspacing=5 cellpadding=0 border=0>
107  <tr>
108    <td>
109      &nbsp;
110    </td>
111    <td>
112
113<p>
114
115<p>
116Definition at line <a class="el" href="OgreKeyFrame_8h-source.html#l00053">53</a> of file <a class="el" href="OgreKeyFrame_8h-source.html">OgreKeyFrame.h</a>.    </td>
117  </tr>
118</table>
119<hr><h2>Member Function Documentation</h2>
120<a class="anchor" name="Ogre_1_1VertexPoseKeyFramea9" doxytag="Ogre::KeyFrame::getTime" ></a><p>
121<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
122  <tr>
123    <td class="mdRow">
124      <table cellpadding="0" cellspacing="0" border="0">
125        <tr>
126          <td class="md" nowrap valign="top"> virtual <a class="el" href="namespaceOgre.html#a465">Real</a> Ogre::KeyFrame::getTime </td>
127          <td class="md" valign="top">(&nbsp;</td>
128          <td class="md" nowrap valign="top">void&nbsp;</td>
129          <td class="mdname1" valign="top" nowrap>          </td>
130          <td class="md" valign="top">&nbsp;)&nbsp;</td>
131          <td class="md" nowrap> const<code> [virtual]</code></td>
132        </tr>
133
134      </table>
135    </td>
136  </tr>
137</table>
138<table cellspacing=5 cellpadding=0 border=0>
139  <tr>
140    <td>
141      &nbsp;
142    </td>
143    <td>
144
145<p>
146Gets the time of this keyframe in the animation sequence.
147<p>
148    </td>
149  </tr>
150</table>
151<hr><h2>Member Data Documentation</h2>
152<a class="anchor" name="Ogre_1_1VertexPoseKeyFramep2" doxytag="Ogre::KeyFrame::mParentTrack" ></a><p>
153<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
154  <tr>
155    <td class="mdRow">
156      <table cellpadding="0" cellspacing="0" border="0">
157        <tr>
158          <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_1VertexPoseKeyFramep2">Ogre::KeyFrame::mParentTrack</a><code> [protected]</code>
159      </table>
160    </td>
161  </tr>
162</table>
163<table cellspacing=5 cellpadding=0 border=0>
164  <tr>
165    <td>
166      &nbsp;
167    </td>
168    <td>
169
170<p>
171
172<p>
173Definition at line <a class="el" href="OgreKeyFrame_8h-source.html#l00061">61</a> of file <a class="el" href="OgreKeyFrame_8h-source.html">OgreKeyFrame.h</a>.    </td>
174  </tr>
175</table>
176<a class="anchor" name="Ogre_1_1VertexPoseKeyFramep1" doxytag="Ogre::KeyFrame::mTime" ></a><p>
177<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
178  <tr>
179    <td class="mdRow">
180      <table cellpadding="0" cellspacing="0" border="0">
181        <tr>
182          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a465">Real</a> <a class="el" href="classOgre_1_1KeyFrame.html#Ogre_1_1VertexPoseKeyFramep1">Ogre::KeyFrame::mTime</a><code> [protected]</code>
183      </table>
184    </td>
185  </tr>
186</table>
187<table cellspacing=5 cellpadding=0 border=0>
188  <tr>
189    <td>
190      &nbsp;
191    </td>
192    <td>
193
194<p>
195
196<p>
197Definition at line <a class="el" href="OgreKeyFrame_8h-source.html#l00060">60</a> of file <a class="el" href="OgreKeyFrame_8h-source.html">OgreKeyFrame.h</a>.    </td>
198  </tr>
199</table>
200<hr>The documentation for this class was generated from the following file:<ul>
201<li><a class="el" href="OgreKeyFrame_8h-source.html">OgreKeyFrame.h</a></ul>
202<hr>
203<p>
204Copyright &copy; 2000-2005 by The OGRE Team<br />
205<!--Creative Commons License--><a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/"><img alt="Creative Commons License" border="0" src="http://creativecommons.org/images/public/somerights20.png"/></a><br/>
206This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/">Creative Commons Attribution-ShareAlike 2.5 License</a>.<br/>
207                <!--/Creative Commons License--><!-- <rdf:RDF xmlns="http://web.resource.org/cc/" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
208                <Work rdf:about="">
209                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
210        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
211                </Work>
212                <License rdf:about="http://creativecommons.org/licenses/by-sa/2.5/"><permits rdf:resource="http://web.resource.org/cc/Reproduction"/><permits rdf:resource="http://web.resource.org/cc/Distribution"/><requires rdf:resource="http://web.resource.org/cc/Notice"/><requires rdf:resource="http://web.resource.org/cc/Attribution"/><permits rdf:resource="http://web.resource.org/cc/DerivativeWorks"/><requires rdf:resource="http://web.resource.org/cc/ShareAlike"/></License></rdf:RDF> -->
213
214Last modified Sun Mar 12 14:39:28 2006
215</p>
216</body>
217</html>
Note: See TracBrowser for help on using the repository browser.