<!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>Crystal Space 1.2.1: csJoystickEventHelper Class Reference (Crystal Space 1.2.1 Public API Reference)</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<table border="0" cellpadding="0" cellspacing="0" width="100%" class="head">
<tr height="59">
<td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td>
<td class="head"><h2>Public API Reference</h2></td>
</tr>
<tr height="11">
<td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td>
</tr>
</table>
<div class="content">
<!-- Generated by Doxygen 1.5.3 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<h1>csJoystickEventHelper Class Reference<br>
<small>
[<a class="el" href="group__event__handling.html">Event handling</a>]</small>
</h1><!-- doxytag: class="csJoystickEventHelper" -->Helper class to conveniently deal with joystick events.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="csutil_2event_8h-source.html">csutil/event.h</a>></code>
<p>
<p>
<a href="classcsJoystickEventHelper-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsJoystickEventHelper.html#1f33ce7bb98478d0d68c1a818d768a40">GetAxis</a> (const <a class="el" href="structiEvent.html">iEvent</a> *event, <a class="el" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14">uint</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">retrieve any axis (basis 0) value <a href="#1f33ce7bb98478d0d68c1a818d768a40"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsJoystickEventHelper.html#4f6ea09e8ae0ce385cfcb64a3bfa4494">GetButton</a> (const <a class="el" href="structiEvent.html">iEvent</a> *event)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">retrieve button number <a href="#4f6ea09e8ae0ce385cfcb64a3bfa4494"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsJoystickEventHelper.html#076109c6582331cb9a34aa9492ef503c">GetButtonMask</a> (const <a class="el" href="structiEvent.html">iEvent</a> *event)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve current button mask. <a href="#076109c6582331cb9a34aa9492ef503c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsJoystickEventHelper.html#e12a7ffaa0d2b0dc6692aae781ed3e3d">GetButtonState</a> (const <a class="el" href="structiEvent.html">iEvent</a> *event)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">retrieve button state (pressed/released) <a href="#e12a7ffaa0d2b0dc6692aae781ed3e3d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsJoystickEventHelper.html#73d1a48cec674eeba81426eff8f5cc62">GetEventData</a> (const <a class="el" href="structiEvent.html">iEvent</a> *event, <a class="el" href="structcsJoystickEventData.html">csJoystickEventData</a> &data)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve event data. <a href="#73d1a48cec674eeba81426eff8f5cc62"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsJoystickEventHelper.html#f9f3bf47bef01aad8f7def8a3a106531">GetModifiers</a> (const <a class="el" href="structiEvent.html">iEvent</a> *event)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve modifiers bitmask. <a href="#f9f3bf47bef01aad8f7def8a3a106531"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsJoystickEventHelper.html#c06c2fe68519adf1a0c8bea5aac860c4">GetModifiers</a> (const <a class="el" href="structiEvent.html">iEvent</a> *event, <a class="el" href="struct__csKeyModifiers.html">csKeyModifiers</a> &modifiers)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">retrieve modifier flags <a href="#c06c2fe68519adf1a0c8bea5aac860c4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsJoystickEventHelper.html#55d5e2c1f3f4fa5956f8cc19ce26c26c">GetNumAxes</a> (const <a class="el" href="structiEvent.html">iEvent</a> *)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">retrieve number of axes <a href="#55d5e2c1f3f4fa5956f8cc19ce26c26c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsJoystickEventHelper.html#056b9b1b34c12d8149b1c0274b1dedbd">GetNumber</a> (const <a class="el" href="structiEvent.html">iEvent</a> *event)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve joystick number (0, 1, 2, ...). <a href="#056b9b1b34c12d8149b1c0274b1dedbd"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classcsEvent.html">csEvent</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsJoystickEventHelper.html#35e601bd26f7cb99bf3abb0f8a78c694">NewEvent</a> (<a class="el" href="classcsRef.html">csRef</a>< <a class="el" href="structiEventNameRegistry.html">iEventNameRegistry</a> > &reg, <a class="el" href="group__util.html#g28e82998c4c2d1197a1d412bba7da793">csTicks</a>, <a class="el" href="group__event__handling.html#g51e1762faeeefdadf693499fc93db757">csEventID</a> name, int n, int x, int y, <a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a> axesChanged, <a class="el" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> button, bool buttonState, <a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a> buttonMask, <a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a> modifiers)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create new joystick event. <a href="#35e601bd26f7cb99bf3abb0f8a78c694"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Helper class to conveniently deal with joystick events.
<p>Definition at line <a class="el" href="csutil_2event_8h-source.html#l00154">154</a> of file <a class="el" href="csutil_2event_8h-source.html">event.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="1f33ce7bb98478d0d68c1a818d768a40"></a><!-- doxytag: member="csJoystickEventHelper::GetAxis" ref="1f33ce7bb98478d0d68c1a818d768a40" args="(const iEvent *event, uint)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static int csJoystickEventHelper::GetAxis </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structiEvent.html">iEvent</a> * </td>
<td class="paramname"> <em>event</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> </td>
<td class="paramname"></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
retrieve any axis (basis 0) value
<p>
</div>
</div><p>
<a class="anchor" name="4f6ea09e8ae0ce385cfcb64a3bfa4494"></a><!-- doxytag: member="csJoystickEventHelper::GetButton" ref="4f6ea09e8ae0ce385cfcb64a3bfa4494" args="(const iEvent *event)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> csJoystickEventHelper::GetButton </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structiEvent.html">iEvent</a> * </td>
<td class="paramname"> <em>event</em> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
retrieve button number
<p>
</div>
</div><p>
<a class="anchor" name="076109c6582331cb9a34aa9492ef503c"></a><!-- doxytag: member="csJoystickEventHelper::GetButtonMask" ref="076109c6582331cb9a34aa9492ef503c" args="(const iEvent *event)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a> csJoystickEventHelper::GetButtonMask </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structiEvent.html">iEvent</a> * </td>
<td class="paramname"> <em>event</em> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Retrieve current button mask.
<p>
</div>
</div><p>
<a class="anchor" name="e12a7ffaa0d2b0dc6692aae781ed3e3d"></a><!-- doxytag: member="csJoystickEventHelper::GetButtonState" ref="e12a7ffaa0d2b0dc6692aae781ed3e3d" args="(const iEvent *event)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static bool csJoystickEventHelper::GetButtonState </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structiEvent.html">iEvent</a> * </td>
<td class="paramname"> <em>event</em> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
retrieve button state (pressed/released)
<p>
</div>
</div><p>
<a class="anchor" name="73d1a48cec674eeba81426eff8f5cc62"></a><!-- doxytag: member="csJoystickEventHelper::GetEventData" ref="73d1a48cec674eeba81426eff8f5cc62" args="(const iEvent *event, csJoystickEventData &data)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static bool csJoystickEventHelper::GetEventData </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structiEvent.html">iEvent</a> * </td>
<td class="paramname"> <em>event</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structcsJoystickEventData.html">csJoystickEventData</a> & </td>
<td class="paramname"> <em>data</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Retrieve event data.
<p>
</div>
</div><p>
<a class="anchor" name="f9f3bf47bef01aad8f7def8a3a106531"></a><!-- doxytag: member="csJoystickEventHelper::GetModifiers" ref="f9f3bf47bef01aad8f7def8a3a106531" args="(const iEvent *event)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a> csJoystickEventHelper::GetModifiers </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structiEvent.html">iEvent</a> * </td>
<td class="paramname"> <em>event</em> </td>
<td> ) </td>
<td width="100%"><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Retrieve modifiers bitmask.
<p>
<p>Definition at line <a class="el" href="csutil_2event_8h-source.html#l00183">183</a> of file <a class="el" href="csutil_2event_8h-source.html">event.h</a>.</p>
<p>References <a class="el" href="classcsKeyEventHelper.html#34b0d20268575c6d02c4a09e3181e57f">csKeyEventHelper::GetModifiers()</a>, and <a class="el" href="classcsKeyEventHelper.html#cbf0a3254b47e6c0fe1d02c9570535d7">csKeyEventHelper::GetModifiersBits()</a>.</p>
</div>
</div><p>
<a class="anchor" name="c06c2fe68519adf1a0c8bea5aac860c4"></a><!-- doxytag: member="csJoystickEventHelper::GetModifiers" ref="c06c2fe68519adf1a0c8bea5aac860c4" args="(const iEvent *event, csKeyModifiers &modifiers)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void csJoystickEventHelper::GetModifiers </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structiEvent.html">iEvent</a> * </td>
<td class="paramname"> <em>event</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct__csKeyModifiers.html">csKeyModifiers</a> & </td>
<td class="paramname"> <em>modifiers</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
retrieve modifier flags
<p>
<p>Definition at line <a class="el" href="csutil_2event_8h-source.html#l00180">180</a> of file <a class="el" href="csutil_2event_8h-source.html">event.h</a>.</p>
<p>References <a class="el" href="classcsKeyEventHelper.html#34b0d20268575c6d02c4a09e3181e57f">csKeyEventHelper::GetModifiers()</a>.</p>
</div>
</div><p>
<a class="anchor" name="55d5e2c1f3f4fa5956f8cc19ce26c26c"></a><!-- doxytag: member="csJoystickEventHelper::GetNumAxes" ref="55d5e2c1f3f4fa5956f8cc19ce26c26c" args="(const iEvent *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> csJoystickEventHelper::GetNumAxes </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structiEvent.html">iEvent</a> * </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
retrieve number of axes
<p>
</div>
</div><p>
<a class="anchor" name="056b9b1b34c12d8149b1c0274b1dedbd"></a><!-- doxytag: member="csJoystickEventHelper::GetNumber" ref="056b9b1b34c12d8149b1c0274b1dedbd" args="(const iEvent *event)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> csJoystickEventHelper::GetNumber </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structiEvent.html">iEvent</a> * </td>
<td class="paramname"> <em>event</em> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Retrieve joystick number (0, 1, 2, ...).
<p>
</div>
</div><p>
<a class="anchor" name="35e601bd26f7cb99bf3abb0f8a78c694"></a><!-- doxytag: member="csJoystickEventHelper::NewEvent" ref="35e601bd26f7cb99bf3abb0f8a78c694" args="(csRef< iEventNameRegistry > &reg, csTicks, csEventID name, int n, int x, int y, uint32 axesChanged, uint button, bool buttonState, uint32 buttonMask, uint32 modifiers)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classcsEvent.html">csEvent</a>* csJoystickEventHelper::NewEvent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classcsRef.html">csRef</a>< <a class="el" href="structiEventNameRegistry.html">iEventNameRegistry</a> > & </td>
<td class="paramname"> <em>reg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__util.html#g28e82998c4c2d1197a1d412bba7da793">csTicks</a> </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__event__handling.html#g51e1762faeeefdadf693499fc93db757">csEventID</a> </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>n</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a> </td>
<td class="paramname"> <em>axesChanged</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> </td>
<td class="paramname"> <em>button</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>buttonState</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a> </td>
<td class="paramname"> <em>buttonMask</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a> </td>
<td class="paramname"> <em>modifiers</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create new joystick event.
<p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>csutil/<a class="el" href="csutil_2event_8h-source.html">event.h</a></ul>
<hr size="1"><address><small>Generated for Crystal Space 1.2.1 by
<a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3
</small></address> </div></body> </html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
bad97183153701b09df5fae1052b1c30
>
files
>
699
