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

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

added ogre dependencies and patched ogre sources
Line 
1<html>
2<head>
3<title>Ogre::EventQueue 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::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. 
11<a href="#_details">More...</a>
12<p>
13<code>#include &lt;<a class="el" href="OgreEventQueue_8h-source.html">OgreEventQueue.h</a>&gt;</code>
14<p>
15<a href="classOgre_1_1EventQueue-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
16<tr><td></td></tr>
17<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
18<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1EventQueue.html#Ogre_1_1EventQueuea0">EventQueue</a> ()</td></tr>
19
20<tr><td class="memItemLeft" nowrap align=right valign=top>virtual&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1EventQueue.html#Ogre_1_1EventQueuea1">~EventQueue</a> ()</td></tr>
21
22<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" 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>
23
24<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1InputEvent.html">InputEvent</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1EventQueue.html#Ogre_1_1EventQueuea3">pop</a> ()</td></tr>
25
26<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1EventQueue.html#Ogre_1_1EventQueuea4">activateEventQueue</a> (bool set)</td></tr>
27
28<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Turn the queue on so it can pop and push InputEvents.  <a href="#Ogre_1_1EventQueuea4"></a><br><br></td></tr>
29<tr><td class="memItemLeft" nowrap align=right valign=top>size_t&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1EventQueue.html#Ogre_1_1EventQueuea5">getSize</a> () const </td></tr>
30
31<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
32<tr><td class="memItemLeft" nowrap align=right valign=top>std::queue&lt; <a class="el" href="classOgre_1_1InputEvent.html">InputEvent</a> * &gt;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1EventQueue.html#Ogre_1_1EventQueuep0">mEventQueue</a></td></tr>
33
34<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1EventQueue.html#Ogre_1_1EventQueuep1">mActivateEventQueue</a></td></tr>
35
36</table>
37<hr><a name="_details"></a><h2>Detailed Description</h2>
38This class holds InputEvents given to it by the <a class="el" href="classOgre_1_1EventProcessor.html">EventProcessor</a> in a FIFO queue.
39<p>
40
41<p>
42Definition 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 &amp; Destructor Documentation</h2>
43<a class="anchor" name="Ogre_1_1EventQueuea0" doxytag="Ogre::EventQueue::EventQueue" ></a><p>
44<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
45  <tr>
46    <td class="mdRow">
47      <table cellpadding="0" cellspacing="0" border="0">
48        <tr>
49          <td class="md" nowrap valign="top"> Ogre::EventQueue::EventQueue </td>
50          <td class="md" valign="top">(&nbsp;</td>
51          <td class="mdname1" valign="top" nowrap>          </td>
52          <td class="md" valign="top">&nbsp;)&nbsp;</td>
53          <td class="md" nowrap></td>
54        </tr>
55
56      </table>
57    </td>
58  </tr>
59</table>
60<table cellspacing=5 cellpadding=0 border=0>
61  <tr>
62    <td>
63      &nbsp;
64    </td>
65    <td>
66
67<p>
68    </td>
69  </tr>
70</table>
71<a class="anchor" name="Ogre_1_1EventQueuea1" doxytag="Ogre::EventQueue::~EventQueue" ></a><p>
72<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
73  <tr>
74    <td class="mdRow">
75      <table cellpadding="0" cellspacing="0" border="0">
76        <tr>
77          <td class="md" nowrap valign="top"> virtual Ogre::EventQueue::~<a class="el" href="classOgre_1_1EventQueue.html">EventQueue</a> </td>
78          <td class="md" valign="top">(&nbsp;</td>
79          <td class="mdname1" valign="top" nowrap>          </td>
80          <td class="md" valign="top">&nbsp;)&nbsp;</td>
81          <td class="md" nowrap><code> [virtual]</code></td>
82        </tr>
83
84      </table>
85    </td>
86  </tr>
87</table>
88<table cellspacing=5 cellpadding=0 border=0>
89  <tr>
90    <td>
91      &nbsp;
92    </td>
93    <td>
94
95<p>
96    </td>
97  </tr>
98</table>
99<hr><h2>Member Function Documentation</h2>
100<a class="anchor" name="Ogre_1_1EventQueuea4" doxytag="Ogre::EventQueue::activateEventQueue" ></a><p>
101<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
102  <tr>
103    <td class="mdRow">
104      <table cellpadding="0" cellspacing="0" border="0">
105        <tr>
106          <td class="md" nowrap valign="top"> void Ogre::EventQueue::activateEventQueue </td>
107          <td class="md" valign="top">(&nbsp;</td>
108          <td class="md" nowrap valign="top">bool&nbsp;</td>
109          <td class="mdname1" valign="top" nowrap> <em>set</em>          </td>
110          <td class="md" valign="top">&nbsp;)&nbsp;</td>
111          <td class="md" nowrap></td>
112        </tr>
113
114      </table>
115    </td>
116  </tr>
117</table>
118<table cellspacing=5 cellpadding=0 border=0>
119  <tr>
120    <td>
121      &nbsp;
122    </td>
123    <td>
124
125<p>
126Turn the queue on so it can pop and push InputEvents.
127<p>
128    </td>
129  </tr>
130</table>
131<a class="anchor" name="Ogre_1_1EventQueuea5" doxytag="Ogre::EventQueue::getSize" ></a><p>
132<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
133  <tr>
134    <td class="mdRow">
135      <table cellpadding="0" cellspacing="0" border="0">
136        <tr>
137          <td class="md" nowrap valign="top"> size_t Ogre::EventQueue::getSize </td>
138          <td class="md" valign="top">(&nbsp;</td>
139          <td class="mdname1" valign="top" nowrap>          </td>
140          <td class="md" valign="top">&nbsp;)&nbsp;</td>
141          <td class="md" nowrap> const</td>
142        </tr>
143
144      </table>
145    </td>
146  </tr>
147</table>
148<table cellspacing=5 cellpadding=0 border=0>
149  <tr>
150    <td>
151      &nbsp;
152    </td>
153    <td>
154
155<p>
156    </td>
157  </tr>
158</table>
159<a class="anchor" name="Ogre_1_1EventQueuea3" doxytag="Ogre::EventQueue::pop" ></a><p>
160<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
161  <tr>
162    <td class="mdRow">
163      <table cellpadding="0" cellspacing="0" border="0">
164        <tr>
165          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1InputEvent.html">InputEvent</a>* Ogre::EventQueue::pop </td>
166          <td class="md" valign="top">(&nbsp;</td>
167          <td class="mdname1" valign="top" nowrap>          </td>
168          <td class="md" valign="top">&nbsp;)&nbsp;</td>
169          <td class="md" nowrap></td>
170        </tr>
171
172      </table>
173    </td>
174  </tr>
175</table>
176<table cellspacing=5 cellpadding=0 border=0>
177  <tr>
178    <td>
179      &nbsp;
180    </td>
181    <td>
182
183<p>
184    </td>
185  </tr>
186</table>
187<a class="anchor" name="Ogre_1_1EventQueuea2" doxytag="Ogre::EventQueue::push" ></a><p>
188<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
189  <tr>
190    <td class="mdRow">
191      <table cellpadding="0" cellspacing="0" border="0">
192        <tr>
193          <td class="md" nowrap valign="top"> void Ogre::EventQueue::push </td>
194          <td class="md" valign="top">(&nbsp;</td>
195          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1InputEvent.html">InputEvent</a> *&nbsp;</td>
196          <td class="mdname1" valign="top" nowrap> <em>e</em>          </td>
197          <td class="md" valign="top">&nbsp;)&nbsp;</td>
198          <td class="md" nowrap></td>
199        </tr>
200
201      </table>
202    </td>
203  </tr>
204</table>
205<table cellspacing=5 cellpadding=0 border=0>
206  <tr>
207    <td>
208      &nbsp;
209    </td>
210    <td>
211
212<p>
213    </td>
214  </tr>
215</table>
216<hr><h2>Member Data Documentation</h2>
217<a class="anchor" name="Ogre_1_1EventQueuep1" doxytag="Ogre::EventQueue::mActivateEventQueue" ></a><p>
218<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
219  <tr>
220    <td class="mdRow">
221      <table cellpadding="0" cellspacing="0" border="0">
222        <tr>
223          <td class="md" nowrap valign="top"> bool <a class="el" href="classOgre_1_1EventQueue.html#Ogre_1_1EventQueuep1">Ogre::EventQueue::mActivateEventQueue</a><code> [protected]</code>
224      </table>
225    </td>
226  </tr>
227</table>
228<table cellspacing=5 cellpadding=0 border=0>
229  <tr>
230    <td>
231      &nbsp;
232    </td>
233    <td>
234
235<p>
236
237<p>
238Definition 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>.    </td>
239  </tr>
240</table>
241<a class="anchor" name="Ogre_1_1EventQueuep0" doxytag="Ogre::EventQueue::mEventQueue" ></a><p>
242<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
243  <tr>
244    <td class="mdRow">
245      <table cellpadding="0" cellspacing="0" border="0">
246        <tr>
247          <td class="md" nowrap valign="top"> std::queue&lt;<a class="el" href="classOgre_1_1InputEvent.html">InputEvent</a>*&gt; <a class="el" href="classOgre_1_1EventQueue.html#Ogre_1_1EventQueuep0">Ogre::EventQueue::mEventQueue</a><code> [protected]</code>
248      </table>
249    </td>
250  </tr>
251</table>
252<table cellspacing=5 cellpadding=0 border=0>
253  <tr>
254    <td>
255      &nbsp;
256    </td>
257    <td>
258
259<p>
260
261<p>
262Definition 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>.    </td>
263  </tr>
264</table>
265<hr>The documentation for this class was generated from the following file:<ul>
266<li><a class="el" href="OgreEventQueue_8h-source.html">OgreEventQueue.h</a></ul>
267<hr>
268<p>
269Copyright &copy; 2000-2005 by The OGRE Team<br />
270<!--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/>
271This 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/>
272                <!--/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#">
273                <Work rdf:about="">
274                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
275        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
276                </Work>
277                <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> -->
278
279Last modified Sun Feb 12 13:00:26 2006
280</p>
281</body>
282</html>
Note: See TracBrowser for help on using the repository browser.