Files
Bomberman/classRAY_1_1Controller_1_1Mouse.html
2021-06-26 11:31:13 +00:00

296 lines
13 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Bomberman: RAY::Controller::Mouse Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Bomberman
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</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>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceRAY.html">RAY</a></li><li class="navelem"><a class="el" href="namespaceRAY_1_1Controller.html">Controller</a></li><li class="navelem"><a class="el" href="classRAY_1_1Controller_1_1Mouse.html">Mouse</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="classRAY_1_1Controller_1_1Mouse-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">RAY::Controller::Mouse Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="classRAY_1_1Controller_1_1Mouse.html" title="Mouse event manager.">Mouse</a> event manager.
<a href="classRAY_1_1Controller_1_1Mouse.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="Mouse_8hpp_source.html">Mouse.hpp</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for RAY::Controller::Mouse:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classRAY_1_1Controller_1_1Mouse__coll__graph.svg" width="179" height="147"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:ab48958256b79581774bb40d60d82a11f"><td class="memItemLeft" align="right" valign="top">typedef ::MouseButton&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRAY_1_1Controller_1_1Mouse.html#ab48958256b79581774bb40d60d82a11f">Button</a></td></tr>
<tr class="separator:ab48958256b79581774bb40d60d82a11f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:ac6cddf1adb641269158f9a14749614ee"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRAY_1_1Controller_1_1Mouse.html#ac6cddf1adb641269158f9a14749614ee">isPressed</a> (<a class="el" href="classRAY_1_1Controller_1_1Mouse.html#ab48958256b79581774bb40d60d82a11f">Button</a>)</td></tr>
<tr class="separator:ac6cddf1adb641269158f9a14749614ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab0d758d7410ef6277a588ddb55b9c397"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRAY_1_1Controller_1_1Mouse.html#ab0d758d7410ef6277a588ddb55b9c397">isDown</a> (<a class="el" href="classRAY_1_1Controller_1_1Mouse.html#ab48958256b79581774bb40d60d82a11f">Button</a>)</td></tr>
<tr class="separator:ab0d758d7410ef6277a588ddb55b9c397"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad6f414229432b440e45f372b9367820c"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRAY_1_1Controller_1_1Mouse.html#ad6f414229432b440e45f372b9367820c">isReleased</a> (<a class="el" href="classRAY_1_1Controller_1_1Mouse.html#ab48958256b79581774bb40d60d82a11f">Button</a>)</td></tr>
<tr class="separator:ad6f414229432b440e45f372b9367820c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a10a338b47042eb2a39dc28c75ffbae78"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRAY_1_1Controller_1_1Mouse.html#a10a338b47042eb2a39dc28c75ffbae78">isUp</a> (<a class="el" href="classRAY_1_1Controller_1_1Mouse.html#ab48958256b79581774bb40d60d82a11f">Button</a>)</td></tr>
<tr class="separator:a10a338b47042eb2a39dc28c75ffbae78"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afd1d5cdcc68ed759831ecf6645d1559d"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classRAY_1_1Vector2.html">RAY::Vector2</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRAY_1_1Controller_1_1Mouse.html#afd1d5cdcc68ed759831ecf6645d1559d">getCursorPosition</a> (void)</td></tr>
<tr class="separator:afd1d5cdcc68ed759831ecf6645d1559d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classRAY_1_1Controller_1_1Mouse.html" title="Mouse event manager.">Mouse</a> event manager. </p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="ab48958256b79581774bb40d60d82a11f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab48958256b79581774bb40d60d82a11f">&#9670;&nbsp;</a></span>Button</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef ::MouseButton <a class="el" href="classRAY_1_1Controller_1_1Mouse.html#ab48958256b79581774bb40d60d82a11f">RAY::Controller::Mouse::Button</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="afd1d5cdcc68ed759831ecf6645d1559d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afd1d5cdcc68ed759831ecf6645d1559d">&#9670;&nbsp;</a></span>getCursorPosition()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classRAY_1_1Vector2.html">RAY::Vector2</a> RAY::Controller::Mouse::getCursorPosition </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>A 2D vector holding the current position of the cursor </dd></dl>
</div>
</div>
<a id="ab0d758d7410ef6277a588ddb55b9c397"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab0d758d7410ef6277a588ddb55b9c397">&#9670;&nbsp;</a></span>isDown()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool RAY::Controller::Mouse::isDown </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classRAY_1_1Controller_1_1Mouse.html#ab48958256b79581774bb40d60d82a11f">Button</a>&#160;</td>
<td class="paramname"><em>button</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>true if Key is down on the keyboard </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">Key</td><td>The keycode of the key </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ac6cddf1adb641269158f9a14749614ee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac6cddf1adb641269158f9a14749614ee">&#9670;&nbsp;</a></span>isPressed()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool RAY::Controller::Mouse::isPressed </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classRAY_1_1Controller_1_1Mouse.html#ab48958256b79581774bb40d60d82a11f">Button</a>&#160;</td>
<td class="paramname"><em>button</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>true if Key is pressed on the keyboard </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">Key</td><td>The keycode of the key </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ad6f414229432b440e45f372b9367820c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad6f414229432b440e45f372b9367820c">&#9670;&nbsp;</a></span>isReleased()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool RAY::Controller::Mouse::isReleased </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classRAY_1_1Controller_1_1Mouse.html#ab48958256b79581774bb40d60d82a11f">Button</a>&#160;</td>
<td class="paramname"><em>button</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>true if Key is released on the keyboard </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">Key</td><td>The keycode of the key </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a10a338b47042eb2a39dc28c75ffbae78"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a10a338b47042eb2a39dc28c75ffbae78">&#9670;&nbsp;</a></span>isUp()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool RAY::Controller::Mouse::isUp </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classRAY_1_1Controller_1_1Mouse.html#ab48958256b79581774bb40d60d82a11f">Button</a>&#160;</td>
<td class="paramname"><em>button</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>true if Key is up on the keyboard </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">Key</td><td>The keycode of the key </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>lib/Ray/sources/Controllers/<a class="el" href="Mouse_8hpp_source.html">Mouse.hpp</a></li>
<li>lib/Ray/sources/Controllers/<a class="el" href="Mouse_8cpp.html">Mouse.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>