Sophie

Sophie

distrib > Mandriva > 2010.1 > x86_64 > media > contrib-release > by-pkgid > 58828b263d8f56d90ac336dea07a4586 > files > 944

irrlicht-doc-1.6.1-1mdv2010.1.x86_64.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Irrlicht Engine: irr::SEvent::SMouseInput Struct Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<table class="irrlicht" >
  <tr valign="middle"> 
    <td><font size="2"><a class="qindex" href="index.html"><font color="#FFFFFF">Home</font></a> 
      | <a class="qindex" href="namespaces.html"><font color="#FFFFFF">Namespaces</font></a> 
      | <a class="qindex" href="hierarchy.html"><font color="#FFFFFF">Hierarchy</font></a> 
      | <a class="qindex" href="classes.html"><font color="#FFFFFF">Alphabetical 
      List</font></a> | <a class="qindex" href="annotated.html"><font color="#FFFFFF"> 
      Class list</font></a> | <a class="qindex" href="files.html"><font color="#FFFFFF">Files</font></a> 
      | <a class="qindex" href="namespacemembers.html"><font color="#FFFFFF"> 
      Namespace&nbsp;Members</font></a> | <a class="qindex" href="functions.html"><font color="#FFFFFF">Class 
      members</font></a> | <a class="qindex" href="globals.html"><font color="#FFFFFF">File 
      members</font></a> | <a class="qindex" href="pages.html"><font color="#FFFFFF">Tutorials</font></a></font> </td>
  </tr>
</table>
<!-- Generated by Doxygen 1.5.6 -->
  <div class="navpath"><a class="el" href="namespaceirr.html">irr</a>::<a class="el" href="structirr_1_1_s_event.html">SEvent</a>::<a class="el" href="structirr_1_1_s_event_1_1_s_mouse_input.html">SMouseInput</a>
  </div>
<div class="contents">
<h1>irr::SEvent::SMouseInput Struct Reference</h1><!-- doxytag: class="irr::SEvent::SMouseInput" -->Any kind of mouse event.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="_i_event_receiver_8h-source.html">IEventReceiver.h</a>&gt;</code>
<p>

<p>
<a href="structirr_1_1_s_event_1_1_s_mouse_input-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structirr_1_1_s_event_1_1_s_mouse_input.html#7c3fec25a36a285f46897a6350c8fc24">isLeftPressed</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Is the left button pressed down?  <a href="#7c3fec25a36a285f46897a6350c8fc24"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structirr_1_1_s_event_1_1_s_mouse_input.html#1a93f70157bfad1c15ae2a7c10745432">isMiddlePressed</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Is the middle button pressed down?  <a href="#1a93f70157bfad1c15ae2a7c10745432"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structirr_1_1_s_event_1_1_s_mouse_input.html#6dc635dc9841455ab2233f469c24c6e9">isRightPressed</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Is the right button pressed down?  <a href="#6dc635dc9841455ab2233f469c24c6e9"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceirr.html#0416a53257075833e7002efd0a18e804">u32</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structirr_1_1_s_event_1_1_s_mouse_input.html#f2f4e21a673879db7f89335ccdc3efdd">ButtonStates</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structirr_1_1_s_event_1_1_s_mouse_input.html#2b0cf7a5d52c4489dbfc739fe62aa354">Control</a>:1</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">True if ctrl was also pressed.  <a href="#2b0cf7a5d52c4489dbfc739fe62aa354"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceirr.html#2dbf2a247aa17a9eeefbbf36ebd5739f">EMOUSE_INPUT_EVENT</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structirr_1_1_s_event_1_1_s_mouse_input.html#dc389bcfee10b86dc5c6d2f39c4f5acd">Event</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Type of mouse event.  <a href="#dc389bcfee10b86dc5c6d2f39c4f5acd"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structirr_1_1_s_event_1_1_s_mouse_input.html#fa1f5dca47f1378ccc27157ba225feda">Shift</a>:1</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">True if shift was also pressed.  <a href="#fa1f5dca47f1378ccc27157ba225feda"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceirr.html#0277be98d67dc26ff93b1a6a1d086b07">f32</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structirr_1_1_s_event_1_1_s_mouse_input.html#0821c616196a7ffcc574e68c060b6d18">Wheel</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">mouse wheel delta, usually 1.0 or -1.0.  <a href="#0821c616196a7ffcc574e68c060b6d18"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceirr.html#c66849b7a6ed16e30ebede579f9b47c6">s32</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structirr_1_1_s_event_1_1_s_mouse_input.html#8d1f2d8281cc8982eff089b580f58e86">X</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">X position of mouse cursor.  <a href="#8d1f2d8281cc8982eff089b580f58e86"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceirr.html#c66849b7a6ed16e30ebede579f9b47c6">s32</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structirr_1_1_s_event_1_1_s_mouse_input.html#274d984da2c05655589bd13c4e71e5a3">Y</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Y position of mouse cursor.  <a href="#274d984da2c05655589bd13c4e71e5a3"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Any kind of mouse event. 
<p>Definition at line <a class="el" href="_i_event_receiver_8h-source.html#l00256">256</a> of file <a class="el" href="_i_event_receiver_8h-source.html">IEventReceiver.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="7c3fec25a36a285f46897a6350c8fc24"></a><!-- doxytag: member="irr::SEvent::SMouseInput::isLeftPressed" ref="7c3fec25a36a285f46897a6350c8fc24" 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>&nbsp;)&nbsp;</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#l00280">280</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#l00277">ButtonStates</a>, and <a class="el" href="_i_event_receiver_8h-source.html#l00117">irr::EMBSM_LEFT</a>.</p>

