<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>mrpt::hwdrivers::CJoystick Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<div align="left"><a href="http://www.mrpt.org/">Main MRPT website</a> > <b>C++ reference</b> </div>
<div align="right">
<a href="index.html"><img border="0" src="mrpt_logo.png" alt="MRPT logo"></a>
</div>
<!-- Generated by Doxygen 1.7.5 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</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="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<div class="left">
<form id="FSearchBox" action="search.php" method="get">
<img id="MSearchSelect" src="search/mag.png" alt=""/>
<input type="text" id="MSearchField" name="query" value="Search" size="20" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"/>
</form>
</div><div class="right"></div>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacemrpt.html">mrpt</a> </li>
<li class="navelem"><a class="el" href="namespacemrpt_1_1hwdrivers.html">hwdrivers</a> </li>
<li class="navelem"><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_joystick.html">CJoystick</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#pri-attribs">Private Attributes</a> </div>
<div class="headertitle">
<div class="title">mrpt::hwdrivers::CJoystick Class Reference<div class="ingroups"><a class="el" href="group__mrpt__hwdrivers__grp.html">[mrpt-hwdrivers]</a></div></div> </div>
</div>
<div class="contents">
<!-- doxytag: class="mrpt::hwdrivers::CJoystick" --><hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Access to joysticks and gamepads (read buttons and position), and request number of joysticks in the system. </p>
</div>
<p><code>#include <<a class="el" href="_c_joystick_8h_source.html">mrpt/hwdrivers/CJoystick.h</a>></code></p>
<p><a href="classmrpt_1_1hwdrivers_1_1_c_joystick-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_joystick.html#a860acd657b148ebb68d715653b990a0e">CJoystick</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a860acd657b148ebb68d715653b990a0e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_joystick.html#a970f7d552f631fac1abcf2e2282ed96b">~CJoystick</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a970f7d552f631fac1abcf2e2282ed96b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_joystick.html#a44c0db295ce5a5cda14ec39acbdeb4b4">getJoystickPosition</a> (int nJoy, float &x, float &y, float &z, <a class="el" href="classstd_1_1vector.html">std::vector</a>< bool > &buttons, int *raw_x_pos=NULL, int *raw_y_pos=NULL, int *raw_z_pos=NULL)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets joystick information. <a href="#a44c0db295ce5a5cda14ec39acbdeb4b4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_joystick.html#a1ae2426a4296ea357184f10e83768e27">setLimits</a> (int x_min=-32767, int x_max=32767, int y_min=-32767, int y_max=32767, int z_min=-32767, int z_max=32767)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the axis limit values, for computing a [-1,1] position index easily (Only required to calibrate analog joystick). <a href="#a1ae2426a4296ea357184f10e83768e27"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_joystick.html#a5c2d962d101edb277ab0c3108e7ee83b">getJoysticksCount</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of Joysticks in the computer. <a href="#a5c2d962d101edb277ab0c3108e7ee83b"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_joystick.html#a3e778d5a454d8d5d3505f787fa7797bb">m_x_min</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The axis limits: <a href="#a3e778d5a454d8d5d3505f787fa7797bb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_joystick.html#aa232e9b2031a14f6eba73344cbb8b2ab">m_x_max</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_joystick.html#a110c5234308765b08f5d86c08af123c4">m_y_min</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_joystick.html#a1f53bde0b4f278f021c4bc540c388924">m_y_max</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_joystick.html#a3d2b0a01cc1ca57477cdd7c3f191841f">m_z_min</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_joystick.html#a0975a014982ee3ef889f706245e6e9dc">m_z_max</a></td></tr>
</table>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a860acd657b148ebb68d715653b990a0e"></a><!-- doxytag: member="mrpt::hwdrivers::CJoystick::CJoystick" ref="a860acd657b148ebb68d715653b990a0e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mrpt::hwdrivers::CJoystick::CJoystick </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor. </p>
</div>
</div>
<a class="anchor" id="a970f7d552f631fac1abcf2e2282ed96b"></a><!-- doxytag: member="mrpt::hwdrivers::CJoystick::~CJoystick" ref="a970f7d552f631fac1abcf2e2282ed96b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual mrpt::hwdrivers::CJoystick::~CJoystick </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a44c0db295ce5a5cda14ec39acbdeb4b4"></a><!-- doxytag: member="mrpt::hwdrivers::CJoystick::getJoystickPosition" ref="a44c0db295ce5a5cda14ec39acbdeb4b4" args="(int nJoy, float &x, float &y, float &z, std::vector< bool > &buttons, int *raw_x_pos=NULL, int *raw_y_pos=NULL, int *raw_z_pos=NULL)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool mrpt::hwdrivers::CJoystick::getJoystickPosition </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>nJoy</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float & </td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float & </td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float & </td>
<td class="paramname"><em>z</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classstd_1_1vector.html">std::vector</a>< bool > & </td>
<td class="paramname"><em>buttons</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>raw_x_pos</em> = <code>NULL</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>raw_y_pos</em> = <code>NULL</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>raw_z_pos</em> = <code>NULL</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets joystick information. </p>
<p>This method will try first to open the joystick, so you can safely call it while the joystick is plugged and removed arbitrarly.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">nJoy</td><td>The index of the joystick to query: The first one is 0, the second 1, etc... See <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_joystick.html#a5c2d962d101edb277ab0c3108e7ee83b" title="Returns the number of Joysticks in the computer.">CJoystick::getJoysticksCount</a> to discover the number of joysticks in the system. </td></tr>
<tr><td class="paramname">x</td><td>The x axis position, range [-1,1] </td></tr>
<tr><td class="paramname">y</td><td>The y axis position, range [-1,1] </td></tr>
<tr><td class="paramname">z</td><td>The z axis position, range [-1,1] </td></tr>
<tr><td class="paramname">buttons</td><td>Each element will hold true if buttons are pressed. The size of the vector will be set automatically to the number of buttons. </td></tr>
<tr><td class="paramname">raw_x_pos</td><td>If it is desired the raw integer measurement from JoyStick, set this pointer to a desired placeholder. </td></tr>
<tr><td class="paramname">raw_y_pos</td><td>If it is desired the raw integer measurement from JoyStick, set this pointer to a desired placeholder. </td></tr>
<tr><td class="paramname">raw_z_pos</td><td>If it is desired the raw integer measurement from JoyStick, set this pointer to a desired placeholder.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns true if successfull, false on error, for example, if joystick is not present.</dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_joystick.html#a1ae2426a4296ea357184f10e83768e27" title="Set the axis limit values, for computing a [-1,1] position index easily (Only required to calibrate a...">setLimits</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a5c2d962d101edb277ab0c3108e7ee83b"></a><!-- doxytag: member="mrpt::hwdrivers::CJoystick::getJoysticksCount" ref="a5c2d962d101edb277ab0c3108e7ee83b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static int mrpt::hwdrivers::CJoystick::getJoysticksCount </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the number of Joysticks in the computer. </p>
</div>
</div>
<a class="anchor" id="a1ae2426a4296ea357184f10e83768e27"></a><!-- doxytag: member="mrpt::hwdrivers::CJoystick::setLimits" ref="a1ae2426a4296ea357184f10e83768e27" args="(int x_min=-32767, int x_max=32767, int y_min=-32767, int y_max=32767, int z_min=-32767, int z_max=32767)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mrpt::hwdrivers::CJoystick::setLimits </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>x_min</em> = <code>-32767</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>x_max</em> = <code>32767</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>y_min</em> = <code>-32767</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>y_max</em> = <code>32767</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>z_min</em> = <code>-32767</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>z_max</em> = <code>32767</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the axis limit values, for computing a [-1,1] position index easily (Only required to calibrate analog joystick). </p>
<p>It seems that these values must been calibrated for each joystick model.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classmrpt_1_1hwdrivers_1_1_c_joystick.html#a44c0db295ce5a5cda14ec39acbdeb4b4" title="Gets joystick information.">getJoystickPosition</a> </dd></dl>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="aa232e9b2031a14f6eba73344cbb8b2ab"></a><!-- doxytag: member="mrpt::hwdrivers::CJoystick::m_x_max" ref="aa232e9b2031a14f6eba73344cbb8b2ab" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_joystick.html#aa232e9b2031a14f6eba73344cbb8b2ab">mrpt::hwdrivers::CJoystick::m_x_max</a><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_c_joystick_8h_source.html#l00050">50</a> of file <a class="el" href="_c_joystick_8h_source.html">CJoystick.h</a>.</p>
</div>
</div>
<a class="anchor" id="a3e778d5a454d8d5d3505f787fa7797bb"></a><!-- doxytag: member="mrpt::hwdrivers::CJoystick::m_x_min" ref="a3e778d5a454d8d5d3505f787fa7797bb" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_joystick.html#a3e778d5a454d8d5d3505f787fa7797bb">mrpt::hwdrivers::CJoystick::m_x_min</a><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The axis limits: </p>
<p>Definition at line <a class="el" href="_c_joystick_8h_source.html#l00050">50</a> of file <a class="el" href="_c_joystick_8h_source.html">CJoystick.h</a>.</p>
</div>
</div>
<a class="anchor" id="a1f53bde0b4f278f021c4bc540c388924"></a><!-- doxytag: member="mrpt::hwdrivers::CJoystick::m_y_max" ref="a1f53bde0b4f278f021c4bc540c388924" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_joystick.html#a1f53bde0b4f278f021c4bc540c388924">mrpt::hwdrivers::CJoystick::m_y_max</a><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_c_joystick_8h_source.html#l00050">50</a> of file <a class="el" href="_c_joystick_8h_source.html">CJoystick.h</a>.</p>
</div>
</div>
<a class="anchor" id="a110c5234308765b08f5d86c08af123c4"></a><!-- doxytag: member="mrpt::hwdrivers::CJoystick::m_y_min" ref="a110c5234308765b08f5d86c08af123c4" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_joystick.html#a110c5234308765b08f5d86c08af123c4">mrpt::hwdrivers::CJoystick::m_y_min</a><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_c_joystick_8h_source.html#l00050">50</a> of file <a class="el" href="_c_joystick_8h_source.html">CJoystick.h</a>.</p>
</div>
</div>
<a class="anchor" id="a0975a014982ee3ef889f706245e6e9dc"></a><!-- doxytag: member="mrpt::hwdrivers::CJoystick::m_z_max" ref="a0975a014982ee3ef889f706245e6e9dc" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_joystick.html#a0975a014982ee3ef889f706245e6e9dc">mrpt::hwdrivers::CJoystick::m_z_max</a><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_c_joystick_8h_source.html#l00050">50</a> of file <a class="el" href="_c_joystick_8h_source.html">CJoystick.h</a>.</p>
</div>
</div>
<a class="anchor" id="a3d2b0a01cc1ca57477cdd7c3f191841f"></a><!-- doxytag: member="mrpt::hwdrivers::CJoystick::m_z_min" ref="a3d2b0a01cc1ca57477cdd7c3f191841f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_joystick.html#a3d2b0a01cc1ca57477cdd7c3f191841f">mrpt::hwdrivers::CJoystick::m_z_min</a><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_c_joystick_8h_source.html#l00050">50</a> of file <a class="el" href="_c_joystick_8h_source.html">CJoystick.h</a>.</p>
</div>
</div>
</div>
<br><hr><br> <table border="0" width="100%"> <tr> <td> Page generated by <a href="http://www.doxygen.org" target="_blank">Doxygen 1.7.5</a> for MRPT 0.9.5 SVN: at Sun Sep 25 17:20:18 UTC 2011</td><td></td> <td width="100"> </td> <td width="150"> </td></tr> </table> </body></html>
