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

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

adding ogre 1.2 and dependencies
Line 
1<html>
2<head>
3<title>Ogre::NumericKeyFrame 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::NumericKeyFrame Class Reference</h1>Specialised <a class="el" href="classOgre_1_1KeyFrame.html">KeyFrame</a> which stores any numeric value. 
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::NumericKeyFrame:
16<p><center><img src="classOgre_1_1NumericKeyFrame.png" usemap="#Ogre::NumericKeyFrame_map" border="0" alt=""></center>
17<map name="Ogre::NumericKeyFrame_map">
18<area href="classOgre_1_1KeyFrame.html" alt="Ogre::KeyFrame" shape="rect" coords="0,0,152,24">
19</map>
20<a href="classOgre_1_1NumericKeyFrame-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
21<tr><td></td></tr>
22<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
23<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1NumericKeyFrame.html#Ogre_1_1NumericKeyFramea0">NumericKeyFrame</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>
24
25<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_1NumericKeyFramea0"></a><br><br></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_1NumericKeyFrame.html#Ogre_1_1NumericKeyFramea1">~NumericKeyFrame</a> ()</td></tr>
27
28<tr><td class="memItemLeft" nowrap align=right valign=top>virtual const <a class="el" href="classOgre_1_1AnyNumeric.html">AnyNumeric</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1NumericKeyFrame.html#Ogre_1_1NumericKeyFramea2">getValue</a> (void) const </td></tr>
29
30<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the value at this keyframe.  <a href="#Ogre_1_1NumericKeyFramea2"></a><br><br></td></tr>
31<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1NumericKeyFrame.html#Ogre_1_1NumericKeyFramea3">setValue</a> (const <a class="el" href="classOgre_1_1AnyNumeric.html">AnyNumeric</a> &amp;val)</td></tr>
32
33<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the value at this keyframe.  <a href="#Ogre_1_1NumericKeyFramea3"></a><br><br></td></tr>
34<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>
35
36<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>
37<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
38<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1AnyNumeric.html">AnyNumeric</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1NumericKeyFrame.html#Ogre_1_1NumericKeyFramep0">mValue</a></td></tr>
39
40<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>
41
42<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>
43
44</table>
45<hr><a name="_details"></a><h2>Detailed Description</h2>
46Specialised <a class="el" href="classOgre_1_1KeyFrame.html">KeyFrame</a> which stores any numeric value.
47<p>
48
49<p>
50
51<p>
52Definition at line <a class="el" href="OgreKeyFrame_8h-source.html#l00067">67</a> of file <a class="el" href="OgreKeyFrame_8h-source.html">OgreKeyFrame.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
53<a class="anchor" name="Ogre_1_1NumericKeyFramea0" doxytag="Ogre::NumericKeyFrame::NumericKeyFrame" ></a><p>
54<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
55  <tr>
56    <td class="mdRow">
57      <table cellpadding="0" cellspacing="0" border="0">
58        <tr>
59          <td class="md" nowrap valign="top"> Ogre::NumericKeyFrame::NumericKeyFrame </td>
60          <td class="md" valign="top">(&nbsp;</td>
61          <td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1AnimationTrack.html">AnimationTrack</a> *&nbsp;</td>
62          <td class="mdname" nowrap> <em>parent</em>, </td>
63        </tr>
64        <tr>
65          <td class="md" nowrap align="right"></td>
66          <td></td>
67          <td class="md" nowrap><a class="el" href="namespaceOgre.html#a465">Real</a>&nbsp;</td>
68          <td class="mdname" nowrap> <em>time</em></td>
69        </tr>
70        <tr>
71          <td></td>
72          <td class="md">)&nbsp;</td>
73          <td class="md" colspan="2"></td>
74        </tr>
75
76      </table>
77    </td>
78  </tr>
79</table>
80<table cellspacing=5 cellpadding=0 border=0>
81  <tr>
82    <td>
83      &nbsp;
84    </td>
85    <td>
86
87<p>
88Default constructor, you should not call this but use <a class="el" href="classOgre_1_1AnimationTrack.html#Ogre_1_1VertexAnimationTracka20">AnimationTrack::createKeyFrame</a> instead.
89<p>
90    </td>
91  </tr>
92</table>
93<a class="anchor" name="Ogre_1_1NumericKeyFramea1" doxytag="Ogre::NumericKeyFrame::~NumericKeyFrame" ></a><p>
94<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
95  <tr>
96    <td class="mdRow">
97      <table cellpadding="0" cellspacing="0" border="0">
98        <tr>
99          <td class="md" nowrap valign="top"> Ogre::NumericKeyFrame::~<a class="el" href="classOgre_1_1NumericKeyFrame.html">NumericKeyFrame</a> </td>
100          <td class="md" valign="top">(&nbsp;</td>
101          <td class="mdname1" valign="top" nowrap>          </td>
102          <td class="md" valign="top">&nbsp;)&nbsp;</td>
103          <td class="md" nowrap></td>
104        </tr>
105
106      </table>
107    </td>
108  </tr>
109</table>
110<table cellspacing=5 cellpadding=0 border=0>
111  <tr>
112    <td>
113      &nbsp;
114    </td>
115    <td>
116
117<p>
118
119<p>
120Definition at line <a class="el" href="OgreKeyFrame_8h-source.html#l00072">72</a> of file <a class="el" href="OgreKeyFrame_8h-source.html">OgreKeyFrame.h</a>.    </td>
121  </tr>
122</table>
123<hr><h2>Member Function Documentation</h2>
124<a class="anchor" name="Ogre_1_1VertexPoseKeyFramea9" doxytag="Ogre::NumericKeyFrame::getTime" ></a><p>
125<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
126  <tr>
127    <td class="mdRow">
128      <table cellpadding="0" cellspacing="0" border="0">
129        <tr>
130          <td class="md" nowrap valign="top"> virtual <a class="el" href="namespaceOgre.html#a465">Real</a> Ogre::KeyFrame::getTime </td>
131          <td class="md" valign="top">(&nbsp;</td>
132          <td class="md" nowrap valign="top">void&nbsp;</td>
133          <td class="mdname1" valign="top" nowrap>          </td>
134          <td class="md" valign="top">&nbsp;)&nbsp;</td>
135          <td class="md" nowrap> const<code> [virtual, inherited]</code></td>
136        </tr>
137
138      </table>
139    </td>
140  </tr>
141</table>
142<table cellspacing=5 cellpadding=0 border=0>
143  <tr>
144    <td>
145      &nbsp;
146    </td>
147    <td>
148
149<p>
150Gets the time of this keyframe in the animation sequence.
151<p>
152    </td>
153  </tr>
154</table>
155<a class="anchor" name="Ogre_1_1NumericKeyFramea2" doxytag="Ogre::NumericKeyFrame::getValue" ></a><p>
156<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
157  <tr>
158    <td class="mdRow">
159      <table cellpadding="0" cellspacing="0" border="0">
160        <tr>
161          <td class="md" nowrap valign="top"> virtual const <a class="el" href="classOgre_1_1AnyNumeric.html">AnyNumeric</a>&amp; Ogre::NumericKeyFrame::getValue </td>
162          <td class="md" valign="top">(&nbsp;</td>
163          <td class="md" nowrap valign="top">void&nbsp;</td>
164          <td class="mdname1" valign="top" nowrap>          </td>
165          <td class="md" valign="top">&nbsp;)&nbsp;</td>
166          <td class="md" nowrap> const<code> [virtual]</code></td>
167        </tr>
168
169      </table>
170    </td>
171  </tr>
172</table>
173<table cellspacing=5 cellpadding=0 border=0>
174  <tr>
175    <td>
176      &nbsp;
177    </td>
178    <td>
179
180<p>
181Get the value at this keyframe.
182<p>
183    </td>
184  </tr>
185</table>
186<a class="anchor" name="Ogre_1_1NumericKeyFramea3" doxytag="Ogre::NumericKeyFrame::setValue" ></a><p>
187<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
188  <tr>
189    <td class="mdRow">
190      <table cellpadding="0" cellspacing="0" border="0">
191        <tr>
192          <td class="md" nowrap valign="top"> virtual void Ogre::NumericKeyFrame::setValue </td>
193          <td class="md" valign="top">(&nbsp;</td>
194          <td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1AnyNumeric.html">AnyNumeric</a> &amp;&nbsp;</td>
195          <td class="mdname1" valign="top" nowrap> <em>val</em>          </td>
196          <td class="md" valign="top">&nbsp;)&nbsp;</td>
197          <td class="md" nowrap><code> [virtual]</code></td>
198        </tr>
199
200      </table>
201    </td>
202  </tr>
203</table>
204<table cellspacing=5 cellpadding=0 border=0>
205  <tr>
206    <td>
207      &nbsp;
208    </td>
209    <td>
210
211<p>
212Set the value at this keyframe.
213<p>
214<dl compact><dt><b>Remarks:</b></dt><dd>All keyframe values must have a consistent type.</dd></dl>
215    </td>
216  </tr>
217</table>
218<hr><h2>Member Data Documentation</h2>
219<a class="anchor" name="Ogre_1_1VertexPoseKeyFramep2" doxytag="Ogre::NumericKeyFrame::mParentTrack" ></a><p>
220<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
221  <tr>
222    <td class="mdRow">
223      <table cellpadding="0" cellspacing="0" border="0">
224        <tr>
225          <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, inherited]</code>
226      </table>
227    </td>
228  </tr>
229</table>
230<table cellspacing=5 cellpadding=0 border=0>
231  <tr>
232    <td>
233      &nbsp;
234    </td>
235    <td>
236
237<p>
238
239<p>
240Definition 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>
241  </tr>
242</table>
243<a class="anchor" name="Ogre_1_1VertexPoseKeyFramep1" doxytag="Ogre::NumericKeyFrame::mTime" ></a><p>
244<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
245  <tr>
246    <td class="mdRow">
247      <table cellpadding="0" cellspacing="0" border="0">
248        <tr>
249          <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, inherited]</code>
250      </table>
251    </td>
252  </tr>
253</table>
254<table cellspacing=5 cellpadding=0 border=0>
255  <tr>
256    <td>
257      &nbsp;
258    </td>
259    <td>
260
261<p>
262
263<p>
264Definition 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>
265  </tr>
266</table>
267<a class="anchor" name="Ogre_1_1NumericKeyFramep0" doxytag="Ogre::NumericKeyFrame::mValue" ></a><p>
268<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
269  <tr>
270    <td class="mdRow">
271      <table cellpadding="0" cellspacing="0" border="0">
272        <tr>
273          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1AnyNumeric.html">AnyNumeric</a> <a class="el" href="classOgre_1_1NumericKeyFrame.html#Ogre_1_1NumericKeyFramep0">Ogre::NumericKeyFrame::mValue</a><code> [protected]</code>
274      </table>
275    </td>
276  </tr>
277</table>
278<table cellspacing=5 cellpadding=0 border=0>
279  <tr>
280    <td>
281      &nbsp;
282    </td>
283    <td>
284
285<p>
286
287<p>
288Definition at line <a class="el" href="OgreKeyFrame_8h-source.html#l00083">83</a> of file <a class="el" href="OgreKeyFrame_8h-source.html">OgreKeyFrame.h</a>.    </td>
289  </tr>
290</table>
291<hr>The documentation for this class was generated from the following file:<ul>
292<li><a class="el" href="OgreKeyFrame_8h-source.html">OgreKeyFrame.h</a></ul>
293<hr>
294<p>
295Copyright &copy; 2000-2005 by The OGRE Team<br />
296<!--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/>
297This 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/>
298                <!--/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#">
299                <Work rdf:about="">
300                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
301        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
302                </Work>
303                <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> -->
304
305Last modified Sun Mar 12 14:39:28 2006
306</p>
307</body>
308</html>
Note: See TracBrowser for help on using the repository browser.