<html>
<head>
<title>Ogre::EventQueue 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::EventQueue Class Reference</h1>This class holds InputEvents given to it by the <a class="el" href="classOgre_1_1EventProcessor.html">EventProcessor</a> in a FIFO queue.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="OgreEventQueue_8h-source.html">OgreEventQueue.h</a>></code>
<p>
<a href="classOgre_1_1EventQueue-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> </td><td valign=bottom><a class="el" href="classOgre_1_1EventQueue.html#Ogre_1_1EventQueuea0">EventQueue</a> ()</td></tr>
<tr><td nowrap align=right valign=top>virtual </td><td valign=bottom><a class="el" href="classOgre_1_1EventQueue.html#Ogre_1_1EventQueuea1">~EventQueue</a> ()</td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classOgre_1_1EventQueue.html#Ogre_1_1EventQueuea2">push</a> (<a class="el" href="classOgre_1_1InputEvent.html">InputEvent</a> *e)</td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="classOgre_1_1InputEvent.html">InputEvent</a> * </td><td valign=bottom><a class="el" href="classOgre_1_1EventQueue.html#Ogre_1_1EventQueuea3">pop</a> ()</td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classOgre_1_1EventQueue.html#Ogre_1_1EventQueuea4">activateEventQueue</a> (bool set)</td></tr>
<tr><td> </td><td><font size=-1><em>Turn the queue on so it can pop and push InputEvents.</em> <a href="#Ogre_1_1EventQueuea4"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>size_t </td><td valign=bottom><a class="el" href="classOgre_1_1EventQueue.html#Ogre_1_1EventQueuea5">getSize</a> () const</td></tr>
<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
<tr><td nowrap align=right valign=top>std::queue< <a class="el" href="classOgre_1_1InputEvent.html">InputEvent</a> * > </td><td valign=bottom><a class="el" href="classOgre_1_1EventQueue.html#Ogre_1_1EventQueuen0">mEventQueue</a></td></tr>
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classOgre_1_1EventQueue.html#Ogre_1_1EventQueuen1">mActivateEventQueue</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This class holds InputEvents given to it by the <a class="el" href="classOgre_1_1EventProcessor.html">EventProcessor</a> in a FIFO queue.
<p>
<p>
Definition at line <a class="el" href="OgreEventQueue_8h-source.html#l00044">44</a> of file <a class="el" href="OgreEventQueue_8h-source.html">OgreEventQueue.h</a>.<hr><h2>Constructor & Destructor Documentation</h2>
<a name="Ogre_1_1EventQueuea0" doxytag="Ogre::EventQueue::EventQueue"></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"> Ogre::EventQueue::EventQueue </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></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="OgreEventQueue_8cpp-source.html#l00033">33</a> of file <a class="el" href="OgreEventQueue_8cpp-source.html">OgreEventQueue.cpp</a>.
<p>
References <a class="el" href="OgreEventQueue_8h-source.html#l00048">mActivateEventQueue</a>. </td>
</tr>
</table>
<a name="Ogre_1_1EventQueuea1" doxytag="Ogre::EventQueue::~EventQueue"></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"> Ogre::EventQueue::~EventQueue </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="OgreEventQueue_8cpp-source.html#l00042">42</a> of file <a class="el" href="OgreEventQueue_8cpp-source.html">OgreEventQueue.cpp</a>.
<p>
References <a class="el" href="OgreEventQueue_8h-source.html#l00047">mEventQueue</a>. </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="Ogre_1_1EventQueuea4" doxytag="Ogre::EventQueue::activateEventQueue"></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"> void Ogre::EventQueue::activateEventQueue </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">bool </td>
<td class="mdname1" valign="top" nowrap> <em>set</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Turn the queue on so it can pop and push InputEvents.
<p>
<p>
Definition at line <a class="el" href="OgreEventQueue_8cpp-source.html#l00076">76</a> of file <a class="el" href="OgreEventQueue_8cpp-source.html">OgreEventQueue.cpp</a>.
<p>
References <a class="el" href="OgreEventQueue_8h-source.html#l00048">mActivateEventQueue</a>.
<p>
Referenced by <a class="el" href="OgreEventProcessor_8cpp-source.html#l00124">Ogre::EventProcessor::startProcessingEvents</a>(), and <a class="el" href="OgreEventProcessor_8cpp-source.html#l00082">Ogre::EventProcessor::stopProcessingEvents</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1EventQueuea5" doxytag="Ogre::EventQueue::getSize"></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"> size_t Ogre::EventQueue::getSize </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const</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="OgreEventQueue_8cpp-source.html#l00082">82</a> of file <a class="el" href="OgreEventQueue_8cpp-source.html">OgreEventQueue.cpp</a>.
<p>
References <a class="el" href="OgreEventQueue_8h-source.html#l00047">mEventQueue</a>.
<p>
Referenced by <a class="el" href="OgreEventProcessor_8cpp-source.html#l00137">Ogre::EventProcessor::frameStarted</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1EventQueuea3" doxytag="Ogre::EventQueue::pop"></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"> <a class="el" href="classOgre_1_1InputEvent.html">InputEvent</a> * Ogre::EventQueue::pop </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></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="OgreEventQueue_8cpp-source.html#l00064">64</a> of file <a class="el" href="OgreEventQueue_8cpp-source.html">OgreEventQueue.cpp</a>.
<p>
References <a class="el" href="OgreEventQueue_8h-source.html#l00048">mActivateEventQueue</a>, and <a class="el" href="OgreEventQueue_8h-source.html#l00047">mEventQueue</a>.
<p>
Referenced by <a class="el" href="OgreEventProcessor_8cpp-source.html#l00137">Ogre::EventProcessor::frameStarted</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1EventQueuea2" doxytag="Ogre::EventQueue::push"></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"> void Ogre::EventQueue::push </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1InputEvent.html">InputEvent</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>e</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></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="OgreEventQueue_8cpp-source.html#l00055">55</a> of file <a class="el" href="OgreEventQueue_8cpp-source.html">OgreEventQueue.cpp</a>.
<p>
References <a class="el" href="OgreEventQueue_8h-source.html#l00047">mEventQueue</a>.
<p>
Referenced by <a class="el" href="OgreInput_8cpp-source.html#l00123">Ogre::InputReader::createKeyEvent</a>(), and <a class="el" href="OgreInput_8cpp-source.html#l00104">Ogre::InputReader::createMouseEvent</a>(). </td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a name="Ogre_1_1EventQueuen1" doxytag="Ogre::EventQueue::mActivateEventQueue"></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"> bool Ogre::EventQueue::mActivateEventQueue<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="OgreEventQueue_8h-source.html#l00048">48</a> of file <a class="el" href="OgreEventQueue_8h-source.html">OgreEventQueue.h</a>.
<p>
Referenced by <a class="el" href="OgreEventQueue_8cpp-source.html#l00076">activateEventQueue</a>(), <a class="el" href="OgreEventQueue_8cpp-source.html#l00033">EventQueue</a>(), and <a class="el" href="OgreEventQueue_8cpp-source.html#l00064">pop</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1EventQueuen0" doxytag="Ogre::EventQueue::mEventQueue"></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"> std::queue<<a class="el" href="classOgre_1_1InputEvent.html">InputEvent</a>*> Ogre::EventQueue::mEventQueue<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="OgreEventQueue_8h-source.html#l00047">47</a> of file <a class="el" href="OgreEventQueue_8h-source.html">OgreEventQueue.h</a>.
<p>
Referenced by <a class="el" href="OgreEventQueue_8cpp-source.html#l00082">getSize</a>(), <a class="el" href="OgreEventQueue_8cpp-source.html#l00064">pop</a>(), <a class="el" href="OgreEventQueue_8cpp-source.html#l00055">push</a>(), and <a class="el" href="OgreEventQueue_8cpp-source.html#l00042">~EventQueue</a>(). </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="OgreEventQueue_8h-source.html">OgreEventQueue.h</a><li><a class="el" href="OgreEventQueue_8cpp-source.html">OgreEventQueue.cpp</a></ul>
<p>
Copyright © 2002-2003 by The OGRE Team<br />
Last modified Wed Jan 21 00:17:22 2004
</p>
</body>
</html>
