<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <title>Irrlicht 3D Engine: irr::SEvent::SMouseInput Struct Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css" /> <link href="navtree.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="resize.js"></script> <script type="text/javascript" src="navtree.js"></script> <script type="text/javascript"> $(document).ready(initResizable); </script> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/search.js"></script> <script type="text/javascript"> $(document).ready(function() { searchBox.OnSelectItem(0); }); </script> </head> <body> <div id="top"><!-- do not remove this div! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td id="projectlogo"><img alt="Logo" src="irrlichtlogo.png"/></td> <td style="padding-left: 0.5em;"> <div id="projectname">Irrlicht 3D Engine </div> </td> <td> <div id="MSearchBox" class="MSearchBoxInactive"> <span class="left"> <img id="MSearchSelect" src="search/mag_sel.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""/> <input type="text" id="MSearchField" value="Search" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/> </span><span class="right"> <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> </span> </div> </td> </tr> </tbody> </table> </div> <!-- Generated by Doxygen 1.7.5.1 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </script> <script type="text/javascript" src="dynsections.js"></script> </div> <div id="side-nav" class="ui-resizable side-nav-resizable"> <div id="nav-tree"> <div id="nav-tree-contents"> </div> </div> <div id="splitbar" style="-moz-user-select:none;" class="ui-resizable-handle"> </div> </div> <script type="text/javascript"> initNavTree('structirr_1_1_s_event_1_1_s_mouse_input.html',''); </script> <div id="doc-content"> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#pub-attribs">Public Attributes</a> </div> <div class="headertitle"> <div class="title">irr::SEvent::SMouseInput Struct Reference</div> </div> </div> <div class="contents"> <!-- doxytag: class="irr::SEvent::SMouseInput" --> <p>Any kind of mouse event. <a href="structirr_1_1_s_event_1_1_s_mouse_input.html#details">More...</a></p> <p><code>#include <<a class="el" href="_i_event_receiver_8h_source.html">IEventReceiver.h</a>></code></p> <p><a href="structirr_1_1_s_event_1_1_s_mouse_input-members.html">List of all members.</a></p> <h2><a name="pub-methods"></a> Public Member Functions</h2> <ul> <li>bool <a class="el" href="structirr_1_1_s_event_1_1_s_mouse_input.html#a7c3fec25a36a285f46897a6350c8fc24">isLeftPressed</a> () const <dl class="el"><dd class="mdescRight">Is the left button pressed down? <a href="#a7c3fec25a36a285f46897a6350c8fc24"></a><br/></dl><li>bool <a class="el" href="structirr_1_1_s_event_1_1_s_mouse_input.html#a1a93f70157bfad1c15ae2a7c10745432">isMiddlePressed</a> () const <dl class="el"><dd class="mdescRight">Is the middle button pressed down? <a href="#a1a93f70157bfad1c15ae2a7c10745432"></a><br/></dl><li>bool <a class="el" href="structirr_1_1_s_event_1_1_s_mouse_input.html#a6dc635dc9841455ab2233f469c24c6e9">isRightPressed</a> () const <dl class="el"><dd class="mdescRight">Is the right button pressed down? <a href="#a6dc635dc9841455ab2233f469c24c6e9"></a><br/></dl></ul> <h2><a name="pub-attribs"></a> Public Attributes</h2> <ul> <li><a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> <a class="el" href="structirr_1_1_s_event_1_1_s_mouse_input.html#af2f4e21a673879db7f89335ccdc3efdd">ButtonStates</a> <li>bool <a class="el" href="structirr_1_1_s_event_1_1_s_mouse_input.html#a2b0cf7a5d52c4489dbfc739fe62aa354">Control</a>:1 <dl class="el"><dd class="mdescRight">True if ctrl was also pressed. <a href="#a2b0cf7a5d52c4489dbfc739fe62aa354"></a><br/></dl><li><a class="el" href="namespaceirr.html#a2dbf2a247aa17a9eeefbbf36ebd5739f">EMOUSE_INPUT_EVENT</a> <a class="el" href="structirr_1_1_s_event_1_1_s_mouse_input.html#adc389bcfee10b86dc5c6d2f39c4f5acd">Event</a> <dl class="el"><dd class="mdescRight">Type of mouse event. <a href="#adc389bcfee10b86dc5c6d2f39c4f5acd"></a><br/></dl><li>bool <a class="el" href="structirr_1_1_s_event_1_1_s_mouse_input.html#afa1f5dca47f1378ccc27157ba225feda">Shift</a>:1 <dl class="el"><dd class="mdescRight">True if shift was also pressed. <a href="#afa1f5dca47f1378ccc27157ba225feda"></a><br/></dl><li><a class="el" href="namespaceirr.html#a0277be98d67dc26ff93b1a6a1d086b07">f32</a> <a class="el" href="structirr_1_1_s_event_1_1_s_mouse_input.html#a0821c616196a7ffcc574e68c060b6d18">Wheel</a> <dl class="el"><dd class="mdescRight">mouse wheel delta, often 1.0 or -1.0, but can have other values < 0.f or > 0.f; <a href="#a0821c616196a7ffcc574e68c060b6d18"></a><br/></dl><li><a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> <a class="el" href="structirr_1_1_s_event_1_1_s_mouse_input.html#a8d1f2d8281cc8982eff089b580f58e86">X</a> <dl class="el"><dd class="mdescRight">X position of mouse cursor. <a href="#a8d1f2d8281cc8982eff089b580f58e86"></a><br/></dl><li><a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> <a class="el" href="structirr_1_1_s_event_1_1_s_mouse_input.html#a274d984da2c05655589bd13c4e71e5a3">Y</a> <dl class="el"><dd class="mdescRight">Y position of mouse cursor. <a href="#a274d984da2c05655589bd13c4e71e5a3"></a><br/></dl></ul> <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> <div class="textblock"><p>Any kind of mouse event. </p> <p>Definition at line <a class="el" href="_i_event_receiver_8h_source.html#l00279">279</a> of file <a class="el" href="_i_event_receiver_8h_source.html">IEventReceiver.h</a>.</p> </div><hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a7c3fec25a36a285f46897a6350c8fc24"></a><!-- doxytag: member="irr::SEvent::SMouseInput::isLeftPressed" ref="a7c3fec25a36a285f46897a6350c8fc24" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool irr::SEvent::SMouseInput::isLeftPressed </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Is the left button pressed down? </p> <p>Definition at line <a class="el" href="_i_event_receiver_8h_source.html#l00303">303</a> of file <a class="el" href="_i_event_receiver_8h_source.html">IEventReceiver.h</a>.</p> <p>References <a class="el" href="_i_event_receiver_8h_source.html#l00300">ButtonStates</a>, and <a class="el" href="_i_event_receiver_8h_source.html#l00132">irr::EMBSM_LEFT</a>.</p> </div> </div> <a class="anchor" id="a1a93f70157bfad1c15ae2a7c10745432"></a><!-- doxytag: member="irr::SEvent::SMouseInput::isMiddlePressed" ref="a1a93f70157bfad1c15ae2a7c10745432" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool irr::SEvent::SMouseInput::isMiddlePressed </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Is the middle button pressed down? </p> <p>Definition at line <a class="el" href="_i_event_receiver_8h_source.html#l00309">309</a> of file <a class="el" href="_i_event_receiver_8h_source.html">IEventReceiver.h</a>.</p> <p>References <a class="el" href="_i_event_receiver_8h_source.html#l00300">ButtonStates</a>, and <a class="el" href="_i_event_receiver_8h_source.html#l00134">irr::EMBSM_MIDDLE</a>.</p> </div> </div> <a class="anchor" id="a6dc635dc9841455ab2233f469c24c6e9"></a><!-- doxytag: member="irr::SEvent::SMouseInput::isRightPressed" ref="a6dc635dc9841455ab2233f469c24c6e9" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool irr::SEvent::SMouseInput::isRightPressed </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Is the right button pressed down? </p> <p>Definition at line <a class="el" href="_i_event_receiver_8h_source.html#l00306">306</a> of file <a class="el" href="_i_event_receiver_8h_source.html">IEventReceiver.h</a>.</p> <p>References <a class="el" href="_i_event_receiver_8h_source.html#l00300">ButtonStates</a>, and <a class="el" href="_i_event_receiver_8h_source.html#l00133">irr::EMBSM_RIGHT</a>.</p> </div> </div> <hr/><h2>Member Data Documentation</h2> <a class="anchor" id="af2f4e21a673879db7f89335ccdc3efdd"></a><!-- doxytag: member="irr::SEvent::SMouseInput::ButtonStates" ref="af2f4e21a673879db7f89335ccdc3efdd" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> <a class="el" href="structirr_1_1_s_event_1_1_s_mouse_input.html#af2f4e21a673879db7f89335ccdc3efdd">irr::SEvent::SMouseInput::ButtonStates</a></td> </tr> </table> </div> <div class="memdoc"> <p>A bitmap of button states. You can use isButtonPressed() to determine if a button is pressed or not. Currently only valid if the event was EMIE_MOUSE_MOVED </p> <p>Definition at line <a class="el" href="_i_event_receiver_8h_source.html#l00300">300</a> of file <a class="el" href="_i_event_receiver_8h_source.html">IEventReceiver.h</a>.</p> <p>Referenced by <a class="el" href="_i_event_receiver_8h_source.html#l00303">isLeftPressed()</a>, <a class="el" href="_i_event_receiver_8h_source.html#l00309">isMiddlePressed()</a>, and <a class="el" href="_i_event_receiver_8h_source.html#l00306">isRightPressed()</a>.</p> </div> </div> <a class="anchor" id="a2b0cf7a5d52c4489dbfc739fe62aa354"></a><!-- doxytag: member="irr::SEvent::SMouseInput::Control" ref="a2b0cf7a5d52c4489dbfc739fe62aa354" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool <a class="el" href="structirr_1_1_s_event_1_1_s_mouse_input.html#a2b0cf7a5d52c4489dbfc739fe62aa354">irr::SEvent::SMouseInput::Control</a></td> </tr> </table> </div> <div class="memdoc"> <p>True if ctrl was also pressed. </p> <p>Definition at line <a class="el" href="_i_event_receiver_8h_source.html#l00295">295</a> of file <a class="el" href="_i_event_receiver_8h_source.html">IEventReceiver.h</a>.</p> </div> </div> <a class="anchor" id="adc389bcfee10b86dc5c6d2f39c4f5acd"></a><!-- doxytag: member="irr::SEvent::SMouseInput::Event" ref="adc389bcfee10b86dc5c6d2f39c4f5acd" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="namespaceirr.html#a2dbf2a247aa17a9eeefbbf36ebd5739f">EMOUSE_INPUT_EVENT</a> <a class="el" href="structirr_1_1_s_event_1_1_s_mouse_input.html#adc389bcfee10b86dc5c6d2f39c4f5acd">irr::SEvent::SMouseInput::Event</a></td> </tr> </table> </div> <div class="memdoc"> <p>Type of mouse event. </p> <p>Definition at line <a class="el" href="_i_event_receiver_8h_source.html#l00312">312</a> of file <a class="el" href="_i_event_receiver_8h_source.html">IEventReceiver.h</a>.</p> </div> </div> <a class="anchor" id="afa1f5dca47f1378ccc27157ba225feda"></a><!-- doxytag: member="irr::SEvent::SMouseInput::Shift" ref="afa1f5dca47f1378ccc27157ba225feda" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool <a class="el" href="structirr_1_1_s_event_1_1_s_mouse_input.html#afa1f5dca47f1378ccc27157ba225feda">irr::SEvent::SMouseInput::Shift</a></td> </tr> </table> </div> <div class="memdoc"> <p>True if shift was also pressed. </p> <p>Definition at line <a class="el" href="_i_event_receiver_8h_source.html#l00292">292</a> of file <a class="el" href="_i_event_receiver_8h_source.html">IEventReceiver.h</a>.</p> </div> </div> <a class="anchor" id="a0821c616196a7ffcc574e68c060b6d18"></a><!-- doxytag: member="irr::SEvent::SMouseInput::Wheel" ref="a0821c616196a7ffcc574e68c060b6d18" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="namespaceirr.html#a0277be98d67dc26ff93b1a6a1d086b07">f32</a> <a class="el" href="structirr_1_1_s_event_1_1_s_mouse_input.html#a0821c616196a7ffcc574e68c060b6d18">irr::SEvent::SMouseInput::Wheel</a></td> </tr> </table> </div> <div class="memdoc"> <p>mouse wheel delta, often 1.0 or -1.0, but can have other values < 0.f or > 0.f; </p> <p>Only valid if event was EMIE_MOUSE_WHEEL </p> <p>Definition at line <a class="el" href="_i_event_receiver_8h_source.html#l00289">289</a> of file <a class="el" href="_i_event_receiver_8h_source.html">IEventReceiver.h</a>.</p> </div> </div> <a class="anchor" id="a8d1f2d8281cc8982eff089b580f58e86"></a><!-- doxytag: member="irr::SEvent::SMouseInput::X" ref="a8d1f2d8281cc8982eff089b580f58e86" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> <a class="el" href="structirr_1_1_s_event_1_1_s_mouse_input.html#a8d1f2d8281cc8982eff089b580f58e86">irr::SEvent::SMouseInput::X</a></td> </tr> </table> </div> <div class="memdoc"> <p>X position of mouse cursor. </p> <p>Definition at line <a class="el" href="_i_event_receiver_8h_source.html#l00282">282</a> of file <a class="el" href="_i_event_receiver_8h_source.html">IEventReceiver.h</a>.</p> </div> </div> <a class="anchor" id="a274d984da2c05655589bd13c4e71e5a3"></a><!-- doxytag: member="irr::SEvent::SMouseInput::Y" ref="a274d984da2c05655589bd13c4e71e5a3" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="namespaceirr.html#ac66849b7a6ed16e30ebede579f9b47c6">s32</a> <a class="el" href="structirr_1_1_s_event_1_1_s_mouse_input.html#a274d984da2c05655589bd13c4e71e5a3">irr::SEvent::SMouseInput::Y</a></td> </tr> </table> </div> <div class="memdoc"> <p>Y position of mouse cursor. </p> <p>Definition at line <a class="el" href="_i_event_receiver_8h_source.html#l00285">285</a> of file <a class="el" href="_i_event_receiver_8h_source.html">IEventReceiver.h</a>.</p> </div> </div> <hr/>The documentation for this struct was generated from the following file:<ul> <li><a class="el" href="_i_event_receiver_8h_source.html">IEventReceiver.h</a></li> </ul> </div> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="namespaceirr.html">irr</a> </li> <li class="navelem"><a class="el" href="structirr_1_1_s_event.html">SEvent</a> </li> <li class="navelem"><a class="el" href="structirr_1_1_s_event_1_1_s_mouse_input.html">SMouseInput</a> </li> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Defines</a></div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <li class="footer"> <a href="http://irrlicht.sourceforge.net" target="_blank">Irrlicht Engine</a> Documentation © 2003-2012 by Nikolaus Gebhardt. Generated on Sun Nov 17 2013 20:18:43 for Irrlicht 3D Engine by <a href="http://www.doxygen.org/index.html" target="_blank">Doxygen</a> 1.7.5.1 </li> </ul> </div> </body> </html>