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

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

added ogre dependencies and patched ogre sources
Line 
1<html>
2<head>
3<title>Ogre::MouseState struct 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::MouseState Struct Reference</h1>Structure representing a snapshot of the state of the mouse input controller. 
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<a href="structOgre_1_1MouseState-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
16<tr><td></td></tr>
17<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
18<tr><td class="memItemLeft" nowrap align=right valign=top>long&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="structOgre_1_1MouseState.html#Ogre_1_1MouseStatea0">isButtonDown</a> (<a class="el" href="namespaceOgre.html#a421">uchar</a> button) const </td></tr>
19
20<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the pressed state of a mouse button.  <a href="#Ogre_1_1MouseStatea0"></a><br><br></td></tr>
21<tr><td colspan=2><br><h2>Public Attributes</h2></td></tr>
22<tr><td class="memItemLeft" nowrap align=right valign=top>long&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="structOgre_1_1MouseState.html#Ogre_1_1MouseStateo0">Xabs</a></td></tr>
23
24<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Absolute position of the mouse pointer.  <a href="#Ogre_1_1MouseStateo0"></a><br><br></td></tr>
25<tr><td class="memItemLeft" nowrap align=right valign=top>long&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="structOgre_1_1MouseState.html#Ogre_1_1MouseStateo1">Yabs</a></td></tr>
26
27<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Absolute position of the mouse pointer.  <a href="#Ogre_1_1MouseStateo1"></a><br><br></td></tr>
28<tr><td class="memItemLeft" nowrap align=right valign=top>long&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="structOgre_1_1MouseState.html#Ogre_1_1MouseStateo2">Zabs</a></td></tr>
29
30<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Absolute position of the mouse pointer.  <a href="#Ogre_1_1MouseStateo2"></a><br><br></td></tr>
31<tr><td class="memItemLeft" nowrap align=right valign=top>long&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="structOgre_1_1MouseState.html#Ogre_1_1MouseStateo3">Xrel</a></td></tr>
32
33<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Relative position of the mouse pointer.  <a href="#Ogre_1_1MouseStateo3"></a><br><br></td></tr>
34<tr><td class="memItemLeft" nowrap align=right valign=top>long&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="structOgre_1_1MouseState.html#Ogre_1_1MouseStateo4">Yrel</a></td></tr>
35
36<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Relative position of the mouse pointer.  <a href="#Ogre_1_1MouseStateo4"></a><br><br></td></tr>
37<tr><td class="memItemLeft" nowrap align=right valign=top>long&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="structOgre_1_1MouseState.html#Ogre_1_1MouseStateo5">Zrel</a></td></tr>
38
39<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Relative position of the mouse pointer.  <a href="#Ogre_1_1MouseStateo5"></a><br><br></td></tr>
40<tr><td class="memItemLeft" nowrap align=right valign=top>long&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="structOgre_1_1MouseState.html#Ogre_1_1MouseStateo6">Buttons</a></td></tr>
41
42<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The buttons that have been pressed.  <a href="#Ogre_1_1MouseStateo6"></a><br><br></td></tr>
43</table>
44<hr><a name="_details"></a><h2>Detailed Description</h2>
45Structure representing a snapshot of the state of the mouse input controller.
46<p>
47
48<p>
49Definition at line <a class="el" href="OgreInput_8h-source.html#l00184">184</a> of file <a class="el" href="OgreInput_8h-source.html">OgreInput.h</a>.<hr><h2>Member Function Documentation</h2>
50<a class="anchor" name="Ogre_1_1MouseStatea0" doxytag="Ogre::MouseState::isButtonDown" ></a><p>
51<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
52  <tr>
53    <td class="mdRow">
54      <table cellpadding="0" cellspacing="0" border="0">
55        <tr>
56          <td class="md" nowrap valign="top"> long Ogre::MouseState::isButtonDown </td>
57          <td class="md" valign="top">(&nbsp;</td>
58          <td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a421">uchar</a>&nbsp;</td>
59          <td class="mdname1" valign="top" nowrap> <em>button</em>          </td>
60          <td class="md" valign="top">&nbsp;)&nbsp;</td>
61          <td class="md" nowrap> const</td>
62        </tr>
63
64      </table>
65    </td>
66  </tr>
67</table>
68<table cellspacing=5 cellpadding=0 border=0>
69  <tr>
70    <td>
71      &nbsp;
72    </td>
73    <td>
74
75<p>
76Retrieves the pressed state of a mouse button.
77<p>
78
79<p>
80Definition at line <a class="el" href="OgreInput_8h-source.html#l00195">195</a> of file <a class="el" href="OgreInput_8h-source.html">OgreInput.h</a>.
81<p>
82References <a class="el" href="OgrePrerequisites_8h-source.html#l00139">Ogre::uchar</a>.    </td>
83  </tr>
84</table>
85<hr><h2>Member Data Documentation</h2>
86<a class="anchor" name="Ogre_1_1MouseStateo6" doxytag="Ogre::MouseState::Buttons" ></a><p>
87<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
88  <tr>
89    <td class="mdRow">
90      <table cellpadding="0" cellspacing="0" border="0">
91        <tr>
92          <td class="md" nowrap valign="top"> long <a class="el" href="structOgre_1_1MouseState.html#Ogre_1_1MouseStateo6">Ogre::MouseState::Buttons</a>
93      </table>
94    </td>
95  </tr>
96</table>
97<table cellspacing=5 cellpadding=0 border=0>
98  <tr>
99    <td>
100      &nbsp;
101    </td>
102    <td>
103
104<p>
105The buttons that have been pressed.
106<p>
107Each bit maps to a mouse button.
108<p>
109Definition at line <a class="el" href="OgreInput_8h-source.html#l00192">192</a> of file <a class="el" href="OgreInput_8h-source.html">OgreInput.h</a>.    </td>
110  </tr>
111</table>
112<a class="anchor" name="Ogre_1_1MouseStateo0" doxytag="Ogre::MouseState::Xabs" ></a><p>
113<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
114  <tr>
115    <td class="mdRow">
116      <table cellpadding="0" cellspacing="0" border="0">
117        <tr>
118          <td class="md" nowrap valign="top"> long <a class="el" href="structOgre_1_1MouseState.html#Ogre_1_1MouseStateo0">Ogre::MouseState::Xabs</a>
119      </table>
120    </td>
121  </tr>
122</table>
123<table cellspacing=5 cellpadding=0 border=0>
124  <tr>
125    <td>
126      &nbsp;
127    </td>
128    <td>
129
130<p>
131Absolute position of the mouse pointer.
132<p>
133
134<p>
135Definition at line <a class="el" href="OgreInput_8h-source.html#l00187">187</a> of file <a class="el" href="OgreInput_8h-source.html">OgreInput.h</a>.    </td>
136  </tr>
137</table>
138<a class="anchor" name="Ogre_1_1MouseStateo3" doxytag="Ogre::MouseState::Xrel" ></a><p>
139<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
140  <tr>
141    <td class="mdRow">
142      <table cellpadding="0" cellspacing="0" border="0">
143        <tr>
144          <td class="md" nowrap valign="top"> long <a class="el" href="structOgre_1_1MouseState.html#Ogre_1_1MouseStateo3">Ogre::MouseState::Xrel</a>
145      </table>
146    </td>
147  </tr>
148</table>
149<table cellspacing=5 cellpadding=0 border=0>
150  <tr>
151    <td>
152      &nbsp;
153    </td>
154    <td>
155
156<p>
157Relative position of the mouse pointer.
158<p>
159
160<p>
161Definition at line <a class="el" href="OgreInput_8h-source.html#l00189">189</a> of file <a class="el" href="OgreInput_8h-source.html">OgreInput.h</a>.    </td>
162  </tr>
163</table>
164<a class="anchor" name="Ogre_1_1MouseStateo1" doxytag="Ogre::MouseState::Yabs" ></a><p>
165<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
166  <tr>
167    <td class="mdRow">
168      <table cellpadding="0" cellspacing="0" border="0">
169        <tr>
170          <td class="md" nowrap valign="top"> long <a class="el" href="structOgre_1_1MouseState.html#Ogre_1_1MouseStateo1">Ogre::MouseState::Yabs</a>
171      </table>
172    </td>
173  </tr>
174</table>
175<table cellspacing=5 cellpadding=0 border=0>
176  <tr>
177    <td>
178      &nbsp;
179    </td>
180    <td>
181
182<p>
183Absolute position of the mouse pointer.
184<p>
185
186<p>
187Definition at line <a class="el" href="OgreInput_8h-source.html#l00187">187</a> of file <a class="el" href="OgreInput_8h-source.html">OgreInput.h</a>.    </td>
188  </tr>
189</table>
190<a class="anchor" name="Ogre_1_1MouseStateo4" doxytag="Ogre::MouseState::Yrel" ></a><p>
191<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
192  <tr>
193    <td class="mdRow">
194      <table cellpadding="0" cellspacing="0" border="0">
195        <tr>
196          <td class="md" nowrap valign="top"> long <a class="el" href="structOgre_1_1MouseState.html#Ogre_1_1MouseStateo4">Ogre::MouseState::Yrel</a>
197      </table>
198    </td>
199  </tr>
200</table>
201<table cellspacing=5 cellpadding=0 border=0>
202  <tr>
203    <td>
204      &nbsp;
205    </td>
206    <td>
207
208<p>
209Relative position of the mouse pointer.
210<p>
211
212<p>
213Definition at line <a class="el" href="OgreInput_8h-source.html#l00189">189</a> of file <a class="el" href="OgreInput_8h-source.html">OgreInput.h</a>.    </td>
214  </tr>
215</table>
216<a class="anchor" name="Ogre_1_1MouseStateo2" doxytag="Ogre::MouseState::Zabs" ></a><p>
217<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
218  <tr>
219    <td class="mdRow">
220      <table cellpadding="0" cellspacing="0" border="0">
221        <tr>
222          <td class="md" nowrap valign="top"> long <a class="el" href="structOgre_1_1MouseState.html#Ogre_1_1MouseStateo2">Ogre::MouseState::Zabs</a>
223      </table>
224    </td>
225  </tr>
226</table>
227<table cellspacing=5 cellpadding=0 border=0>
228  <tr>
229    <td>
230      &nbsp;
231    </td>
232    <td>
233
234<p>
235Absolute position of the mouse pointer.
236<p>
237
238<p>
239Definition at line <a class="el" href="OgreInput_8h-source.html#l00187">187</a> of file <a class="el" href="OgreInput_8h-source.html">OgreInput.h</a>.    </td>
240  </tr>
241</table>
242<a class="anchor" name="Ogre_1_1MouseStateo5" doxytag="Ogre::MouseState::Zrel" ></a><p>
243<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
244  <tr>
245    <td class="mdRow">
246      <table cellpadding="0" cellspacing="0" border="0">
247        <tr>
248          <td class="md" nowrap valign="top"> long <a class="el" href="structOgre_1_1MouseState.html#Ogre_1_1MouseStateo5">Ogre::MouseState::Zrel</a>
249      </table>
250    </td>
251  </tr>
252</table>
253<table cellspacing=5 cellpadding=0 border=0>
254  <tr>
255    <td>
256      &nbsp;
257    </td>
258    <td>
259
260<p>
261Relative position of the mouse pointer.
262<p>
263
264<p>
265Definition at line <a class="el" href="OgreInput_8h-source.html#l00189">189</a> of file <a class="el" href="OgreInput_8h-source.html">OgreInput.h</a>.    </td>
266  </tr>
267</table>
268<hr>The documentation for this struct was generated from the following file:<ul>
269<li><a class="el" href="OgreInput_8h-source.html">OgreInput.h</a></ul>
270<hr>
271<p>
272Copyright &copy; 2000-2005 by The OGRE Team<br />
273<!--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/>
274This 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/>
275                <!--/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#">
276                <Work rdf:about="">
277                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
278        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
279                </Work>
280                <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> -->
281
282Last modified Sun Feb 12 13:00:50 2006
283</p>
284</body>
285</html>
Note: See TracBrowser for help on using the repository browser.