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

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

added ogre dependencies and patched ogre sources
Line 
1<html>
2<head>
3<title>Ogre::MouseEvent 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::MouseEvent Class Reference</h1>An event which indicates that a mouse action occurred in a <a class="el" href="classOgre_1_1MouseTarget.html">MouseTarget</a> (e.g. 
11<a href="#_details">More...</a>
12<p>
13<code>#include &lt;<a class="el" href="OgreMouseEvent_8h-source.html">OgreMouseEvent.h</a>&gt;</code>
14<p>
15<p>Inheritance diagram for Ogre::MouseEvent:
16<p><center><img src="classOgre_1_1MouseEvent.png" usemap="#Ogre::MouseEvent_map" border="0" alt=""></center>
17<map name="Ogre::MouseEvent_map">
18<area href="classOgre_1_1InputEvent.html" alt="Ogre::InputEvent" shape="rect" coords="0,0,117,24">
19</map>
20<a href="classOgre_1_1MouseEvent-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
21<tr><td></td></tr>
22<tr><td colspan=2><br><h2>Public Types</h2></td></tr>
23<tr><td class="memItemLeft" nowrap align=right valign=top>enum &nbsp;</td><td class="memItemRight" valign=bottom>{ <a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEventw13Ogre_1_1MouseEventw0">ME_FIRST_EVENT</a> =  500,
24<a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEventw13Ogre_1_1MouseEventw1">ME_LAST_EVENT</a> =  510
25 }</td></tr>
26
27<tr><td class="memItemLeft" nowrap align=right valign=top>enum &nbsp;</td><td class="memItemRight" valign=bottom>{ <br>
28&nbsp;&nbsp;<a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEventw14Ogre_1_1MouseEventw2">ME_MOUSE_CLICKED</a> =  ME_FIRST_EVENT,
29<a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEventw14Ogre_1_1MouseEventw3">ME_MOUSE_PRESSED</a>,
30<a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEventw14Ogre_1_1MouseEventw4">ME_MOUSE_RELEASED</a>,
31<a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEventw14Ogre_1_1MouseEventw5">ME_MOUSE_MOVED</a>,
32<br>
33&nbsp;&nbsp;<a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEventw14Ogre_1_1MouseEventw6">ME_MOUSE_ENTERED</a>,
34<a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEventw14Ogre_1_1MouseEventw7">ME_MOUSE_EXITED</a>,
35<a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEventw14Ogre_1_1MouseEventw8">ME_MOUSE_DRAGGED</a>,
36<a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEventw14Ogre_1_1MouseEventw9">ME_MOUSE_DRAGENTERED</a>,
37<br>
38&nbsp;&nbsp;<a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEventw14Ogre_1_1MouseEventw10">ME_MOUSE_DRAGEXITED</a>,
39<a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEventw14Ogre_1_1MouseEventw11">ME_MOUSE_DRAGMOVED</a>,
40<a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEventw14Ogre_1_1MouseEventw12">ME_MOUSE_DRAGDROPPED</a>
41<br>
42 }</td></tr>
43
44<tr><td class="memItemLeft" nowrap align=right valign=top>enum &nbsp;</td><td class="memItemRight" valign=bottom>{ <br>
45&nbsp;&nbsp;<a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventw24Ogre_1_1MouseEventw15">SHIFT_MASK</a> =  1 &lt;&lt; 0,
46<a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventw24Ogre_1_1MouseEventw16">CTRL_MASK</a> =  1 &lt;&lt; 1,
47<a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventw24Ogre_1_1MouseEventw17">META_MASK</a> =  1 &lt;&lt; 2,
48<a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventw24Ogre_1_1MouseEventw18">ALT_MASK</a> =  1 &lt;&lt; 3,
49<br>
50&nbsp;&nbsp;<a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventw24Ogre_1_1MouseEventw19">BUTTON0_MASK</a> =  1 &lt;&lt; 4,
51<a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventw24Ogre_1_1MouseEventw20">BUTTON1_MASK</a> =  1 &lt;&lt; 5,
52<a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventw24Ogre_1_1MouseEventw21">BUTTON2_MASK</a> =  1 &lt;&lt; 6,
53<a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventw24Ogre_1_1MouseEventw22">BUTTON3_MASK</a> =  1 &lt;&lt; 7,
54<br>
55&nbsp;&nbsp;<a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventw24Ogre_1_1MouseEventw23">BUTTON_ANY_MASK</a> =  0xF &lt;&lt; 4
56<br>
57 }</td></tr>
58
59<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
60<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEventa0">MouseEvent</a> (<a class="el" href="classOgre_1_1PositionTarget.html">PositionTarget</a> *source, int <a class="el" href="OgreGLPrerequisites_8h.html#a86">id</a>, int whichButton, <a class="el" href="namespaceOgre.html#a420">Real</a> when, int modifiers, <a class="el" href="namespaceOgre.html#a420">Real</a> x, <a class="el" href="namespaceOgre.html#a420">Real</a> y, <a class="el" href="namespaceOgre.html#a420">Real</a> z, int clickCount)</td></tr>
61
62<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructs a <a class="el" href="classOgre_1_1MouseEvent.html">MouseEvent</a> object with the specified source <a class="el" href="classOgre_1_1MouseTarget.html">MouseTarget</a>, type, modifiers, coordinates, and click count.  <a href="#Ogre_1_1MouseEventa0"></a><br><br></td></tr>
63<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEventa1">MouseEvent</a> (<a class="el" href="classOgre_1_1PositionTarget.html">PositionTarget</a> *source, int <a class="el" href="OgreGLPrerequisites_8h.html#a86">id</a>, int whichButton, <a class="el" href="namespaceOgre.html#a420">Real</a> when, int modifiers, <a class="el" href="namespaceOgre.html#a420">Real</a> x, <a class="el" href="namespaceOgre.html#a420">Real</a> y, <a class="el" href="namespaceOgre.html#a420">Real</a> z, <a class="el" href="namespaceOgre.html#a420">Real</a> relx, <a class="el" href="namespaceOgre.html#a420">Real</a> rely, <a class="el" href="namespaceOgre.html#a420">Real</a> relz, int clickCount)</td></tr>
64
65<tr><td class="memItemLeft" nowrap align=right valign=top>int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEventa2">getClickCount</a> ()</td></tr>
66
67<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the number of mouse clicks associated with this event.  <a href="#Ogre_1_1MouseEventa2"></a><br><br></td></tr>
68<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a420">Real</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEventa3">getX</a> () const </td></tr>
69
70<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the horizontal x position of the event relative to the source <a class="el" href="classOgre_1_1MouseTarget.html">MouseTarget</a>.  <a href="#Ogre_1_1MouseEventa3"></a><br><br></td></tr>
71<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a420">Real</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEventa4">getY</a> () const </td></tr>
72
73<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the vertical y position of the event relative to the source <a class="el" href="classOgre_1_1MouseTarget.html">MouseTarget</a>.  <a href="#Ogre_1_1MouseEventa4"></a><br><br></td></tr>
74<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a420">Real</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEventa5">getZ</a> () const </td></tr>
75
76<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the scrollwheel z position of the event relative to the source <a class="el" href="classOgre_1_1MouseTarget.html">MouseTarget</a>.  <a href="#Ogre_1_1MouseEventa5"></a><br><br></td></tr>
77<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a420">Real</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEventa6">getRelX</a> () const </td></tr>
78
79<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">get relative X cursor movement  <a href="#Ogre_1_1MouseEventa6"></a><br><br></td></tr>
80<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a420">Real</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEventa7">getRelY</a> () const </td></tr>
81
82<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">get relative Y cursor movement  <a href="#Ogre_1_1MouseEventa7"></a><br><br></td></tr>
83<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a420">Real</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEventa8">getRelZ</a> () const </td></tr>
84
85<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">get relative Z cursor movement  <a href="#Ogre_1_1MouseEventa8"></a><br><br></td></tr>
86<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a426">String</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEventa9">paramString</a> () const </td></tr>
87
88<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns a parameter string identifying this event.  <a href="#Ogre_1_1MouseEventa9"></a><br><br></td></tr>
89<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEventa10">translatePoint</a> (<a class="el" href="namespaceOgre.html#a420">Real</a> x, <a class="el" href="namespaceOgre.html#a420">Real</a> y)</td></tr>
90
91<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Translates the event's coordinates to a new position by adding specified x (horizontal) and y (veritcal) offsets.  <a href="#Ogre_1_1MouseEventa10"></a><br><br></td></tr>
92<tr><td class="memItemLeft" nowrap align=right valign=top>int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEventa11">getButtonID</a> () const </td></tr>
93
94<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">return the ID of the button  <a href="#Ogre_1_1MouseEventa11"></a><br><br></td></tr>
95<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>
96
97<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>
98<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>
99
100<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>
101<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a420">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>
102
103<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>
104<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>
105
106<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>
107<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>
108
109<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>
110<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>
111
112<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>
113<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>
114
115<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>
116<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>
117
118<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>
119<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>
120
121<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>
122
123<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>
124
125<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
126<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a420">Real</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEventp0">mX</a></td></tr>
127
128<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The mouse events x coordinate.  <a href="#Ogre_1_1MouseEventp0"></a><br><br></td></tr>
129<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a420">Real</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEventp1">mY</a></td></tr>
130
131<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The mouse events y coordinate.  <a href="#Ogre_1_1MouseEventp1"></a><br><br></td></tr>
132<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a420">Real</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEventp2">mZ</a></td></tr>
133
134<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The mouse events z coordinate.  <a href="#Ogre_1_1MouseEventp2"></a><br><br></td></tr>
135<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a420">Real</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEventp3">mRelX</a></td></tr>
136
137<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a420">Real</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEventp4">mRelY</a></td></tr>
138
139<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a420">Real</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEventp5">mRelZ</a></td></tr>
140
141<tr><td class="memItemLeft" nowrap align=right valign=top>int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEventp6">mButtonID</a></td></tr>
142
143<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Which button was pressed.  <a href="#Ogre_1_1MouseEventp6"></a><br><br></td></tr>
144<tr><td class="memItemLeft" nowrap align=right valign=top>int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEventp7">mClickCount</a></td></tr>
145
146<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">not implemented yet  <a href="#Ogre_1_1MouseEventp7"></a><br><br></td></tr>
147<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a420">Real</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventp8">mWhen</a></td></tr>
148
149<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Not implemented yet.  <a href="#Ogre_1_1MouseEventp8"></a><br><br></td></tr>
150<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>
151
152<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>
153<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>
154
155<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>
156<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>
157
158<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The ID of the event.  <a href="#Ogre_1_1MouseEventp11"></a><br><br></td></tr>
159<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>
160
161<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>
162</table>
163<hr><a name="_details"></a><h2>Detailed Description</h2>
164An event which indicates that a mouse action occurred in a <a class="el" href="classOgre_1_1MouseTarget.html">MouseTarget</a> (e.g.
165<p>
166<a class="el" href="classOgre_1_1MouseTarget.html">MouseTarget</a>). <dl compact><dt><b>Remarks:</b></dt><dd>This event is used both for mouse events (click, enter, exit) and mouse motion events (moves and drags). </dd></dl>
167This low-level event is generated by a <a class="el" href="classOgre_1_1MouseTarget.html">MouseTarget</a> object for: <ul>
168<li>
169Mouse Events <ul>
170<li>
171a mouse button is pressed </li>
172<li>
173a mouse button is released </li>
174<li>
175a mouse button is clicked (pressed and released) </li>
176<li>
177the mouse cursor enters a <a class="el" href="classOgre_1_1MouseTarget.html">MouseTarget</a> </li>
178<li>
179the mouse cursor exits a <a class="el" href="classOgre_1_1MouseTarget.html">MouseTarget</a> </li>
180</ul>
181</li>
182<li>
183Mouse Motion Events <ul>
184<li>
185the mouse is moved </li>
186<li>
187the mouse is dragged </li>
188</ul>
189</li>
190</ul>
191<p>
192A <a class="el" href="classOgre_1_1MouseEvent.html">MouseEvent</a> object is passed to every <a class="el" href="classOgre_1_1MouseListener.html">MouseListener</a> object which registered to receive the "interesting" mouse events using MouseTarget's <code>addMouseListener</code> method.<p>
193A <a class="el" href="classOgre_1_1MouseEvent.html">MouseEvent</a> object is also passed to every <a class="el" href="classOgre_1_1MouseMotionListener.html">MouseMotionListener</a> object which registered to receive mouse motion events using the MouseTarget's addMouseMotionListener method<p>
194When a mouse button is clicked, events are generated and sent to the registered MouseListeners, with the button mask set in the modifier field. For example, if the first mouse button is pressed, events are sent in the following order: <pre><div>
195    MOUSE_PRESSED:  BUTTON1_MASK
196    MOUSE_RELEASED: BUTTON1_MASK
197    MOUSE_CLICKED:  BUTTON1_MASK
198 </pre></div> When multiple mouse buttons are pressed, each press, release, and click results in a separate event. The button mask in the modifier field reflects only the button that changed state, not the current state of all buttons. <p>
199For example, if the user presses button 1 followed by button 2 and releases them in the same order, the following sequence of events is generated: <pre><div>
200    MOUSE_PRESSED:  BUTTON1_MASK
201    MOUSE_PRESSED:  BUTTON2_MASK
202    MOUSE_RELEASED: BUTTON1_MASK
203    MOUSE_CLICKED:  BUTTON1_MASK
204    MOUSE_RELEASED: BUTTON2_MASK
205    MOUSE_CLICKED:  BUTTON2_MASK
206 </pre></div> If button2 is released first, the MOUSE_RELEASED/MOUSE_CLICKED pair for BUTTON2_MASK arrives first, followed by the pair for BUTTON1_MASK.
207<p>
208
209<p>
210Definition at line <a class="el" href="OgreMouseEvent_8h-source.html#l00158">158</a> of file <a class="el" href="OgreMouseEvent_8h-source.html">OgreMouseEvent.h</a>.<hr><h2>Member Enumeration Documentation</h2>
211<a class="anchor" name="Ogre_1_1MouseEventw13" doxytag="Ogre::MouseEvent::@10" ></a><p>
212<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
213  <tr>
214    <td class="mdRow">
215      <table cellpadding="0" cellspacing="0" border="0">
216        <tr>
217          <td class="md" nowrap valign="top"> anonymous enum
218      </table>
219    </td>
220  </tr>
221</table>
222<table cellspacing=5 cellpadding=0 border=0>
223  <tr>
224    <td>
225      &nbsp;
226    </td>
227    <td>
228
229<p>
230<dl compact><dt><b>Enumeration values: </b></dt><dd>
231<table border=0 cellspacing=2 cellpadding=0>
232<tr><td valign=top><em><a class="anchor" name="Ogre_1_1MouseEventw13Ogre_1_1MouseEventw0" doxytag="ME_FIRST_EVENT" ></a>ME_FIRST_EVENT</em>&nbsp;</td><td>
233</td></tr>
234<tr><td valign=top><em><a class="anchor" name="Ogre_1_1MouseEventw13Ogre_1_1MouseEventw1" doxytag="ME_LAST_EVENT" ></a>ME_LAST_EVENT</em>&nbsp;</td><td>
235</td></tr>
236</table>
237</dl>
238
239<p>
240Definition at line <a class="el" href="OgreMouseEvent_8h-source.html#l00201">201</a> of file <a class="el" href="OgreMouseEvent_8h-source.html">OgreMouseEvent.h</a>.    </td>
241  </tr>
242</table>
243<a class="anchor" name="Ogre_1_1MouseEventw14" doxytag="Ogre::MouseEvent::@11" ></a><p>
244<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
245  <tr>
246    <td class="mdRow">
247      <table cellpadding="0" cellspacing="0" border="0">
248        <tr>
249          <td class="md" nowrap valign="top"> anonymous enum
250      </table>
251    </td>
252  </tr>
253</table>
254<table cellspacing=5 cellpadding=0 border=0>
255  <tr>
256    <td>
257      &nbsp;
258    </td>
259    <td>
260
261<p>
262<dl compact><dt><b>Enumeration values: </b></dt><dd>
263<table border=0 cellspacing=2 cellpadding=0>
264<tr><td valign=top><em><a class="anchor" name="Ogre_1_1MouseEventw14Ogre_1_1MouseEventw2" doxytag="ME_MOUSE_CLICKED" ></a>ME_MOUSE_CLICKED</em>&nbsp;</td><td>
265</td></tr>
266<tr><td valign=top><em><a class="anchor" name="Ogre_1_1MouseEventw14Ogre_1_1MouseEventw3" doxytag="ME_MOUSE_PRESSED" ></a>ME_MOUSE_PRESSED</em>&nbsp;</td><td>
267</td></tr>
268<tr><td valign=top><em><a class="anchor" name="Ogre_1_1MouseEventw14Ogre_1_1MouseEventw4" doxytag="ME_MOUSE_RELEASED" ></a>ME_MOUSE_RELEASED</em>&nbsp;</td><td>
269</td></tr>
270<tr><td valign=top><em><a class="anchor" name="Ogre_1_1MouseEventw14Ogre_1_1MouseEventw5" doxytag="ME_MOUSE_MOVED" ></a>ME_MOUSE_MOVED</em>&nbsp;</td><td>
271</td></tr>
272<tr><td valign=top><em><a class="anchor" name="Ogre_1_1MouseEventw14Ogre_1_1MouseEventw6" doxytag="ME_MOUSE_ENTERED" ></a>ME_MOUSE_ENTERED</em>&nbsp;</td><td>
273</td></tr>
274<tr><td valign=top><em><a class="anchor" name="Ogre_1_1MouseEventw14Ogre_1_1MouseEventw7" doxytag="ME_MOUSE_EXITED" ></a>ME_MOUSE_EXITED</em>&nbsp;</td><td>
275</td></tr>
276<tr><td valign=top><em><a class="anchor" name="Ogre_1_1MouseEventw14Ogre_1_1MouseEventw8" doxytag="ME_MOUSE_DRAGGED" ></a>ME_MOUSE_DRAGGED</em>&nbsp;</td><td>
277</td></tr>
278<tr><td valign=top><em><a class="anchor" name="Ogre_1_1MouseEventw14Ogre_1_1MouseEventw9" doxytag="ME_MOUSE_DRAGENTERED" ></a>ME_MOUSE_DRAGENTERED</em>&nbsp;</td><td>
279</td></tr>
280<tr><td valign=top><em><a class="anchor" name="Ogre_1_1MouseEventw14Ogre_1_1MouseEventw10" doxytag="ME_MOUSE_DRAGEXITED" ></a>ME_MOUSE_DRAGEXITED</em>&nbsp;</td><td>
281</td></tr>
282<tr><td valign=top><em><a class="anchor" name="Ogre_1_1MouseEventw14Ogre_1_1MouseEventw11" doxytag="ME_MOUSE_DRAGMOVED" ></a>ME_MOUSE_DRAGMOVED</em>&nbsp;</td><td>
283</td></tr>
284<tr><td valign=top><em><a class="anchor" name="Ogre_1_1MouseEventw14Ogre_1_1MouseEventw12" doxytag="ME_MOUSE_DRAGDROPPED" ></a>ME_MOUSE_DRAGDROPPED</em>&nbsp;</td><td>
285</td></tr>
286</table>
287</dl>
288
289<p>
290Definition at line <a class="el" href="OgreMouseEvent_8h-source.html#l00207">207</a> of file <a class="el" href="OgreMouseEvent_8h-source.html">OgreMouseEvent.h</a>.    </td>
291  </tr>
292</table>
293<a class="anchor" name="Ogre_1_1MouseEventw24" doxytag="Ogre::MouseEvent::@6" ></a><p>
294<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
295  <tr>
296    <td class="mdRow">
297      <table cellpadding="0" cellspacing="0" border="0">
298        <tr>
299          <td class="md" nowrap valign="top"> anonymous enum<code> [inherited]</code>
300      </table>
301    </td>
302  </tr>
303</table>
304<table cellspacing=5 cellpadding=0 border=0>
305  <tr>
306    <td>
307      &nbsp;
308    </td>
309    <td>
310
311<p>
312<dl compact><dt><b>Enumeration values: </b></dt><dd>
313<table border=0 cellspacing=2 cellpadding=0>
314<tr><td valign=top><em><a class="anchor" name="Ogre_1_1MouseEventw24Ogre_1_1MouseEventw15" doxytag="SHIFT_MASK" ></a>SHIFT_MASK</em>&nbsp;</td><td>
315This flag indicates that the Shift key was down when the event occurred.
316<p>
317</td></tr>
318<tr><td valign=top><em><a class="anchor" name="Ogre_1_1MouseEventw24Ogre_1_1MouseEventw16" doxytag="CTRL_MASK" ></a>CTRL_MASK</em>&nbsp;</td><td>
319This flag indicates that the Control key was down when the event occurred.
320<p>
321</td></tr>
322<tr><td valign=top><em><a class="anchor" name="Ogre_1_1MouseEventw24Ogre_1_1MouseEventw17" doxytag="META_MASK" ></a>META_MASK</em>&nbsp;</td><td>
323This flag indicates that the Meta key was down when the event occurred.
324<p>
325For mouse events, this flag indicates that the right button was pressed or released.</td></tr>
326<tr><td valign=top><em><a class="anchor" name="Ogre_1_1MouseEventw24Ogre_1_1MouseEventw18" doxytag="ALT_MASK" ></a>ALT_MASK</em>&nbsp;</td><td>
327This flag indicates that the Alt key was down when the event occurred.
328<p>
329For mouse events, this flag indicates that the middle mouse button was pressed or released.</td></tr>
330<tr><td valign=top><em><a class="anchor" name="Ogre_1_1MouseEventw24Ogre_1_1MouseEventw19" doxytag="BUTTON0_MASK" ></a>BUTTON0_MASK</em>&nbsp;</td><td>
331</td></tr>
332<tr><td valign=top><em><a class="anchor" name="Ogre_1_1MouseEventw24Ogre_1_1MouseEventw20" doxytag="BUTTON1_MASK" ></a>BUTTON1_MASK</em>&nbsp;</td><td>
333</td></tr>
334<tr><td valign=top><em><a class="anchor" name="Ogre_1_1MouseEventw24Ogre_1_1MouseEventw21" doxytag="BUTTON2_MASK" ></a>BUTTON2_MASK</em>&nbsp;</td><td>
335</td></tr>
336<tr><td valign=top><em><a class="anchor" name="Ogre_1_1MouseEventw24Ogre_1_1MouseEventw22" doxytag="BUTTON3_MASK" ></a>BUTTON3_MASK</em>&nbsp;</td><td>
337</td></tr>
338<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>
339</td></tr>
340</table>
341</dl>
342
343<p>
344Definition 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>
345  </tr>
346</table>
347<hr><h2>Constructor &amp; Destructor Documentation</h2>
348<a class="anchor" name="Ogre_1_1MouseEventa0" doxytag="Ogre::MouseEvent::MouseEvent" ></a><p>
349<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
350  <tr>
351    <td class="mdRow">
352      <table cellpadding="0" cellspacing="0" border="0">
353        <tr>
354          <td class="md" nowrap valign="top"> Ogre::MouseEvent::MouseEvent </td>
355          <td class="md" valign="top">(&nbsp;</td>
356          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1PositionTarget.html">PositionTarget</a> *&nbsp;</td>
357          <td class="mdname" nowrap> <em>source</em>, </td>
358        </tr>
359        <tr>
360          <td class="md" nowrap align="right"></td>
361          <td></td>
362          <td class="md" nowrap>int&nbsp;</td>
363          <td class="mdname" nowrap> <em>id</em>, </td>
364        </tr>
365        <tr>
366          <td class="md" nowrap align="right"></td>
367          <td></td>
368          <td class="md" nowrap>int&nbsp;</td>
369          <td class="mdname" nowrap> <em>whichButton</em>, </td>
370        </tr>
371        <tr>
372          <td class="md" nowrap align="right"></td>
373          <td></td>
374          <td class="md" nowrap><a class="el" href="namespaceOgre.html#a420">Real</a>&nbsp;</td>
375          <td class="mdname" nowrap> <em>when</em>, </td>
376        </tr>
377        <tr>
378          <td class="md" nowrap align="right"></td>
379          <td></td>
380          <td class="md" nowrap>int&nbsp;</td>
381          <td class="mdname" nowrap> <em>modifiers</em>, </td>
382        </tr>
383        <tr>
384          <td class="md" nowrap align="right"></td>
385          <td></td>
386          <td class="md" nowrap><a class="el" href="namespaceOgre.html#a420">Real</a>&nbsp;</td>
387          <td class="mdname" nowrap> <em>x</em>, </td>
388        </tr>
389        <tr>
390          <td class="md" nowrap align="right"></td>
391          <td></td>
392          <td class="md" nowrap><a class="el" href="namespaceOgre.html#a420">Real</a>&nbsp;</td>
393          <td class="mdname" nowrap> <em>y</em>, </td>
394        </tr>
395        <tr>
396          <td class="md" nowrap align="right"></td>
397          <td></td>
398          <td class="md" nowrap><a class="el" href="namespaceOgre.html#a420">Real</a>&nbsp;</td>
399          <td class="mdname" nowrap> <em>z</em>, </td>
400        </tr>
401        <tr>
402          <td class="md" nowrap align="right"></td>
403          <td></td>
404          <td class="md" nowrap>int&nbsp;</td>
405          <td class="mdname" nowrap> <em>clickCount</em></td>
406        </tr>
407        <tr>
408          <td></td>
409          <td class="md">)&nbsp;</td>
410          <td class="md" colspan="2"></td>
411        </tr>
412
413      </table>
414    </td>
415  </tr>
416</table>
417<table cellspacing=5 cellpadding=0 border=0>
418  <tr>
419    <td>
420      &nbsp;
421    </td>
422    <td>
423
424<p>
425Constructs a <a class="el" href="classOgre_1_1MouseEvent.html">MouseEvent</a> object with the specified source <a class="el" href="classOgre_1_1MouseTarget.html">MouseTarget</a>, type, modifiers, coordinates, and click count.
426<p>
427<dl compact><dt><b>Parameters:</b></dt><dd>
428  <table border="0" cellspacing="2" cellpadding="0">
429    <tr><td valign=top><em>source</em>&nbsp;</td><td>the <a class="el" href="classOgre_1_1MouseTarget.html">MouseTarget</a> that originated the event </td></tr>
430    <tr><td valign=top><em>id</em>&nbsp;</td><td>the integer that identifies the event </td></tr>
431    <tr><td valign=top><em>when</em>&nbsp;</td><td>a long int that gives the time the event occurred </td></tr>
432    <tr><td valign=top><em>modifiers</em>&nbsp;</td><td>the modifier keys down during event (shift, ctrl, alt, meta) </td></tr>
433    <tr><td valign=top><em>x</em>&nbsp;</td><td>the horizontal x coordinate for the mouse location </td></tr>
434    <tr><td valign=top><em>y</em>&nbsp;</td><td>the vertical y coordinate for the mouse location </td></tr>
435    <tr><td valign=top><em>clickCount</em>&nbsp;</td><td>the number of mouse clicks associated with event</td></tr>
436  </table>
437</dl>
438    </td>
439  </tr>
440</table>
441<a class="anchor" name="Ogre_1_1MouseEventa1" doxytag="Ogre::MouseEvent::MouseEvent" ></a><p>
442<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
443  <tr>
444    <td class="mdRow">
445      <table cellpadding="0" cellspacing="0" border="0">
446        <tr>
447          <td class="md" nowrap valign="top"> Ogre::MouseEvent::MouseEvent </td>
448          <td class="md" valign="top">(&nbsp;</td>
449          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1PositionTarget.html">PositionTarget</a> *&nbsp;</td>
450          <td class="mdname" nowrap> <em>source</em>, </td>
451        </tr>
452        <tr>
453          <td class="md" nowrap align="right"></td>
454          <td></td>
455          <td class="md" nowrap>int&nbsp;</td>
456          <td class="mdname" nowrap> <em>id</em>, </td>
457        </tr>
458        <tr>
459          <td class="md" nowrap align="right"></td>
460          <td></td>
461          <td class="md" nowrap>int&nbsp;</td>
462          <td class="mdname" nowrap> <em>whichButton</em>, </td>
463        </tr>
464        <tr>
465          <td class="md" nowrap align="right"></td>
466          <td></td>
467          <td class="md" nowrap><a class="el" href="namespaceOgre.html#a420">Real</a>&nbsp;</td>
468          <td class="mdname" nowrap> <em>when</em>, </td>
469        </tr>
470        <tr>
471          <td class="md" nowrap align="right"></td>
472          <td></td>
473          <td class="md" nowrap>int&nbsp;</td>
474          <td class="mdname" nowrap> <em>modifiers</em>, </td>
475        </tr>
476        <tr>
477          <td class="md" nowrap align="right"></td>
478          <td></td>
479          <td class="md" nowrap><a class="el" href="namespaceOgre.html#a420">Real</a>&nbsp;</td>
480          <td class="mdname" nowrap> <em>x</em>, </td>
481        </tr>
482        <tr>
483          <td class="md" nowrap align="right"></td>
484          <td></td>
485          <td class="md" nowrap><a class="el" href="namespaceOgre.html#a420">Real</a>&nbsp;</td>
486          <td class="mdname" nowrap> <em>y</em>, </td>
487        </tr>
488        <tr>
489          <td class="md" nowrap align="right"></td>
490          <td></td>
491          <td class="md" nowrap><a class="el" href="namespaceOgre.html#a420">Real</a>&nbsp;</td>
492          <td class="mdname" nowrap> <em>z</em>, </td>
493        </tr>
494        <tr>
495          <td class="md" nowrap align="right"></td>
496          <td></td>
497          <td class="md" nowrap><a class="el" href="namespaceOgre.html#a420">Real</a>&nbsp;</td>
498          <td class="mdname" nowrap> <em>relx</em>, </td>
499        </tr>
500        <tr>
501          <td class="md" nowrap align="right"></td>
502          <td></td>
503          <td class="md" nowrap><a class="el" href="namespaceOgre.html#a420">Real</a>&nbsp;</td>
504          <td class="mdname" nowrap> <em>rely</em>, </td>
505        </tr>
506        <tr>
507          <td class="md" nowrap align="right"></td>
508          <td></td>
509          <td class="md" nowrap><a class="el" href="namespaceOgre.html#a420">Real</a>&nbsp;</td>
510          <td class="mdname" nowrap> <em>relz</em>, </td>
511        </tr>
512        <tr>
513          <td class="md" nowrap align="right"></td>
514          <td></td>
515          <td class="md" nowrap>int&nbsp;</td>
516          <td class="mdname" nowrap> <em>clickCount</em></td>
517        </tr>
518        <tr>
519          <td></td>
520          <td class="md">)&nbsp;</td>
521          <td class="md" colspan="2"></td>
522        </tr>
523
524      </table>
525    </td>
526  </tr>
527</table>
528<table cellspacing=5 cellpadding=0 border=0>
529  <tr>
530    <td>
531      &nbsp;
532    </td>
533    <td>
534
535<p>
536    </td>
537  </tr>
538</table>
539<hr><h2>Member Function Documentation</h2>
540<a class="anchor" name="Ogre_1_1MouseEventa12" doxytag="Ogre::MouseEvent::consume" ></a><p>
541<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
542  <tr>
543    <td class="mdRow">
544      <table cellpadding="0" cellspacing="0" border="0">
545        <tr>
546          <td class="md" nowrap valign="top"> void Ogre::InputEvent::consume </td>
547          <td class="md" valign="top">(&nbsp;</td>
548          <td class="mdname1" valign="top" nowrap>          </td>
549          <td class="md" valign="top">&nbsp;)&nbsp;</td>
550          <td class="md" nowrap><code> [inherited]</code></td>
551        </tr>
552
553      </table>
554    </td>
555  </tr>
556</table>
557<table cellspacing=5 cellpadding=0 border=0>
558  <tr>
559    <td>
560      &nbsp;
561    </td>
562    <td>
563
564<p>
565Consumes this event so that it will not be processed in the default manner by the source which originated it.
566<p>
567    </td>
568  </tr>
569</table>
570<a class="anchor" name="Ogre_1_1MouseEventa11" doxytag="Ogre::MouseEvent::getButtonID" ></a><p>
571<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
572  <tr>
573    <td class="mdRow">
574      <table cellpadding="0" cellspacing="0" border="0">
575        <tr>
576          <td class="md" nowrap valign="top"> int Ogre::MouseEvent::getButtonID </td>
577          <td class="md" valign="top">(&nbsp;</td>
578          <td class="mdname1" valign="top" nowrap>          </td>
579          <td class="md" valign="top">&nbsp;)&nbsp;</td>
580          <td class="md" nowrap> const</td>
581        </tr>
582
583      </table>
584    </td>
585  </tr>
586</table>
587<table cellspacing=5 cellpadding=0 border=0>
588  <tr>
589    <td>
590      &nbsp;
591    </td>
592    <td>
593
594<p>
595return the ID of the button
596<p>
597    </td>
598  </tr>
599</table>
600<a class="anchor" name="Ogre_1_1MouseEventa2" doxytag="Ogre::MouseEvent::getClickCount" ></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 Ogre::MouseEvent::getClickCount </td>
607          <td class="md" valign="top">(&nbsp;</td>
608          <td class="mdname1" valign="top" nowrap>          </td>
609          <td class="md" valign="top">&nbsp;)&nbsp;</td>
610          <td class="md" nowrap></td>
611        </tr>
612
613      </table>
614    </td>
615  </tr>
616</table>
617<table cellspacing=5 cellpadding=0 border=0>
618  <tr>
619    <td>
620      &nbsp;
621    </td>
622    <td>
623
624<p>
625Return the number of mouse clicks associated with this event.
626<p>
627<dl compact><dt><b>Returns:</b></dt><dd>integer value for the number of clicks - NOT IMPLEMENTED</dd></dl>
628    </td>
629  </tr>
630</table>
631<a class="anchor" name="Ogre_1_1MouseEventa21" doxytag="Ogre::MouseEvent::getID" ></a><p>
632<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
633  <tr>
634    <td class="mdRow">
635      <table cellpadding="0" cellspacing="0" border="0">
636        <tr>
637          <td class="md" nowrap valign="top"> int Ogre::InputEvent::getID </td>
638          <td class="md" valign="top">(&nbsp;</td>
639          <td class="mdname1" valign="top" nowrap>          </td>
640          <td class="md" valign="top">&nbsp;)&nbsp;</td>
641          <td class="md" nowrap> const<code> [inherited]</code></td>
642        </tr>
643
644      </table>
645    </td>
646  </tr>
647</table>
648<table cellspacing=5 cellpadding=0 border=0>
649  <tr>
650    <td>
651      &nbsp;
652    </td>
653    <td>
654
655<p>
656    </td>
657  </tr>
658</table>
659<a class="anchor" name="Ogre_1_1MouseEventa13" doxytag="Ogre::MouseEvent::getModifiers" ></a><p>
660<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
661  <tr>
662    <td class="mdRow">
663      <table cellpadding="0" cellspacing="0" border="0">
664        <tr>
665          <td class="md" nowrap valign="top"> int Ogre::InputEvent::getModifiers </td>
666          <td class="md" valign="top">(&nbsp;</td>
667          <td class="mdname1" valign="top" nowrap>          </td>
668          <td class="md" valign="top">&nbsp;)&nbsp;</td>
669          <td class="md" nowrap> const<code> [inherited]</code></td>
670        </tr>
671
672      </table>
673    </td>
674  </tr>
675</table>
676<table cellspacing=5 cellpadding=0 border=0>
677  <tr>
678    <td>
679      &nbsp;
680    </td>
681    <td>
682
683<p>
684Returns the modifiers flag for this event.
685<p>
686    </td>
687  </tr>
688</table>
689<a class="anchor" name="Ogre_1_1MouseEventa6" doxytag="Ogre::MouseEvent::getRelX" ></a><p>
690<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
691  <tr>
692    <td class="mdRow">
693      <table cellpadding="0" cellspacing="0" border="0">
694        <tr>
695          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a420">Real</a> Ogre::MouseEvent::getRelX </td>
696          <td class="md" valign="top">(&nbsp;</td>
697          <td class="mdname1" valign="top" nowrap>          </td>
698          <td class="md" valign="top">&nbsp;)&nbsp;</td>
699          <td class="md" nowrap> const</td>
700        </tr>
701
702      </table>
703    </td>
704  </tr>
705</table>
706<table cellspacing=5 cellpadding=0 border=0>
707  <tr>
708    <td>
709      &nbsp;
710    </td>
711    <td>
712
713<p>
714get relative X cursor movement
715<p>
716
717<p>
718Definition at line <a class="el" href="OgreMouseEvent_8h-source.html#l00277">277</a> of file <a class="el" href="OgreMouseEvent_8h-source.html">OgreMouseEvent.h</a>.
719<p>
720References <a class="el" href="OgrePrerequisites_8h-source.html#l00111">Ogre::Real</a>.    </td>
721  </tr>
722</table>
723<a class="anchor" name="Ogre_1_1MouseEventa7" doxytag="Ogre::MouseEvent::getRelY" ></a><p>
724<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
725  <tr>
726    <td class="mdRow">
727      <table cellpadding="0" cellspacing="0" border="0">
728        <tr>
729          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a420">Real</a> Ogre::MouseEvent::getRelY </td>
730          <td class="md" valign="top">(&nbsp;</td>
731          <td class="mdname1" valign="top" nowrap>          </td>
732          <td class="md" valign="top">&nbsp;)&nbsp;</td>
733          <td class="md" nowrap> const</td>
734        </tr>
735
736      </table>
737    </td>
738  </tr>
739</table>
740<table cellspacing=5 cellpadding=0 border=0>
741  <tr>
742    <td>
743      &nbsp;
744    </td>
745    <td>
746
747<p>
748get relative Y cursor movement
749<p>
750
751<p>
752Definition at line <a class="el" href="OgreMouseEvent_8h-source.html#l00280">280</a> of file <a class="el" href="OgreMouseEvent_8h-source.html">OgreMouseEvent.h</a>.
753<p>
754References <a class="el" href="OgrePrerequisites_8h-source.html#l00111">Ogre::Real</a>.    </td>
755  </tr>
756</table>
757<a class="anchor" name="Ogre_1_1MouseEventa8" doxytag="Ogre::MouseEvent::getRelZ" ></a><p>
758<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
759  <tr>
760    <td class="mdRow">
761      <table cellpadding="0" cellspacing="0" border="0">
762        <tr>
763          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a420">Real</a> Ogre::MouseEvent::getRelZ </td>
764          <td class="md" valign="top">(&nbsp;</td>
765          <td class="mdname1" valign="top" nowrap>          </td>
766          <td class="md" valign="top">&nbsp;)&nbsp;</td>
767          <td class="md" nowrap> const</td>
768        </tr>
769
770      </table>
771    </td>
772  </tr>
773</table>
774<table cellspacing=5 cellpadding=0 border=0>
775  <tr>
776    <td>
777      &nbsp;
778    </td>
779    <td>
780
781<p>
782get relative Z cursor movement
783<p>
784
785<p>
786Definition at line <a class="el" href="OgreMouseEvent_8h-source.html#l00283">283</a> of file <a class="el" href="OgreMouseEvent_8h-source.html">OgreMouseEvent.h</a>.
787<p>
788References <a class="el" href="OgrePrerequisites_8h-source.html#l00111">Ogre::Real</a>.    </td>
789  </tr>
790</table>
791<a class="anchor" name="Ogre_1_1MouseEventa22" doxytag="Ogre::MouseEvent::getSource" ></a><p>
792<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
793  <tr>
794    <td class="mdRow">
795      <table cellpadding="0" cellspacing="0" border="0">
796        <tr>
797          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1EventTarget.html">EventTarget</a>* Ogre::InputEvent::getSource </td>
798          <td class="md" valign="top">(&nbsp;</td>
799          <td class="mdname1" valign="top" nowrap>          </td>
800          <td class="md" valign="top">&nbsp;)&nbsp;</td>
801          <td class="md" nowrap> const<code> [inherited]</code></td>
802        </tr>
803
804      </table>
805    </td>
806  </tr>
807</table>
808<table cellspacing=5 cellpadding=0 border=0>
809  <tr>
810    <td>
811      &nbsp;
812    </td>
813    <td>
814
815<p>
816    </td>
817  </tr>
818</table>
819<a class="anchor" name="Ogre_1_1MouseEventa14" doxytag="Ogre::MouseEvent::getWhen" ></a><p>
820<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
821  <tr>
822    <td class="mdRow">
823      <table cellpadding="0" cellspacing="0" border="0">
824        <tr>
825          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a420">Real</a> Ogre::InputEvent::getWhen </td>
826          <td class="md" valign="top">(&nbsp;</td>
827          <td class="mdname1" valign="top" nowrap>          </td>
828          <td class="md" valign="top">&nbsp;)&nbsp;</td>
829          <td class="md" nowrap> const<code> [inherited]</code></td>
830        </tr>
831
832      </table>
833    </td>
834  </tr>
835</table>
836<table cellspacing=5 cellpadding=0 border=0>
837  <tr>
838    <td>
839      &nbsp;
840    </td>
841    <td>
842
843<p>
844Returns the timestamp of when this event occurred.
845<p>
846Not implemented yet    </td>
847  </tr>
848</table>
849<a class="anchor" name="Ogre_1_1MouseEventa3" doxytag="Ogre::MouseEvent::getX" ></a><p>
850<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
851  <tr>
852    <td class="mdRow">
853      <table cellpadding="0" cellspacing="0" border="0">
854        <tr>
855          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a420">Real</a> Ogre::MouseEvent::getX </td>
856          <td class="md" valign="top">(&nbsp;</td>
857          <td class="mdname1" valign="top" nowrap>          </td>
858          <td class="md" valign="top">&nbsp;)&nbsp;</td>
859          <td class="md" nowrap> const</td>
860        </tr>
861
862      </table>
863    </td>
864  </tr>
865</table>
866<table cellspacing=5 cellpadding=0 border=0>
867  <tr>
868    <td>
869      &nbsp;
870    </td>
871    <td>
872
873<p>
874Returns the horizontal x position of the event relative to the source <a class="el" href="classOgre_1_1MouseTarget.html">MouseTarget</a>.
875<p>
876<dl compact><dt><b>Returns:</b></dt><dd>x an integer indicating horizontal position relative to the <a class="el" href="classOgre_1_1MouseTarget.html">MouseTarget</a></dd></dl>
877    </td>
878  </tr>
879</table>
880<a class="anchor" name="Ogre_1_1MouseEventa4" doxytag="Ogre::MouseEvent::getY" ></a><p>
881<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
882  <tr>
883    <td class="mdRow">
884      <table cellpadding="0" cellspacing="0" border="0">
885        <tr>
886          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a420">Real</a> Ogre::MouseEvent::getY </td>
887          <td class="md" valign="top">(&nbsp;</td>
888          <td class="mdname1" valign="top" nowrap>          </td>
889          <td class="md" valign="top">&nbsp;)&nbsp;</td>
890          <td class="md" nowrap> const</td>
891        </tr>
892
893      </table>
894    </td>
895  </tr>
896</table>
897<table cellspacing=5 cellpadding=0 border=0>
898  <tr>
899    <td>
900      &nbsp;
901    </td>
902    <td>
903
904<p>
905Returns the vertical y position of the event relative to the source <a class="el" href="classOgre_1_1MouseTarget.html">MouseTarget</a>.
906<p>
907<dl compact><dt><b>Returns:</b></dt><dd>y an integer indicating vertical position relative to the <a class="el" href="classOgre_1_1MouseTarget.html">MouseTarget</a></dd></dl>
908    </td>
909  </tr>
910</table>
911<a class="anchor" name="Ogre_1_1MouseEventa5" doxytag="Ogre::MouseEvent::getZ" ></a><p>
912<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
913  <tr>
914    <td class="mdRow">
915      <table cellpadding="0" cellspacing="0" border="0">
916        <tr>
917          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a420">Real</a> Ogre::MouseEvent::getZ </td>
918          <td class="md" valign="top">(&nbsp;</td>
919          <td class="mdname1" valign="top" nowrap>          </td>
920          <td class="md" valign="top">&nbsp;)&nbsp;</td>
921          <td class="md" nowrap> const</td>
922        </tr>
923
924      </table>
925    </td>
926  </tr>
927</table>
928<table cellspacing=5 cellpadding=0 border=0>
929  <tr>
930    <td>
931      &nbsp;
932    </td>
933    <td>
934
935<p>
936Returns the scrollwheel z position of the event relative to the source <a class="el" href="classOgre_1_1MouseTarget.html">MouseTarget</a>.
937<p>
938<dl compact><dt><b>Returns:</b></dt><dd>y an integer indicating scrollwheel position relative to the <a class="el" href="classOgre_1_1MouseTarget.html">MouseTarget</a></dd></dl>
939    </td>
940  </tr>
941</table>
942<a class="anchor" name="Ogre_1_1MouseEventa15" doxytag="Ogre::MouseEvent::isAltDown" ></a><p>
943<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
944  <tr>
945    <td class="mdRow">
946      <table cellpadding="0" cellspacing="0" border="0">
947        <tr>
948          <td class="md" nowrap valign="top"> bool Ogre::InputEvent::isAltDown </td>
949          <td class="md" valign="top">(&nbsp;</td>
950          <td class="mdname1" valign="top" nowrap>          </td>
951          <td class="md" valign="top">&nbsp;)&nbsp;</td>
952          <td class="md" nowrap> const<code> [inherited]</code></td>
953        </tr>
954
955      </table>
956    </td>
957  </tr>
958</table>
959<table cellspacing=5 cellpadding=0 border=0>
960  <tr>
961    <td>
962      &nbsp;
963    </td>
964    <td>
965
966<p>
967Returns whether or not the Alt modifier is down on this event.
968<p>
969    </td>
970  </tr>
971</table>
972<a class="anchor" name="Ogre_1_1MouseEventa16" doxytag="Ogre::MouseEvent::isConsumed" ></a><p>
973<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
974  <tr>
975    <td class="mdRow">
976      <table cellpadding="0" cellspacing="0" border="0">
977        <tr>
978          <td class="md" nowrap valign="top"> bool Ogre::InputEvent::isConsumed </td>
979          <td class="md" valign="top">(&nbsp;</td>
980          <td class="mdname1" valign="top" nowrap>          </td>
981          <td class="md" valign="top">&nbsp;)&nbsp;</td>
982          <td class="md" nowrap> const<code> [inherited]</code></td>
983        </tr>
984
985      </table>
986    </td>
987  </tr>
988</table>
989<table cellspacing=5 cellpadding=0 border=0>
990  <tr>
991    <td>
992      &nbsp;
993    </td>
994    <td>
995
996<p>
997Returns whether or not this event has been consumed.
998<p>
999<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventa12">consume</a></dd></dl>
1000    </td>
1001  </tr>
1002</table>
1003<a class="anchor" name="Ogre_1_1MouseEventa17" doxytag="Ogre::MouseEvent::isControlDown" ></a><p>
1004<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1005  <tr>
1006    <td class="mdRow">
1007      <table cellpadding="0" cellspacing="0" border="0">
1008        <tr>
1009          <td class="md" nowrap valign="top"> bool Ogre::InputEvent::isControlDown </td>
1010          <td class="md" valign="top">(&nbsp;</td>
1011          <td class="mdname1" valign="top" nowrap>          </td>
1012          <td class="md" valign="top">&nbsp;)&nbsp;</td>
1013          <td class="md" nowrap> const<code> [inherited]</code></td>
1014        </tr>
1015
1016      </table>
1017    </td>
1018  </tr>
1019</table>
1020<table cellspacing=5 cellpadding=0 border=0>
1021  <tr>
1022    <td>
1023      &nbsp;
1024    </td>
1025    <td>
1026
1027<p>
1028Returns whether or not the Control modifier is down on this event.
1029<p>
1030    </td>
1031  </tr>
1032</table>
1033<a class="anchor" name="Ogre_1_1MouseEventa20" doxytag="Ogre::MouseEvent::isEventBetween" ></a><p>
1034<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1035  <tr>
1036    <td class="mdRow">
1037      <table cellpadding="0" cellspacing="0" border="0">
1038        <tr>
1039          <td class="md" nowrap valign="top"> bool Ogre::InputEvent::isEventBetween </td>
1040          <td class="md" valign="top">(&nbsp;</td>
1041          <td class="md" nowrap valign="top">int&nbsp;</td>
1042          <td class="mdname" nowrap> <em>start</em>, </td>
1043        </tr>
1044        <tr>
1045          <td class="md" nowrap align="right"></td>
1046          <td></td>
1047          <td class="md" nowrap>int&nbsp;</td>
1048          <td class="mdname" nowrap> <em>end</em></td>
1049        </tr>
1050        <tr>
1051          <td></td>
1052          <td class="md">)&nbsp;</td>
1053          <td class="md" colspan="2"> const<code> [inherited]</code></td>
1054        </tr>
1055
1056      </table>
1057    </td>
1058  </tr>
1059</table>
1060<table cellspacing=5 cellpadding=0 border=0>
1061  <tr>
1062    <td>
1063      &nbsp;
1064    </td>
1065    <td>
1066
1067<p>
1068    </td>
1069  </tr>
1070</table>
1071<a class="anchor" name="Ogre_1_1MouseEventa18" doxytag="Ogre::MouseEvent::isMetaDown" ></a><p>
1072<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1073  <tr>
1074    <td class="mdRow">
1075      <table cellpadding="0" cellspacing="0" border="0">
1076        <tr>
1077          <td class="md" nowrap valign="top"> bool Ogre::InputEvent::isMetaDown </td>
1078          <td class="md" valign="top">(&nbsp;</td>
1079          <td class="mdname1" valign="top" nowrap>          </td>
1080          <td class="md" valign="top">&nbsp;)&nbsp;</td>
1081          <td class="md" nowrap> const<code> [inherited]</code></td>
1082        </tr>
1083
1084      </table>
1085    </td>
1086  </tr>
1087</table>
1088<table cellspacing=5 cellpadding=0 border=0>
1089  <tr>
1090    <td>
1091      &nbsp;
1092    </td>
1093    <td>
1094
1095<p>
1096Returns whether or not the Meta modifier is down on this event.
1097<p>
1098    </td>
1099  </tr>
1100</table>
1101<a class="anchor" name="Ogre_1_1MouseEventa19" doxytag="Ogre::MouseEvent::isShiftDown" ></a><p>
1102<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1103  <tr>
1104    <td class="mdRow">
1105      <table cellpadding="0" cellspacing="0" border="0">
1106        <tr>
1107          <td class="md" nowrap valign="top"> bool Ogre::InputEvent::isShiftDown </td>
1108          <td class="md" valign="top">(&nbsp;</td>
1109          <td class="mdname1" valign="top" nowrap>          </td>
1110          <td class="md" valign="top">&nbsp;)&nbsp;</td>
1111          <td class="md" nowrap> const<code> [inherited]</code></td>
1112        </tr>
1113
1114      </table>
1115    </td>
1116  </tr>
1117</table>
1118<table cellspacing=5 cellpadding=0 border=0>
1119  <tr>
1120    <td>
1121      &nbsp;
1122    </td>
1123    <td>
1124
1125<p>
1126Returns whether or not the Shift modifier is down on this event.
1127<p>
1128    </td>
1129  </tr>
1130</table>
1131<a class="anchor" name="Ogre_1_1MouseEventa9" doxytag="Ogre::MouseEvent::paramString" ></a><p>
1132<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1133  <tr>
1134    <td class="mdRow">
1135      <table cellpadding="0" cellspacing="0" border="0">
1136        <tr>
1137          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a426">String</a> Ogre::MouseEvent::paramString </td>
1138          <td class="md" valign="top">(&nbsp;</td>
1139          <td class="mdname1" valign="top" nowrap>          </td>
1140          <td class="md" valign="top">&nbsp;)&nbsp;</td>
1141          <td class="md" nowrap> const</td>
1142        </tr>
1143
1144      </table>
1145    </td>
1146  </tr>
1147</table>
1148<table cellspacing=5 cellpadding=0 border=0>
1149  <tr>
1150    <td>
1151      &nbsp;
1152    </td>
1153    <td>
1154
1155<p>
1156Returns a parameter string identifying this event.
1157<p>
1158This method is useful for event-logging and for debugging.<p>
1159<dl compact><dt><b>Returns:</b></dt><dd>a string identifying the event and its attributes</dd></dl>
1160    </td>
1161  </tr>
1162</table>
1163<a class="anchor" name="Ogre_1_1MouseEventa10" doxytag="Ogre::MouseEvent::translatePoint" ></a><p>
1164<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1165  <tr>
1166    <td class="mdRow">
1167      <table cellpadding="0" cellspacing="0" border="0">
1168        <tr>
1169          <td class="md" nowrap valign="top"> void Ogre::MouseEvent::translatePoint </td>
1170          <td class="md" valign="top">(&nbsp;</td>
1171          <td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a420">Real</a>&nbsp;</td>
1172          <td class="mdname" nowrap> <em>x</em>, </td>
1173        </tr>
1174        <tr>
1175          <td class="md" nowrap align="right"></td>
1176          <td></td>
1177          <td class="md" nowrap><a class="el" href="namespaceOgre.html#a420">Real</a>&nbsp;</td>
1178          <td class="mdname" nowrap> <em>y</em></td>
1179        </tr>
1180        <tr>
1181          <td></td>
1182          <td class="md">)&nbsp;</td>
1183          <td class="md" colspan="2"></td>
1184        </tr>
1185
1186      </table>
1187    </td>
1188  </tr>
1189</table>
1190<table cellspacing=5 cellpadding=0 border=0>
1191  <tr>
1192    <td>
1193      &nbsp;
1194    </td>
1195    <td>
1196
1197<p>
1198Translates the event's coordinates to a new position by adding specified x (horizontal) and y (veritcal) offsets.
1199<p>
1200<dl compact><dt><b>Parameters:</b></dt><dd>
1201  <table border="0" cellspacing="2" cellpadding="0">
1202    <tr><td valign=top><em>x</em>&nbsp;</td><td>the horizontal x value to add to the current x coordinate position </td></tr>
1203    <tr><td valign=top><em>y</em>&nbsp;</td><td>the vertical y value to add to the current y coordinate position</td></tr>
1204  </table>
1205</dl>
1206    </td>
1207  </tr>
1208</table>
1209<hr><h2>Member Data Documentation</h2>
1210<a class="anchor" name="Ogre_1_1MouseEventp6" doxytag="Ogre::MouseEvent::mButtonID" ></a><p>
1211<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1212  <tr>
1213    <td class="mdRow">
1214      <table cellpadding="0" cellspacing="0" border="0">
1215        <tr>
1216          <td class="md" nowrap valign="top"> int <a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEventp6">Ogre::MouseEvent::mButtonID</a><code> [protected]</code>
1217      </table>
1218    </td>
1219  </tr>
1220</table>
1221<table cellspacing=5 cellpadding=0 border=0>
1222  <tr>
1223    <td>
1224      &nbsp;
1225    </td>
1226    <td>
1227
1228<p>
1229Which button was pressed.
1230<p>
1231
1232<p>
1233Definition at line <a class="el" href="OgreMouseEvent_8h-source.html#l00190">190</a> of file <a class="el" href="OgreMouseEvent_8h-source.html">OgreMouseEvent.h</a>.    </td>
1234  </tr>
1235</table>
1236<a class="anchor" name="Ogre_1_1MouseEventp7" doxytag="Ogre::MouseEvent::mClickCount" ></a><p>
1237<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1238  <tr>
1239    <td class="mdRow">
1240      <table cellpadding="0" cellspacing="0" border="0">
1241        <tr>
1242          <td class="md" nowrap valign="top"> int <a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEventp7">Ogre::MouseEvent::mClickCount</a><code> [protected]</code>
1243      </table>
1244    </td>
1245  </tr>
1246</table>
1247<table cellspacing=5 cellpadding=0 border=0>
1248  <tr>
1249    <td>
1250      &nbsp;
1251    </td>
1252    <td>
1253
1254<p>
1255not implemented yet
1256<p>
1257
1258<p>
1259Definition at line <a class="el" href="OgreMouseEvent_8h-source.html#l00194">194</a> of file <a class="el" href="OgreMouseEvent_8h-source.html">OgreMouseEvent.h</a>.    </td>
1260  </tr>
1261</table>
1262<a class="anchor" name="Ogre_1_1MouseEventp12" doxytag="Ogre::MouseEvent::mConsumed" ></a><p>
1263<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1264  <tr>
1265    <td class="mdRow">
1266      <table cellpadding="0" cellspacing="0" border="0">
1267        <tr>
1268          <td class="md" nowrap valign="top"> bool <a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventp12">Ogre::InputEvent::mConsumed</a><code> [protected, inherited]</code>
1269      </table>
1270    </td>
1271  </tr>
1272</table>
1273<table cellspacing=5 cellpadding=0 border=0>
1274  <tr>
1275    <td>
1276      &nbsp;
1277    </td>
1278    <td>
1279
1280<p>
1281whether the event has been consumed
1282<p>
1283
1284<p>
1285Definition 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>
1286  </tr>
1287</table>
1288<a class="anchor" name="Ogre_1_1MouseEventp11" doxytag="Ogre::MouseEvent::mId" ></a><p>
1289<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1290  <tr>
1291    <td class="mdRow">
1292      <table cellpadding="0" cellspacing="0" border="0">
1293        <tr>
1294          <td class="md" nowrap valign="top"> int <a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventp11">Ogre::InputEvent::mId</a><code> [protected, inherited]</code>
1295      </table>
1296    </td>
1297  </tr>
1298</table>
1299<table cellspacing=5 cellpadding=0 border=0>
1300  <tr>
1301    <td>
1302      &nbsp;
1303    </td>
1304    <td>
1305
1306<p>
1307The ID of the event.
1308<p>
1309
1310<p>
1311Definition 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>
1312  </tr>
1313</table>
1314<a class="anchor" name="Ogre_1_1MouseEventp9" doxytag="Ogre::MouseEvent::mModifiers" ></a><p>
1315<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1316  <tr>
1317    <td class="mdRow">
1318      <table cellpadding="0" cellspacing="0" border="0">
1319        <tr>
1320          <td class="md" nowrap valign="top"> int <a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventp9">Ogre::InputEvent::mModifiers</a><code> [protected, inherited]</code>
1321      </table>
1322    </td>
1323  </tr>
1324</table>
1325<table cellspacing=5 cellpadding=0 border=0>
1326  <tr>
1327    <td>
1328      &nbsp;
1329    </td>
1330    <td>
1331
1332<p>
1333The state of the modifier keys at the time the input event was fired.
1334<p>
1335
1336<p>
1337Definition 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>
1338  </tr>
1339</table>
1340<a class="anchor" name="Ogre_1_1MouseEventp3" doxytag="Ogre::MouseEvent::mRelX" ></a><p>
1341<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1342  <tr>
1343    <td class="mdRow">
1344      <table cellpadding="0" cellspacing="0" border="0">
1345        <tr>
1346          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a420">Real</a> <a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEventp3">Ogre::MouseEvent::mRelX</a><code> [protected]</code>
1347      </table>
1348    </td>
1349  </tr>
1350</table>
1351<table cellspacing=5 cellpadding=0 border=0>
1352  <tr>
1353    <td>
1354      &nbsp;
1355    </td>
1356    <td>
1357
1358<p>
1359
1360<p>
1361Definition at line <a class="el" href="OgreMouseEvent_8h-source.html#l00182">182</a> of file <a class="el" href="OgreMouseEvent_8h-source.html">OgreMouseEvent.h</a>.    </td>
1362  </tr>
1363</table>
1364<a class="anchor" name="Ogre_1_1MouseEventp4" doxytag="Ogre::MouseEvent::mRelY" ></a><p>
1365<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1366  <tr>
1367    <td class="mdRow">
1368      <table cellpadding="0" cellspacing="0" border="0">
1369        <tr>
1370          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a420">Real</a> <a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEventp4">Ogre::MouseEvent::mRelY</a><code> [protected]</code>
1371      </table>
1372    </td>
1373  </tr>
1374</table>
1375<table cellspacing=5 cellpadding=0 border=0>
1376  <tr>
1377    <td>
1378      &nbsp;
1379    </td>
1380    <td>
1381
1382<p>
1383
1384<p>
1385Definition at line <a class="el" href="OgreMouseEvent_8h-source.html#l00183">183</a> of file <a class="el" href="OgreMouseEvent_8h-source.html">OgreMouseEvent.h</a>.    </td>
1386  </tr>
1387</table>
1388<a class="anchor" name="Ogre_1_1MouseEventp5" doxytag="Ogre::MouseEvent::mRelZ" ></a><p>
1389<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1390  <tr>
1391    <td class="mdRow">
1392      <table cellpadding="0" cellspacing="0" border="0">
1393        <tr>
1394          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a420">Real</a> <a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEventp5">Ogre::MouseEvent::mRelZ</a><code> [protected]</code>
1395      </table>
1396    </td>
1397  </tr>
1398</table>
1399<table cellspacing=5 cellpadding=0 border=0>
1400  <tr>
1401    <td>
1402      &nbsp;
1403    </td>
1404    <td>
1405
1406<p>
1407
1408<p>
1409Definition at line <a class="el" href="OgreMouseEvent_8h-source.html#l00184">184</a> of file <a class="el" href="OgreMouseEvent_8h-source.html">OgreMouseEvent.h</a>.    </td>
1410  </tr>
1411</table>
1412<a class="anchor" name="Ogre_1_1MouseEventp10" doxytag="Ogre::MouseEvent::mSource" ></a><p>
1413<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1414  <tr>
1415    <td class="mdRow">
1416      <table cellpadding="0" cellspacing="0" border="0">
1417        <tr>
1418          <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, inherited]</code>
1419      </table>
1420    </td>
1421  </tr>
1422</table>
1423<table cellspacing=5 cellpadding=0 border=0>
1424  <tr>
1425    <td>
1426      &nbsp;
1427    </td>
1428    <td>
1429
1430<p>
1431The target to process the event.
1432<p>
1433This is ususally found by the dispatcher
1434<p>
1435Definition 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>
1436  </tr>
1437</table>
1438<a class="anchor" name="Ogre_1_1MouseEventp8" doxytag="Ogre::MouseEvent::mWhen" ></a><p>
1439<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1440  <tr>
1441    <td class="mdRow">
1442      <table cellpadding="0" cellspacing="0" border="0">
1443        <tr>
1444          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a420">Real</a> <a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventp8">Ogre::InputEvent::mWhen</a><code> [protected, inherited]</code>
1445      </table>
1446    </td>
1447  </tr>
1448</table>
1449<table cellspacing=5 cellpadding=0 border=0>
1450  <tr>
1451    <td>
1452      &nbsp;
1453    </td>
1454    <td>
1455
1456<p>
1457Not implemented yet.
1458<p>
1459
1460<p>
1461Definition 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>
1462  </tr>
1463</table>
1464<a class="anchor" name="Ogre_1_1MouseEventp0" doxytag="Ogre::MouseEvent::mX" ></a><p>
1465<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1466  <tr>
1467    <td class="mdRow">
1468      <table cellpadding="0" cellspacing="0" border="0">
1469        <tr>
1470          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a420">Real</a> <a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEventp0">Ogre::MouseEvent::mX</a><code> [protected]</code>
1471      </table>
1472    </td>
1473  </tr>
1474</table>
1475<table cellspacing=5 cellpadding=0 border=0>
1476  <tr>
1477    <td>
1478      &nbsp;
1479    </td>
1480    <td>
1481
1482<p>
1483The mouse events x coordinate.
1484<p>
1485The x value is relative to the <a class="el" href="classOgre_1_1MouseTarget.html">MouseTarget</a> that fired the event.
1486<p>
1487Definition at line <a class="el" href="OgreMouseEvent_8h-source.html#l00166">166</a> of file <a class="el" href="OgreMouseEvent_8h-source.html">OgreMouseEvent.h</a>.    </td>
1488  </tr>
1489</table>
1490<a class="anchor" name="Ogre_1_1MouseEventp1" doxytag="Ogre::MouseEvent::mY" ></a><p>
1491<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1492  <tr>
1493    <td class="mdRow">
1494      <table cellpadding="0" cellspacing="0" border="0">
1495        <tr>
1496          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a420">Real</a> <a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEventp1">Ogre::MouseEvent::mY</a><code> [protected]</code>
1497      </table>
1498    </td>
1499  </tr>
1500</table>
1501<table cellspacing=5 cellpadding=0 border=0>
1502  <tr>
1503    <td>
1504      &nbsp;
1505    </td>
1506    <td>
1507
1508<p>
1509The mouse events y coordinate.
1510<p>
1511The y value is relative to the <a class="el" href="classOgre_1_1MouseTarget.html">MouseTarget</a> that fired the event.
1512<p>
1513Definition at line <a class="el" href="OgreMouseEvent_8h-source.html#l00172">172</a> of file <a class="el" href="OgreMouseEvent_8h-source.html">OgreMouseEvent.h</a>.    </td>
1514  </tr>
1515</table>
1516<a class="anchor" name="Ogre_1_1MouseEventp2" doxytag="Ogre::MouseEvent::mZ" ></a><p>
1517<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1518  <tr>
1519    <td class="mdRow">
1520      <table cellpadding="0" cellspacing="0" border="0">
1521        <tr>
1522          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a420">Real</a> <a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEventp2">Ogre::MouseEvent::mZ</a><code> [protected]</code>
1523      </table>
1524    </td>
1525  </tr>
1526</table>
1527<table cellspacing=5 cellpadding=0 border=0>
1528  <tr>
1529    <td>
1530      &nbsp;
1531    </td>
1532    <td>
1533
1534<p>
1535The mouse events z coordinate.
1536<p>
1537The z value is relative to the <a class="el" href="classOgre_1_1MouseTarget.html">MouseTarget</a> that fired the event.
1538<p>
1539Definition at line <a class="el" href="OgreMouseEvent_8h-source.html#l00179">179</a> of file <a class="el" href="OgreMouseEvent_8h-source.html">OgreMouseEvent.h</a>.    </td>
1540  </tr>
1541</table>
1542<hr>The documentation for this class was generated from the following file:<ul>
1543<li><a class="el" href="OgreMouseEvent_8h-source.html">OgreMouseEvent.h</a></ul>
1544<hr>
1545<p>
1546Copyright &copy; 2000-2005 by The OGRE Team<br />
1547<!--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/>
1548This 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/>
1549                <!--/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#">
1550                <Work rdf:about="">
1551                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
1552        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
1553                </Work>
1554                <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> -->
1555
1556Last modified Sun Feb 12 13:01:19 2006
1557</p>
1558</body>
1559</html>
Note: See TracBrowser for help on using the repository browser.