<html>
<head>
<title>Ogre::FrameListener 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.2.16 -->
<center>
<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">Compound 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">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> <a class="qindex" href="pages.html">Related Pages</a> </center>
<hr><h1>Ogre::FrameListener Class Reference</h1>A interface class defining a listener which can be used to receive notifications of frame events.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="OgreFrameListener_8h-source.html">OgreFrameListener.h</a>></code>
<p>
Inheritance diagram for Ogre::FrameListener:<p><center><img src="classOgre_1_1FrameListener__inherit__graph.png" border="0" usemap="#Ogre_1_1FrameListener__inherit__map" alt="Inheritance graph"></center>
<map name="Ogre_1_1FrameListener__inherit__map">
<area href="classOgre_1_1EventProcessor.html" shape="rect" coords="7,105,148,87" alt="">
<area href="classOgre_1_1FrameTimeControllerValue.html" shape="rect" coords="172,105,377,87" alt="">
<area href="classOgre_1_1ParticleSystemManager.html" shape="rect" coords="401,105,591,87" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classOgre_1_1FrameListener-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top>virtual bool </td><td 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> &evt)</td></tr>
<tr><td> </td><td><font size=-1><em>Called when a frame is about to begin rendering.</em> <a href="#Ogre_1_1FrameListenera0"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual bool </td><td 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> &evt)</td></tr>
<tr><td> </td><td><font size=-1><em>Called just after a frame has been rendered.</em> <a href="#Ogre_1_1FrameListenera1"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual </td><td valign=bottom><a class="el" href="classOgre_1_1FrameListener.html#Ogre_1_1FrameListenera2">~FrameListener</a> ()</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A interface class defining a listener which can be used to receive notifications of frame events.
<p>
<dl compact><dt><b>
Remarks: </b><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_1Roota15">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_1Roota17">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. </dl>
<p>
<p>
Definition 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 & Destructor Documentation</h2>
<a name="Ogre_1_1FrameListenera2" doxytag="Ogre::FrameListener::~FrameListener"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual Ogre::FrameListener::~FrameListener </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition 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>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="Ogre_1_1FrameListenera1" doxytag="Ogre::FrameListener::frameEnded"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual bool Ogre::FrameListener::frameEnded </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="structOgre_1_1FrameEvent.html">FrameEvent</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>evt</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Called just after a frame has been rendered.
<p>
<dl compact><dt><b>
Returns: </b><dd>
True to continue with the next frame, false to drop out of the rendering loop. </dl>
<p>
Reimplemented in <a class="el" href="classOgre_1_1ParticleSystemManager.html#Ogre_1_1ParticleSystemManagera17">Ogre::ParticleSystemManager</a>, and <a class="el" href="classOgre_1_1FrameTimeControllerValue.html#Ogre_1_1FrameTimeControllerValuea1">Ogre::FrameTimeControllerValue</a>.
<p>
Definition 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>
</tr>
</table>
<a name="Ogre_1_1FrameListenera0" doxytag="Ogre::FrameListener::frameStarted"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual bool Ogre::FrameListener::frameStarted </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="structOgre_1_1FrameEvent.html">FrameEvent</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>evt</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Called when a frame is about to begin rendering.
<p>
<dl compact><dt><b>
Returns: </b><dd>
True to go ahead, false to abort rendering and drop out of the rendering loop. </dl>
<p>
Reimplemented in <a class="el" href="classOgre_1_1EventProcessor.html#Ogre_1_1EventProcessora10">Ogre::EventProcessor</a>, <a class="el" href="classOgre_1_1ParticleSystemManager.html#Ogre_1_1ParticleSystemManagera16">Ogre::ParticleSystemManager</a>, and <a class="el" href="classOgre_1_1FrameTimeControllerValue.html#Ogre_1_1FrameTimeControllerValuea2">Ogre::FrameTimeControllerValue</a>.
<p>
Definition 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>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="OgreFrameListener_8h-source.html">OgreFrameListener.h</a></ul>
<p>
Copyright © 2002-2003 by The OGRE Team<br />
Last modified Wed Jan 21 00:17:24 2004
</p>
</body>
</html>
distrib
>
Mandriva
>
10.0
>
i586
>
media
>
contrib
>
by-pkgid
>
06719cf03808e17ae6f0852ca1052dc2
>
files
>
2179
