<html>
<head>
<title>Ogre::MouseEvent class Reference - OGRE Documentation</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<link type="text/css" rel="stylesheet" href="style.css">
</head>
<body>
<!-- Generated by Doxygen 1.2.16 -->
<center>
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="namespacemembers.html">Namespace Members</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> <a class="qindex" href="pages.html">Related Pages</a> </center>
<hr><h1>Ogre::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.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="OgreMouseEvent_8h-source.html">OgreMouseEvent.h</a>></code>
<p>
Inheritance diagram for Ogre::MouseEvent:<p><center><img src="classOgre_1_1MouseEvent__inherit__graph.png" border="0" usemap="#Ogre_1_1MouseEvent__inherit__map" alt="Inheritance graph"></center>
<map name="Ogre_1_1MouseEvent__inherit__map">
<area href="classOgre_1_1InputEvent.html" shape="rect" coords="12,36,121,17" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for Ogre::MouseEvent:<p><center><img src="classOgre_1_1MouseEvent__coll__graph.png" border="0" usemap="#Ogre_1_1MouseEvent__coll__map" alt="Collaboration graph"></center>
<map name="Ogre_1_1MouseEvent__coll__map">
<area href="classOgre_1_1InputEvent.html" shape="rect" coords="12,126,121,108" alt="">
<area href="classOgre_1_1EventTarget.html" shape="rect" coords="7,36,127,17" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classOgre_1_1MouseEvent-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Public Types</h2></td></tr>
<tr><td nowrap align=right valign=top>enum </td><td valign=bottom>{ <a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEvents13Ogre_1_1MouseEvents0">ME_FIRST_EVENT</a> = 500,
<a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEvents13Ogre_1_1MouseEvents1">ME_LAST_EVENT</a> = 510
}</td></tr>
<tr><td nowrap align=right valign=top>enum </td><td valign=bottom>{ <br>
<a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEvents14Ogre_1_1MouseEvents2">ME_MOUSE_CLICKED</a> = ME_FIRST_EVENT,
<a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEvents14Ogre_1_1MouseEvents3">ME_MOUSE_PRESSED</a>,
<a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEvents14Ogre_1_1MouseEvents4">ME_MOUSE_RELEASED</a>,
<a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEvents14Ogre_1_1MouseEvents5">ME_MOUSE_MOVED</a>,
<br>
<a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEvents14Ogre_1_1MouseEvents6">ME_MOUSE_ENTERED</a>,
<a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEvents14Ogre_1_1MouseEvents7">ME_MOUSE_EXITED</a>,
<a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEvents14Ogre_1_1MouseEvents8">ME_MOUSE_DRAGGED</a>,
<a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEvents14Ogre_1_1MouseEvents9">ME_MOUSE_DRAGENTERED</a>,
<br>
<a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEvents14Ogre_1_1MouseEvents10">ME_MOUSE_DRAGEXITED</a>,
<a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEvents14Ogre_1_1MouseEvents11">ME_MOUSE_DRAGMOVED</a>,
<a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEvents14Ogre_1_1MouseEvents12">ME_MOUSE_DRAGDROPPED</a>
<br>
}</td></tr>
<tr><td nowrap align=right valign=top>enum </td><td valign=bottom>{ <br>
<a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1ScrollEvents14Ogre_1_1ScrollEvents5">SHIFT_MASK</a> = 1 << 0,
<a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1ScrollEvents14Ogre_1_1ScrollEvents6">CTRL_MASK</a> = 1 << 1,
<a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1ScrollEvents14Ogre_1_1ScrollEvents7">META_MASK</a> = 1 << 2,
<a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1ScrollEvents14Ogre_1_1ScrollEvents8">ALT_MASK</a> = 1 << 3,
<br>
<a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1ScrollEvents14Ogre_1_1ScrollEvents9">BUTTON0_MASK</a> = 1 << 4,
<a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1ScrollEvents14Ogre_1_1ScrollEvents10">BUTTON1_MASK</a> = 1 << 5,
<a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1ScrollEvents14Ogre_1_1ScrollEvents11">BUTTON2_MASK</a> = 1 << 6,
<a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1ScrollEvents14Ogre_1_1ScrollEvents12">BUTTON3_MASK</a> = 1 << 7,
<br>
<a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1ScrollEvents14Ogre_1_1ScrollEvents13">BUTTON_ANY_MASK</a> = 0x1111 << 4
<br>
}</td></tr>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEventa0">MouseEvent</a> (<a class="el" href="classOgre_1_1PositionTarget.html">PositionTarget</a> *source, int id, int whichButton, <a class="el" href="namespaceOgre.html#a349">Real</a> when, int modifiers, <a class="el" href="namespaceOgre.html#a349">Real</a> x, <a class="el" href="namespaceOgre.html#a349">Real</a> y, <a class="el" href="namespaceOgre.html#a349">Real</a> z, int clickCount)</td></tr>
<tr><td> </td><td><font size=-1><em>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.</em> <a href="#Ogre_1_1MouseEventa0"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top> </td><td 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 id, int whichButton, <a class="el" href="namespaceOgre.html#a349">Real</a> when, int modifiers, <a class="el" href="namespaceOgre.html#a349">Real</a> x, <a class="el" href="namespaceOgre.html#a349">Real</a> y, <a class="el" href="namespaceOgre.html#a349">Real</a> z, <a class="el" href="namespaceOgre.html#a349">Real</a> relx, <a class="el" href="namespaceOgre.html#a349">Real</a> rely, <a class="el" href="namespaceOgre.html#a349">Real</a> relz, int clickCount)</td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEventa2">getClickCount</a> ()</td></tr>
<tr><td> </td><td><font size=-1><em>Return the number of mouse clicks associated with this event.</em> <a href="#Ogre_1_1MouseEventa2"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a349">Real</a> </td><td valign=bottom><a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEventa3">getX</a> () const</td></tr>
<tr><td> </td><td><font size=-1><em>Returns the horizontal x position of the event relative to the source <a class="el" href="classOgre_1_1GuiElement.html">GuiElement</a>.</em> <a href="#Ogre_1_1MouseEventa3"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a349">Real</a> </td><td valign=bottom><a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEventa4">getY</a> () const</td></tr>
<tr><td> </td><td><font size=-1><em>Returns the vertical y position of the event relative to the source <a class="el" href="classOgre_1_1GuiElement.html">GuiElement</a>.</em> <a href="#Ogre_1_1MouseEventa4"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a349">Real</a> </td><td valign=bottom><a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEventa5">getZ</a> () const</td></tr>
<tr><td> </td><td><font size=-1><em>Returns the vertical y position of the event relative to the source <a class="el" href="classOgre_1_1GuiElement.html">GuiElement</a>.</em> <a href="#Ogre_1_1MouseEventa5"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a349">Real</a> </td><td valign=bottom><a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEventa6">getRelX</a> () const</td></tr>
<tr><td> </td><td><font size=-1><em>get relative X cursor movement</em> <a href="#Ogre_1_1MouseEventa6"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a349">Real</a> </td><td valign=bottom><a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEventa7">getRelY</a> () const</td></tr>
<tr><td> </td><td><font size=-1><em>get relative Y cursor movement</em> <a href="#Ogre_1_1MouseEventa7"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a349">Real</a> </td><td valign=bottom><a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEventa8">getRelZ</a> () const</td></tr>
<tr><td> </td><td><font size=-1><em>get relative Z cursor movement</em> <a href="#Ogre_1_1MouseEventa8"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="classOgre_1_1String.html">String</a> </td><td valign=bottom><a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEventa9">paramString</a> () const</td></tr>
<tr><td> </td><td><font size=-1><em>Returns a parameter string identifying this event.</em> <a href="#Ogre_1_1MouseEventa9"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEventa10">translatePoint</a> (<a class="el" href="namespaceOgre.html#a349">Real</a> x, <a class="el" href="namespaceOgre.html#a349">Real</a> y)</td></tr>
<tr><td> </td><td><font size=-1><em>Translates the event's coordinates to a new position by adding specified x (horizontal) and y (veritcal) offsets.</em> <a href="#Ogre_1_1MouseEventa10"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEventa11">getButtonID</a> () const</td></tr>
<tr><td> </td><td><font size=-1><em>return the ID of the button</em> <a href="#Ogre_1_1MouseEventa11"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1ScrollEventa5">consume</a> ()</td></tr>
<tr><td> </td><td><font size=-1><em>Consumes this event so that it will not be processed in the default manner by the source which originated it.</em> <a href="#Ogre_1_1ScrollEventa5"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1ScrollEventa6">getModifiers</a> () const</td></tr>
<tr><td> </td><td><font size=-1><em>Returns the modifiers flag for this event.</em> <a href="#Ogre_1_1ScrollEventa6"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a349">Real</a> </td><td valign=bottom><a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1ScrollEventa7">getWhen</a> () const</td></tr>
<tr><td> </td><td><font size=-1><em>Returns the timestamp of when this event occurred.</em> <a href="#Ogre_1_1ScrollEventa7"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1ScrollEventa8">isAltDown</a> () const</td></tr>
<tr><td> </td><td><font size=-1><em>Returns whether or not the Alt modifier is down on this event.</em> <a href="#Ogre_1_1ScrollEventa8"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1ScrollEventa9">isConsumed</a> () const</td></tr>
<tr><td> </td><td><font size=-1><em>Returns whether or not this event has been consumed.</em> <a href="#Ogre_1_1ScrollEventa9"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1ScrollEventa10">isControlDown</a> () const</td></tr>
<tr><td> </td><td><font size=-1><em>Returns whether or not the Control modifier is down on this event.</em> <a href="#Ogre_1_1ScrollEventa10"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1ScrollEventa11">isMetaDown</a> () const</td></tr>
<tr><td> </td><td><font size=-1><em>Returns whether or not the Meta modifier is down on this event.</em> <a href="#Ogre_1_1ScrollEventa11"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1ScrollEventa12">isShiftDown</a> () const</td></tr>
<tr><td> </td><td><font size=-1><em>Returns whether or not the Shift modifier is down on this event.</em> <a href="#Ogre_1_1ScrollEventa12"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1ScrollEventa13">isEventBetween</a> (int start, int end) const</td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1ScrollEventa14">getID</a> () const</td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="classOgre_1_1EventTarget.html">EventTarget</a> * </td><td valign=bottom><a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1ScrollEventa15">getSource</a> () const</td></tr>
<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a349">Real</a> </td><td valign=bottom><a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEventn0">mX</a></td></tr>
<tr><td> </td><td><font size=-1><em>The mouse events x coordinate.</em> <a href="#Ogre_1_1MouseEventn0"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a349">Real</a> </td><td valign=bottom><a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEventn1">mY</a></td></tr>
<tr><td> </td><td><font size=-1><em>The mouse events y coordinate.</em> <a href="#Ogre_1_1MouseEventn1"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a349">Real</a> </td><td valign=bottom><a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEventn2">mZ</a></td></tr>
<tr><td> </td><td><font size=-1><em>The mouse events z coordinate.</em> <a href="#Ogre_1_1MouseEventn2"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a349">Real</a> </td><td valign=bottom><a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEventn3">mRelX</a></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a349">Real</a> </td><td valign=bottom><a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEventn4">mRelY</a></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a349">Real</a> </td><td valign=bottom><a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEventn5">mRelZ</a></td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEventn6">mButtonID</a></td></tr>
<tr><td> </td><td><font size=-1><em>Which button was pressed.</em> <a href="#Ogre_1_1MouseEventn6"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEventn7">mClickCount</a></td></tr>
<tr><td> </td><td><font size=-1><em>not implemented yet</em> <a href="#Ogre_1_1MouseEventn7"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a349">Real</a> </td><td valign=bottom><a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1ScrollEventn3">mWhen</a></td></tr>
<tr><td> </td><td><font size=-1><em>Not implemented yet.</em> <a href="#Ogre_1_1ScrollEventn3"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1ScrollEventn4">mModifiers</a></td></tr>
<tr><td> </td><td><font size=-1><em>The state of the modifier keys at the time the input event was fired.</em> <a href="#Ogre_1_1ScrollEventn4"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="classOgre_1_1EventTarget.html">EventTarget</a> * </td><td valign=bottom><a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1ScrollEventn5">mSource</a></td></tr>
<tr><td> </td><td><font size=-1><em>The target to process the event.</em> <a href="#Ogre_1_1ScrollEventn5"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1ScrollEventn6">mId</a></td></tr>
<tr><td> </td><td><font size=-1><em>The ID of the event.</em> <a href="#Ogre_1_1ScrollEventn6"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1ScrollEventn7">mConsumed</a></td></tr>
<tr><td> </td><td><font size=-1><em>whether the event has been consumed</em> <a href="#Ogre_1_1ScrollEventn7"></a><em></em></font><br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
An event which indicates that a mouse action occurred in a <a class="el" href="classOgre_1_1MouseTarget.html">MouseTarget</a> (e.g.
<p>
<a class="el" href="classOgre_1_1MouseTarget.html">MouseTarget</a>). <dl compact><dt><b>
Remarks: </b><dd>
This event is used both for mouse events (click, enter, exit) and mouse motion events (moves and drags). </dl>
<p>
This low-level event is generated by a <a class="el" href="classOgre_1_1MouseTarget.html">MouseTarget</a> object for: <ul>
<li>Mouse Events <ul>
<li>a mouse button is pressed <li>a mouse button is released <li>a mouse button is clicked (pressed and released) <li>the mouse cursor enters a <a class="el" href="classOgre_1_1MouseTarget.html">MouseTarget</a> <li>the mouse cursor exits a <a class="el" href="classOgre_1_1MouseTarget.html">MouseTarget</a> </ul>
<li> Mouse Motion Events <ul>
<li>the mouse is moved <li>the mouse is dragged </ul>
</ul>
<p>
A <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 <a class="el" href="classOgre_1_1MouseTarget.html">MouseTarget</a>'s <code>addMouseListener</code> method.
<p>
A <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 <a class="el" href="classOgre_1_1MouseTarget.html">MouseTarget</a>'s addMouseMotionListener method
<p>
When 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>
MOUSE_PRESSED: BUTTON1_MASK
MOUSE_RELEASED: BUTTON1_MASK
MOUSE_CLICKED: BUTTON1_MASK
</pre> 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>
For 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>
MOUSE_PRESSED: BUTTON1_MASK
MOUSE_PRESSED: BUTTON2_MASK
MOUSE_RELEASED: BUTTON1_MASK
MOUSE_CLICKED: BUTTON1_MASK
MOUSE_RELEASED: BUTTON2_MASK
MOUSE_CLICKED: BUTTON2_MASK
</pre> If button2 is released first, the MOUSE_RELEASED/MOUSE_CLICKED pair for BUTTON2_MASK arrives first, followed by the pair for BUTTON1_MASK.
<p>
<p>
Definition 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>
<a name="Ogre_1_1MouseEvents13" doxytag="Ogre::MouseEvent::@13"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> anonymous enum
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<dl compact><dt><b>
Enumeration values:</b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em><a name="Ogre_1_1MouseEvents13Ogre_1_1MouseEvents0" doxytag="ME_FIRST_EVENT"></a><em>ME_FIRST_EVENT</em></em> </td><td>
</td></tr>
<tr><td valign=top><em><a name="Ogre_1_1MouseEvents13Ogre_1_1MouseEvents1" doxytag="ME_LAST_EVENT"></a><em>ME_LAST_EVENT</em></em> </td><td>
</td></tr>
</table>
</dl>
<p>
Definition 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>
</tr>
</table>
<a name="Ogre_1_1MouseEvents14" doxytag="Ogre::MouseEvent::@14"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> anonymous enum
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<dl compact><dt><b>
Enumeration values:</b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em><a name="Ogre_1_1MouseEvents14Ogre_1_1MouseEvents2" doxytag="ME_MOUSE_CLICKED"></a><em>ME_MOUSE_CLICKED</em></em> </td><td>
</td></tr>
<tr><td valign=top><em><a name="Ogre_1_1MouseEvents14Ogre_1_1MouseEvents3" doxytag="ME_MOUSE_PRESSED"></a><em>ME_MOUSE_PRESSED</em></em> </td><td>
</td></tr>
<tr><td valign=top><em><a name="Ogre_1_1MouseEvents14Ogre_1_1MouseEvents4" doxytag="ME_MOUSE_RELEASED"></a><em>ME_MOUSE_RELEASED</em></em> </td><td>
</td></tr>
<tr><td valign=top><em><a name="Ogre_1_1MouseEvents14Ogre_1_1MouseEvents5" doxytag="ME_MOUSE_MOVED"></a><em>ME_MOUSE_MOVED</em></em> </td><td>
</td></tr>
<tr><td valign=top><em><a name="Ogre_1_1MouseEvents14Ogre_1_1MouseEvents6" doxytag="ME_MOUSE_ENTERED"></a><em>ME_MOUSE_ENTERED</em></em> </td><td>
</td></tr>
<tr><td valign=top><em><a name="Ogre_1_1MouseEvents14Ogre_1_1MouseEvents7" doxytag="ME_MOUSE_EXITED"></a><em>ME_MOUSE_EXITED</em></em> </td><td>
</td></tr>
<tr><td valign=top><em><a name="Ogre_1_1MouseEvents14Ogre_1_1MouseEvents8" doxytag="ME_MOUSE_DRAGGED"></a><em>ME_MOUSE_DRAGGED</em></em> </td><td>
</td></tr>
<tr><td valign=top><em><a name="Ogre_1_1MouseEvents14Ogre_1_1MouseEvents9" doxytag="ME_MOUSE_DRAGENTERED"></a><em>ME_MOUSE_DRAGENTERED</em></em> </td><td>
</td></tr>
<tr><td valign=top><em><a name="Ogre_1_1MouseEvents14Ogre_1_1MouseEvents10" doxytag="ME_MOUSE_DRAGEXITED"></a><em>ME_MOUSE_DRAGEXITED</em></em> </td><td>
</td></tr>
<tr><td valign=top><em><a name="Ogre_1_1MouseEvents14Ogre_1_1MouseEvents11" doxytag="ME_MOUSE_DRAGMOVED"></a><em>ME_MOUSE_DRAGMOVED</em></em> </td><td>
</td></tr>
<tr><td valign=top><em><a name="Ogre_1_1MouseEvents14Ogre_1_1MouseEvents12" doxytag="ME_MOUSE_DRAGDROPPED"></a><em>ME_MOUSE_DRAGDROPPED</em></em> </td><td>
</td></tr>
</table>
</dl>
<p>
Definition 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>
</tr>
</table>
<a name="Ogre_1_1ScrollEvents14" doxytag="Ogre::MouseEvent::@7"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> anonymous enum<code> [inherited]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<dl compact><dt><b>
Enumeration values:</b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em><a name="Ogre_1_1ScrollEvents14Ogre_1_1ScrollEvents5" doxytag="SHIFT_MASK"></a><em>SHIFT_MASK</em></em> </td><td>
This flag indicates that the Shift key was down when the event occurred.</td></tr>
<tr><td valign=top><em><a name="Ogre_1_1ScrollEvents14Ogre_1_1ScrollEvents6" doxytag="CTRL_MASK"></a><em>CTRL_MASK</em></em> </td><td>
This flag indicates that the Control key was down when the event occurred.</td></tr>
<tr><td valign=top><em><a name="Ogre_1_1ScrollEvents14Ogre_1_1ScrollEvents7" doxytag="META_MASK"></a><em>META_MASK</em></em> </td><td>
This flag indicates that the Meta key was down when the event occurred.
<p>
For mouse events, this flag indicates that the right button was pressed or released. </td></tr>
<tr><td valign=top><em><a name="Ogre_1_1ScrollEvents14Ogre_1_1ScrollEvents8" doxytag="ALT_MASK"></a><em>ALT_MASK</em></em> </td><td>
This flag indicates that the Alt key was down when the event occurred.
<p>
For mouse events, this flag indicates that the middle mouse button was pressed or released. </td></tr>
<tr><td valign=top><em><a name="Ogre_1_1ScrollEvents14Ogre_1_1ScrollEvents9" doxytag="BUTTON0_MASK"></a><em>BUTTON0_MASK</em></em> </td><td>
</td></tr>
<tr><td valign=top><em><a name="Ogre_1_1ScrollEvents14Ogre_1_1ScrollEvents10" doxytag="BUTTON1_MASK"></a><em>BUTTON1_MASK</em></em> </td><td>
</td></tr>
<tr><td valign=top><em><a name="Ogre_1_1ScrollEvents14Ogre_1_1ScrollEvents11" doxytag="BUTTON2_MASK"></a><em>BUTTON2_MASK</em></em> </td><td>
</td></tr>
<tr><td valign=top><em><a name="Ogre_1_1ScrollEvents14Ogre_1_1ScrollEvents12" doxytag="BUTTON3_MASK"></a><em>BUTTON3_MASK</em></em> </td><td>
</td></tr>
<tr><td valign=top><em><a name="Ogre_1_1ScrollEvents14Ogre_1_1ScrollEvents13" doxytag="BUTTON_ANY_MASK"></a><em>BUTTON_ANY_MASK</em></em> </td><td>
</td></tr>
</table>
</dl>
<p>
Definition 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>
</tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a name="Ogre_1_1MouseEventa0" doxytag="Ogre::MouseEvent::MouseEvent"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> Ogre::MouseEvent::MouseEvent </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1PositionTarget.html">PositionTarget</a> * </td>
<td class="mdname" nowrap> <em>source</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>id</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>whichButton</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="namespaceOgre.html#a349">Real</a> </td>
<td class="mdname" nowrap> <em>when</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>modifiers</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="namespaceOgre.html#a349">Real</a> </td>
<td class="mdname" nowrap> <em>x</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="namespaceOgre.html#a349">Real</a> </td>
<td class="mdname" nowrap> <em>y</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="namespaceOgre.html#a349">Real</a> </td>
<td class="mdname" nowrap> <em>z</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>clickCount</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
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.
<p>
<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>source</em> </td><td>
the <a class="el" href="classOgre_1_1MouseTarget.html">MouseTarget</a> that originated the event </td></tr>
<tr><td valign=top><em>id</em> </td><td>
the integer that identifies the event </td></tr>
<tr><td valign=top><em>when</em> </td><td>
a long int that gives the time the event occurred </td></tr>
<tr><td valign=top><em>modifiers</em> </td><td>
the modifier keys down during event (shift, ctrl, alt, meta) </td></tr>
<tr><td valign=top><em>x</em> </td><td>
the horizontal x coordinate for the mouse location </td></tr>
<tr><td valign=top><em>y</em> </td><td>
the vertical y coordinate for the mouse location </td></tr>
<tr><td valign=top><em>clickCount</em> </td><td>
the number of mouse clicks associated with event </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="OgreMouseEvent_8cpp-source.html#l00034">34</a> of file <a class="el" href="OgreMouseEvent_8cpp-source.html">OgreMouseEvent.cpp</a>.
<p>
References <a class="el" href="OgrePrerequisites_8h-source.html#l00086">Ogre::Real</a>. </td>
</tr>
</table>
<a name="Ogre_1_1MouseEventa1" doxytag="Ogre::MouseEvent::MouseEvent"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> Ogre::MouseEvent::MouseEvent </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1PositionTarget.html">PositionTarget</a> * </td>
<td class="mdname" nowrap> <em>source</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>id</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>whichButton</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="namespaceOgre.html#a349">Real</a> </td>
<td class="mdname" nowrap> <em>when</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>modifiers</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="namespaceOgre.html#a349">Real</a> </td>
<td class="mdname" nowrap> <em>x</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="namespaceOgre.html#a349">Real</a> </td>
<td class="mdname" nowrap> <em>y</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="namespaceOgre.html#a349">Real</a> </td>
<td class="mdname" nowrap> <em>z</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="namespaceOgre.html#a349">Real</a> </td>
<td class="mdname" nowrap> <em>relx</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="namespaceOgre.html#a349">Real</a> </td>
<td class="mdname" nowrap> <em>rely</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="namespaceOgre.html#a349">Real</a> </td>
<td class="mdname" nowrap> <em>relz</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>clickCount</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="OgreMouseEvent_8cpp-source.html#l00044">44</a> of file <a class="el" href="OgreMouseEvent_8cpp-source.html">OgreMouseEvent.cpp</a>.
<p>
References <a class="el" href="OgrePrerequisites_8h-source.html#l00086">Ogre::Real</a>. </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="Ogre_1_1ScrollEventa5" doxytag="Ogre::MouseEvent::consume"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Ogre::InputEvent::consume </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap><code> [inherited]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Consumes this event so that it will not be processed in the default manner by the source which originated it.
<p>
<p>
Definition at line <a class="el" href="OgreInputEvent_8cpp-source.html#l00043">43</a> of file <a class="el" href="OgreInputEvent_8cpp-source.html">OgreInputEvent.cpp</a>.
<p>
References <a class="el" href="OgreInputEvent_8h-source.html#l00088">Ogre::InputEvent::mConsumed</a>.
<p>
Referenced by <a class="el" href="OgreEventDispatcher_8cpp-source.html#l00155">Ogre::EventDispatcher::retargetMouseEvent</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1MouseEventa11" doxytag="Ogre::MouseEvent::getButtonID"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> int Ogre::MouseEvent::getButtonID </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
return the ID of the button
<p>
<p>
Definition at line <a class="el" href="OgreMouseEvent_8cpp-source.html#l00097">97</a> of file <a class="el" href="OgreMouseEvent_8cpp-source.html">OgreMouseEvent.cpp</a>.
<p>
References <a class="el" href="OgreMouseEvent_8h-source.html#l00190">mButtonID</a>.
<p>
Referenced by <a class="el" href="OgreEventDispatcher_8cpp-source.html#l00155">Ogre::EventDispatcher::retargetMouseEvent</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1MouseEventa2" doxytag="Ogre::MouseEvent::getClickCount"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> int Ogre::MouseEvent::getClickCount </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Return the number of mouse clicks associated with this event.
<p>
<dl compact><dt><b>
Returns: </b><dd>
integer value for the number of clicks - NOT IMPLEMENTED </dl>
<p>
Definition at line <a class="el" href="OgreMouseEvent_8cpp-source.html#l00062">62</a> of file <a class="el" href="OgreMouseEvent_8cpp-source.html">OgreMouseEvent.cpp</a>.
<p>
References <a class="el" href="OgreMouseEvent_8h-source.html#l00194">mClickCount</a>.
<p>
Referenced by <a class="el" href="OgreEventDispatcher_8cpp-source.html#l00155">Ogre::EventDispatcher::retargetMouseEvent</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1ScrollEventa14" doxytag="Ogre::MouseEvent::getID"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> int Ogre::InputEvent::getID </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const<code> [inherited]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="OgreInputEvent_8cpp-source.html#l00089">89</a> of file <a class="el" href="OgreInputEvent_8cpp-source.html">OgreInputEvent.cpp</a>.
<p>
References <a class="el" href="OgreInputEvent_8h-source.html#l00083">Ogre::InputEvent::mId</a>.
<p>
Referenced by <a class="el" href="OgreActionTarget_8cpp-source.html#l00045">Ogre::ActionTarget::processActionEvent</a>(), <a class="el" href="OgreTextBoxGuiElement_8cpp-source.html#l00224">Ogre::TextBoxGuiElement::processEvent</a>(), <a class="el" href="OgreScrollBarGuiElement_8cpp-source.html#l00280">Ogre::ScrollBarGuiElement::processEvent</a>(), <a class="el" href="OgreOverlayManager_8cpp-source.html#l00567">Ogre::OverlayManager::processEvent</a>(), <a class="el" href="OgreGuiElement_8cpp-source.html#l00549">Ogre::GuiElement::processEvent</a>(), <a class="el" href="OgreGuiControl_8cpp-source.html#l00045">Ogre::GuiControl::processEvent</a>(), <a class="el" href="OgreEventProcessor_8cpp-source.html#l00152">Ogre::EventProcessor::processEvent</a>(), <a class="el" href="OgreCursor_8cpp-source.html#l00087">Ogre::Cursor::processEvent</a>(), <a class="el" href="OgreKeyTarget_8cpp-source.html#l00044">Ogre::KeyTarget::processKeyEvent</a>(), <a class="el" href="OgreMouseTarget_8cpp-source.html#l00046">Ogre::MouseTarget::processMouseEvent</a>(), <a class="el" href="OgreEventDispatcher_8cpp-source.html#l00093">Ogre::EventDispatcher::processMouseEvent</a>(), <a class="el" href="OgreMouseMotionTarget_8cpp-source.html#l00044">Ogre::MouseMotionTarget::processMouseMotionEvent</a>(), <a class="el" href="OgreScrollTarget_8cpp-source.html#l00045">Ogre::ScrollTarget::processScrollEvent</a>(), and <a class="el" href="OgreEventDispatcher_8cpp-source.html#l00155">Ogre::EventDispatcher::retargetMouseEvent</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1ScrollEventa6" doxytag="Ogre::MouseEvent::getModifiers"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> int Ogre::InputEvent::getModifiers </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const<code> [inherited]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Returns the modifiers flag for this event.
<p>
<p>
Definition at line <a class="el" href="OgreInputEvent_8cpp-source.html#l00048">48</a> of file <a class="el" href="OgreInputEvent_8cpp-source.html">OgreInputEvent.cpp</a>.
<p>
References <a class="el" href="OgreInputEvent_8h-source.html#l00072">Ogre::InputEvent::mModifiers</a>.
<p>
Referenced by <a class="el" href="OgreMouseEvent_8cpp-source.html#l00109">paramString</a>(), <a class="el" href="OgreEventDispatcher_8cpp-source.html#l00204">Ogre::EventDispatcher::retargetKeyEvent</a>(), and <a class="el" href="OgreEventDispatcher_8cpp-source.html#l00155">Ogre::EventDispatcher::retargetMouseEvent</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1MouseEventa6" doxytag="Ogre::MouseEvent::getRelX"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a349">Real</a> Ogre::MouseEvent::getRelX </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
get relative X cursor movement
<p>
<p>
Definition 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>.
<p>
References <a class="el" href="OgrePrerequisites_8h-source.html#l00086">Ogre::Real</a>. </td>
</tr>
</table>
<a name="Ogre_1_1MouseEventa7" doxytag="Ogre::MouseEvent::getRelY"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a349">Real</a> Ogre::MouseEvent::getRelY </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
get relative Y cursor movement
<p>
<p>
Definition 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>.
<p>
References <a class="el" href="OgrePrerequisites_8h-source.html#l00086">Ogre::Real</a>. </td>
</tr>
</table>
<a name="Ogre_1_1MouseEventa8" doxytag="Ogre::MouseEvent::getRelZ"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a349">Real</a> Ogre::MouseEvent::getRelZ </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
get relative Z cursor movement
<p>
<p>
Definition 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>.
<p>
References <a class="el" href="OgrePrerequisites_8h-source.html#l00086">Ogre::Real</a>. </td>
</tr>
</table>
<a name="Ogre_1_1ScrollEventa15" doxytag="Ogre::MouseEvent::getSource"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1EventTarget.html">EventTarget</a> * Ogre::InputEvent::getSource </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const<code> [inherited]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="OgreInputEvent_8cpp-source.html#l00095">95</a> of file <a class="el" href="OgreInputEvent_8cpp-source.html">OgreInputEvent.cpp</a>.
<p>
References <a class="el" href="OgreInputEvent_8h-source.html#l00078">Ogre::InputEvent::mSource</a>.
<p>
Referenced by <a class="el" href="OgreScrollBarGuiElement_8cpp-source.html#l00316">Ogre::ScrollBarGuiElement::mousePressed</a>(), and <a class="el" href="OgreListGuiElement_8cpp-source.html#l00530">Ogre::ListGuiElement::mousePressed</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1ScrollEventa7" doxytag="Ogre::MouseEvent::getWhen"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a349">Real</a> Ogre::InputEvent::getWhen </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const<code> [inherited]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Returns the timestamp of when this event occurred.
<p>
Not implemented yet
<p>
Definition at line <a class="el" href="OgreInputEvent_8cpp-source.html#l00053">53</a> of file <a class="el" href="OgreInputEvent_8cpp-source.html">OgreInputEvent.cpp</a>.
<p>
References <a class="el" href="OgreInputEvent_8h-source.html#l00067">Ogre::InputEvent::mWhen</a>, and <a class="el" href="OgrePrerequisites_8h-source.html#l00086">Ogre::Real</a>.
<p>
Referenced by <a class="el" href="OgreEventDispatcher_8cpp-source.html#l00204">Ogre::EventDispatcher::retargetKeyEvent</a>(), and <a class="el" href="OgreEventDispatcher_8cpp-source.html#l00155">Ogre::EventDispatcher::retargetMouseEvent</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1MouseEventa3" doxytag="Ogre::MouseEvent::getX"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a349">Real</a> Ogre::MouseEvent::getX </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Returns the horizontal x position of the event relative to the source <a class="el" href="classOgre_1_1GuiElement.html">GuiElement</a>.
<p>
<dl compact><dt><b>
Returns: </b><dd>
x an integer indicating horizontal position relative to the <a class="el" href="classOgre_1_1MouseTarget.html">MouseTarget</a> </dl>
<p>
Definition at line <a class="el" href="OgreMouseEvent_8cpp-source.html#l00073">73</a> of file <a class="el" href="OgreMouseEvent_8cpp-source.html">OgreMouseEvent.cpp</a>.
<p>
References <a class="el" href="OgreMouseEvent_8h-source.html#l00166">mX</a>, and <a class="el" href="OgrePrerequisites_8h-source.html#l00086">Ogre::Real</a>.
<p>
Referenced by <a class="el" href="OgreListGuiElement_8cpp-source.html#l00492">Ogre::ListGuiElement::mouseDragged</a>(), <a class="el" href="OgrePopupMenuGuiElement_8cpp-source.html#l00307">Ogre::PopupMenuGuiElement::mouseMoved</a>(), <a class="el" href="OgreCursorGuiElement_8cpp-source.html#l00097">Ogre::CursorGuiElement::mouseMoved</a>(), <a class="el" href="OgreEventDispatcher_8cpp-source.html#l00093">Ogre::EventDispatcher::processMouseEvent</a>(), and <a class="el" href="OgreEventDispatcher_8cpp-source.html#l00155">Ogre::EventDispatcher::retargetMouseEvent</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1MouseEventa4" doxytag="Ogre::MouseEvent::getY"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a349">Real</a> Ogre::MouseEvent::getY </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Returns the vertical y position of the event relative to the source <a class="el" href="classOgre_1_1GuiElement.html">GuiElement</a>.
<p>
<dl compact><dt><b>
Returns: </b><dd>
y an integer indicating vertical position relative to the <a class="el" href="classOgre_1_1MouseTarget.html">MouseTarget</a> </dl>
<p>
Definition at line <a class="el" href="OgreMouseEvent_8cpp-source.html#l00083">83</a> of file <a class="el" href="OgreMouseEvent_8cpp-source.html">OgreMouseEvent.cpp</a>.
<p>
References <a class="el" href="OgreMouseEvent_8h-source.html#l00172">mY</a>, and <a class="el" href="OgrePrerequisites_8h-source.html#l00086">Ogre::Real</a>.
<p>
Referenced by <a class="el" href="OgreScrollBarGuiElement_8cpp-source.html#l00301">Ogre::ScrollBarGuiElement::mouseDragged</a>(), <a class="el" href="OgreListGuiElement_8cpp-source.html#l00492">Ogre::ListGuiElement::mouseDragged</a>(), <a class="el" href="OgrePopupMenuGuiElement_8cpp-source.html#l00307">Ogre::PopupMenuGuiElement::mouseMoved</a>(), <a class="el" href="OgreCursorGuiElement_8cpp-source.html#l00097">Ogre::CursorGuiElement::mouseMoved</a>(), <a class="el" href="OgreScrollBarGuiElement_8cpp-source.html#l00316">Ogre::ScrollBarGuiElement::mousePressed</a>(), <a class="el" href="OgreEventDispatcher_8cpp-source.html#l00093">Ogre::EventDispatcher::processMouseEvent</a>(), and <a class="el" href="OgreEventDispatcher_8cpp-source.html#l00155">Ogre::EventDispatcher::retargetMouseEvent</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1MouseEventa5" doxytag="Ogre::MouseEvent::getZ"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a349">Real</a> Ogre::MouseEvent::getZ </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Returns the vertical y position of the event relative to the source <a class="el" href="classOgre_1_1GuiElement.html">GuiElement</a>.
<p>
<dl compact><dt><b>
Returns: </b><dd>
y an integer indicating scrollwheel position relative to the <a class="el" href="classOgre_1_1MouseTarget.html">MouseTarget</a> </dl>
<p>
Definition at line <a class="el" href="OgreMouseEvent_8cpp-source.html#l00094">94</a> of file <a class="el" href="OgreMouseEvent_8cpp-source.html">OgreMouseEvent.cpp</a>.
<p>
References <a class="el" href="OgreMouseEvent_8h-source.html#l00179">mZ</a>, and <a class="el" href="OgrePrerequisites_8h-source.html#l00086">Ogre::Real</a>.
<p>
Referenced by <a class="el" href="OgreEventDispatcher_8cpp-source.html#l00155">Ogre::EventDispatcher::retargetMouseEvent</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1ScrollEventa8" doxytag="Ogre::MouseEvent::isAltDown"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool Ogre::InputEvent::isAltDown </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const<code> [inherited]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Returns whether or not the Alt modifier is down on this event.
<p>
<p>
Definition at line <a class="el" href="OgreInputEvent_8cpp-source.html#l00058">58</a> of file <a class="el" href="OgreInputEvent_8cpp-source.html">OgreInputEvent.cpp</a>.
<p>
References <a class="el" href="OgreInputEvent_8h-source.html#l00072">Ogre::InputEvent::mModifiers</a>. </td>
</tr>
</table>
<a name="Ogre_1_1ScrollEventa9" doxytag="Ogre::MouseEvent::isConsumed"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool Ogre::InputEvent::isConsumed </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const<code> [inherited]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Returns whether or not this event has been consumed.
<p>
<dl compact><dt><b>
See also: </b><dd>
<a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1ScrollEventa5">consume</a> </dl>
<p>
Definition at line <a class="el" href="OgreInputEvent_8cpp-source.html#l00063">63</a> of file <a class="el" href="OgreInputEvent_8cpp-source.html">OgreInputEvent.cpp</a>.
<p>
References <a class="el" href="OgreInputEvent_8h-source.html#l00088">Ogre::InputEvent::mConsumed</a>.
<p>
Referenced by <a class="el" href="OgreTextBoxGuiElement_8cpp-source.html#l00224">Ogre::TextBoxGuiElement::processEvent</a>(), <a class="el" href="OgreScrollBarGuiElement_8cpp-source.html#l00280">Ogre::ScrollBarGuiElement::processEvent</a>(), <a class="el" href="OgreGuiElement_8cpp-source.html#l00549">Ogre::GuiElement::processEvent</a>(), <a class="el" href="OgreGuiControl_8cpp-source.html#l00045">Ogre::GuiControl::processEvent</a>(), <a class="el" href="OgreEventProcessor_8cpp-source.html#l00152">Ogre::EventProcessor::processEvent</a>(), <a class="el" href="OgreEventDispatcher_8cpp-source.html#l00083">Ogre::EventDispatcher::processKeyEvent</a>(), and <a class="el" href="OgreEventDispatcher_8cpp-source.html#l00093">Ogre::EventDispatcher::processMouseEvent</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1ScrollEventa10" doxytag="Ogre::MouseEvent::isControlDown"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool Ogre::InputEvent::isControlDown </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const<code> [inherited]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Returns whether or not the Control modifier is down on this event.
<p>
<p>
Definition at line <a class="el" href="OgreInputEvent_8cpp-source.html#l00068">68</a> of file <a class="el" href="OgreInputEvent_8cpp-source.html">OgreInputEvent.cpp</a>.
<p>
References <a class="el" href="OgreInputEvent_8h-source.html#l00072">Ogre::InputEvent::mModifiers</a>. </td>
</tr>
</table>
<a name="Ogre_1_1ScrollEventa13" doxytag="Ogre::MouseEvent::isEventBetween"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool Ogre::InputEvent::isEventBetween </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname" nowrap> <em>start</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>end</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"> const<code> [inherited]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="OgreInputEvent_8cpp-source.html#l00083">83</a> of file <a class="el" href="OgreInputEvent_8cpp-source.html">OgreInputEvent.cpp</a>.
<p>
References <a class="el" href="OgreInputEvent_8h-source.html#l00083">Ogre::InputEvent::mId</a>.
<p>
Referenced by <a class="el" href="OgreEventDispatcher_8cpp-source.html#l00058">Ogre::EventDispatcher::dispatchEvent</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1ScrollEventa11" doxytag="Ogre::MouseEvent::isMetaDown"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool Ogre::InputEvent::isMetaDown </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const<code> [inherited]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Returns whether or not the Meta modifier is down on this event.
<p>
<p>
Definition at line <a class="el" href="OgreInputEvent_8cpp-source.html#l00073">73</a> of file <a class="el" href="OgreInputEvent_8cpp-source.html">OgreInputEvent.cpp</a>.
<p>
References <a class="el" href="OgreInputEvent_8h-source.html#l00072">Ogre::InputEvent::mModifiers</a>. </td>
</tr>
</table>
<a name="Ogre_1_1ScrollEventa12" doxytag="Ogre::MouseEvent::isShiftDown"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool Ogre::InputEvent::isShiftDown </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const<code> [inherited]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Returns whether or not the Shift modifier is down on this event.
<p>
<p>
Definition at line <a class="el" href="OgreInputEvent_8cpp-source.html#l00078">78</a> of file <a class="el" href="OgreInputEvent_8cpp-source.html">OgreInputEvent.cpp</a>.
<p>
References <a class="el" href="OgreInputEvent_8h-source.html#l00072">Ogre::InputEvent::mModifiers</a>. </td>
</tr>
</table>
<a name="Ogre_1_1MouseEventa9" doxytag="Ogre::MouseEvent::paramString"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1String.html">String</a> Ogre::MouseEvent::paramString </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Returns a parameter string identifying this event.
<p>
This method is useful for event-logging and for debugging.
<p>
<dl compact><dt><b>
Returns: </b><dd>
a string identifying the event and its attributes </dl>
<p>
Definition at line <a class="el" href="OgreMouseEvent_8cpp-source.html#l00109">109</a> of file <a class="el" href="OgreMouseEvent_8cpp-source.html">OgreMouseEvent.cpp</a>.
<p>
References <a class="el" href="OgreInputEvent_8cpp-source.html#l00048">Ogre::InputEvent::getModifiers</a>(), <a class="el" href="OgreMouseEvent_8h-source.html#l00194">mClickCount</a>, <a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEvents14Ogre_1_1MouseEvents2">ME_MOUSE_CLICKED</a>, <a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEvents14Ogre_1_1MouseEvents12">ME_MOUSE_DRAGDROPPED</a>, <a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEvents14Ogre_1_1MouseEvents9">ME_MOUSE_DRAGENTERED</a>, <a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEvents14Ogre_1_1MouseEvents10">ME_MOUSE_DRAGEXITED</a>, <a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEvents14Ogre_1_1MouseEvents8">ME_MOUSE_DRAGGED</a>, <a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEvents14Ogre_1_1MouseEvents11">ME_MOUSE_DRAGMOVED</a>, <a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEvents14Ogre_1_1MouseEvents6">ME_MOUSE_ENTERED</a>, <a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEvents14Ogre_1_1MouseEvents7">ME_MOUSE_EXITED</a>, <a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEvents14Ogre_1_1MouseEvents5">ME_MOUSE_MOVED</a>, <a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEvents14Ogre_1_1MouseEvents3">ME_MOUSE_PRESSED</a>, <a class="el" href="classOgre_1_1MouseEvent.html#Ogre_1_1MouseEvents14Ogre_1_1MouseEvents4">ME_MOUSE_RELEASED</a>, <a class="el" href="OgreMouseEvent_8h-source.html#l00166">mX</a>, and <a class="el" href="OgreMouseEvent_8h-source.html#l00172">mY</a>. </td>
</tr>
</table>
<a name="Ogre_1_1MouseEventa10" doxytag="Ogre::MouseEvent::translatePoint"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Ogre::MouseEvent::translatePoint </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a349">Real</a> </td>
<td class="mdname" nowrap> <em>x</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="namespaceOgre.html#a349">Real</a> </td>
<td class="mdname" nowrap> <em>y</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Translates the event's coordinates to a new position by adding specified x (horizontal) and y (veritcal) offsets.
<p>
<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>x</em> </td><td>
the horizontal x value to add to the current x coordinate position </td></tr>
<tr><td valign=top><em>y</em> </td><td>
the vertical y value to add to the current y coordinate position </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="OgreMouseEvent_8cpp-source.html#l00159">159</a> of file <a class="el" href="OgreMouseEvent_8cpp-source.html">OgreMouseEvent.cpp</a>.
<p>
References <a class="el" href="OgreMouseEvent_8h-source.html#l00166">mX</a>, <a class="el" href="OgreMouseEvent_8h-source.html#l00172">mY</a>, and <a class="el" href="OgrePrerequisites_8h-source.html#l00086">Ogre::Real</a>. </td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a name="Ogre_1_1MouseEventn6" doxytag="Ogre::MouseEvent::mButtonID"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> int Ogre::MouseEvent::mButtonID<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Which button was pressed.
<p>
<p>
Definition 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>.
<p>
Referenced by <a class="el" href="OgreMouseEvent_8cpp-source.html#l00097">getButtonID</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1MouseEventn7" doxytag="Ogre::MouseEvent::mClickCount"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> int Ogre::MouseEvent::mClickCount<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
not implemented yet
<p>
<p>
Definition 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>.
<p>
Referenced by <a class="el" href="OgreMouseEvent_8cpp-source.html#l00062">getClickCount</a>(), and <a class="el" href="OgreMouseEvent_8cpp-source.html#l00109">paramString</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1ScrollEventn7" doxytag="Ogre::MouseEvent::mConsumed"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool Ogre::InputEvent::mConsumed<code> [protected, inherited]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
whether the event has been consumed
<p>
<p>
Definition 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>.
<p>
Referenced by <a class="el" href="OgreInputEvent_8cpp-source.html#l00043">Ogre::InputEvent::consume</a>(), <a class="el" href="OgreInputEvent_8cpp-source.html#l00033">Ogre::InputEvent::InputEvent</a>(), and <a class="el" href="OgreInputEvent_8cpp-source.html#l00063">Ogre::InputEvent::isConsumed</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1ScrollEventn6" doxytag="Ogre::MouseEvent::mId"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> int Ogre::InputEvent::mId<code> [protected, inherited]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
The ID of the event.
<p>
<p>
Definition 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>.
<p>
Referenced by <a class="el" href="OgreInputEvent_8cpp-source.html#l00089">Ogre::InputEvent::getID</a>(), and <a class="el" href="OgreInputEvent_8cpp-source.html#l00083">Ogre::InputEvent::isEventBetween</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1ScrollEventn4" doxytag="Ogre::MouseEvent::mModifiers"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> int Ogre::InputEvent::mModifiers<code> [protected, inherited]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
The state of the modifier keys at the time the input event was fired.
<p>
<p>
Definition 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>.
<p>
Referenced by <a class="el" href="OgreKeyEvent_8cpp-source.html#l00048">Ogre::KeyEvent::getKeyChar</a>(), <a class="el" href="OgreInputEvent_8cpp-source.html#l00048">Ogre::InputEvent::getModifiers</a>(), <a class="el" href="OgreInputEvent_8cpp-source.html#l00058">Ogre::InputEvent::isAltDown</a>(), <a class="el" href="OgreInputEvent_8cpp-source.html#l00068">Ogre::InputEvent::isControlDown</a>(), <a class="el" href="OgreInputEvent_8cpp-source.html#l00073">Ogre::InputEvent::isMetaDown</a>(), and <a class="el" href="OgreInputEvent_8cpp-source.html#l00078">Ogre::InputEvent::isShiftDown</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1MouseEventn3" doxytag="Ogre::MouseEvent::mRelX"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a349">Real</a> Ogre::MouseEvent::mRelX<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="OgreMouseEvent_8h-source.html#l00182">182</a> of file <a class="el" href="OgreMouseEvent_8h-source.html">OgreMouseEvent.h</a>. </td>
</tr>
</table>
<a name="Ogre_1_1MouseEventn4" doxytag="Ogre::MouseEvent::mRelY"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a349">Real</a> Ogre::MouseEvent::mRelY<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="OgreMouseEvent_8h-source.html#l00183">183</a> of file <a class="el" href="OgreMouseEvent_8h-source.html">OgreMouseEvent.h</a>. </td>
</tr>
</table>
<a name="Ogre_1_1MouseEventn5" doxytag="Ogre::MouseEvent::mRelZ"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a349">Real</a> Ogre::MouseEvent::mRelZ<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="OgreMouseEvent_8h-source.html#l00184">184</a> of file <a class="el" href="OgreMouseEvent_8h-source.html">OgreMouseEvent.h</a>. </td>
</tr>
</table>
<a name="Ogre_1_1ScrollEventn5" doxytag="Ogre::MouseEvent::mSource"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1EventTarget.html">EventTarget</a>* Ogre::InputEvent::mSource<code> [protected, inherited]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
The target to process the event.
<p>
This is ususally found by the dispatcher
<p>
Definition 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>.
<p>
Referenced by <a class="el" href="OgreInputEvent_8cpp-source.html#l00095">Ogre::InputEvent::getSource</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1ScrollEventn3" doxytag="Ogre::MouseEvent::mWhen"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a349">Real</a> Ogre::InputEvent::mWhen<code> [protected, inherited]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Not implemented yet.
<p>
<p>
Definition 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>.
<p>
Referenced by <a class="el" href="OgreInputEvent_8cpp-source.html#l00053">Ogre::InputEvent::getWhen</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1MouseEventn0" doxytag="Ogre::MouseEvent::mX"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a349">Real</a> Ogre::MouseEvent::mX<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
The mouse events x coordinate.
<p>
The x value is relative to the <a class="el" href="classOgre_1_1MouseTarget.html">MouseTarget</a> that fired the event.
<p>
Definition 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>.
<p>
Referenced by <a class="el" href="OgreMouseEvent_8cpp-source.html#l00073">getX</a>(), <a class="el" href="OgreMouseEvent_8cpp-source.html#l00109">paramString</a>(), and <a class="el" href="OgreMouseEvent_8cpp-source.html#l00159">translatePoint</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1MouseEventn1" doxytag="Ogre::MouseEvent::mY"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a349">Real</a> Ogre::MouseEvent::mY<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
The mouse events y coordinate.
<p>
The y value is relative to the <a class="el" href="classOgre_1_1MouseTarget.html">MouseTarget</a> that fired the event.
<p>
Definition 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>.
<p>
Referenced by <a class="el" href="OgreMouseEvent_8cpp-source.html#l00083">getY</a>(), <a class="el" href="OgreMouseEvent_8cpp-source.html#l00109">paramString</a>(), and <a class="el" href="OgreMouseEvent_8cpp-source.html#l00159">translatePoint</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1MouseEventn2" doxytag="Ogre::MouseEvent::mZ"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a349">Real</a> Ogre::MouseEvent::mZ<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
The mouse events z coordinate.
<p>
The z value is relative to the <a class="el" href="classOgre_1_1MouseTarget.html">MouseTarget</a> that fired the event.
<p>
Definition 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>.
<p>
Referenced by <a class="el" href="OgreMouseEvent_8cpp-source.html#l00094">getZ</a>(). </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="OgreMouseEvent_8h-source.html">OgreMouseEvent.h</a><li><a class="el" href="OgreMouseEvent_8cpp-source.html">OgreMouseEvent.cpp</a></ul>
<p>
Copyright © 2002-2003 by The OGRE Team<br />
Last modified Wed Jan 21 00:18:37 2004
</p>
</body>
</html>
distrib
>
Mandriva
>
10.0
>
i586
>
media
>
contrib
>
by-pkgid
>
06719cf03808e17ae6f0852ca1052dc2
>
files
>
2566
