<html> <head> <title>Ogre::MouseState struct Reference - OGRE Documentation</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> <link type="text/css" rel="stylesheet" href="style.css"> </head> <body> <!-- Generated by Doxygen 1.2.16 --> <center> <a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="namespacemembers.html">Namespace Members</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> <a class="qindex" href="pages.html">Related Pages</a> </center> <hr><h1>Ogre::MouseState Struct Reference</h1>Structure representing a snapshot of the state of the mouse input controller. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="OgreInput_8h-source.html">OgreInput.h</a>></code> <p> <a href="structOgre_1_1MouseState-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> <tr><td colspan=2><br><h2>Public Methods</h2></td></tr> <tr><td nowrap align=right valign=top>long </td><td valign=bottom><a class="el" href="structOgre_1_1MouseState.html#Ogre_1_1MouseStatea0">isButtonDown</a> (<a class="el" href="namespaceOgre.html#a350">uchar</a> button) const</td></tr> <tr><td> </td><td><font size=-1><em>Retrieves the pressed state of a mouse button.</em> <a href="#Ogre_1_1MouseStatea0"></a><em></em></font><br><br></td></tr> <tr><td colspan=2><br><h2>Public Attributes</h2></td></tr> <tr><td nowrap align=right valign=top>long </td><td valign=bottom><a class="el" href="structOgre_1_1MouseState.html#Ogre_1_1MouseStatem0">Xabs</a></td></tr> <tr><td> </td><td><font size=-1><em>Absolute position of the mouse pointer.</em> <a href="#Ogre_1_1MouseStatem0"></a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>long </td><td valign=bottom><a class="el" href="structOgre_1_1MouseState.html#Ogre_1_1MouseStatem1">Yabs</a></td></tr> <tr><td> </td><td><font size=-1><em>Absolute position of the mouse pointer.</em> <a href="#Ogre_1_1MouseStatem1"></a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>long </td><td valign=bottom><a class="el" href="structOgre_1_1MouseState.html#Ogre_1_1MouseStatem2">Zabs</a></td></tr> <tr><td> </td><td><font size=-1><em>Absolute position of the mouse pointer.</em> <a href="#Ogre_1_1MouseStatem2"></a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>long </td><td valign=bottom><a class="el" href="structOgre_1_1MouseState.html#Ogre_1_1MouseStatem3">Xrel</a></td></tr> <tr><td> </td><td><font size=-1><em>Relative position of the mouse pointer.</em> <a href="#Ogre_1_1MouseStatem3"></a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>long </td><td valign=bottom><a class="el" href="structOgre_1_1MouseState.html#Ogre_1_1MouseStatem4">Yrel</a></td></tr> <tr><td> </td><td><font size=-1><em>Relative position of the mouse pointer.</em> <a href="#Ogre_1_1MouseStatem4"></a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>long </td><td valign=bottom><a class="el" href="structOgre_1_1MouseState.html#Ogre_1_1MouseStatem5">Zrel</a></td></tr> <tr><td> </td><td><font size=-1><em>Relative position of the mouse pointer.</em> <a href="#Ogre_1_1MouseStatem5"></a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>long </td><td valign=bottom><a class="el" href="structOgre_1_1MouseState.html#Ogre_1_1MouseStatem6">Buttons</a></td></tr> <tr><td> </td><td><font size=-1><em>The buttons that have been pressed.</em> <a href="#Ogre_1_1MouseStatem6"></a><em></em></font><br><br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> Structure representing a snapshot of the state of the mouse input controller. <p> <p> Definition at line <a class="el" href="OgreInput_8h-source.html#l00190">190</a> of file <a class="el" href="OgreInput_8h-source.html">OgreInput.h</a>.<hr><h2>Member Function Documentation</h2> <a name="Ogre_1_1MouseStatea0" doxytag="Ogre::MouseState::isButtonDown"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> long Ogre::MouseState::isButtonDown </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a350">uchar</a> </td> <td class="mdname1" valign="top" nowrap> <em>button</em> </td> <td class="md" valign="top">) </td> <td class="md" nowrap> const</td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Retrieves the pressed state of a mouse button. <p> <p> Definition at line <a class="el" href="OgreInput_8h-source.html#l00201">201</a> of file <a class="el" href="OgreInput_8h-source.html">OgreInput.h</a>. <p> References <a class="el" href="OgrePrerequisites_8h-source.html#l00114">Ogre::uchar</a>. <p> Referenced by <a class="el" href="OgreWin32Input8_8cpp-source.html#l00794">Ogre::Win32Input8::getMouseButton</a>(), and <a class="el" href="OgreSDLInput_8cpp-source.html#l00530">Ogre::SDLInput::getMouseButton</a>(). </td> </tr> </table> <hr><h2>Member Data Documentation</h2> <a name="Ogre_1_1MouseStatem6" doxytag="Ogre::MouseState::Buttons"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> long Ogre::MouseState::Buttons </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> The buttons that have been pressed. <p> Each bit maps to a mouse button. <p> Definition at line <a class="el" href="OgreInput_8h-source.html#l00198">198</a> of file <a class="el" href="OgreInput_8h-source.html">OgreInput.h</a>. <p> Referenced by <a class="el" href="OgreSDLInput_8cpp-source.html#l00170">Ogre::SDLInput::capture</a>(), and <a class="el" href="OgreWin32Input8_8cpp-source.html#l00478">Ogre::Win32Input8::captureMouse</a>(). </td> </tr> </table> <a name="Ogre_1_1MouseStatem0" doxytag="Ogre::MouseState::Xabs"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> long Ogre::MouseState::Xabs </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Absolute position of the mouse pointer. <p> <p> Definition at line <a class="el" href="OgreInput_8h-source.html#l00193">193</a> of file <a class="el" href="OgreInput_8h-source.html">OgreInput.h</a>. <p> Referenced by <a class="el" href="OgreSDLInput_8cpp-source.html#l00170">Ogre::SDLInput::capture</a>(), <a class="el" href="OgreWin32Input8_8cpp-source.html#l00478">Ogre::Win32Input8::captureMouse</a>(), and <a class="el" href="OgreWin32Input8_8cpp-source.html#l00778">Ogre::Win32Input8::getMouseAbsX</a>(). </td> </tr> </table> <a name="Ogre_1_1MouseStatem3" doxytag="Ogre::MouseState::Xrel"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> long Ogre::MouseState::Xrel </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Relative position of the mouse pointer. <p> <p> Definition 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>. <p> Referenced by <a class="el" href="OgreSDLInput_8cpp-source.html#l00170">Ogre::SDLInput::capture</a>(), <a class="el" href="OgreWin32Input8_8cpp-source.html#l00478">Ogre::Win32Input8::captureMouse</a>(), <a class="el" href="OgreWin32Input8_8cpp-source.html#l00761">Ogre::Win32Input8::getMouseRelX</a>(), and <a class="el" href="OgreWin32Input8_8cpp-source.html#l00198">Ogre::Win32Input8::initialiseImmediateMouse</a>(). </td> </tr> </table> <a name="Ogre_1_1MouseStatem1" doxytag="Ogre::MouseState::Yabs"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> long Ogre::MouseState::Yabs </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Absolute position of the mouse pointer. <p> <p> Definition at line <a class="el" href="OgreInput_8h-source.html#l00193">193</a> of file <a class="el" href="OgreInput_8h-source.html">OgreInput.h</a>. <p> Referenced by <a class="el" href="OgreSDLInput_8cpp-source.html#l00170">Ogre::SDLInput::capture</a>(), <a class="el" href="OgreWin32Input8_8cpp-source.html#l00478">Ogre::Win32Input8::captureMouse</a>(), and <a class="el" href="OgreWin32Input8_8cpp-source.html#l00783">Ogre::Win32Input8::getMouseAbsY</a>(). </td> </tr> </table> <a name="Ogre_1_1MouseStatem4" doxytag="Ogre::MouseState::Yrel"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> long Ogre::MouseState::Yrel </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Relative position of the mouse pointer. <p> <p> Definition 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>. <p> Referenced by <a class="el" href="OgreSDLInput_8cpp-source.html#l00170">Ogre::SDLInput::capture</a>(), <a class="el" href="OgreWin32Input8_8cpp-source.html#l00478">Ogre::Win32Input8::captureMouse</a>(), <a class="el" href="OgreWin32Input8_8cpp-source.html#l00767">Ogre::Win32Input8::getMouseRelY</a>(), and <a class="el" href="OgreWin32Input8_8cpp-source.html#l00198">Ogre::Win32Input8::initialiseImmediateMouse</a>(). </td> </tr> </table> <a name="Ogre_1_1MouseStatem2" doxytag="Ogre::MouseState::Zabs"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> long Ogre::MouseState::Zabs </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Absolute position of the mouse pointer. <p> <p> Definition at line <a class="el" href="OgreInput_8h-source.html#l00193">193</a> of file <a class="el" href="OgreInput_8h-source.html">OgreInput.h</a>. <p> Referenced by <a class="el" href="OgreSDLInput_8cpp-source.html#l00170">Ogre::SDLInput::capture</a>(), <a class="el" href="OgreWin32Input8_8cpp-source.html#l00478">Ogre::Win32Input8::captureMouse</a>(), and <a class="el" href="OgreWin32Input8_8cpp-source.html#l00788">Ogre::Win32Input8::getMouseAbsZ</a>(). </td> </tr> </table> <a name="Ogre_1_1MouseStatem5" doxytag="Ogre::MouseState::Zrel"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> long Ogre::MouseState::Zrel </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Relative position of the mouse pointer. <p> <p> Definition 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>. <p> Referenced by <a class="el" href="OgreSDLInput_8cpp-source.html#l00170">Ogre::SDLInput::capture</a>(), <a class="el" href="OgreWin32Input8_8cpp-source.html#l00478">Ogre::Win32Input8::captureMouse</a>(), <a class="el" href="OgreWin32Input8_8cpp-source.html#l00773">Ogre::Win32Input8::getMouseRelZ</a>(), and <a class="el" href="OgreWin32Input8_8cpp-source.html#l00198">Ogre::Win32Input8::initialiseImmediateMouse</a>(). </td> </tr> </table> <hr>The documentation for this struct was generated from the following file:<ul> <li><a class="el" href="OgreInput_8h-source.html">OgreInput.h</a></ul> <p> Copyright © 2002-2003 by The OGRE Team<br /> Last modified Wed Jan 21 00:18:38 2004 </p> </body> </html>