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

Revision 692, 9.9 KB checked in by mattausch, 18 years ago (diff)

adding ogre 1.2 and dependencies
Line 
1<html>
2<head>
3<title>Ogre::FrameListener 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::FrameListener Class Reference</h1>A interface class defining a listener which can be used to receive notifications of frame events. 
11<a href="#_details">More...</a>
12<p>
13<code>#include &lt;<a class="el" href="OgreFrameListener_8h-source.html">OgreFrameListener.h</a>&gt;</code>
14<p>
15<p>Inheritance diagram for Ogre::FrameListener:
16<p><center><img src="classOgre_1_1FrameListener.png" usemap="#Ogre::FrameListener_map" border="0" alt=""></center>
17<map name="Ogre::FrameListener_map">
18<area href="classOgre_1_1EventProcessor.html" alt="Ogre::EventProcessor" shape="rect" coords="0,56,198,80">
19<area href="classOgre_1_1FrameTimeControllerValue.html" alt="Ogre::FrameTimeControllerValue" shape="rect" coords="208,56,406,80">
20</map>
21<a href="classOgre_1_1FrameListener-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>virtual bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1FrameListener.html#Ogre_1_1FrameListenera0">frameStarted</a> (const <a class="el" href="structOgre_1_1FrameEvent.html">FrameEvent</a> &amp;evt)</td></tr>
25
26<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called when a frame is about to begin rendering.  <a href="#Ogre_1_1FrameListenera0"></a><br><br></td></tr>
27<tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1FrameListener.html#Ogre_1_1FrameListenera1">frameEnded</a> (const <a class="el" href="structOgre_1_1FrameEvent.html">FrameEvent</a> &amp;evt)</td></tr>
28
29<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called just after a frame has been rendered.  <a href="#Ogre_1_1FrameListenera1"></a><br><br></td></tr>
30<tr><td class="memItemLeft" nowrap align=right valign=top>virtual&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1FrameListener.html#Ogre_1_1FrameListenera2">~FrameListener</a> ()</td></tr>
31
32</table>
33<hr><a name="_details"></a><h2>Detailed Description</h2>
34A interface class defining a listener which can be used to receive notifications of frame events.
35<p>
36<dl compact><dt><b>Remarks:</b></dt><dd>A 'listener' is an interface designed to be called back when particular events are called. This class defines the interface relating to frame events. In order to receive notifications of frame events, you should create a subclass of <a class="el" href="classOgre_1_1FrameListener.html">FrameListener</a> and override the methods for which you would like to customise the resulting processing. You should then call <a class="el" href="classOgre_1_1Root.html#Ogre_1_1Roota24">Root::addFrameListener</a> passing an instance of this class. There is no limit to the number of frame listeners you can register, allowing you to register multiple listeners for different purposes. Frame events only occur when <a class="el" href="namespaceOgre.html">Ogre</a> is in continuous rendering mode, ie. after <a class="el" href="classOgre_1_1Root.html#Ogre_1_1Roota27">Root::startRendering</a> is called. If the application is doing ad-hoc rendering without entering a rendering loop, frame events are not generated. Note that a frame event occurs once for all rendering targets, not once per target. </dd></dl>
37
38<p>
39
40<p>
41Definition at line <a class="el" href="OgreFrameListener_8h-source.html#l00073">73</a> of file <a class="el" href="OgreFrameListener_8h-source.html">OgreFrameListener.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
42<a class="anchor" name="Ogre_1_1FrameListenera2" doxytag="Ogre::FrameListener::~FrameListener" ></a><p>
43<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
44  <tr>
45    <td class="mdRow">
46      <table cellpadding="0" cellspacing="0" border="0">
47        <tr>
48          <td class="md" nowrap valign="top"> virtual Ogre::FrameListener::~<a class="el" href="classOgre_1_1FrameListener.html">FrameListener</a> </td>
49          <td class="md" valign="top">(&nbsp;</td>
50          <td class="mdname1" valign="top" nowrap>          </td>
51          <td class="md" valign="top">&nbsp;)&nbsp;</td>
52          <td class="md" nowrap><code> [virtual]</code></td>
53        </tr>
54
55      </table>
56    </td>
57  </tr>
58</table>
59<table cellspacing=5 cellpadding=0 border=0>
60  <tr>
61    <td>
62      &nbsp;
63    </td>
64    <td>
65
66<p>
67
68<p>
69Definition at line <a class="el" href="OgreFrameListener_8h-source.html#l00097">97</a> of file <a class="el" href="OgreFrameListener_8h-source.html">OgreFrameListener.h</a>.    </td>
70  </tr>
71</table>
72<hr><h2>Member Function Documentation</h2>
73<a class="anchor" name="Ogre_1_1FrameListenera1" doxytag="Ogre::FrameListener::frameEnded" ></a><p>
74<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
75  <tr>
76    <td class="mdRow">
77      <table cellpadding="0" cellspacing="0" border="0">
78        <tr>
79          <td class="md" nowrap valign="top"> virtual bool Ogre::FrameListener::frameEnded </td>
80          <td class="md" valign="top">(&nbsp;</td>
81          <td class="md" nowrap valign="top">const <a class="el" href="structOgre_1_1FrameEvent.html">FrameEvent</a> &amp;&nbsp;</td>
82          <td class="mdname1" valign="top" nowrap> <em>evt</em>          </td>
83          <td class="md" valign="top">&nbsp;)&nbsp;</td>
84          <td class="md" nowrap><code> [virtual]</code></td>
85        </tr>
86
87      </table>
88    </td>
89  </tr>
90</table>
91<table cellspacing=5 cellpadding=0 border=0>
92  <tr>
93    <td>
94      &nbsp;
95    </td>
96    <td>
97
98<p>
99Called just after a frame has been rendered.
100<p>
101<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>
102
103<p>
104Reimplemented in <a class="el" href="classOgre_1_1FrameTimeControllerValue.html#Ogre_1_1FrameTimeControllerValuea1">Ogre::FrameTimeControllerValue</a>.
105<p>
106Definition at line <a class="el" href="OgreFrameListener_8h-source.html#l00095">95</a> of file <a class="el" href="OgreFrameListener_8h-source.html">OgreFrameListener.h</a>.    </td>
107  </tr>
108</table>
109<a class="anchor" name="Ogre_1_1FrameListenera0" doxytag="Ogre::FrameListener::frameStarted" ></a><p>
110<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
111  <tr>
112    <td class="mdRow">
113      <table cellpadding="0" cellspacing="0" border="0">
114        <tr>
115          <td class="md" nowrap valign="top"> virtual bool Ogre::FrameListener::frameStarted </td>
116          <td class="md" valign="top">(&nbsp;</td>
117          <td class="md" nowrap valign="top">const <a class="el" href="structOgre_1_1FrameEvent.html">FrameEvent</a> &amp;&nbsp;</td>
118          <td class="mdname1" valign="top" nowrap> <em>evt</em>          </td>
119          <td class="md" valign="top">&nbsp;)&nbsp;</td>
120          <td class="md" nowrap><code> [virtual]</code></td>
121        </tr>
122
123      </table>
124    </td>
125  </tr>
126</table>
127<table cellspacing=5 cellpadding=0 border=0>
128  <tr>
129    <td>
130      &nbsp;
131    </td>
132    <td>
133
134<p>
135Called when a frame is about to begin rendering.
136<p>
137<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>
138
139<p>
140Reimplemented in <a class="el" href="classOgre_1_1EventProcessor.html#Ogre_1_1EventProcessora10">Ogre::EventProcessor</a>, and <a class="el" href="classOgre_1_1FrameTimeControllerValue.html#Ogre_1_1FrameTimeControllerValuea2">Ogre::FrameTimeControllerValue</a>.
141<p>
142Definition at line <a class="el" href="OgreFrameListener_8h-source.html#l00089">89</a> of file <a class="el" href="OgreFrameListener_8h-source.html">OgreFrameListener.h</a>.    </td>
143  </tr>
144</table>
145<hr>The documentation for this class was generated from the following file:<ul>
146<li><a class="el" href="OgreFrameListener_8h-source.html">OgreFrameListener.h</a></ul>
147<hr>
148<p>
149Copyright &copy; 2000-2005 by The OGRE Team<br />
150<!--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/>
151This 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/>
152                <!--/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#">
153                <Work rdf:about="">
154                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
155        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
156                </Work>
157                <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> -->
158
159Last modified Sun Mar 12 14:38:56 2006
160</p>
161</body>
162</html>
Note: See TracBrowser for help on using the repository browser.