</div>
</div><p>
<a class="anchor" name="1a93f70157bfad1c15ae2a7c10745432"></a><!-- doxytag: member="irr::SEvent::SMouseInput::isMiddlePressed" ref="1a93f70157bfad1c15ae2a7c10745432" 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>&nbsp;)&nbsp;</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#l00286">286</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#l00277">ButtonStates</a>, and <a class="el" href="_i_event_receiver_8h-source.html#l00119">irr::EMBSM_MIDDLE</a>.</p>

</div>
</div><p>
<a class="anchor" name="6dc635dc9841455ab2233f469c24c6e9"></a><!-- doxytag: member="irr::SEvent::SMouseInput::isRightPressed" ref="6dc635dc9841455ab2233f469c24c6e9" 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>&nbsp;)&nbsp;</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#l00283">283</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#l00277">ButtonStates</a>, and <a class="el" href="_i_event_receiver_8h-source.html#l00118">irr::EMBSM_RIGHT</a>.</p>

</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="f2f4e21a673879db7f89335ccdc3efdd"></a><!-- doxytag: member="irr::SEvent::SMouseInput::ButtonStates" ref="f2f4e21a673879db7f89335ccdc3efdd" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="namespaceirr.html#0416a53257075833e7002efd0a18e804">u32</a> <a class="el" href="structirr_1_1_s_event_1_1_s_mouse_input.html#f2f4e21a673879db7f89335ccdc3efdd">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>Definition at line <a class="el" href="_i_event_receiver_8h-source.html#l00277">277</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#l00280">isLeftPressed()</a>, <a class="el" href="_i_event_receiver_8h-source.html#l00286">isMiddlePressed()</a>, and <a class="el" href="_i_event_receiver_8h-source.html#l00283">isRightPressed()</a>.</p>

