source: OGRE/trunk/ogrenew/Docs/api/html/classOgre_1_1FrameTimeControllerValue.html @ 657

Revision 657, 19.3 KB checked in by mattausch, 18 years ago (diff)

added ogre dependencies and patched ogre sources
Line 
1<html>
2<head>
3<title>Ogre::FrameTimeControllerValue 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::FrameTimeControllerValue Class Reference</h1>Predefined controller value for getting the latest frame time. 
11<a href="#_details">More...</a>
12<p>
13<code>#include &lt;<a class="el" href="OgrePredefinedControllers_8h-source.html">OgrePredefinedControllers.h</a>&gt;</code>
14<p>
15<p>Inheritance diagram for Ogre::FrameTimeControllerValue:
16<p><center><img src="classOgre_1_1FrameTimeControllerValue.png" usemap="#Ogre::FrameTimeControllerValue_map" border="0" alt=""></center>
17<map name="Ogre::FrameTimeControllerValue_map">
18<area href="classOgre_1_1ControllerValue.html" alt="Ogre::ControllerValue< Real >" shape="rect" coords="0,0,198,24">
19<area href="classOgre_1_1FrameListener.html" alt="Ogre::FrameListener" shape="rect" coords="208,0,406,24">
20</map>
21<a href="classOgre_1_1FrameTimeControllerValue-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
22<tr><td></td></tr>
23<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
24<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1FrameTimeControllerValue.html#Ogre_1_1FrameTimeControllerValuea0">FrameTimeControllerValue</a> ()</td></tr>
25
26<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1FrameTimeControllerValue.html#Ogre_1_1FrameTimeControllerValuea1">frameEnded</a> (const <a class="el" href="structOgre_1_1FrameEvent.html">FrameEvent</a> &amp;evt)</td></tr>
27
28<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called just after a frame has been rendered.  <a href="#Ogre_1_1FrameTimeControllerValuea1"></a><br><br></td></tr>
29<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1FrameTimeControllerValue.html#Ogre_1_1FrameTimeControllerValuea2">frameStarted</a> (const <a class="el" href="structOgre_1_1FrameEvent.html">FrameEvent</a> &amp;evt)</td></tr>
30
31<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called when a frame is about to begin rendering.  <a href="#Ogre_1_1FrameTimeControllerValuea2"></a><br><br></td></tr>
32<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a420">Real</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1FrameTimeControllerValue.html#Ogre_1_1FrameTimeControllerValuea3">getValue</a> (void) const </td></tr>
33
34<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1FrameTimeControllerValue.html#Ogre_1_1FrameTimeControllerValuea4">setValue</a> (<a class="el" href="namespaceOgre.html#a420">Real</a> value)</td></tr>
35
36<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a420">Real</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1FrameTimeControllerValue.html#Ogre_1_1FrameTimeControllerValuea5">getTimeFactor</a> (void) const </td></tr>
37
38<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1FrameTimeControllerValue.html#Ogre_1_1FrameTimeControllerValuea6">setTimeFactor</a> (<a class="el" href="namespaceOgre.html#a420">Real</a> tf)</td></tr>
39
40<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a420">Real</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1FrameTimeControllerValue.html#Ogre_1_1FrameTimeControllerValuea7">getElapsedTime</a> (void) const </td></tr>
41
42<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1FrameTimeControllerValue.html#Ogre_1_1FrameTimeControllerValuea8">setElapsedTime</a> (<a class="el" href="namespaceOgre.html#a420">Real</a> elapsedTime)</td></tr>
43
44<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
45<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a420">Real</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1FrameTimeControllerValue.html#Ogre_1_1FrameTimeControllerValuep0">mFrameTime</a></td></tr>
46
47<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a420">Real</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1FrameTimeControllerValue.html#Ogre_1_1FrameTimeControllerValuep1">mTimeFactor</a></td></tr>
48
49<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a420">Real</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1FrameTimeControllerValue.html#Ogre_1_1FrameTimeControllerValuep2">mElapsedTime</a></td></tr>
50
51</table>
52<hr><a name="_details"></a><h2>Detailed Description</h2>
53Predefined controller value for getting the latest frame time.
54<p>
55
56<p>
57Definition at line <a class="el" href="OgrePredefinedControllers_8h-source.html#l00042">42</a> of file <a class="el" href="OgrePredefinedControllers_8h-source.html">OgrePredefinedControllers.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
58<a class="anchor" name="Ogre_1_1FrameTimeControllerValuea0" doxytag="Ogre::FrameTimeControllerValue::FrameTimeControllerValue" ></a><p>
59<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
60  <tr>
61    <td class="mdRow">
62      <table cellpadding="0" cellspacing="0" border="0">
63        <tr>
64          <td class="md" nowrap valign="top"> Ogre::FrameTimeControllerValue::FrameTimeControllerValue </td>
65          <td class="md" valign="top">(&nbsp;</td>
66          <td class="mdname1" valign="top" nowrap>          </td>
67          <td class="md" valign="top">&nbsp;)&nbsp;</td>
68          <td class="md" nowrap></td>
69        </tr>
70
71      </table>
72    </td>
73  </tr>
74</table>
75<table cellspacing=5 cellpadding=0 border=0>
76  <tr>
77    <td>
78      &nbsp;
79    </td>
80    <td>
81
82<p>
83    </td>
84  </tr>
85</table>
86<hr><h2>Member Function Documentation</h2>
87<a class="anchor" name="Ogre_1_1FrameTimeControllerValuea1" doxytag="Ogre::FrameTimeControllerValue::frameEnded" ></a><p>
88<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
89  <tr>
90    <td class="mdRow">
91      <table cellpadding="0" cellspacing="0" border="0">
92        <tr>
93          <td class="md" nowrap valign="top"> bool Ogre::FrameTimeControllerValue::frameEnded </td>
94          <td class="md" valign="top">(&nbsp;</td>
95          <td class="md" nowrap valign="top">const <a class="el" href="structOgre_1_1FrameEvent.html">FrameEvent</a> &amp;&nbsp;</td>
96          <td class="mdname1" valign="top" nowrap> <em>evt</em>          </td>
97          <td class="md" valign="top">&nbsp;)&nbsp;</td>
98          <td class="md" nowrap><code> [virtual]</code></td>
99        </tr>
100
101      </table>
102    </td>
103  </tr>
104</table>
105<table cellspacing=5 cellpadding=0 border=0>
106  <tr>
107    <td>
108      &nbsp;
109    </td>
110    <td>
111
112<p>
113Called just after a frame has been rendered.
114<p>
115<dl compact><dt><b>Returns:</b></dt><dd>True to continue with the next frame, false to drop out of the rendering loop. </dd></dl>
116
117<p>
118Reimplemented from <a class="el" href="classOgre_1_1FrameListener.html#Ogre_1_1FrameListenera1">Ogre::FrameListener</a>.    </td>
119  </tr>
120</table>
121<a class="anchor" name="Ogre_1_1FrameTimeControllerValuea2" doxytag="Ogre::FrameTimeControllerValue::frameStarted" ></a><p>
122<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
123  <tr>
124    <td class="mdRow">
125      <table cellpadding="0" cellspacing="0" border="0">
126        <tr>
127          <td class="md" nowrap valign="top"> bool Ogre::FrameTimeControllerValue::frameStarted </td>
128          <td class="md" valign="top">(&nbsp;</td>
129          <td class="md" nowrap valign="top">const <a class="el" href="structOgre_1_1FrameEvent.html">FrameEvent</a> &amp;&nbsp;</td>
130          <td class="mdname1" valign="top" nowrap> <em>evt</em>          </td>
131          <td class="md" valign="top">&nbsp;)&nbsp;</td>
132          <td class="md" nowrap><code> [virtual]</code></td>
133        </tr>
134
135      </table>
136    </td>
137  </tr>
138</table>
139<table cellspacing=5 cellpadding=0 border=0>
140  <tr>
141    <td>
142      &nbsp;
143    </td>
144    <td>
145
146<p>
147Called when a frame is about to begin rendering.
148<p>
149<dl compact><dt><b>Returns:</b></dt><dd>True to go ahead, false to abort rendering and drop out of the rendering loop. </dd></dl>
150
151<p>
152Reimplemented from <a class="el" href="classOgre_1_1FrameListener.html#Ogre_1_1FrameListenera0">Ogre::FrameListener</a>.    </td>
153  </tr>
154</table>
155<a class="anchor" name="Ogre_1_1FrameTimeControllerValuea7" doxytag="Ogre::FrameTimeControllerValue::getElapsedTime" ></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"> <a class="el" href="namespaceOgre.html#a420">Real</a> Ogre::FrameTimeControllerValue::getElapsedTime </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</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>
181    </td>
182  </tr>
183</table>
184<a class="anchor" name="Ogre_1_1FrameTimeControllerValuea5" doxytag="Ogre::FrameTimeControllerValue::getTimeFactor" ></a><p>
185<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
186  <tr>
187    <td class="mdRow">
188      <table cellpadding="0" cellspacing="0" border="0">
189        <tr>
190          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a420">Real</a> Ogre::FrameTimeControllerValue::getTimeFactor </td>
191          <td class="md" valign="top">(&nbsp;</td>
192          <td class="md" nowrap valign="top">void&nbsp;</td>
193          <td class="mdname1" valign="top" nowrap>          </td>
194          <td class="md" valign="top">&nbsp;)&nbsp;</td>
195          <td class="md" nowrap> const</td>
196        </tr>
197
198      </table>
199    </td>
200  </tr>
201</table>
202<table cellspacing=5 cellpadding=0 border=0>
203  <tr>
204    <td>
205      &nbsp;
206    </td>
207    <td>
208
209<p>
210    </td>
211  </tr>
212</table>
213<a class="anchor" name="Ogre_1_1FrameTimeControllerValuea3" doxytag="Ogre::FrameTimeControllerValue::getValue" ></a><p>
214<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
215  <tr>
216    <td class="mdRow">
217      <table cellpadding="0" cellspacing="0" border="0">
218        <tr>
219          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a420">Real</a> Ogre::FrameTimeControllerValue::getValue </td>
220          <td class="md" valign="top">(&nbsp;</td>
221          <td class="md" nowrap valign="top">void&nbsp;</td>
222          <td class="mdname1" valign="top" nowrap>          </td>
223          <td class="md" valign="top">&nbsp;)&nbsp;</td>
224          <td class="md" nowrap> const<code> [virtual]</code></td>
225        </tr>
226
227      </table>
228    </td>
229  </tr>
230</table>
231<table cellspacing=5 cellpadding=0 border=0>
232  <tr>
233    <td>
234      &nbsp;
235    </td>
236    <td>
237
238<p>
239
240<p>
241Implements <a class="el" href="classOgre_1_1ControllerValue.html#Ogre_1_1ControllerValuea1">Ogre::ControllerValue&lt; Real &gt;</a>.    </td>
242  </tr>
243</table>
244<a class="anchor" name="Ogre_1_1FrameTimeControllerValuea8" doxytag="Ogre::FrameTimeControllerValue::setElapsedTime" ></a><p>
245<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
246  <tr>
247    <td class="mdRow">
248      <table cellpadding="0" cellspacing="0" border="0">
249        <tr>
250          <td class="md" nowrap valign="top"> void Ogre::FrameTimeControllerValue::setElapsedTime </td>
251          <td class="md" valign="top">(&nbsp;</td>
252          <td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a420">Real</a>&nbsp;</td>
253          <td class="mdname1" valign="top" nowrap> <em>elapsedTime</em>          </td>
254          <td class="md" valign="top">&nbsp;)&nbsp;</td>
255          <td class="md" nowrap></td>
256        </tr>
257
258      </table>
259    </td>
260  </tr>
261</table>
262<table cellspacing=5 cellpadding=0 border=0>
263  <tr>
264    <td>
265      &nbsp;
266    </td>
267    <td>
268
269<p>
270    </td>
271  </tr>
272</table>
273<a class="anchor" name="Ogre_1_1FrameTimeControllerValuea6" doxytag="Ogre::FrameTimeControllerValue::setTimeFactor" ></a><p>
274<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
275  <tr>
276    <td class="mdRow">
277      <table cellpadding="0" cellspacing="0" border="0">
278        <tr>
279          <td class="md" nowrap valign="top"> void Ogre::FrameTimeControllerValue::setTimeFactor </td>
280          <td class="md" valign="top">(&nbsp;</td>
281          <td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a420">Real</a>&nbsp;</td>
282          <td class="mdname1" valign="top" nowrap> <em>tf</em>          </td>
283          <td class="md" valign="top">&nbsp;)&nbsp;</td>
284          <td class="md" nowrap></td>
285        </tr>
286
287      </table>
288    </td>
289  </tr>
290</table>
291<table cellspacing=5 cellpadding=0 border=0>
292  <tr>
293    <td>
294      &nbsp;
295    </td>
296    <td>
297
298<p>
299    </td>
300  </tr>
301</table>
302<a class="anchor" name="Ogre_1_1FrameTimeControllerValuea4" doxytag="Ogre::FrameTimeControllerValue::setValue" ></a><p>
303<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
304  <tr>
305    <td class="mdRow">
306      <table cellpadding="0" cellspacing="0" border="0">
307        <tr>
308          <td class="md" nowrap valign="top"> void Ogre::FrameTimeControllerValue::setValue </td>
309          <td class="md" valign="top">(&nbsp;</td>
310          <td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a420">Real</a>&nbsp;</td>
311          <td class="mdname1" valign="top" nowrap> <em>value</em>          </td>
312          <td class="md" valign="top">&nbsp;)&nbsp;</td>
313          <td class="md" nowrap><code> [virtual]</code></td>
314        </tr>
315
316      </table>
317    </td>
318  </tr>
319</table>
320<table cellspacing=5 cellpadding=0 border=0>
321  <tr>
322    <td>
323      &nbsp;
324    </td>
325    <td>
326
327<p>
328
329<p>
330Implements <a class="el" href="classOgre_1_1ControllerValue.html#Ogre_1_1ControllerValuea2">Ogre::ControllerValue&lt; Real &gt;</a>.    </td>
331  </tr>
332</table>
333<hr><h2>Member Data Documentation</h2>
334<a class="anchor" name="Ogre_1_1FrameTimeControllerValuep2" doxytag="Ogre::FrameTimeControllerValue::mElapsedTime" ></a><p>
335<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
336  <tr>
337    <td class="mdRow">
338      <table cellpadding="0" cellspacing="0" border="0">
339        <tr>
340          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a420">Real</a> <a class="el" href="classOgre_1_1FrameTimeControllerValue.html#Ogre_1_1FrameTimeControllerValuep2">Ogre::FrameTimeControllerValue::mElapsedTime</a><code> [protected]</code>
341      </table>
342    </td>
343  </tr>
344</table>
345<table cellspacing=5 cellpadding=0 border=0>
346  <tr>
347    <td>
348      &nbsp;
349    </td>
350    <td>
351
352<p>
353
354<p>
355Definition at line <a class="el" href="OgrePredefinedControllers_8h-source.html#l00047">47</a> of file <a class="el" href="OgrePredefinedControllers_8h-source.html">OgrePredefinedControllers.h</a>.    </td>
356  </tr>
357</table>
358<a class="anchor" name="Ogre_1_1FrameTimeControllerValuep0" doxytag="Ogre::FrameTimeControllerValue::mFrameTime" ></a><p>
359<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
360  <tr>
361    <td class="mdRow">
362      <table cellpadding="0" cellspacing="0" border="0">
363        <tr>
364          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a420">Real</a> <a class="el" href="classOgre_1_1FrameTimeControllerValue.html#Ogre_1_1FrameTimeControllerValuep0">Ogre::FrameTimeControllerValue::mFrameTime</a><code> [protected]</code>
365      </table>
366    </td>
367  </tr>
368</table>
369<table cellspacing=5 cellpadding=0 border=0>
370  <tr>
371    <td>
372      &nbsp;
373    </td>
374    <td>
375
376<p>
377
378<p>
379Definition at line <a class="el" href="OgrePredefinedControllers_8h-source.html#l00045">45</a> of file <a class="el" href="OgrePredefinedControllers_8h-source.html">OgrePredefinedControllers.h</a>.    </td>
380  </tr>
381</table>
382<a class="anchor" name="Ogre_1_1FrameTimeControllerValuep1" doxytag="Ogre::FrameTimeControllerValue::mTimeFactor" ></a><p>
383<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
384  <tr>
385    <td class="mdRow">
386      <table cellpadding="0" cellspacing="0" border="0">
387        <tr>
388          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a420">Real</a> <a class="el" href="classOgre_1_1FrameTimeControllerValue.html#Ogre_1_1FrameTimeControllerValuep1">Ogre::FrameTimeControllerValue::mTimeFactor</a><code> [protected]</code>
389      </table>
390    </td>
391  </tr>
392</table>
393<table cellspacing=5 cellpadding=0 border=0>
394  <tr>
395    <td>
396      &nbsp;
397    </td>
398    <td>
399
400<p>
401
402<p>
403Definition at line <a class="el" href="OgrePredefinedControllers_8h-source.html#l00046">46</a> of file <a class="el" href="OgrePredefinedControllers_8h-source.html">OgrePredefinedControllers.h</a>.    </td>
404  </tr>
405</table>
406<hr>The documentation for this class was generated from the following file:<ul>
407<li><a class="el" href="OgrePredefinedControllers_8h-source.html">OgrePredefinedControllers.h</a></ul>
408<hr>
409<p>
410Copyright &copy; 2000-2005 by The OGRE Team<br />
411<!--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/>
412This 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/>
413                <!--/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#">
414                <Work rdf:about="">
415                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
416        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
417                </Work>
418                <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> -->
419
420Last modified Sun Feb 12 13:02:10 2006
421</p>
422</body>
423</html>
Note: See TracBrowser for help on using the repository browser.