0
0
mirror of https://github.com/Nimac0/SDL_Minigame synced 2026-01-12 09:03:42 +00:00
SDL_Minigame/classInteractionComponent.html

192 lines
10 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: InteractionComponent 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">&#160;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&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;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&amp;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&amp;dn=expat.txt MIT */
$(function(){initNavTree('classInteractionComponent.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="#pub-methods">Public Member Functions</a> &#124;
<a href="classInteractionComponent-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">InteractionComponent Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="classInteractionComponent.html" title="InteractionComponent class to handle interaction events.">InteractionComponent</a> class to handle interaction events.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="InteractionComponent_8h_source.html">InteractionComponent.h</a>&gt;</code></p>
<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:af60fed077b6f92c22f2246c2464923ed" id="r_af60fed077b6f92c22f2246c2464923ed"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af60fed077b6f92c22f2246c2464923ed">InteractionComponent</a> (std::function&lt; void(void *, void *)&gt; callback)</td></tr>
<tr class="memdesc:af60fed077b6f92c22f2246c2464923ed"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor for the <a class="el" href="classInteractionComponent.html" title="InteractionComponent class to handle interaction events.">InteractionComponent</a>. <br /></td></tr>
<tr class="separator:af60fed077b6f92c22f2246c2464923ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab6358a875d127206cb5f867f93e05368" id="r_ab6358a875d127206cb5f867f93e05368"><td class="memItemLeft" align="right" valign="top"><a id="ab6358a875d127206cb5f867f93e05368" name="ab6358a875d127206cb5f867f93e05368"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>interact</b> (void *actor, void *data) override</td></tr>
<tr class="memdesc:ab6358a875d127206cb5f867f93e05368"><td class="mdescLeft">&#160;</td><td class="mdescRight">Internal function to be called when an interaction event is triggered. <br /></td></tr>
<tr class="separator:ab6358a875d127206cb5f867f93e05368"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a88ef331d132baf4f9a4c24544077f9f2" id="r_a88ef331d132baf4f9a4c24544077f9f2"><td class="memItemLeft" align="right" valign="top"><a id="a88ef331d132baf4f9a4c24544077f9f2" name="a88ef331d132baf4f9a4c24544077f9f2"></a>
std::shared_ptr&lt; Vector2D &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>getPosition</b> () override</td></tr>
<tr class="memdesc:a88ef331d132baf4f9a4c24544077f9f2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Internal function to use as reference for targeting. <br /></td></tr>
<tr class="separator:a88ef331d132baf4f9a4c24544077f9f2"><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="classInteractionComponent.html" title="InteractionComponent class to handle interaction events.">InteractionComponent</a> class to handle interaction events. </p>
<p>This class manages interaction events, allowing for the registration of a callback function to be called when an interaction event is triggered. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="af60fed077b6f92c22f2246c2464923ed" name="af60fed077b6f92c22f2246c2464923ed"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af60fed077b6f92c22f2246c2464923ed">&#9670;&#160;</a></span>InteractionComponent()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">InteractionComponent::InteractionComponent </td>
<td>(</td>
<td class="paramtype">std::function&lt; void(void *, void *)&gt;</td> <td class="paramname"><span class="paramname"><em>callback</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor for the <a class="el" href="classInteractionComponent.html" title="InteractionComponent class to handle interaction events.">InteractionComponent</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">callback</td><td>A function to be called when an interaction event is triggered. void* actor, void* data are passed to the callback function from <a class="el" href="structInteractionEventdataStruct.html" title="Struct to hold data for interaction events. This struct is used to pass data to the interaction manag...">InteractionEventdataStruct</a>. </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="InteractionComponent_8h_source.html">InteractionComponent.h</a></li>
<li>src/<b>InteractionComponent.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="classInteractionComponent.html">InteractionComponent</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>