</div>
</div><p>
<a class="anchor" name="2b0cf7a5d52c4489dbfc739fe62aa354"></a><!-- doxytag: member="irr::SEvent::SMouseInput::Control" ref="2b0cf7a5d52c4489dbfc739fe62aa354" 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#2b0cf7a5d52c4489dbfc739fe62aa354">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#l00272">272</a> of file <a class="el" href="_i_event_receiver_8h-source.html">IEventReceiver.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="dc389bcfee10b86dc5c6d2f39c4f5acd"></a><!-- doxytag: member="irr::SEvent::SMouseInput::Event" ref="dc389bcfee10b86dc5c6d2f39c4f5acd" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="namespaceirr.html#2dbf2a247aa17a9eeefbbf36ebd5739f">EMOUSE_INPUT_EVENT</a> <a class="el" href="structirr_1_1_s_event_1_1_s_mouse_input.html#dc389bcfee10b86dc5c6d2f39c4f5acd">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#l00289">289</a> of file <a class="el" href="_i_event_receiver_8h-source.html">IEventReceiver.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="fa1f5dca47f1378ccc27157ba225feda"></a><!-- doxytag: member="irr::SEvent::SMouseInput::Shift" ref="fa1f5dca47f1378ccc27157ba225feda" 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#fa1f5dca47f1378ccc27157ba225feda">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#l00269">269</a> of file <a class="el" href="_i_event_receiver_8h-source.html">IEventReceiver.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="0821c616196a7ffcc574e68c060b6d18"></a><!-- doxytag: member="irr::SEvent::SMouseInput::Wheel" ref="0821c616196a7ffcc574e68c060b6d18" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="namespaceirr.html#0277be98d67dc26ff93b1a6a1d086b07">f32</a> <a class="el" href="structirr_1_1_s_event_1_1_s_mouse_input.html#0821c616196a7ffcc574e68c060b6d18">irr::SEvent::SMouseInput::Wheel</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
mouse wheel delta, usually 1.0 or -1.0. 
<p>
Only valid if event was EMIE_MOUSE_WHEEL 
<p>Definition at line <a class="el" href="_i_event_receiver_8h-source.html#l00266">266</a> of file <a class="el" href="_i_event_receiver_8h-source.html">IEventReceiver.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="8d1f2d8281cc8982eff089b580f58e86"></a><!-- doxytag: member="irr::SEvent::SMouseInput::X" ref="8d1f2d8281cc8982eff089b580f58e86" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="namespaceirr.html#c66849b7a6ed16e30ebede579f9b47c6">s32</a> <a class="el" href="structirr_1_1_s_event_1_1_s_mouse_input.html#8d1f2d8281cc8982eff089b580f58e86">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#l00259">259</a> of file <a class="el" href="_i_event_receiver_8h-source.html">IEventReceiver.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="274d984da2c05655589bd13c4e71e5a3"></a><!-- doxytag: member="irr::SEvent::SMouseInput::Y" ref="274d984da2c05655589bd13c4e71e5a3" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="namespaceirr.html#c66849b7a6ed16e30ebede579f9b47c6">s32</a> <a class="el" href="structirr_1_1_s_event_1_1_s_mouse_input.html#274d984da2c05655589bd13c4e71e5a3">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#l00262">262</a> of file <a class="el" href="_i_event_receiver_8h-source.html">IEventReceiver.h</a>.</p>

</div>
</div><p>
<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></ul>
</div>
<hr size="1">
<address style="align: right;">
<small> </small>
</address>
<table width="100%" border="0" cellspacing="0" cellpadding="2">
  <tr> 
    <td width="0"> <div align="left"><small><a href="http://irrlicht.sourceforge.net" target="_blank"><img src="irrlicht.png" alt="The Irrlicht Engine" align="middle" border=0 width=88 height=31></a></small></div></td>
    <td> <div align="left"><small><em><font size="2">The <a href="http://irrlicht.sourceforge.net" target="_blank">Irrlicht 
        Engine</a> Documentation &copy; 2003-2009 by Nikolaus Gebhardt. Generated 
        on Sun Jan 10 09:24:09 2010 by <a href="http://www.doxygen.org" target="_blank">Doxygen</a> 
        (1.5.6)</font></em></small></div></td>
  </tr>
</table>
<address style="align: right;">
</address>
</body>
</html>