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

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

added ogre dependencies and patched ogre sources
Line 
1<html>
2<head>
3<title>Ogre::InputReader class Reference - OGRE Documentation</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
4<link type="text/css" rel="stylesheet" href="style.css">
5</head>
6
7<body>
8<!-- Generated by Doxygen 1.3.6 -->
9<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a></div>
10<h1>Ogre::InputReader Class Reference</h1>Abstract class which allows input to be read from various controllers. 
11<a href="#_details">More...</a>
12<p>
13<code>#include &lt;<a class="el" href="OgreInput_8h-source.html">OgreInput.h</a>&gt;</code>
14<p>
15<p>Inheritance diagram for Ogre::InputReader:
16<p><center><img src="classOgre_1_1InputReader.png" usemap="#Ogre::InputReader_map" border="0" alt=""></center>
17<map name="Ogre::InputReader_map">
18<area href="classOgre_1_1GLXInput.html" alt="Ogre::GLXInput" shape="rect" coords="0,56,116,80">
19<area href="classOgre_1_1SDLInput.html" alt="Ogre::SDLInput" shape="rect" coords="126,56,242,80">
20<area href="classOgre_1_1Win32Input8.html" alt="Ogre::Win32Input8" shape="rect" coords="252,56,368,80">
21</map>
22<a href="classOgre_1_1InputReader-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
23<tr><td></td></tr>
24<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
25<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputReader.html#Ogre_1_1InputReadera0">InputReader</a> ()</td></tr>
26
27<tr><td class="memItemLeft" nowrap align=right valign=top>virtual&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputReader.html#Ogre_1_1InputReadera1">~InputReader</a> ()</td></tr>
28
29<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</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>
30
31<tr><td class="mdescLeft">&nbsp;</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>
32<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</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>
33
34<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</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>
35
36<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialise the input system.  <a href="#Ogre_1_1InputReadera4"></a><br><br></td></tr>
37<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputReader.html#Ogre_1_1InputReadera5">capture</a> ()=0</td></tr>
38
39<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Captures the state of all the input devices.  <a href="#Ogre_1_1InputReadera5"></a><br><br></td></tr>
40<tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool&nbsp;</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#a658">KeyCode</a> kc) const </td></tr>
41
42<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Determines if the specified key is currently depressed.  <a href="#Ogre_1_1Win32Input8a15"></a><br><br></td></tr>
43<tr><td class="memItemLeft" nowrap align=right valign=top>virtual long&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputReader.html#Ogre_1_1Win32Input8a16">getMouseRelativeX</a> () const </td></tr>
44
45<tr><td class="mdescLeft">&nbsp;</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>
46<tr><td class="memItemLeft" nowrap align=right valign=top>virtual long&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputReader.html#Ogre_1_1Win32Input8a17">getMouseRelativeY</a> () const </td></tr>
47
48<tr><td class="mdescLeft">&nbsp;</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>
49<tr><td class="memItemLeft" nowrap align=right valign=top>virtual long&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputReader.html#Ogre_1_1Win32Input8a18">getMouseRelativeZ</a> () const </td></tr>
50
51<tr><td class="mdescLeft">&nbsp;</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>
52<tr><td class="memItemLeft" nowrap align=right valign=top>virtual long&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputReader.html#Ogre_1_1InputReadera10">getMouseRelX</a> () const=0</td></tr>
53
54<tr><td class="mdescLeft">&nbsp;</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>
55<tr><td class="memItemLeft" nowrap align=right valign=top>virtual long&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputReader.html#Ogre_1_1InputReadera11">getMouseRelY</a> () const=0</td></tr>
56
57<tr><td class="mdescLeft">&nbsp;</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>
58<tr><td class="memItemLeft" nowrap align=right valign=top>virtual long&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputReader.html#Ogre_1_1InputReadera12">getMouseRelZ</a> () const=0</td></tr>
59
60<tr><td class="mdescLeft">&nbsp;</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>
61<tr><td class="memItemLeft" nowrap align=right valign=top>virtual long&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputReader.html#Ogre_1_1InputReadera13">getMouseAbsX</a> () const=0</td></tr>
62
63<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the absolute mouse position on the X (horizontal) axis.  <a href="#Ogre_1_1InputReadera13"></a><br><br></td></tr>
64<tr><td class="memItemLeft" nowrap align=right valign=top>virtual long&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputReader.html#Ogre_1_1InputReadera14">getMouseAbsY</a> () const=0</td></tr>
65
66<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the absolute mouse position on the Y (vertical) axis.  <a href="#Ogre_1_1InputReadera14"></a><br><br></td></tr>
67<tr><td class="memItemLeft" nowrap align=right valign=top>virtual long&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputReader.html#Ogre_1_1InputReadera15">getMouseAbsZ</a> () const=0</td></tr>
68
69<tr><td class="mdescLeft">&nbsp;</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>
70<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</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> &amp;state) const=0</td></tr>
71
72<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the current state of the mouse.  <a href="#Ogre_1_1InputReadera16"></a><br><br></td></tr>
73<tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool&nbsp;</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>
74
75<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the state of a mouse button.  <a href="#Ogre_1_1InputReadera17"></a><br><br></td></tr>
76<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</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>
77
78<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Adds a mouse motion listener to the cursor object.  <a href="#Ogre_1_1Win32Input8a19"></a><br><br></td></tr>
79<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</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>
80
81<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Remove a mouse motion listener to the cursor object.  <a href="#Ogre_1_1Win32Input8a20"></a><br><br></td></tr>
82<tr><td colspan=2><br><h2>Static Public Member Functions</h2></td></tr>
83<tr><td class="memItemLeft" nowrap align=right valign=top>char&nbsp;</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>
84
85<tr><td colspan=2><br><h2>Protected Types</h2></td></tr>
86<tr><td class="memItemLeft" nowrap align=right valign=top>typedef std::set&lt; <a class="el" href="namespaceOgre.html#a658">KeyCode</a> &gt;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputReader.html#Ogre_1_1Win32Input8x0">BufferedKeysDownSet</a></td></tr>
87
88<tr><td class="mdescLeft">&nbsp;</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>
89<tr><td colspan=2><br><h2>Protected Member Functions</h2></td></tr>
90<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputReader.html#Ogre_1_1Win32Input8b1">mouseMoved</a> ()</td></tr>
91
92<tr><td class="mdescLeft">&nbsp;</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>
93<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputReader.html#Ogre_1_1Win32Input8b2">createMouseEvent</a> (int <a class="el" href="OgreGLPrerequisites_8h.html#a86">id</a>, int button)</td></tr>
94
95<tr><td class="mdescLeft">&nbsp;</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>
96<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</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>
97
98<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates mouse pressed, released, and clicked events.  <a href="#Ogre_1_1Win32Input8b3"></a><br><br></td></tr>
99<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputReader.html#Ogre_1_1Win32Input8b4">createKeyEvent</a> (int <a class="el" href="OgreGLPrerequisites_8h.html#a86">id</a>, int key)</td></tr>
100
101<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</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>
102
103<tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool&nbsp;</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#a658">KeyCode</a> kc) const=0</td></tr>
104
105<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return whether a key is down in immediate mode.  <a href="#Ogre_1_1InputReaderb5"></a><br><br></td></tr>
106<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
107<tr><td class="memItemLeft" nowrap align=right valign=top>long&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputReader.html#Ogre_1_1Win32Input8p0">mModifiers</a></td></tr>
108
109<tr><td class="mdescLeft">&nbsp;</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>
110<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1Cursor.html">Cursor</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputReader.html#Ogre_1_1Win32Input8p1">mCursor</a></td></tr>
111
112<tr><td class="mdescLeft">&nbsp;</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>
113<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1EventQueue.html">EventQueue</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputReader.html#Ogre_1_1Win32Input8p2">mEventQueue</a></td></tr>
114
115<tr><td class="mdescLeft">&nbsp;</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>
116<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputReader.html#Ogre_1_1Win32Input8p3">mUseBufferedKeys</a></td></tr>
117
118<tr><td class="mdescLeft">&nbsp;</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>
119<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputReader.html#Ogre_1_1Win32Input8p4">mUseBufferedMouse</a></td></tr>
120
121<tr><td class="mdescLeft">&nbsp;</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>
122<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="structOgre_1_1MouseState.html">MouseState</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputReader.html#Ogre_1_1Win32Input8p5">mMouseState</a></td></tr>
123
124<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The mouse state in immediate mode.  <a href="#Ogre_1_1Win32Input8p5"></a><br><br></td></tr>
125<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1InputReader.html#Ogre_1_1Win32Input8x0">BufferedKeysDownSet</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputReader.html#Ogre_1_1Win32Input8p6">mBufferedKeysDown</a></td></tr>
126
127</table>
128<hr><a name="_details"></a><h2>Detailed Description</h2>
129Abstract class which allows input to be read from various controllers.
130<p>
131<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>
132<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>
133<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>
134
135<p>
136
137<p>
138Definition 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>
139<a class="anchor" name="Ogre_1_1Win32Input8x0" doxytag="Ogre::InputReader::BufferedKeysDownSet" ></a><p>
140<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
141  <tr>
142    <td class="mdRow">
143      <table cellpadding="0" cellspacing="0" border="0">
144        <tr>
145          <td class="md" nowrap valign="top"> typedef std::set&lt;<a class="el" href="namespaceOgre.html#a658">KeyCode</a>&gt; <a class="el" href="classOgre_1_1InputReader.html#Ogre_1_1Win32Input8x0">Ogre::InputReader::BufferedKeysDownSet</a><code> [protected]</code>
146      </table>
147    </td>
148  </tr>
149</table>
150<table cellspacing=5 cellpadding=0 border=0>
151  <tr>
152    <td>
153      &nbsp;
154    </td>
155    <td>
156
157<p>
158Set of all the keys currently depressed based on buffered input events.
159<p>
160
161<p>
162Definition 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>
163  </tr>
164</table>
165<hr><h2>Constructor &amp; Destructor Documentation</h2>
166<a class="anchor" name="Ogre_1_1InputReadera0" doxytag="Ogre::InputReader::InputReader" ></a><p>
167<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
168  <tr>
169    <td class="mdRow">
170      <table cellpadding="0" cellspacing="0" border="0">
171        <tr>
172          <td class="md" nowrap valign="top"> Ogre::InputReader::InputReader </td>
173          <td class="md" valign="top">(&nbsp;</td>
174          <td class="mdname1" valign="top" nowrap>          </td>
175          <td class="md" valign="top">&nbsp;)&nbsp;</td>
176          <td class="md" nowrap></td>
177        </tr>
178
179      </table>
180    </td>
181  </tr>
182</table>
183<table cellspacing=5 cellpadding=0 border=0>
184  <tr>
185    <td>
186      &nbsp;
187    </td>
188    <td>
189
190<p>
191    </td>
192  </tr>
193</table>
194<a class="anchor" name="Ogre_1_1InputReadera1" doxytag="Ogre::InputReader::~InputReader" ></a><p>
195<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
196  <tr>
197    <td class="mdRow">
198      <table cellpadding="0" cellspacing="0" border="0">
199        <tr>
200          <td class="md" nowrap valign="top"> virtual Ogre::InputReader::~<a class="el" href="classOgre_1_1InputReader.html">InputReader</a> </td>
201          <td class="md" valign="top">(&nbsp;</td>
202          <td class="mdname1" valign="top" nowrap>          </td>
203          <td class="md" valign="top">&nbsp;)&nbsp;</td>
204          <td class="md" nowrap><code> [virtual]</code></td>
205        </tr>
206
207      </table>
208    </td>
209  </tr>
210</table>
211<table cellspacing=5 cellpadding=0 border=0>
212  <tr>
213    <td>
214      &nbsp;
215    </td>
216    <td>
217
218<p>
219    </td>
220  </tr>
221</table>
222<hr><h2>Member Function Documentation</h2>
223<a class="anchor" name="Ogre_1_1Win32Input8a19" doxytag="Ogre::InputReader::addCursorMoveListener" ></a><p>
224<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
225  <tr>
226    <td class="mdRow">
227      <table cellpadding="0" cellspacing="0" border="0">
228        <tr>
229          <td class="md" nowrap valign="top"> void Ogre::InputReader::addCursorMoveListener </td>
230          <td class="md" valign="top">(&nbsp;</td>
231          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1MouseMotionListener.html">MouseMotionListener</a> *&nbsp;</td>
232          <td class="mdname1" valign="top" nowrap> <em>c</em>          </td>
233          <td class="md" valign="top">&nbsp;)&nbsp;</td>
234          <td class="md" nowrap></td>
235        </tr>
236
237      </table>
238    </td>
239  </tr>
240</table>
241<table cellspacing=5 cellpadding=0 border=0>
242  <tr>
243    <td>
244      &nbsp;
245    </td>
246    <td>
247
248<p>
249Adds a mouse motion listener to the cursor object.
250<p>
251This keeps the <a class="el" href="classOgre_1_1Cursor.html">Cursor</a> object hidden.     </td>
252  </tr>
253</table>
254<a class="anchor" name="Ogre_1_1InputReadera5" doxytag="Ogre::InputReader::capture" ></a><p>
255<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
256  <tr>
257    <td class="mdRow">
258      <table cellpadding="0" cellspacing="0" border="0">
259        <tr>
260          <td class="md" nowrap valign="top"> virtual void Ogre::InputReader::capture </td>
261          <td class="md" valign="top">(&nbsp;</td>
262          <td class="mdname1" valign="top" nowrap>          </td>
263          <td class="md" valign="top">&nbsp;)&nbsp;</td>
264          <td class="md" nowrap><code> [pure virtual]</code></td>
265        </tr>
266
267      </table>
268    </td>
269  </tr>
270</table>
271<table cellspacing=5 cellpadding=0 border=0>
272  <tr>
273    <td>
274      &nbsp;
275    </td>
276    <td>
277
278<p>
279Captures the state of all the input devices.
280<p>
281<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>
282
283<p>
284Implemented 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>
285  </tr>
286</table>
287<a class="anchor" name="Ogre_1_1Win32Input8b4" doxytag="Ogre::InputReader::createKeyEvent" ></a><p>
288<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
289  <tr>
290    <td class="mdRow">
291      <table cellpadding="0" cellspacing="0" border="0">
292        <tr>
293          <td class="md" nowrap valign="top"> void Ogre::InputReader::createKeyEvent </td>
294          <td class="md" valign="top">(&nbsp;</td>
295          <td class="md" nowrap valign="top">int&nbsp;</td>
296          <td class="mdname" nowrap> <em>id</em>, </td>
297        </tr>
298        <tr>
299          <td class="md" nowrap align="right"></td>
300          <td></td>
301          <td class="md" nowrap>int&nbsp;</td>
302          <td class="mdname" nowrap> <em>key</em></td>
303        </tr>
304        <tr>
305          <td></td>
306          <td class="md">)&nbsp;</td>
307          <td class="md" colspan="2"><code> [protected]</code></td>
308        </tr>
309
310      </table>
311    </td>
312  </tr>
313</table>
314<table cellspacing=5 cellpadding=0 border=0>
315  <tr>
316    <td>
317      &nbsp;
318    </td>
319    <td>
320
321<p>
322    </td>
323  </tr>
324</table>
325<a class="anchor" name="Ogre_1_1Win32Input8b2" doxytag="Ogre::InputReader::createMouseEvent" ></a><p>
326<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
327  <tr>
328    <td class="mdRow">
329      <table cellpadding="0" cellspacing="0" border="0">
330        <tr>
331          <td class="md" nowrap valign="top"> void Ogre::InputReader::createMouseEvent </td>
332          <td class="md" valign="top">(&nbsp;</td>
333          <td class="md" nowrap valign="top">int&nbsp;</td>
334          <td class="mdname" nowrap> <em>id</em>, </td>
335        </tr>
336        <tr>
337          <td class="md" nowrap align="right"></td>
338          <td></td>
339          <td class="md" nowrap>int&nbsp;</td>
340          <td class="mdname" nowrap> <em>button</em></td>
341        </tr>
342        <tr>
343          <td></td>
344          <td class="md">)&nbsp;</td>
345          <td class="md" colspan="2"><code> [protected]</code></td>
346        </tr>
347
348      </table>
349    </td>
350  </tr>
351</table>
352<table cellspacing=5 cellpadding=0 border=0>
353  <tr>
354    <td>
355      &nbsp;
356    </td>
357    <td>
358
359<p>
360Creates a <a class="el" href="classOgre_1_1MouseEvent.html">MouseEvent</a> that first gets processed by the cursor, then gets pushed on the queue.
361<p>
362    </td>
363  </tr>
364</table>
365<a class="anchor" name="Ogre_1_1Win32Input8e0" doxytag="Ogre::InputReader::getKeyChar" ></a><p>
366<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
367  <tr>
368    <td class="mdRow">
369      <table cellpadding="0" cellspacing="0" border="0">
370        <tr>
371          <td class="md" nowrap valign="top"> char Ogre::InputReader::getKeyChar </td>
372          <td class="md" valign="top">(&nbsp;</td>
373          <td class="md" nowrap valign="top">int&nbsp;</td>
374          <td class="mdname" nowrap> <em>keyCode</em>, </td>
375        </tr>
376        <tr>
377          <td class="md" nowrap align="right"></td>
378          <td></td>
379          <td class="md" nowrap>long&nbsp;</td>
380          <td class="mdname" nowrap> <em>modifiers</em> = 0</td>
381        </tr>
382        <tr>
383          <td></td>
384          <td class="md">)&nbsp;</td>
385          <td class="md" colspan="2"><code> [static]</code></td>
386        </tr>
387
388      </table>
389    </td>
390  </tr>
391</table>
392<table cellspacing=5 cellpadding=0 border=0>
393  <tr>
394    <td>
395      &nbsp;
396    </td>
397    <td>
398
399<p>
400    </td>
401  </tr>
402</table>
403<a class="anchor" name="Ogre_1_1InputReadera13" doxytag="Ogre::InputReader::getMouseAbsX" ></a><p>
404<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
405  <tr>
406    <td class="mdRow">
407      <table cellpadding="0" cellspacing="0" border="0">
408        <tr>
409          <td class="md" nowrap valign="top"> virtual long Ogre::InputReader::getMouseAbsX </td>
410          <td class="md" valign="top">(&nbsp;</td>
411          <td class="mdname1" valign="top" nowrap>          </td>
412          <td class="md" valign="top">&nbsp;)&nbsp;</td>
413          <td class="md" nowrap> const<code> [pure virtual]</code></td>
414        </tr>
415
416      </table>
417    </td>
418  </tr>
419</table>
420<table cellspacing=5 cellpadding=0 border=0>
421  <tr>
422    <td>
423      &nbsp;
424    </td>
425    <td>
426
427<p>
428Retrieves the absolute mouse position on the X (horizontal) axis.
429<p>
430
431<p>
432Implemented 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>
433  </tr>
434</table>
435<a class="anchor" name="Ogre_1_1InputReadera14" doxytag="Ogre::InputReader::getMouseAbsY" ></a><p>
436<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
437  <tr>
438    <td class="mdRow">
439      <table cellpadding="0" cellspacing="0" border="0">
440        <tr>
441          <td class="md" nowrap valign="top"> virtual long Ogre::InputReader::getMouseAbsY </td>
442          <td class="md" valign="top">(&nbsp;</td>
443          <td class="mdname1" valign="top" nowrap>          </td>
444          <td class="md" valign="top">&nbsp;)&nbsp;</td>
445          <td class="md" nowrap> const<code> [pure virtual]</code></td>
446        </tr>
447
448      </table>
449    </td>
450  </tr>
451</table>
452<table cellspacing=5 cellpadding=0 border=0>
453  <tr>
454    <td>
455      &nbsp;
456    </td>
457    <td>
458
459<p>
460Retrieves the absolute mouse position on the Y (vertical) axis.
461<p>
462
463<p>
464Implemented 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>
465  </tr>
466</table>
467<a class="anchor" name="Ogre_1_1InputReadera15" doxytag="Ogre::InputReader::getMouseAbsZ" ></a><p>
468<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
469  <tr>
470    <td class="mdRow">
471      <table cellpadding="0" cellspacing="0" border="0">
472        <tr>
473          <td class="md" nowrap valign="top"> virtual long Ogre::InputReader::getMouseAbsZ </td>
474          <td class="md" valign="top">(&nbsp;</td>
475          <td class="mdname1" valign="top" nowrap>          </td>
476          <td class="md" valign="top">&nbsp;)&nbsp;</td>
477          <td class="md" nowrap> const<code> [pure virtual]</code></td>
478        </tr>
479
480      </table>
481    </td>
482  </tr>
483</table>
484<table cellspacing=5 cellpadding=0 border=0>
485  <tr>
486    <td>
487      &nbsp;
488    </td>
489    <td>
490
491<p>
492Retrieves the absolute mouse position on the Z (mouse wheel) axis.
493<p>
494
495<p>
496Implemented 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>
497  </tr>
498</table>
499<a class="anchor" name="Ogre_1_1InputReadera17" doxytag="Ogre::InputReader::getMouseButton" ></a><p>
500<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
501  <tr>
502    <td class="mdRow">
503      <table cellpadding="0" cellspacing="0" border="0">
504        <tr>
505          <td class="md" nowrap valign="top"> virtual bool Ogre::InputReader::getMouseButton </td>
506          <td class="md" valign="top">(&nbsp;</td>
507          <td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a421">uchar</a>&nbsp;</td>
508          <td class="mdname1" valign="top" nowrap> <em>button</em>          </td>
509          <td class="md" valign="top">&nbsp;)&nbsp;</td>
510          <td class="md" nowrap> const<code> [pure virtual]</code></td>
511        </tr>
512
513      </table>
514    </td>
515  </tr>
516</table>
517<table cellspacing=5 cellpadding=0 border=0>
518  <tr>
519    <td>
520      &nbsp;
521    </td>
522    <td>
523
524<p>
525Retrieves the state of a mouse button.
526<p>
527
528<p>
529Implemented 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>
530  </tr>
531</table>
532<a class="anchor" name="Ogre_1_1Win32Input8a16" doxytag="Ogre::InputReader::getMouseRelativeX" ></a><p>
533<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
534  <tr>
535    <td class="mdRow">
536      <table cellpadding="0" cellspacing="0" border="0">
537        <tr>
538          <td class="md" nowrap valign="top"> virtual long Ogre::InputReader::getMouseRelativeX </td>
539          <td class="md" valign="top">(&nbsp;</td>
540          <td class="mdname1" valign="top" nowrap>          </td>
541          <td class="md" valign="top">&nbsp;)&nbsp;</td>
542          <td class="md" nowrap> const<code> [virtual]</code></td>
543        </tr>
544
545      </table>
546    </td>
547  </tr>
548</table>
549<table cellspacing=5 cellpadding=0 border=0>
550  <tr>
551    <td>
552      &nbsp;
553    </td>
554    <td>
555
556<p>
557Retrieves the relative position of the mouse when capture was called relative to the last time.
558<p>
559
560<p>
561Definition 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>
562  </tr>
563</table>
564<a class="anchor" name="Ogre_1_1Win32Input8a17" doxytag="Ogre::InputReader::getMouseRelativeY" ></a><p>
565<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
566  <tr>
567    <td class="mdRow">
568      <table cellpadding="0" cellspacing="0" border="0">
569        <tr>
570          <td class="md" nowrap valign="top"> virtual long Ogre::InputReader::getMouseRelativeY </td>
571          <td class="md" valign="top">(&nbsp;</td>
572          <td class="mdname1" valign="top" nowrap>          </td>
573          <td class="md" valign="top">&nbsp;)&nbsp;</td>
574          <td class="md" nowrap> const<code> [virtual]</code></td>
575        </tr>
576
577      </table>
578    </td>
579  </tr>
580</table>
581<table cellspacing=5 cellpadding=0 border=0>
582  <tr>
583    <td>
584      &nbsp;
585    </td>
586    <td>
587
588<p>
589Retrieves the relative position of the mouse when capture was called relative to the last time.
590<p>
591
592<p>
593Definition 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>
594  </tr>
595</table>
596<a class="anchor" name="Ogre_1_1Win32Input8a18" doxytag="Ogre::InputReader::getMouseRelativeZ" ></a><p>
597<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
598  <tr>
599    <td class="mdRow">
600      <table cellpadding="0" cellspacing="0" border="0">
601        <tr>
602          <td class="md" nowrap valign="top"> virtual long Ogre::InputReader::getMouseRelativeZ </td>
603          <td class="md" valign="top">(&nbsp;</td>
604          <td class="mdname1" valign="top" nowrap>          </td>
605          <td class="md" valign="top">&nbsp;)&nbsp;</td>
606          <td class="md" nowrap> const<code> [virtual]</code></td>
607        </tr>
608
609      </table>
610    </td>
611  </tr>
612</table>
613<table cellspacing=5 cellpadding=0 border=0>
614  <tr>
615    <td>
616      &nbsp;
617    </td>
618    <td>
619
620<p>
621Retrieves the relative position of the mouse when capture was called relative to the last time.
622<p>
623
624<p>
625Definition 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>
626  </tr>
627</table>
628<a class="anchor" name="Ogre_1_1InputReadera10" doxytag="Ogre::InputReader::getMouseRelX" ></a><p>
629<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
630  <tr>
631    <td class="mdRow">
632      <table cellpadding="0" cellspacing="0" border="0">
633        <tr>
634          <td class="md" nowrap valign="top"> virtual long Ogre::InputReader::getMouseRelX </td>
635          <td class="md" valign="top">(&nbsp;</td>
636          <td class="mdname1" valign="top" nowrap>          </td>
637          <td class="md" valign="top">&nbsp;)&nbsp;</td>
638          <td class="md" nowrap> const<code> [pure virtual]</code></td>
639        </tr>
640
641      </table>
642    </td>
643  </tr>
644</table>
645<table cellspacing=5 cellpadding=0 border=0>
646  <tr>
647    <td>
648      &nbsp;
649    </td>
650    <td>
651
652<p>
653Retrieves the relative (compared to the last input poll) mouse movement on the X (horizontal) axis.
654<p>
655
656<p>
657Implemented 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>
658  </tr>
659</table>
660<a class="anchor" name="Ogre_1_1InputReadera11" doxytag="Ogre::InputReader::getMouseRelY" ></a><p>
661<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
662  <tr>
663    <td class="mdRow">
664      <table cellpadding="0" cellspacing="0" border="0">
665        <tr>
666          <td class="md" nowrap valign="top"> virtual long Ogre::InputReader::getMouseRelY </td>
667          <td class="md" valign="top">(&nbsp;</td>
668          <td class="mdname1" valign="top" nowrap>          </td>
669          <td class="md" valign="top">&nbsp;)&nbsp;</td>
670          <td class="md" nowrap> const<code> [pure virtual]</code></td>
671        </tr>
672
673      </table>
674    </td>
675  </tr>
676</table>
677<table cellspacing=5 cellpadding=0 border=0>
678  <tr>
679    <td>
680      &nbsp;
681    </td>
682    <td>
683
684<p>
685Retrieves the relative (compared to the last input poll) mouse movement on the Y (vertical) axis.
686<p>
687
688<p>
689Implemented 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>
690  </tr>
691</table>
692<a class="anchor" name="Ogre_1_1InputReadera12" doxytag="Ogre::InputReader::getMouseRelZ" ></a><p>
693<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
694  <tr>
695    <td class="mdRow">
696      <table cellpadding="0" cellspacing="0" border="0">
697        <tr>
698          <td class="md" nowrap valign="top"> virtual long Ogre::InputReader::getMouseRelZ </td>
699          <td class="md" valign="top">(&nbsp;</td>
700          <td class="mdname1" valign="top" nowrap>          </td>
701          <td class="md" valign="top">&nbsp;)&nbsp;</td>
702          <td class="md" nowrap> const<code> [pure virtual]</code></td>
703        </tr>
704
705      </table>
706    </td>
707  </tr>
708</table>
709<table cellspacing=5 cellpadding=0 border=0>
710  <tr>
711    <td>
712      &nbsp;
713    </td>
714    <td>
715
716<p>
717Retrieves the relative (compared to the last input poll) mouse movement on the Z (mouse wheel) axis.
718<p>
719
720<p>
721Implemented 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>
722  </tr>
723</table>
724<a class="anchor" name="Ogre_1_1InputReadera16" doxytag="Ogre::InputReader::getMouseState" ></a><p>
725<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
726  <tr>
727    <td class="mdRow">
728      <table cellpadding="0" cellspacing="0" border="0">
729        <tr>
730          <td class="md" nowrap valign="top"> virtual void Ogre::InputReader::getMouseState </td>
731          <td class="md" valign="top">(&nbsp;</td>
732          <td class="md" nowrap valign="top"><a class="el" href="structOgre_1_1MouseState.html">MouseState</a> &amp;&nbsp;</td>
733          <td class="mdname1" valign="top" nowrap> <em>state</em>          </td>
734          <td class="md" valign="top">&nbsp;)&nbsp;</td>
735          <td class="md" nowrap> const<code> [pure virtual]</code></td>
736        </tr>
737
738      </table>
739    </td>
740  </tr>
741</table>
742<table cellspacing=5 cellpadding=0 border=0>
743  <tr>
744    <td>
745      &nbsp;
746    </td>
747    <td>
748
749<p>
750Retrieves the current state of the mouse.
751<p>
752
753<p>
754Implemented 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>
755  </tr>
756</table>
757<a class="anchor" name="Ogre_1_1InputReadera4" doxytag="Ogre::InputReader::initialise" ></a><p>
758<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
759  <tr>
760    <td class="mdRow">
761      <table cellpadding="0" cellspacing="0" border="0">
762        <tr>
763          <td class="md" nowrap valign="top"> virtual void Ogre::InputReader::initialise </td>
764          <td class="md" valign="top">(&nbsp;</td>
765          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1RenderWindow.html">RenderWindow</a> *&nbsp;</td>
766          <td class="mdname" nowrap> <em>pWindow</em>, </td>
767        </tr>
768        <tr>
769          <td class="md" nowrap align="right"></td>
770          <td></td>
771          <td class="md" nowrap>bool&nbsp;</td>
772          <td class="mdname" nowrap> <em>useKeyboard</em> = true, </td>
773        </tr>
774        <tr>
775          <td class="md" nowrap align="right"></td>
776          <td></td>
777          <td class="md" nowrap>bool&nbsp;</td>
778          <td class="mdname" nowrap> <em>useMouse</em> = true, </td>
779        </tr>
780        <tr>
781          <td class="md" nowrap align="right"></td>
782          <td></td>
783          <td class="md" nowrap>bool&nbsp;</td>
784          <td class="mdname" nowrap> <em>useGameController</em> = false</td>
785        </tr>
786        <tr>
787          <td></td>
788          <td class="md">)&nbsp;</td>
789          <td class="md" colspan="2"><code> [pure virtual]</code></td>
790        </tr>
791
792      </table>
793    </td>
794  </tr>
795</table>
796<table cellspacing=5 cellpadding=0 border=0>
797  <tr>
798    <td>
799      &nbsp;
800    </td>
801    <td>
802
803<p>
804Initialise the input system.
805<p>
806<dl compact><dt><b>Note:</b></dt><dd>Only keyboard and mouse currently implemented. </dd></dl>
807<dl compact><dt><b>Parameters:</b></dt><dd>
808  <table border="0" cellspacing="2" cellpadding="0">
809    <tr><td valign=top><em>pWindow</em>&nbsp;</td><td>The window to capture input for </td></tr>
810    <tr><td valign=top><em>useKeyboard</em>&nbsp;</td><td>If true, keyboard input will be supported. </td></tr>
811    <tr><td valign=top><em>useMouse</em>&nbsp;</td><td>If true, mouse input will be supported. </td></tr>
812    <tr><td valign=top><em>useGameController</em>&nbsp;</td><td>If true, joysticks/gamepads will be supported. </td></tr>
813  </table>
814</dl>
815
816<p>
817Implemented 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>
818  </tr>
819</table>
820<a class="anchor" name="Ogre_1_1Win32Input8a15" doxytag="Ogre::InputReader::isKeyDown" ></a><p>
821<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
822  <tr>
823    <td class="mdRow">
824      <table cellpadding="0" cellspacing="0" border="0">
825        <tr>
826          <td class="md" nowrap valign="top"> virtual bool Ogre::InputReader::isKeyDown </td>
827          <td class="md" valign="top">(&nbsp;</td>
828          <td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a658">KeyCode</a>&nbsp;</td>
829          <td class="mdname1" valign="top" nowrap> <em>kc</em>          </td>
830          <td class="md" valign="top">&nbsp;)&nbsp;</td>
831          <td class="md" nowrap> const<code> [virtual]</code></td>
832        </tr>
833
834      </table>
835    </td>
836  </tr>
837</table>
838<table cellspacing=5 cellpadding=0 border=0>
839  <tr>
840    <td>
841      &nbsp;
842    </td>
843    <td>
844
845<p>
846Determines if the specified key is currently depressed.
847<p>
848<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>
849    </td>
850  </tr>
851</table>
852<a class="anchor" name="Ogre_1_1InputReaderb5" doxytag="Ogre::InputReader::isKeyDownImmediate" ></a><p>
853<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
854  <tr>
855    <td class="mdRow">
856      <table cellpadding="0" cellspacing="0" border="0">
857        <tr>
858          <td class="md" nowrap valign="top"> virtual bool Ogre::InputReader::isKeyDownImmediate </td>
859          <td class="md" valign="top">(&nbsp;</td>
860          <td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a658">KeyCode</a>&nbsp;</td>
861          <td class="mdname1" valign="top" nowrap> <em>kc</em>          </td>
862          <td class="md" valign="top">&nbsp;)&nbsp;</td>
863          <td class="md" nowrap> const<code> [protected, pure virtual]</code></td>
864        </tr>
865
866      </table>
867    </td>
868  </tr>
869</table>
870<table cellspacing=5 cellpadding=0 border=0>
871  <tr>
872    <td>
873      &nbsp;
874    </td>
875    <td>
876
877<p>
878Return whether a key is down in immediate mode.
879<p>
880
881<p>
882Implemented 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>
883  </tr>
884</table>
885<a class="anchor" name="Ogre_1_1Win32Input8b5" doxytag="Ogre::InputReader::keyChanged" ></a><p>
886<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
887  <tr>
888    <td class="mdRow">
889      <table cellpadding="0" cellspacing="0" border="0">
890        <tr>
891          <td class="md" nowrap valign="top"> void Ogre::InputReader::keyChanged </td>
892          <td class="md" valign="top">(&nbsp;</td>
893          <td class="md" nowrap valign="top">int&nbsp;</td>
894          <td class="mdname" nowrap> <em>key</em>, </td>
895        </tr>
896        <tr>
897          <td class="md" nowrap align="right"></td>
898          <td></td>
899          <td class="md" nowrap>bool&nbsp;</td>
900          <td class="mdname" nowrap> <em>down</em></td>
901        </tr>
902        <tr>
903          <td></td>
904          <td class="md">)&nbsp;</td>
905          <td class="md" colspan="2"><code> [protected]</code></td>
906        </tr>
907
908      </table>
909    </td>
910  </tr>
911</table>
912<table cellspacing=5 cellpadding=0 border=0>
913  <tr>
914    <td>
915      &nbsp;
916    </td>
917    <td>
918
919<p>
920    </td>
921  </tr>
922</table>
923<a class="anchor" name="Ogre_1_1Win32Input8b1" doxytag="Ogre::InputReader::mouseMoved" ></a><p>
924<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
925  <tr>
926    <td class="mdRow">
927      <table cellpadding="0" cellspacing="0" border="0">
928        <tr>
929          <td class="md" nowrap valign="top"> void Ogre::InputReader::mouseMoved </td>
930          <td class="md" valign="top">(&nbsp;</td>
931          <td class="mdname1" valign="top" nowrap>          </td>
932          <td class="md" valign="top">&nbsp;)&nbsp;</td>
933          <td class="md" nowrap><code> [protected]</code></td>
934        </tr>
935
936      </table>
937    </td>
938  </tr>
939</table>
940<table cellspacing=5 cellpadding=0 border=0>
941  <tr>
942    <td>
943      &nbsp;
944    </td>
945    <td>
946
947<p>
948Creates mouse moved or dragged events depending if any button is pressed.
949<p>
950    </td>
951  </tr>
952</table>
953<a class="anchor" name="Ogre_1_1Win32Input8a20" doxytag="Ogre::InputReader::removeCursorMoveListener" ></a><p>
954<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
955  <tr>
956    <td class="mdRow">
957      <table cellpadding="0" cellspacing="0" border="0">
958        <tr>
959          <td class="md" nowrap valign="top"> void Ogre::InputReader::removeCursorMoveListener </td>
960          <td class="md" valign="top">(&nbsp;</td>
961          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1MouseMotionListener.html">MouseMotionListener</a> *&nbsp;</td>
962          <td class="mdname1" valign="top" nowrap> <em>c</em>          </td>
963          <td class="md" valign="top">&nbsp;)&nbsp;</td>
964          <td class="md" nowrap></td>
965        </tr>
966
967      </table>
968    </td>
969  </tr>
970</table>
971<table cellspacing=5 cellpadding=0 border=0>
972  <tr>
973    <td>
974      &nbsp;
975    </td>
976    <td>
977
978<p>
979Remove a mouse motion listener to the cursor object.
980<p>
981This keeps the <a class="el" href="classOgre_1_1Cursor.html">Cursor</a> object hidden.     </td>
982  </tr>
983</table>
984<a class="anchor" name="Ogre_1_1SDLInputa14" doxytag="Ogre::InputReader::setBufferedInput" ></a><p>
985<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
986  <tr>
987    <td class="mdRow">
988      <table cellpadding="0" cellspacing="0" border="0">
989        <tr>
990          <td class="md" nowrap valign="top"> virtual void Ogre::InputReader::setBufferedInput </td>
991          <td class="md" valign="top">(&nbsp;</td>
992          <td class="md" nowrap valign="top">bool&nbsp;</td>
993          <td class="mdname" nowrap> <em>keys</em>, </td>
994        </tr>
995        <tr>
996          <td class="md" nowrap align="right"></td>
997          <td></td>
998          <td class="md" nowrap>bool&nbsp;</td>
999          <td class="mdname" nowrap> <em>mouse</em></td>
1000        </tr>
1001        <tr>
1002          <td></td>
1003          <td class="md">)&nbsp;</td>
1004          <td class="md" colspan="2"><code> [virtual]</code></td>
1005        </tr>
1006
1007      </table>
1008    </td>
1009  </tr>
1010</table>
1011<table cellspacing=5 cellpadding=0 border=0>
1012  <tr>
1013    <td>
1014      &nbsp;
1015    </td>
1016    <td>
1017
1018<p>
1019
1020<p>
1021Reimplemented in <a class="el" href="classOgre_1_1Win32Input8.html#Ogre_1_1Win32Input8a12">Ogre::Win32Input8</a>.    </td>
1022  </tr>
1023</table>
1024<a class="anchor" name="Ogre_1_1Win32Input8b3" doxytag="Ogre::InputReader::triggerMouseButton" ></a><p>
1025<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1026  <tr>
1027    <td class="mdRow">
1028      <table cellpadding="0" cellspacing="0" border="0">
1029        <tr>
1030          <td class="md" nowrap valign="top"> void Ogre::InputReader::triggerMouseButton </td>
1031          <td class="md" valign="top">(&nbsp;</td>
1032          <td class="md" nowrap valign="top">int&nbsp;</td>
1033          <td class="mdname" nowrap> <em>nMouseCode</em>, </td>
1034        </tr>
1035        <tr>
1036          <td class="md" nowrap align="right"></td>
1037          <td></td>
1038          <td class="md" nowrap>bool&nbsp;</td>
1039          <td class="mdname" nowrap> <em>mousePressed</em></td>
1040        </tr>
1041        <tr>
1042          <td></td>
1043          <td class="md">)&nbsp;</td>
1044          <td class="md" colspan="2"><code> [protected]</code></td>
1045        </tr>
1046
1047      </table>
1048    </td>
1049  </tr>
1050</table>
1051<table cellspacing=5 cellpadding=0 border=0>
1052  <tr>
1053    <td>
1054      &nbsp;
1055    </td>
1056    <td>
1057
1058<p>
1059Creates mouse pressed, released, and clicked events.
1060<p>
1061    </td>
1062  </tr>
1063</table>
1064<a class="anchor" name="Ogre_1_1Win32Input8a14" doxytag="Ogre::InputReader::useBufferedInput" ></a><p>
1065<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1066  <tr>
1067    <td class="mdRow">
1068      <table cellpadding="0" cellspacing="0" border="0">
1069        <tr>
1070          <td class="md" nowrap valign="top"> void Ogre::InputReader::useBufferedInput </td>
1071          <td class="md" valign="top">(&nbsp;</td>
1072          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1EventQueue.html">EventQueue</a> *&nbsp;</td>
1073          <td class="mdname" nowrap> <em>pEventQueue</em>, </td>
1074        </tr>
1075        <tr>
1076          <td class="md" nowrap align="right"></td>
1077          <td></td>
1078          <td class="md" nowrap>bool&nbsp;</td>
1079          <td class="mdname" nowrap> <em>keys</em> = true, </td>
1080        </tr>
1081        <tr>
1082          <td class="md" nowrap align="right"></td>
1083          <td></td>
1084          <td class="md" nowrap>bool&nbsp;</td>
1085          <td class="mdname" nowrap> <em>mouse</em> = true</td>
1086        </tr>
1087        <tr>
1088          <td></td>
1089          <td class="md">)&nbsp;</td>
1090          <td class="md" colspan="2"></td>
1091        </tr>
1092
1093      </table>
1094    </td>
1095  </tr>
1096</table>
1097<table cellspacing=5 cellpadding=0 border=0>
1098  <tr>
1099    <td>
1100      &nbsp;
1101    </td>
1102    <td>
1103
1104<p>
1105Tells the reader to use buffered input and update the passed in queue.
1106<p>
1107<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>
1108    </td>
1109  </tr>
1110</table>
1111<hr><h2>Member Data Documentation</h2>
1112<a class="anchor" name="Ogre_1_1Win32Input8p6" doxytag="Ogre::InputReader::mBufferedKeysDown" ></a><p>
1113<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1114  <tr>
1115    <td class="mdRow">
1116      <table cellpadding="0" cellspacing="0" border="0">
1117        <tr>
1118          <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>
1119      </table>
1120    </td>
1121  </tr>
1122</table>
1123<table cellspacing=5 cellpadding=0 border=0>
1124  <tr>
1125    <td>
1126      &nbsp;
1127    </td>
1128    <td>
1129
1130<p>
1131
1132<p>
1133Definition 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>
1134  </tr>
1135</table>
1136<a class="anchor" name="Ogre_1_1Win32Input8p1" doxytag="Ogre::InputReader::mCursor" ></a><p>
1137<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1138  <tr>
1139    <td class="mdRow">
1140      <table cellpadding="0" cellspacing="0" border="0">
1141        <tr>
1142          <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>
1143      </table>
1144    </td>
1145  </tr>
1146</table>
1147<table cellspacing=5 cellpadding=0 border=0>
1148  <tr>
1149    <td>
1150      &nbsp;
1151    </td>
1152    <td>
1153
1154<p>
1155Internal <a class="el" href="classOgre_1_1Cursor.html">Cursor</a> object.
1156<p>
1157<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>
1158<dl compact><dt><b>See also:</b></dt><dd>CursorGuiElement. </dd></dl>
1159
1160<p>
1161Definition 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>
1162  </tr>
1163</table>
1164<a class="anchor" name="Ogre_1_1Win32Input8p2" doxytag="Ogre::InputReader::mEventQueue" ></a><p>
1165<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1166  <tr>
1167    <td class="mdRow">
1168      <table cellpadding="0" cellspacing="0" border="0">
1169        <tr>
1170          <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>
1171      </table>
1172    </td>
1173  </tr>
1174</table>
1175<table cellspacing=5 cellpadding=0 border=0>
1176  <tr>
1177    <td>
1178      &nbsp;
1179    </td>
1180    <td>
1181
1182<p>
1183<a class="el" href="classOgre_1_1EventQueue.html">EventQueue</a> is used for buffered input support.
1184<p>
1185
1186<p>
1187Definition 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>
1188  </tr>
1189</table>
1190<a class="anchor" name="Ogre_1_1Win32Input8p0" doxytag="Ogre::InputReader::mModifiers" ></a><p>
1191<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1192  <tr>
1193    <td class="mdRow">
1194      <table cellpadding="0" cellspacing="0" border="0">
1195        <tr>
1196          <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>
1197      </table>
1198    </td>
1199  </tr>
1200</table>
1201<table cellspacing=5 cellpadding=0 border=0>
1202  <tr>
1203    <td>
1204      &nbsp;
1205    </td>
1206    <td>
1207
1208<p>
1209The modifiers are a binary flags that represent what buttons are pressed, and what key modifiers are down (e.g.
1210<p>
1211shift/alt).
1212<p>
1213Definition 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>
1214  </tr>
1215</table>
1216<a class="anchor" name="Ogre_1_1Win32Input8p5" doxytag="Ogre::InputReader::mMouseState" ></a><p>
1217<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1218  <tr>
1219    <td class="mdRow">
1220      <table cellpadding="0" cellspacing="0" border="0">
1221        <tr>
1222          <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>
1223      </table>
1224    </td>
1225  </tr>
1226</table>
1227<table cellspacing=5 cellpadding=0 border=0>
1228  <tr>
1229    <td>
1230      &nbsp;
1231    </td>
1232    <td>
1233
1234<p>
1235The mouse state in immediate mode.
1236<p>
1237
1238<p>
1239Definition 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>
1240  </tr>
1241</table>
1242<a class="anchor" name="Ogre_1_1Win32Input8p3" doxytag="Ogre::InputReader::mUseBufferedKeys" ></a><p>
1243<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1244  <tr>
1245    <td class="mdRow">
1246      <table cellpadding="0" cellspacing="0" border="0">
1247        <tr>
1248          <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>
1249      </table>
1250    </td>
1251  </tr>
1252</table>
1253<table cellspacing=5 cellpadding=0 border=0>
1254  <tr>
1255    <td>
1256      &nbsp;
1257    </td>
1258    <td>
1259
1260<p>
1261Wether to use buffering input support - buffering support relies on using an <a class="el" href="classOgre_1_1EventQueue.html">EventQueue</a>.
1262<p>
1263<dl compact><dt><b>See also:</b></dt><dd>class <a class="el" href="classOgre_1_1EventQueue.html">EventQueue</a> </dd></dl>
1264
1265<p>
1266Definition 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>
1267  </tr>
1268</table>
1269<a class="anchor" name="Ogre_1_1Win32Input8p4" doxytag="Ogre::InputReader::mUseBufferedMouse" ></a><p>
1270<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1271  <tr>
1272    <td class="mdRow">
1273      <table cellpadding="0" cellspacing="0" border="0">
1274        <tr>
1275          <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>
1276      </table>
1277    </td>
1278  </tr>
1279</table>
1280<table cellspacing=5 cellpadding=0 border=0>
1281  <tr>
1282    <td>
1283      &nbsp;
1284    </td>
1285    <td>
1286
1287<p>
1288Wether to use buffering input support - buffering support relies on using an <a class="el" href="classOgre_1_1EventQueue.html">EventQueue</a>.
1289<p>
1290<dl compact><dt><b>See also:</b></dt><dd>class <a class="el" href="classOgre_1_1EventQueue.html">EventQueue</a> </dd></dl>
1291
1292<p>
1293Definition 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>
1294  </tr>
1295</table>
1296<hr>The documentation for this class was generated from the following file:<ul>
1297<li><a class="el" href="OgreInput_8h-source.html">OgreInput.h</a></ul>
1298<hr>
1299<p>
1300Copyright &copy; 2000-2005 by The OGRE Team<br />
1301<!--Creative Commons License--><a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/"><img alt="Creative Commons License" border="0" src="http://creativecommons.org/images/public/somerights20.png"/></a><br/>
1302This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/">Creative Commons Attribution-ShareAlike 2.5 License</a>.<br/>
1303                <!--/Creative Commons License--><!-- <rdf:RDF xmlns="http://web.resource.org/cc/" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
1304                <Work rdf:about="">
1305                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
1306        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
1307                </Work>
1308                <License rdf:about="http://creativecommons.org/licenses/by-sa/2.5/"><permits rdf:resource="http://web.resource.org/cc/Reproduction"/><permits rdf:resource="http://web.resource.org/cc/Distribution"/><requires rdf:resource="http://web.resource.org/cc/Notice"/><requires rdf:resource="http://web.resource.org/cc/Attribution"/><permits rdf:resource="http://web.resource.org/cc/DerivativeWorks"/><requires rdf:resource="http://web.resource.org/cc/ShareAlike"/></License></rdf:RDF> -->
1309
1310Last modified Sun Feb 12 13:00:51 2006
1311</p>
1312</body>
1313</html>
Note: See TracBrowser for help on using the repository browser.