mirror of
https://github.com/Nimac0/SDL_Minigame
synced 2026-01-12 09:03:42 +00:00
247 lines
14 KiB
HTML
247 lines
14 KiB
HTML
<!-- HTML header for doxygen 1.10.0-->
|
|
<!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" lang="en-US">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8" />
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11" />
|
|
<meta name="generator" content="Doxygen 1.13.2" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
|
<title>VEGO-Engine: InputManager 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>
|
|
<script type="text/javascript" src="clipboard.js"></script>
|
|
<script type="text/javascript" src="doxygen-awesome-darkmode-toggle.js"></script>
|
|
<script type="text/javascript">
|
|
DoxygenAwesomeDarkModeToggle.init()
|
|
</script>
|
|
<script type="text/javascript" src="doxygen-awesome-fragment-copy-button.js"></script>
|
|
<script type="text/javascript">
|
|
DoxygenAwesomeFragmentCopyButton.init()
|
|
</script>
|
|
<script type="text/javascript" src="doxygen-awesome-paragraph-link.js"></script>
|
|
<script type="text/javascript">
|
|
DoxygenAwesomeParagraphLink.init()
|
|
</script>
|
|
<script type="text/javascript" src="doxygen-awesome-interactive-toc.js"></script>
|
|
<script type="text/javascript">
|
|
DoxygenAwesomeInteractiveToc.init()
|
|
</script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="cookie.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" />
|
|
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
|
|
<link href="doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>
|
|
<link href="doxygen-awesome-sidebar-only-darkmode-toggle.css" rel="stylesheet" type="text/css"/>
|
|
<link href="custom.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 id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">VEGO-Engine
|
|
<span id="projectnumber"> 0.1</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.13.2 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() { codefold.init(0); });
|
|
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search',true);
|
|
$(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function(){initNavTree('classInputManager.html',''); initResizable(true); });
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- 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">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#nested-classes">Classes</a> |
|
|
<a href="#pub-types">Public Types</a> |
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="classInputManager-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">InputManager Class Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><a class="el" href="classInputManager.html" title="InputManager class to handle input events and actions.">InputManager</a> class to handle input events and actions.
|
|
<a href="#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="InputManager_8h_source.html">InputManager.h</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
|
|
Classes</h2></td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structInputManager_1_1InputAction.html">InputAction</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="structInputManager_1_1InputAction.html" title="InputAction struct to represent an action and its bindings.">InputAction</a> struct to represent an action and its bindings. <a href="structInputManager_1_1InputAction.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
|
|
Public Types</h2></td></tr>
|
|
<tr class="memitem:ace0b942f00c773dedae4956e27636e89" id="r_ace0b942f00c773dedae4956e27636e89"><td class="memItemLeft" align="right" valign="top"><a id="ace0b942f00c773dedae4956e27636e89" name="ace0b942f00c773dedae4956e27636e89"></a>enum class  </td><td class="memItemRight" valign="bottom"><a class="el" href="#ace0b942f00c773dedae4956e27636e89">Key</a> </td></tr>
|
|
<tr class="memdesc:ace0b942f00c773dedae4956e27636e89"><td class="mdescLeft"> </td><td class="mdescRight">A list of every key that can be bound to an action. <br /></td></tr>
|
|
<tr class="separator:ace0b942f00c773dedae4956e27636e89"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:afee4ab4cebfdac2fe08cd01e1a1c1620" id="r_afee4ab4cebfdac2fe08cd01e1a1c1620"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#afee4ab4cebfdac2fe08cd01e1a1c1620">registerAction</a> (const std::string &actionName, const std::vector< <a class="el" href="#ace0b942f00c773dedae4956e27636e89">Key</a> > &keys, std::function< void(bool)> callback, const std::string &context="Default")</td></tr>
|
|
<tr class="memdesc:afee4ab4cebfdac2fe08cd01e1a1c1620"><td class="mdescLeft"> </td><td class="mdescRight">Register an action with a name, key bindings, and a callback function. <br /></td></tr>
|
|
<tr class="separator:afee4ab4cebfdac2fe08cd01e1a1c1620"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6020878de8bb7046055cc40312e221e6" id="r_a6020878de8bb7046055cc40312e221e6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a6020878de8bb7046055cc40312e221e6">setActiveContext</a> (const std::string &context)</td></tr>
|
|
<tr class="memdesc:a6020878de8bb7046055cc40312e221e6"><td class="mdescLeft"> </td><td class="mdescRight">set the active context, is "Default" by default <br /></td></tr>
|
|
<tr class="separator:a6020878de8bb7046055cc40312e221e6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8c3240499dc0103d5a855c0d38127281" id="r_a8c3240499dc0103d5a855c0d38127281"><td class="memItemLeft" align="right" valign="top"><a id="a8c3240499dc0103d5a855c0d38127281" name="a8c3240499dc0103d5a855c0d38127281"></a>
|
|
std::string </td><td class="memItemRight" valign="bottom"><b>getActiveContext</b> () const</td></tr>
|
|
<tr class="memdesc:a8c3240499dc0103d5a855c0d38127281"><td class="mdescLeft"> </td><td class="mdescRight">Get the active context. <br /></td></tr>
|
|
<tr class="separator:a8c3240499dc0103d5a855c0d38127281"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p><a class="el" href="classInputManager.html" title="InputManager class to handle input events and actions.">InputManager</a> class to handle input events and actions. </p>
|
|
<p>This class manages input events, allowing for the registration of actions and their corresponding key bindings. </p>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="afee4ab4cebfdac2fe08cd01e1a1c1620" name="afee4ab4cebfdac2fe08cd01e1a1c1620"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afee4ab4cebfdac2fe08cd01e1a1c1620">◆ </a></span>registerAction()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void InputManager::registerAction </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string &</td> <td class="paramname"><span class="paramname"><em>actionName</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::vector< <a class="el" href="#ace0b942f00c773dedae4956e27636e89">Key</a> > &</td> <td class="paramname"><span class="paramname"><em>keys</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">std::function< void(bool)></td> <td class="paramname"><span class="paramname"><em>callback</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::string &</td> <td class="paramname"><span class="paramname"><em>context</em></span><span class="paramdefsep"> = </span><span class="paramdefval">"Default"</span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Register an action with a name, key bindings, and a callback function. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">actionName</td><td>The name of the action </td></tr>
|
|
<tr><td class="paramname">keys</td><td>The keys that are bound to this action </td></tr>
|
|
<tr><td class="paramname">callback</td><td>The function to call when the action is triggered </td></tr>
|
|
<tr><td class="paramname">context</td><td>The context in which the action is valid can be used to switch between e.g. gameplay and menu so the same keys can be used for different actions </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6020878de8bb7046055cc40312e221e6" name="a6020878de8bb7046055cc40312e221e6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6020878de8bb7046055cc40312e221e6">◆ </a></span>setActiveContext()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void InputManager::setActiveContext </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string &</td> <td class="paramname"><span class="paramname"><em>context</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>set the active context, is "Default" by default </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">context</td><td>The name of the context to set as active </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>include/<a class="el" href="InputManager_8h_source.html">InputManager.h</a></li>
|
|
<li>src/<b>InputManager.cpp</b></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="classInputManager.html">InputManager</a></li>
|
|
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.2 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|