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

Revision 692, 29.6 KB checked in by mattausch, 19 years ago (diff)

adding ogre 1.2 and dependencies
Line 
1<html>
2<head>
3<title>Ogre::InputEvent 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::InputEvent Class Reference</h1>The root event class for all GuiElement-level input events. 
11<a href="#_details">More...</a>
12<p>
13<code>#include &lt;<a class="el" href="OgreInputEvent_8h-source.html">OgreInputEvent.h</a>&gt;</code>
14<p>
15<p>Inheritance diagram for Ogre::InputEvent:
16<p><center><img src="classOgre_1_1InputEvent.png" usemap="#Ogre::InputEvent_map" border="0" alt=""></center>
17<map name="Ogre::InputEvent_map">
18<area href="classOgre_1_1KeyEvent.html" alt="Ogre::KeyEvent" shape="rect" coords="0,56,117,80">
19<area href="classOgre_1_1MouseEvent.html" alt="Ogre::MouseEvent" shape="rect" coords="127,56,244,80">
20</map>
21<a href="classOgre_1_1InputEvent-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 Types</h2></td></tr>
24<tr><td class="memItemLeft" nowrap align=right valign=top>enum &nbsp;</td><td class="memItemRight" valign=bottom>{ <br>
25&nbsp;&nbsp;<a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventw24Ogre_1_1MouseEventw15">SHIFT_MASK</a> =  1 &lt;&lt; 0,
26<a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventw24Ogre_1_1MouseEventw16">CTRL_MASK</a> =  1 &lt;&lt; 1,
27<a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventw24Ogre_1_1MouseEventw17">META_MASK</a> =  1 &lt;&lt; 2,
28<a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventw24Ogre_1_1MouseEventw18">ALT_MASK</a> =  1 &lt;&lt; 3,
29<br>
30&nbsp;&nbsp;<a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventw24Ogre_1_1MouseEventw19">BUTTON0_MASK</a> =  1 &lt;&lt; 4,
31<a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventw24Ogre_1_1MouseEventw20">BUTTON1_MASK</a> =  1 &lt;&lt; 5,
32<a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventw24Ogre_1_1MouseEventw21">BUTTON2_MASK</a> =  1 &lt;&lt; 6,
33<a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventw24Ogre_1_1MouseEventw22">BUTTON3_MASK</a> =  1 &lt;&lt; 7,
34<br>
35&nbsp;&nbsp;<a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventw24Ogre_1_1MouseEventw23">BUTTON_ANY_MASK</a> =  0xF &lt;&lt; 4
36<br>
37 }</td></tr>
38
39<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
40<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1InputEventa0">InputEvent</a> (<a class="el" href="classOgre_1_1EventTarget.html">EventTarget</a> *source, int id, long when, int modifiers)</td></tr>
41
42<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructs an <a class="el" href="classOgre_1_1InputEvent.html">InputEvent</a> object with the specified source GuiElement, modifiers, and type.  <a href="#Ogre_1_1InputEventa0"></a><br><br></td></tr>
43<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventa12">consume</a> ()</td></tr>
44
45<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Consumes this event so that it will not be processed in the default manner by the source which originated it.  <a href="#Ogre_1_1MouseEventa12"></a><br><br></td></tr>
46<tr><td class="memItemLeft" nowrap align=right valign=top>int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventa13">getModifiers</a> () const </td></tr>
47
48<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the modifiers flag for this event.  <a href="#Ogre_1_1MouseEventa13"></a><br><br></td></tr>
49<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a465">Real</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventa14">getWhen</a> () const </td></tr>
50
51<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the timestamp of when this event occurred.  <a href="#Ogre_1_1MouseEventa14"></a><br><br></td></tr>
52<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventa15">isAltDown</a> () const </td></tr>
53
54<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns whether or not the Alt modifier is down on this event.  <a href="#Ogre_1_1MouseEventa15"></a><br><br></td></tr>
55<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventa16">isConsumed</a> () const </td></tr>
56
57<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns whether or not this event has been consumed.  <a href="#Ogre_1_1MouseEventa16"></a><br><br></td></tr>
58<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventa17">isControlDown</a> () const </td></tr>
59
60<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns whether or not the Control modifier is down on this event.  <a href="#Ogre_1_1MouseEventa17"></a><br><br></td></tr>
61<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventa18">isMetaDown</a> () const </td></tr>
62
63<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns whether or not the Meta modifier is down on this event.  <a href="#Ogre_1_1MouseEventa18"></a><br><br></td></tr>
64<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventa19">isShiftDown</a> () const </td></tr>
65
66<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns whether or not the Shift modifier is down on this event.  <a href="#Ogre_1_1MouseEventa19"></a><br><br></td></tr>
67<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventa20">isEventBetween</a> (int start, int end) const </td></tr>
68
69<tr><td class="memItemLeft" nowrap align=right valign=top>int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventa21">getID</a> () const </td></tr>
70
71<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1EventTarget.html">EventTarget</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventa22">getSource</a> () const </td></tr>
72
73<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
74<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a465">Real</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventp8">mWhen</a></td></tr>
75
76<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Not implemented yet.  <a href="#Ogre_1_1MouseEventp8"></a><br><br></td></tr>
77<tr><td class="memItemLeft" nowrap align=right valign=top>int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventp9">mModifiers</a></td></tr>
78
79<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The state of the modifier keys at the time the input event was fired.  <a href="#Ogre_1_1MouseEventp9"></a><br><br></td></tr>
80<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1EventTarget.html">EventTarget</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventp10">mSource</a></td></tr>
81
82<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The target to process the event.  <a href="#Ogre_1_1MouseEventp10"></a><br><br></td></tr>
83<tr><td class="memItemLeft" nowrap align=right valign=top>int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventp11">mId</a></td></tr>
84
85<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The ID of the event.  <a href="#Ogre_1_1MouseEventp11"></a><br><br></td></tr>
86<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventp12">mConsumed</a></td></tr>
87
88<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">whether the event has been consumed  <a href="#Ogre_1_1MouseEventp12"></a><br><br></td></tr>
89</table>
90<hr><a name="_details"></a><h2>Detailed Description</h2>
91The root event class for all GuiElement-level input events.
92<p>
93<dl compact><dt><b>Remarks:</b></dt><dd>Input events are delivered to listeners before they are processed normally by the source where they originated. This allows listeners and GuiElement subclasses to "consume" the event so that the source will not process them in their default manner. For example, consuming mousePressed events on a Button GuiElement will prevent the Button from being activated.</dd></dl>
94
95<p>
96
97<p>
98Definition at line <a class="el" href="OgreInputEvent_8h-source.html#l00060">60</a> of file <a class="el" href="OgreInputEvent_8h-source.html">OgreInputEvent.h</a>.<hr><h2>Member Enumeration Documentation</h2>
99<a class="anchor" name="Ogre_1_1MouseEventw24" doxytag="Ogre::InputEvent::@7" ></a><p>
100<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
101  <tr>
102    <td class="mdRow">
103      <table cellpadding="0" cellspacing="0" border="0">
104        <tr>
105          <td class="md" nowrap valign="top"> anonymous enum
106      </table>
107    </td>
108  </tr>
109</table>
110<table cellspacing=5 cellpadding=0 border=0>
111  <tr>
112    <td>
113      &nbsp;
114    </td>
115    <td>
116
117<p>
118<dl compact><dt><b>Enumeration values: </b></dt><dd>
119<table border=0 cellspacing=2 cellpadding=0>
120<tr><td valign=top><em><a class="anchor" name="Ogre_1_1MouseEventw24Ogre_1_1MouseEventw15" doxytag="SHIFT_MASK" ></a>SHIFT_MASK</em>&nbsp;</td><td>
121This flag indicates that the Shift key was down when the event occurred.
122<p>
123</td></tr>
124<tr><td valign=top><em><a class="anchor" name="Ogre_1_1MouseEventw24Ogre_1_1MouseEventw16" doxytag="CTRL_MASK" ></a>CTRL_MASK</em>&nbsp;</td><td>
125This flag indicates that the Control key was down when the event occurred.
126<p>
127</td></tr>
128<tr><td valign=top><em><a class="anchor" name="Ogre_1_1MouseEventw24Ogre_1_1MouseEventw17" doxytag="META_MASK" ></a>META_MASK</em>&nbsp;</td><td>
129This flag indicates that the Meta key was down when the event occurred.
130<p>
131For mouse events, this flag indicates that the right button was pressed or released.</td></tr>
132<tr><td valign=top><em><a class="anchor" name="Ogre_1_1MouseEventw24Ogre_1_1MouseEventw18" doxytag="ALT_MASK" ></a>ALT_MASK</em>&nbsp;</td><td>
133This flag indicates that the Alt key was down when the event occurred.
134<p>
135For mouse events, this flag indicates that the middle mouse button was pressed or released.</td></tr>
136<tr><td valign=top><em><a class="anchor" name="Ogre_1_1MouseEventw24Ogre_1_1MouseEventw19" doxytag="BUTTON0_MASK" ></a>BUTTON0_MASK</em>&nbsp;</td><td>
137</td></tr>
138<tr><td valign=top><em><a class="anchor" name="Ogre_1_1MouseEventw24Ogre_1_1MouseEventw20" doxytag="BUTTON1_MASK" ></a>BUTTON1_MASK</em>&nbsp;</td><td>
139</td></tr>
140<tr><td valign=top><em><a class="anchor" name="Ogre_1_1MouseEventw24Ogre_1_1MouseEventw21" doxytag="BUTTON2_MASK" ></a>BUTTON2_MASK</em>&nbsp;</td><td>
141</td></tr>
142<tr><td valign=top><em><a class="anchor" name="Ogre_1_1MouseEventw24Ogre_1_1MouseEventw22" doxytag="BUTTON3_MASK" ></a>BUTTON3_MASK</em>&nbsp;</td><td>
143</td></tr>
144<tr><td valign=top><em><a class="anchor" name="Ogre_1_1MouseEventw24Ogre_1_1MouseEventw23" doxytag="BUTTON_ANY_MASK" ></a>BUTTON_ANY_MASK</em>&nbsp;</td><td>
145</td></tr>
146</table>
147</dl>
148
149<p>
150Definition at line <a class="el" href="OgreInputEvent_8h-source.html#l00093">93</a> of file <a class="el" href="OgreInputEvent_8h-source.html">OgreInputEvent.h</a>.    </td>
151  </tr>
152</table>
153<hr><h2>Constructor &amp; Destructor Documentation</h2>
154<a class="anchor" name="Ogre_1_1InputEventa0" doxytag="Ogre::InputEvent::InputEvent" ></a><p>
155<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
156  <tr>
157    <td class="mdRow">
158      <table cellpadding="0" cellspacing="0" border="0">
159        <tr>
160          <td class="md" nowrap valign="top"> Ogre::InputEvent::InputEvent </td>
161          <td class="md" valign="top">(&nbsp;</td>
162          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1EventTarget.html">EventTarget</a> *&nbsp;</td>
163          <td class="mdname" nowrap> <em>source</em>, </td>
164        </tr>
165        <tr>
166          <td class="md" nowrap align="right"></td>
167          <td></td>
168          <td class="md" nowrap>int&nbsp;</td>
169          <td class="mdname" nowrap> <em>id</em>, </td>
170        </tr>
171        <tr>
172          <td class="md" nowrap align="right"></td>
173          <td></td>
174          <td class="md" nowrap>long&nbsp;</td>
175          <td class="mdname" nowrap> <em>when</em>, </td>
176        </tr>
177        <tr>
178          <td class="md" nowrap align="right"></td>
179          <td></td>
180          <td class="md" nowrap>int&nbsp;</td>
181          <td class="mdname" nowrap> <em>modifiers</em></td>
182        </tr>
183        <tr>
184          <td></td>
185          <td class="md">)&nbsp;</td>
186          <td class="md" colspan="2"></td>
187        </tr>
188
189      </table>
190    </td>
191  </tr>
192</table>
193<table cellspacing=5 cellpadding=0 border=0>
194  <tr>
195    <td>
196      &nbsp;
197    </td>
198    <td>
199
200<p>
201Constructs an <a class="el" href="classOgre_1_1InputEvent.html">InputEvent</a> object with the specified source GuiElement, modifiers, and type.
202<p>
203<dl compact><dt><b>Parameters:</b></dt><dd>
204  <table border="0" cellspacing="2" cellpadding="0">
205    <tr><td valign=top><em>source</em>&nbsp;</td><td>the object where the event originated  the event type  the time the event occurred  the modifier keys down while event occurred</td></tr>
206  </table>
207</dl>
208    </td>
209  </tr>
210</table>
211<hr><h2>Member Function Documentation</h2>
212<a class="anchor" name="Ogre_1_1MouseEventa12" doxytag="Ogre::InputEvent::consume" ></a><p>
213<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
214  <tr>
215    <td class="mdRow">
216      <table cellpadding="0" cellspacing="0" border="0">
217        <tr>
218          <td class="md" nowrap valign="top"> void Ogre::InputEvent::consume </td>
219          <td class="md" valign="top">(&nbsp;</td>
220          <td class="mdname1" valign="top" nowrap>          </td>
221          <td class="md" valign="top">&nbsp;)&nbsp;</td>
222          <td class="md" nowrap></td>
223        </tr>
224
225      </table>
226    </td>
227  </tr>
228</table>
229<table cellspacing=5 cellpadding=0 border=0>
230  <tr>
231    <td>
232      &nbsp;
233    </td>
234    <td>
235
236<p>
237Consumes this event so that it will not be processed in the default manner by the source which originated it.
238<p>
239    </td>
240  </tr>
241</table>
242<a class="anchor" name="Ogre_1_1MouseEventa21" doxytag="Ogre::InputEvent::getID" ></a><p>
243<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
244  <tr>
245    <td class="mdRow">
246      <table cellpadding="0" cellspacing="0" border="0">
247        <tr>
248          <td class="md" nowrap valign="top"> int Ogre::InputEvent::getID </td>
249          <td class="md" valign="top">(&nbsp;</td>
250          <td class="mdname1" valign="top" nowrap>          </td>
251          <td class="md" valign="top">&nbsp;)&nbsp;</td>
252          <td class="md" nowrap> const</td>
253        </tr>
254
255      </table>
256    </td>
257  </tr>
258</table>
259<table cellspacing=5 cellpadding=0 border=0>
260  <tr>
261    <td>
262      &nbsp;
263    </td>
264    <td>
265
266<p>
267    </td>
268  </tr>
269</table>
270<a class="anchor" name="Ogre_1_1MouseEventa13" doxytag="Ogre::InputEvent::getModifiers" ></a><p>
271<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
272  <tr>
273    <td class="mdRow">
274      <table cellpadding="0" cellspacing="0" border="0">
275        <tr>
276          <td class="md" nowrap valign="top"> int Ogre::InputEvent::getModifiers </td>
277          <td class="md" valign="top">(&nbsp;</td>
278          <td class="mdname1" valign="top" nowrap>          </td>
279          <td class="md" valign="top">&nbsp;)&nbsp;</td>
280          <td class="md" nowrap> const</td>
281        </tr>
282
283      </table>
284    </td>
285  </tr>
286</table>
287<table cellspacing=5 cellpadding=0 border=0>
288  <tr>
289    <td>
290      &nbsp;
291    </td>
292    <td>
293
294<p>
295Returns the modifiers flag for this event.
296<p>
297    </td>
298  </tr>
299</table>
300<a class="anchor" name="Ogre_1_1MouseEventa22" doxytag="Ogre::InputEvent::getSource" ></a><p>
301<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
302  <tr>
303    <td class="mdRow">
304      <table cellpadding="0" cellspacing="0" border="0">
305        <tr>
306          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1EventTarget.html">EventTarget</a>* Ogre::InputEvent::getSource </td>
307          <td class="md" valign="top">(&nbsp;</td>
308          <td class="mdname1" valign="top" nowrap>          </td>
309          <td class="md" valign="top">&nbsp;)&nbsp;</td>
310          <td class="md" nowrap> const</td>
311        </tr>
312
313      </table>
314    </td>
315  </tr>
316</table>
317<table cellspacing=5 cellpadding=0 border=0>
318  <tr>
319    <td>
320      &nbsp;
321    </td>
322    <td>
323
324<p>
325    </td>
326  </tr>
327</table>
328<a class="anchor" name="Ogre_1_1MouseEventa14" doxytag="Ogre::InputEvent::getWhen" ></a><p>
329<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
330  <tr>
331    <td class="mdRow">
332      <table cellpadding="0" cellspacing="0" border="0">
333        <tr>
334          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a465">Real</a> Ogre::InputEvent::getWhen </td>
335          <td class="md" valign="top">(&nbsp;</td>
336          <td class="mdname1" valign="top" nowrap>          </td>
337          <td class="md" valign="top">&nbsp;)&nbsp;</td>
338          <td class="md" nowrap> const</td>
339        </tr>
340
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>
353Returns the timestamp of when this event occurred.
354<p>
355Not implemented yet    </td>
356  </tr>
357</table>
358<a class="anchor" name="Ogre_1_1MouseEventa15" doxytag="Ogre::InputEvent::isAltDown" ></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"> bool Ogre::InputEvent::isAltDown </td>
365          <td class="md" valign="top">(&nbsp;</td>
366          <td class="mdname1" valign="top" nowrap>          </td>
367          <td class="md" valign="top">&nbsp;)&nbsp;</td>
368          <td class="md" nowrap> const</td>
369        </tr>
370
371      </table>
372    </td>
373  </tr>
374</table>
375<table cellspacing=5 cellpadding=0 border=0>
376  <tr>
377    <td>
378      &nbsp;
379    </td>
380    <td>
381
382<p>
383Returns whether or not the Alt modifier is down on this event.
384<p>
385    </td>
386  </tr>
387</table>
388<a class="anchor" name="Ogre_1_1MouseEventa16" doxytag="Ogre::InputEvent::isConsumed" ></a><p>
389<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
390  <tr>
391    <td class="mdRow">
392      <table cellpadding="0" cellspacing="0" border="0">
393        <tr>
394          <td class="md" nowrap valign="top"> bool Ogre::InputEvent::isConsumed </td>
395          <td class="md" valign="top">(&nbsp;</td>
396          <td class="mdname1" valign="top" nowrap>          </td>
397          <td class="md" valign="top">&nbsp;)&nbsp;</td>
398          <td class="md" nowrap> const</td>
399        </tr>
400
401      </table>
402    </td>
403  </tr>
404</table>
405<table cellspacing=5 cellpadding=0 border=0>
406  <tr>
407    <td>
408      &nbsp;
409    </td>
410    <td>
411
412<p>
413Returns whether or not this event has been consumed.
414<p>
415<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventa12">consume</a></dd></dl>
416    </td>
417  </tr>
418</table>
419<a class="anchor" name="Ogre_1_1MouseEventa17" doxytag="Ogre::InputEvent::isControlDown" ></a><p>
420<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
421  <tr>
422    <td class="mdRow">
423      <table cellpadding="0" cellspacing="0" border="0">
424        <tr>
425          <td class="md" nowrap valign="top"> bool Ogre::InputEvent::isControlDown </td>
426          <td class="md" valign="top">(&nbsp;</td>
427          <td class="mdname1" valign="top" nowrap>          </td>
428          <td class="md" valign="top">&nbsp;)&nbsp;</td>
429          <td class="md" nowrap> const</td>
430        </tr>
431
432      </table>
433    </td>
434  </tr>
435</table>
436<table cellspacing=5 cellpadding=0 border=0>
437  <tr>
438    <td>
439      &nbsp;
440    </td>
441    <td>
442
443<p>
444Returns whether or not the Control modifier is down on this event.
445<p>
446    </td>
447  </tr>
448</table>
449<a class="anchor" name="Ogre_1_1MouseEventa20" doxytag="Ogre::InputEvent::isEventBetween" ></a><p>
450<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
451  <tr>
452    <td class="mdRow">
453      <table cellpadding="0" cellspacing="0" border="0">
454        <tr>
455          <td class="md" nowrap valign="top"> bool Ogre::InputEvent::isEventBetween </td>
456          <td class="md" valign="top">(&nbsp;</td>
457          <td class="md" nowrap valign="top">int&nbsp;</td>
458          <td class="mdname" nowrap> <em>start</em>, </td>
459        </tr>
460        <tr>
461          <td class="md" nowrap align="right"></td>
462          <td></td>
463          <td class="md" nowrap>int&nbsp;</td>
464          <td class="mdname" nowrap> <em>end</em></td>
465        </tr>
466        <tr>
467          <td></td>
468          <td class="md">)&nbsp;</td>
469          <td class="md" colspan="2"> const</td>
470        </tr>
471
472      </table>
473    </td>
474  </tr>
475</table>
476<table cellspacing=5 cellpadding=0 border=0>
477  <tr>
478    <td>
479      &nbsp;
480    </td>
481    <td>
482
483<p>
484    </td>
485  </tr>
486</table>
487<a class="anchor" name="Ogre_1_1MouseEventa18" doxytag="Ogre::InputEvent::isMetaDown" ></a><p>
488<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
489  <tr>
490    <td class="mdRow">
491      <table cellpadding="0" cellspacing="0" border="0">
492        <tr>
493          <td class="md" nowrap valign="top"> bool Ogre::InputEvent::isMetaDown </td>
494          <td class="md" valign="top">(&nbsp;</td>
495          <td class="mdname1" valign="top" nowrap>          </td>
496          <td class="md" valign="top">&nbsp;)&nbsp;</td>
497          <td class="md" nowrap> const</td>
498        </tr>
499
500      </table>
501    </td>
502  </tr>
503</table>
504<table cellspacing=5 cellpadding=0 border=0>
505  <tr>
506    <td>
507      &nbsp;
508    </td>
509    <td>
510
511<p>
512Returns whether or not the Meta modifier is down on this event.
513<p>
514    </td>
515  </tr>
516</table>
517<a class="anchor" name="Ogre_1_1MouseEventa19" doxytag="Ogre::InputEvent::isShiftDown" ></a><p>
518<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
519  <tr>
520    <td class="mdRow">
521      <table cellpadding="0" cellspacing="0" border="0">
522        <tr>
523          <td class="md" nowrap valign="top"> bool Ogre::InputEvent::isShiftDown </td>
524          <td class="md" valign="top">(&nbsp;</td>
525          <td class="mdname1" valign="top" nowrap>          </td>
526          <td class="md" valign="top">&nbsp;)&nbsp;</td>
527          <td class="md" nowrap> const</td>
528        </tr>
529
530      </table>
531    </td>
532  </tr>
533</table>
534<table cellspacing=5 cellpadding=0 border=0>
535  <tr>
536    <td>
537      &nbsp;
538    </td>
539    <td>
540
541<p>
542Returns whether or not the Shift modifier is down on this event.
543<p>
544    </td>
545  </tr>
546</table>
547<hr><h2>Member Data Documentation</h2>
548<a class="anchor" name="Ogre_1_1MouseEventp12" doxytag="Ogre::InputEvent::mConsumed" ></a><p>
549<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
550  <tr>
551    <td class="mdRow">
552      <table cellpadding="0" cellspacing="0" border="0">
553        <tr>
554          <td class="md" nowrap valign="top"> bool <a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventp12">Ogre::InputEvent::mConsumed</a><code> [protected]</code>
555      </table>
556    </td>
557  </tr>
558</table>
559<table cellspacing=5 cellpadding=0 border=0>
560  <tr>
561    <td>
562      &nbsp;
563    </td>
564    <td>
565
566<p>
567whether the event has been consumed
568<p>
569
570<p>
571Definition at line <a class="el" href="OgreInputEvent_8h-source.html#l00088">88</a> of file <a class="el" href="OgreInputEvent_8h-source.html">OgreInputEvent.h</a>.    </td>
572  </tr>
573</table>
574<a class="anchor" name="Ogre_1_1MouseEventp11" doxytag="Ogre::InputEvent::mId" ></a><p>
575<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
576  <tr>
577    <td class="mdRow">
578      <table cellpadding="0" cellspacing="0" border="0">
579        <tr>
580          <td class="md" nowrap valign="top"> int <a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventp11">Ogre::InputEvent::mId</a><code> [protected]</code>
581      </table>
582    </td>
583  </tr>
584</table>
585<table cellspacing=5 cellpadding=0 border=0>
586  <tr>
587    <td>
588      &nbsp;
589    </td>
590    <td>
591
592<p>
593The ID of the event.
594<p>
595
596<p>
597Definition at line <a class="el" href="OgreInputEvent_8h-source.html#l00083">83</a> of file <a class="el" href="OgreInputEvent_8h-source.html">OgreInputEvent.h</a>.    </td>
598  </tr>
599</table>
600<a class="anchor" name="Ogre_1_1MouseEventp9" doxytag="Ogre::InputEvent::mModifiers" ></a><p>
601<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
602  <tr>
603    <td class="mdRow">
604      <table cellpadding="0" cellspacing="0" border="0">
605        <tr>
606          <td class="md" nowrap valign="top"> int <a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventp9">Ogre::InputEvent::mModifiers</a><code> [protected]</code>
607      </table>
608    </td>
609  </tr>
610</table>
611<table cellspacing=5 cellpadding=0 border=0>
612  <tr>
613    <td>
614      &nbsp;
615    </td>
616    <td>
617
618<p>
619The state of the modifier keys at the time the input event was fired.
620<p>
621
622<p>
623Definition at line <a class="el" href="OgreInputEvent_8h-source.html#l00072">72</a> of file <a class="el" href="OgreInputEvent_8h-source.html">OgreInputEvent.h</a>.    </td>
624  </tr>
625</table>
626<a class="anchor" name="Ogre_1_1MouseEventp10" doxytag="Ogre::InputEvent::mSource" ></a><p>
627<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
628  <tr>
629    <td class="mdRow">
630      <table cellpadding="0" cellspacing="0" border="0">
631        <tr>
632          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1EventTarget.html">EventTarget</a>* <a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventp10">Ogre::InputEvent::mSource</a><code> [protected]</code>
633      </table>
634    </td>
635  </tr>
636</table>
637<table cellspacing=5 cellpadding=0 border=0>
638  <tr>
639    <td>
640      &nbsp;
641    </td>
642    <td>
643
644<p>
645The target to process the event.
646<p>
647This is ususally found by the dispatcher
648<p>
649Definition at line <a class="el" href="OgreInputEvent_8h-source.html#l00078">78</a> of file <a class="el" href="OgreInputEvent_8h-source.html">OgreInputEvent.h</a>.    </td>
650  </tr>
651</table>
652<a class="anchor" name="Ogre_1_1MouseEventp8" doxytag="Ogre::InputEvent::mWhen" ></a><p>
653<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
654  <tr>
655    <td class="mdRow">
656      <table cellpadding="0" cellspacing="0" border="0">
657        <tr>
658          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a465">Real</a> <a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventp8">Ogre::InputEvent::mWhen</a><code> [protected]</code>
659      </table>
660    </td>
661  </tr>
662</table>
663<table cellspacing=5 cellpadding=0 border=0>
664  <tr>
665    <td>
666      &nbsp;
667    </td>
668    <td>
669
670<p>
671Not implemented yet.
672<p>
673
674<p>
675Definition at line <a class="el" href="OgreInputEvent_8h-source.html#l00067">67</a> of file <a class="el" href="OgreInputEvent_8h-source.html">OgreInputEvent.h</a>.    </td>
676  </tr>
677</table>
678<hr>The documentation for this class was generated from the following file:<ul>
679<li><a class="el" href="OgreInputEvent_8h-source.html">OgreInputEvent.h</a></ul>
680<hr>
681<p>
682Copyright &copy; 2000-2005 by The OGRE Team<br />
683<!--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/>
684This 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/>
685                <!--/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#">
686                <Work rdf:about="">
687                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
688        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
689                </Work>
690                <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> -->
691
692Last modified Sun Mar 12 14:39:26 2006
693</p>
694</body>
695</html>
Note: See TracBrowser for help on using the repository browser.