<html>
<head>
<title>Ogre::InputReader 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.3.6 -->
<div class="qindex"><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">Class 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">Class Members</a> | <a class="qindex" href="globals.html">File Members</a> | <a class="qindex" href="pages.html">Related Pages</a></div>
<h1>Ogre::InputReader Class Reference</h1>Abstract class which allows input to be read from various controllers.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="OgreInput_8h-source.html">OgreInput.h</a>></code>
<p>
Inheritance diagram for Ogre::InputReader:<p><center><img src="classOgre_1_1InputReader__inherit__graph.png" border="0" usemap="#Ogre_1_1InputReader__inherit__map" alt="Inheritance graph"></center>
<map name="Ogre_1_1InputReader__inherit__map">
<area href="classOgre_1_1GLXInput.html" shape="rect" coords="7,87,108,105" alt="">
<area href="classOgre_1_1SDLInput.html" shape="rect" coords="132,87,233,105" alt="">
<area href="classOgre_1_1Win32Input8.html" shape="rect" coords="257,87,377,105" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classOgre_1_1InputReader-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputReader.html#Ogre_1_1InputReadera0">InputReader</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputReader.html#Ogre_1_1InputReadera1">~InputReader</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputReader.html#Ogre_1_1Win32Input8a14">useBufferedInput</a> (<a class="el" href="classOgre_1_1EventQueue.html">EventQueue</a> *pEventQueue, bool keys=true, bool mouse=true)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Tells the reader to use buffered input and update the passed in queue. <a href="#Ogre_1_1Win32Input8a14"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputReader.html#Ogre_1_1SDLInputa14">setBufferedInput</a> (bool keys, bool mouse)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputReader.html#Ogre_1_1InputReadera4">initialise</a> (<a class="el" href="classOgre_1_1RenderWindow.html">RenderWindow</a> *pWindow, bool useKeyboard=true, bool useMouse=true, bool useGameController=false)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialise the input system. <a href="#Ogre_1_1InputReadera4"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputReader.html#Ogre_1_1InputReadera5">capture</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Captures the state of all the input devices. <a href="#Ogre_1_1InputReadera5"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputReader.html#Ogre_1_1Win32Input8a15">isKeyDown</a> (<a class="el" href="namespaceOgre.html#a657">KeyCode</a> kc) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Determines if the specified key is currently depressed. <a href="#Ogre_1_1Win32Input8a15"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual long </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputReader.html#Ogre_1_1Win32Input8a16">getMouseRelativeX</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the relative position of the mouse when capture was called relative to the last time. <a href="#Ogre_1_1Win32Input8a16"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual long </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputReader.html#Ogre_1_1Win32Input8a17">getMouseRelativeY</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the relative position of the mouse when capture was called relative to the last time. <a href="#Ogre_1_1Win32Input8a17"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual long </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputReader.html#Ogre_1_1Win32Input8a18">getMouseRelativeZ</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the relative position of the mouse when capture was called relative to the last time. <a href="#Ogre_1_1Win32Input8a18"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual long </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputReader.html#Ogre_1_1InputReadera10">getMouseRelX</a> () const=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the relative (compared to the last input poll) mouse movement on the X (horizontal) axis. <a href="#Ogre_1_1InputReadera10"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual long </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputReader.html#Ogre_1_1InputReadera11">getMouseRelY</a> () const=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the relative (compared to the last input poll) mouse movement on the Y (vertical) axis. <a href="#Ogre_1_1InputReadera11"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual long </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputReader.html#Ogre_1_1InputReadera12">getMouseRelZ</a> () const=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the relative (compared to the last input poll) mouse movement on the Z (mouse wheel) axis. <a href="#Ogre_1_1InputReadera12"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual long </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputReader.html#Ogre_1_1InputReadera13">getMouseAbsX</a> () const=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the absolute mouse position on the X (horizontal) axis. <a href="#Ogre_1_1InputReadera13"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual long </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputReader.html#Ogre_1_1InputReadera14">getMouseAbsY</a> () const=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the absolute mouse position on the Y (vertical) axis. <a href="#Ogre_1_1InputReadera14"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual long </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputReader.html#Ogre_1_1InputReadera15">getMouseAbsZ</a> () const=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the absolute mouse position on the Z (mouse wheel) axis. <a href="#Ogre_1_1InputReadera15"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputReader.html#Ogre_1_1InputReadera16">getMouseState</a> (<a class="el" href="structOgre_1_1MouseState.html">MouseState</a> &state) const=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the current state of the mouse. <a href="#Ogre_1_1InputReadera16"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputReader.html#Ogre_1_1InputReadera17">getMouseButton</a> (<a class="el" href="namespaceOgre.html#a421">uchar</a> button) const=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the state of a mouse button. <a href="#Ogre_1_1InputReadera17"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputReader.html#Ogre_1_1Win32Input8a19">addCursorMoveListener</a> (<a class="el" href="classOgre_1_1MouseMotionListener.html">MouseMotionListener</a> *c)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds a mouse motion listener to the cursor object. <a href="#Ogre_1_1Win32Input8a19"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputReader.html#Ogre_1_1Win32Input8a20">removeCursorMoveListener</a> (<a class="el" href="classOgre_1_1MouseMotionListener.html">MouseMotionListener</a> *c)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove a mouse motion listener to the cursor object. <a href="#Ogre_1_1Win32Input8a20"></a><br><br></td></tr>
<tr><td colspan=2><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>char </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputReader.html#Ogre_1_1Win32Input8e0">getKeyChar</a> (int keyCode, long modifiers=0)</td></tr>
<tr><td colspan=2><br><h2>Protected Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef std::set< <a class="el" href="namespaceOgre.html#a657">KeyCode</a> > </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputReader.html#Ogre_1_1Win32Input8x0">BufferedKeysDownSet</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set of all the keys currently depressed based on buffered input events. <a href="#Ogre_1_1Win32Input8x0"></a><br><br></td></tr>
<tr><td colspan=2><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputReader.html#Ogre_1_1Win32Input8b1">mouseMoved</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates mouse moved or dragged events depending if any button is pressed. <a href="#Ogre_1_1Win32Input8b1"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputReader.html#Ogre_1_1Win32Input8b2">createMouseEvent</a> (int id, int button)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a <a class="el" href="classOgre_1_1MouseEvent.html">MouseEvent</a> that first gets processed by the cursor, then gets pushed on the queue. <a href="#Ogre_1_1Win32Input8b2"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputReader.html#Ogre_1_1Win32Input8b3">triggerMouseButton</a> (int nMouseCode, bool mousePressed)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates mouse pressed, released, and clicked events. <a href="#Ogre_1_1Win32Input8b3"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputReader.html#Ogre_1_1Win32Input8b4">createKeyEvent</a> (int id, int key)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputReader.html#Ogre_1_1Win32Input8b5">keyChanged</a> (int key, bool down)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputReader.html#Ogre_1_1InputReaderb5">isKeyDownImmediate</a> (<a class="el" href="namespaceOgre.html#a657">KeyCode</a> kc) const=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return whether a key is down in immediate mode. <a href="#Ogre_1_1InputReaderb5"></a><br><br></td></tr>
<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>long </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputReader.html#Ogre_1_1Win32Input8p0">mModifiers</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The modifiers are a binary flags that represent what buttons are pressed, and what key modifiers are down (e.g. <a href="#Ogre_1_1Win32Input8p0"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1Cursor.html">Cursor</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputReader.html#Ogre_1_1Win32Input8p1">mCursor</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Internal <a class="el" href="classOgre_1_1Cursor.html">Cursor</a> object. <a href="#Ogre_1_1Win32Input8p1"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1EventQueue.html">EventQueue</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputReader.html#Ogre_1_1Win32Input8p2">mEventQueue</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classOgre_1_1EventQueue.html">EventQueue</a> is used for buffered input support. <a href="#Ogre_1_1Win32Input8p2"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputReader.html#Ogre_1_1Win32Input8p3">mUseBufferedKeys</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Wether to use buffering input support - buffering support relies on using an <a class="el" href="classOgre_1_1EventQueue.html">EventQueue</a>. <a href="#Ogre_1_1Win32Input8p3"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputReader.html#Ogre_1_1Win32Input8p4">mUseBufferedMouse</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Wether to use buffering input support - buffering support relies on using an <a class="el" href="classOgre_1_1EventQueue.html">EventQueue</a>. <a href="#Ogre_1_1Win32Input8p4"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="structOgre_1_1MouseState.html">MouseState</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputReader.html#Ogre_1_1Win32Input8p5">mMouseState</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The mouse state in immediate mode. <a href="#Ogre_1_1Win32Input8p5"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1InputReader.html#Ogre_1_1Win32Input8x0">BufferedKeysDownSet</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputReader.html#Ogre_1_1Win32Input8p6">mBufferedKeysDown</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Abstract class which allows input to be read from various controllers.
<p>
<dl compact><dt><b>Remarks:</b></dt><dd>You can access an appropriate concrete subclass of this interface by calling <a class="el" href="classOgre_1_1PlatformManager.html#Ogre_1_1PlatformManagera5">PlatformManager::createInputReader</a>. </dd></dl>
<dl compact><dt><b>Warning:</b></dt><dd>Temporary implementation only. This class is likely to be refactored into a better design when I get time to look at it properly. For now it's a quick-and-dirty way to get what I need. </dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classOgre_1_1PlatformManager.html#Ogre_1_1PlatformManagera5">PlatformManager::createInputReader</a> </dd></dl>
<p>
<p>
Definition at line <a class="el" href="OgreInput_8h-source.html#l00212">212</a> of file <a class="el" href="OgreInput_8h-source.html">OgreInput.h</a>.<hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="Ogre_1_1Win32Input8x0" doxytag="Ogre::InputReader::BufferedKeysDownSet" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> typedef std::set<<a class="el" href="namespaceOgre.html#a657">KeyCode</a>> <a class="el" href="classOgre_1_1InputReader.html#Ogre_1_1Win32Input8x0">Ogre::InputReader::BufferedKeysDownSet</a><code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Set of all the keys currently depressed based on buffered input events.
<p>
<p>
Definition at line <a class="el" href="OgreInput_8h-source.html#l00337">337</a> of file <a class="el" href="OgreInput_8h-source.html">OgreInput.h</a>. </td>
</tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="Ogre_1_1InputReadera0" doxytag="Ogre::InputReader::InputReader" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> Ogre::InputReader::InputReader </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>
</td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1InputReadera1" doxytag="Ogre::InputReader::~InputReader" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual Ogre::InputReader::~<a class="el" href="classOgre_1_1InputReader.html">InputReader</a> </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="Ogre_1_1Win32Input8a19" doxytag="Ogre::InputReader::addCursorMoveListener" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Ogre::InputReader::addCursorMoveListener </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1MouseMotionListener.html">MouseMotionListener</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>c</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Adds a mouse motion listener to the cursor object.
<p>
This keeps the <a class="el" href="classOgre_1_1Cursor.html">Cursor</a> object hidden. </td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1InputReadera5" doxytag="Ogre::InputReader::capture" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual void Ogre::InputReader::capture </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> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Captures the state of all the input devices.
<p>
<dl compact><dt><b>Remarks:</b></dt><dd>This method captures the state of all input devices and stores it internally for use when the enquiry methods are next called. This is done to ensure that all input is captured at once and therefore combinations of input are not subject to time differences when methods are called. </dd></dl>
<p>
Implemented in <a class="el" href="classOgre_1_1GLXInput.html#Ogre_1_1GLXInputa3">Ogre::GLXInput</a>, <a class="el" href="classOgre_1_1SDLInput.html#Ogre_1_1SDLInputa3">Ogre::SDLInput</a>, and <a class="el" href="classOgre_1_1Win32Input8.html#Ogre_1_1Win32Input8a3">Ogre::Win32Input8</a>. </td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1Win32Input8b4" doxytag="Ogre::InputReader::createKeyEvent" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Ogre::InputReader::createKeyEvent </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname" nowrap> <em>id</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>key</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1Win32Input8b2" doxytag="Ogre::InputReader::createMouseEvent" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Ogre::InputReader::createMouseEvent </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname" nowrap> <em>id</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>button</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Creates a <a class="el" href="classOgre_1_1MouseEvent.html">MouseEvent</a> that first gets processed by the cursor, then gets pushed on the queue.
<p>
</td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1Win32Input8e0" doxytag="Ogre::InputReader::getKeyChar" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> char Ogre::InputReader::getKeyChar </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname" nowrap> <em>keyCode</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>long </td>
<td class="mdname" nowrap> <em>modifiers</em> = 0</td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1InputReadera13" doxytag="Ogre::InputReader::getMouseAbsX" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual long Ogre::InputReader::getMouseAbsX </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> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Retrieves the absolute mouse position on the X (horizontal) axis.
<p>
<p>
Implemented in <a class="el" href="classOgre_1_1GLXInput.html#Ogre_1_1GLXInputa7">Ogre::GLXInput</a>, <a class="el" href="classOgre_1_1SDLInput.html#Ogre_1_1SDLInputa8">Ogre::SDLInput</a>, and <a class="el" href="classOgre_1_1Win32Input8.html#Ogre_1_1Win32Input8a7">Ogre::Win32Input8</a>. </td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1InputReadera14" doxytag="Ogre::InputReader::getMouseAbsY" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual long Ogre::InputReader::getMouseAbsY </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> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Retrieves the absolute mouse position on the Y (vertical) axis.
<p>
<p>
Implemented in <a class="el" href="classOgre_1_1GLXInput.html#Ogre_1_1GLXInputa8">Ogre::GLXInput</a>, <a class="el" href="classOgre_1_1SDLInput.html#Ogre_1_1SDLInputa9">Ogre::SDLInput</a>, and <a class="el" href="classOgre_1_1Win32Input8.html#Ogre_1_1Win32Input8a8">Ogre::Win32Input8</a>. </td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1InputReadera15" doxytag="Ogre::InputReader::getMouseAbsZ" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual long Ogre::InputReader::getMouseAbsZ </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> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Retrieves the absolute mouse position on the Z (mouse wheel) axis.
<p>
<p>
Implemented in <a class="el" href="classOgre_1_1GLXInput.html#Ogre_1_1GLXInputa9">Ogre::GLXInput</a>, <a class="el" href="classOgre_1_1SDLInput.html#Ogre_1_1SDLInputa10">Ogre::SDLInput</a>, and <a class="el" href="classOgre_1_1Win32Input8.html#Ogre_1_1Win32Input8a9">Ogre::Win32Input8</a>. </td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1InputReadera17" doxytag="Ogre::InputReader::getMouseButton" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual bool Ogre::InputReader::getMouseButton </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a421">uchar</a> </td>
<td class="mdname1" valign="top" nowrap> <em>button</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Retrieves the state of a mouse button.
<p>
<p>
Implemented in <a class="el" href="classOgre_1_1GLXInput.html#Ogre_1_1GLXInputa11">Ogre::GLXInput</a>, <a class="el" href="classOgre_1_1SDLInput.html#Ogre_1_1SDLInputa12">Ogre::SDLInput</a>, and <a class="el" href="classOgre_1_1Win32Input8.html#Ogre_1_1Win32Input8a11">Ogre::Win32Input8</a>. </td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1Win32Input8a16" doxytag="Ogre::InputReader::getMouseRelativeX" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual long Ogre::InputReader::getMouseRelativeX </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> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Retrieves the relative position of the mouse when capture was called relative to the last time.
<p>
<p>
Definition at line <a class="el" href="OgreInput_8h-source.html#l00266">266</a> of file <a class="el" href="OgreInput_8h-source.html">OgreInput.h</a>. </td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1Win32Input8a17" doxytag="Ogre::InputReader::getMouseRelativeY" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual long Ogre::InputReader::getMouseRelativeY </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> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Retrieves the relative position of the mouse when capture was called relative to the last time.
<p>
<p>
Definition at line <a class="el" href="OgreInput_8h-source.html#l00270">270</a> of file <a class="el" href="OgreInput_8h-source.html">OgreInput.h</a>. </td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1Win32Input8a18" doxytag="Ogre::InputReader::getMouseRelativeZ" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual long Ogre::InputReader::getMouseRelativeZ </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> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Retrieves the relative position of the mouse when capture was called relative to the last time.
<p>
<p>
Definition at line <a class="el" href="OgreInput_8h-source.html#l00274">274</a> of file <a class="el" href="OgreInput_8h-source.html">OgreInput.h</a>. </td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1InputReadera10" doxytag="Ogre::InputReader::getMouseRelX" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual long Ogre::InputReader::getMouseRelX </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> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Retrieves the relative (compared to the last input poll) mouse movement on the X (horizontal) axis.
<p>
<p>
Implemented in <a class="el" href="classOgre_1_1GLXInput.html#Ogre_1_1GLXInputa4">Ogre::GLXInput</a>, <a class="el" href="classOgre_1_1SDLInput.html#Ogre_1_1SDLInputa5">Ogre::SDLInput</a>, and <a class="el" href="classOgre_1_1Win32Input8.html#Ogre_1_1Win32Input8a4">Ogre::Win32Input8</a>. </td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1InputReadera11" doxytag="Ogre::InputReader::getMouseRelY" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual long Ogre::InputReader::getMouseRelY </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> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Retrieves the relative (compared to the last input poll) mouse movement on the Y (vertical) axis.
<p>
<p>
Implemented in <a class="el" href="classOgre_1_1GLXInput.html#Ogre_1_1GLXInputa5">Ogre::GLXInput</a>, <a class="el" href="classOgre_1_1SDLInput.html#Ogre_1_1SDLInputa6">Ogre::SDLInput</a>, and <a class="el" href="classOgre_1_1Win32Input8.html#Ogre_1_1Win32Input8a5">Ogre::Win32Input8</a>. </td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1InputReadera12" doxytag="Ogre::InputReader::getMouseRelZ" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual long Ogre::InputReader::getMouseRelZ </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> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Retrieves the relative (compared to the last input poll) mouse movement on the Z (mouse wheel) axis.
<p>
<p>
Implemented in <a class="el" href="classOgre_1_1GLXInput.html#Ogre_1_1GLXInputa6">Ogre::GLXInput</a>, <a class="el" href="classOgre_1_1SDLInput.html#Ogre_1_1SDLInputa7">Ogre::SDLInput</a>, and <a class="el" href="classOgre_1_1Win32Input8.html#Ogre_1_1Win32Input8a6">Ogre::Win32Input8</a>. </td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1InputReadera16" doxytag="Ogre::InputReader::getMouseState" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual void Ogre::InputReader::getMouseState </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="structOgre_1_1MouseState.html">MouseState</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>state</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Retrieves the current state of the mouse.
<p>
<p>
Implemented in <a class="el" href="classOgre_1_1GLXInput.html#Ogre_1_1GLXInputa10">Ogre::GLXInput</a>, <a class="el" href="classOgre_1_1SDLInput.html#Ogre_1_1SDLInputa11">Ogre::SDLInput</a>, and <a class="el" href="classOgre_1_1Win32Input8.html#Ogre_1_1Win32Input8a10">Ogre::Win32Input8</a>. </td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1InputReadera4" doxytag="Ogre::InputReader::initialise" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual void Ogre::InputReader::initialise </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1RenderWindow.html">RenderWindow</a> * </td>
<td class="mdname" nowrap> <em>pWindow</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>useKeyboard</em> = true, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>useMouse</em> = true, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>useGameController</em> = false</td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Initialise the input system.
<p>
<dl compact><dt><b>Note:</b></dt><dd>Only keyboard and mouse currently implemented. </dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>pWindow</em> </td><td>The window to capture input for </td></tr>
<tr><td valign=top><em>useKeyboard</em> </td><td>If true, keyboard input will be supported. </td></tr>
<tr><td valign=top><em>useMouse</em> </td><td>If true, mouse input will be supported. </td></tr>
<tr><td valign=top><em>useGameController</em> </td><td>If true, joysticks/gamepads will be supported. </td></tr>
</table>
</dl>
<p>
Implemented in <a class="el" href="classOgre_1_1GLXInput.html#Ogre_1_1GLXInputa2">Ogre::GLXInput</a>, <a class="el" href="classOgre_1_1SDLInput.html#Ogre_1_1SDLInputa2">Ogre::SDLInput</a>, and <a class="el" href="classOgre_1_1Win32Input8.html#Ogre_1_1Win32Input8a2">Ogre::Win32Input8</a>. </td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1Win32Input8a15" doxytag="Ogre::InputReader::isKeyDown" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual bool Ogre::InputReader::isKeyDown </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a657">KeyCode</a> </td>
<td class="mdname1" valign="top" nowrap> <em>kc</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Determines if the specified key is currently depressed.
<p>
<dl compact><dt><b>Note:</b></dt><dd>In immediate mode, this enquiry method uses the state of the keyboard at the last 'capture' call. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1InputReaderb5" doxytag="Ogre::InputReader::isKeyDownImmediate" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual bool Ogre::InputReader::isKeyDownImmediate </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a657">KeyCode</a> </td>
<td class="mdname1" valign="top" nowrap> <em>kc</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [protected, pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Return whether a key is down in immediate mode.
<p>
<p>
Implemented in <a class="el" href="classOgre_1_1GLXInput.html#Ogre_1_1GLXInputd1">Ogre::GLXInput</a>, <a class="el" href="classOgre_1_1SDLInput.html#Ogre_1_1SDLInputd4">Ogre::SDLInput</a>, and <a class="el" href="classOgre_1_1Win32Input8.html#Ogre_1_1Win32Input8b0">Ogre::Win32Input8</a>. </td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1Win32Input8b5" doxytag="Ogre::InputReader::keyChanged" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Ogre::InputReader::keyChanged </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname" nowrap> <em>key</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>down</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1Win32Input8b1" doxytag="Ogre::InputReader::mouseMoved" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Ogre::InputReader::mouseMoved </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> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Creates mouse moved or dragged events depending if any button is pressed.
<p>
</td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1Win32Input8a20" doxytag="Ogre::InputReader::removeCursorMoveListener" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Ogre::InputReader::removeCursorMoveListener </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1MouseMotionListener.html">MouseMotionListener</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>c</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Remove a mouse motion listener to the cursor object.
<p>
This keeps the <a class="el" href="classOgre_1_1Cursor.html">Cursor</a> object hidden. </td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1SDLInputa14" doxytag="Ogre::InputReader::setBufferedInput" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual void Ogre::InputReader::setBufferedInput </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">bool </td>
<td class="mdname" nowrap> <em>keys</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>mouse</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Reimplemented in <a class="el" href="classOgre_1_1Win32Input8.html#Ogre_1_1Win32Input8a12">Ogre::Win32Input8</a>. </td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1Win32Input8b3" doxytag="Ogre::InputReader::triggerMouseButton" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Ogre::InputReader::triggerMouseButton </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname" nowrap> <em>nMouseCode</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>mousePressed</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Creates mouse pressed, released, and clicked events.
<p>
</td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1Win32Input8a14" doxytag="Ogre::InputReader::useBufferedInput" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Ogre::InputReader::useBufferedInput </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1EventQueue.html">EventQueue</a> * </td>
<td class="mdname" nowrap> <em>pEventQueue</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>keys</em> = true, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>mouse</em> = true</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>
Tells the reader to use buffered input and update the passed in queue.
<p>
<dl compact><dt><b>Remarks:</b></dt><dd>The default behaviour of the input reader is simply to capture the current state of the mouse / keyboard on demand. An alternative is to use buffered input where all events are registered on a queue. </dd></dl>
</td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="Ogre_1_1Win32Input8p6" doxytag="Ogre::InputReader::mBufferedKeysDown" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1InputReader.html#Ogre_1_1Win32Input8x0">BufferedKeysDownSet</a> <a class="el" href="classOgre_1_1InputReader.html#Ogre_1_1Win32Input8p6">Ogre::InputReader::mBufferedKeysDown</a><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="OgreInput_8h-source.html#l00338">338</a> of file <a class="el" href="OgreInput_8h-source.html">OgreInput.h</a>. </td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1Win32Input8p1" doxytag="Ogre::InputReader::mCursor" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1Cursor.html">Cursor</a>* <a class="el" href="classOgre_1_1InputReader.html#Ogre_1_1Win32Input8p1">Ogre::InputReader::mCursor</a><code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Internal <a class="el" href="classOgre_1_1Cursor.html">Cursor</a> object.
<p>
<dl compact><dt><b>Remarks:</b></dt><dd>This is a mathematical representation of where the cursor is, it does not draw a cursor. </dd></dl>
<dl compact><dt><b>See also:</b></dt><dd>CursorGuiElement. </dd></dl>
<p>
Definition at line <a class="el" href="OgreInput_8h-source.html#l00323">323</a> of file <a class="el" href="OgreInput_8h-source.html">OgreInput.h</a>. </td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1Win32Input8p2" doxytag="Ogre::InputReader::mEventQueue" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1EventQueue.html">EventQueue</a>* <a class="el" href="classOgre_1_1InputReader.html#Ogre_1_1Win32Input8p2">Ogre::InputReader::mEventQueue</a><code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<a class="el" href="classOgre_1_1EventQueue.html">EventQueue</a> is used for buffered input support.
<p>
<p>
Definition at line <a class="el" href="OgreInput_8h-source.html#l00326">326</a> of file <a class="el" href="OgreInput_8h-source.html">OgreInput.h</a>. </td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1Win32Input8p0" doxytag="Ogre::InputReader::mModifiers" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> long <a class="el" href="classOgre_1_1InputReader.html#Ogre_1_1Win32Input8p0">Ogre::InputReader::mModifiers</a><code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
The modifiers are a binary flags that represent what buttons are pressed, and what key modifiers are down (e.g.
<p>
shift/alt).
<p>
Definition at line <a class="el" href="OgreInput_8h-source.html#l00315">315</a> of file <a class="el" href="OgreInput_8h-source.html">OgreInput.h</a>. </td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1Win32Input8p5" doxytag="Ogre::InputReader::mMouseState" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="structOgre_1_1MouseState.html">MouseState</a> <a class="el" href="classOgre_1_1InputReader.html#Ogre_1_1Win32Input8p5">Ogre::InputReader::mMouseState</a><code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
The mouse state in immediate mode.
<p>
<p>
Definition at line <a class="el" href="OgreInput_8h-source.html#l00334">334</a> of file <a class="el" href="OgreInput_8h-source.html">OgreInput.h</a>. </td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1Win32Input8p3" doxytag="Ogre::InputReader::mUseBufferedKeys" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool <a class="el" href="classOgre_1_1InputReader.html#Ogre_1_1Win32Input8p3">Ogre::InputReader::mUseBufferedKeys</a><code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Wether to use buffering input support - buffering support relies on using an <a class="el" href="classOgre_1_1EventQueue.html">EventQueue</a>.
<p>
<dl compact><dt><b>See also:</b></dt><dd>class <a class="el" href="classOgre_1_1EventQueue.html">EventQueue</a> </dd></dl>
<p>
Definition at line <a class="el" href="OgreInput_8h-source.html#l00331">331</a> of file <a class="el" href="OgreInput_8h-source.html">OgreInput.h</a>. </td>
</tr>
</table>
<a class="anchor" name="Ogre_1_1Win32Input8p4" doxytag="Ogre::InputReader::mUseBufferedMouse" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool <a class="el" href="classOgre_1_1InputReader.html#Ogre_1_1Win32Input8p4">Ogre::InputReader::mUseBufferedMouse</a><code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Wether to use buffering input support - buffering support relies on using an <a class="el" href="classOgre_1_1EventQueue.html">EventQueue</a>.
<p>
<dl compact><dt><b>See also:</b></dt><dd>class <a class="el" href="classOgre_1_1EventQueue.html">EventQueue</a> </dd></dl>
<p>
Definition at line <a class="el" href="OgreInput_8h-source.html#l00331">331</a> of file <a class="el" href="OgreInput_8h-source.html">OgreInput.h</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="OgreInput_8h-source.html">OgreInput.h</a></ul>
<p>
Copyright © 2000-2005 by The OGRE Team<br />
Last modified Wed Feb 23 00:20:31 2005
</p>
</body>
</html>
distrib
>
Mandriva
>
10.2
>
i586
>
media
>
contrib
>
by-pkgid
>
04e5d8c10ae76748689b4e7f48e0fa33
>
files
>
2250
