nanopenguin/SDL_Minigame
0
0
Fork 0
mirror of https://github.com/Nimac0/SDL_Minigame synced 2026-01-12 12:33:43 +00:00
Code Actions Wiki
SDL_Minigame/classColliderComponent.html

305 lines
15 KiB
HTML
Raw Blame History

<!-- 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: ColliderComponent 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('classColliderComponent.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="classColliderComponent-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ColliderComponent Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Adds a collision box to an entity when added via entity.addComponent()
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="ColliderComponent_8h_source.html">ColliderComponent.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:a334729b3c9b86cf7ee99b908f100a043" id="r_a334729b3c9b86cf7ee99b908f100a043"><td class="memItemLeft" align="right" valign="top">SDL_Rect &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a334729b3c9b86cf7ee99b908f100a043">getCollider</a> ()</td></tr>
<tr class="separator:a334729b3c9b86cf7ee99b908f100a043"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4438054178328402309cf72589f4f163" id="r_a4438054178328402309cf72589f4f163"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4438054178328402309cf72589f4f163">getTag</a> () const</td></tr>
<tr class="separator:a4438054178328402309cf72589f4f163"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a916be6c5f07a15fbd4f198be4c3c5a5f" id="r_a916be6c5f07a15fbd4f198be4c3c5a5f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a916be6c5f07a15fbd4f198be4c3c5a5f">hasCollision</a> () const</td></tr>
<tr class="separator:a916be6c5f07a15fbd4f198be4c3c5a5f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab2b8fbba2f80f7b9bbf70504f8c3c670" id="r_ab2b8fbba2f80f7b9bbf70504f8c3c670"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab2b8fbba2f80f7b9bbf70504f8c3c670">ColliderComponent</a> (const char *tag)</td></tr>
<tr class="memdesc:ab2b8fbba2f80f7b9bbf70504f8c3c670"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor for <a class="el" href="classColliderComponent.html" title="Adds a collision box to an entity when added via entity.addComponent()">ColliderComponent</a>. <br /></td></tr>
<tr class="separator:ab2b8fbba2f80f7b9bbf70504f8c3c670"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a29b7a4326327382ec473730a07f57b9a" id="r_a29b7a4326327382ec473730a07f57b9a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a29b7a4326327382ec473730a07f57b9a">ColliderComponent</a> (const char *tag, float hitboxScale)</td></tr>
<tr class="memdesc:a29b7a4326327382ec473730a07f57b9a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor for <a class="el" href="classColliderComponent.html" title="Adds a collision box to an entity when added via entity.addComponent()">ColliderComponent</a>. <br /></td></tr>
<tr class="separator:a29b7a4326327382ec473730a07f57b9a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6ac04cfb252c5712d53aaa30603165e3" id="r_a6ac04cfb252c5712d53aaa30603165e3"><td class="memItemLeft" align="right" valign="top"><a id="a6ac04cfb252c5712d53aaa30603165e3" name="a6ac04cfb252c5712d53aaa30603165e3"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>removeCollision</b> ()</td></tr>
<tr class="memdesc:a6ac04cfb252c5712d53aaa30603165e3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Removes the collision of an entity. <br /></td></tr>
<tr class="separator:a6ac04cfb252c5712d53aaa30603165e3"><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>Adds a collision box to an entity when added via entity.addComponent() </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ab2b8fbba2f80f7b9bbf70504f8c3c670" name="ab2b8fbba2f80f7b9bbf70504f8c3c670"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab2b8fbba2f80f7b9bbf70504f8c3c670">&#9670;&#160;</a></span>ColliderComponent() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ColliderComponent::ColliderComponent </td>
<td>(</td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>tag</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor for <a class="el" href="classColliderComponent.html" title="Adds a collision box to an entity when added via entity.addComponent()">ColliderComponent</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">tag</td><td>The tag of the collider, can be any char* </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a29b7a4326327382ec473730a07f57b9a" name="a29b7a4326327382ec473730a07f57b9a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a29b7a4326327382ec473730a07f57b9a">&#9670;&#160;</a></span>ColliderComponent() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ColliderComponent::ColliderComponent </td>
<td>(</td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>tag</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>hitboxScale</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor for <a class="el" href="classColliderComponent.html" title="Adds a collision box to an entity when added via entity.addComponent()">ColliderComponent</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">tag</td><td>The tag of the collider, can be any char* </td></tr>
<tr><td class="paramname">hitboxScale</td><td>The scale of the collider, used to scale the collider size (this is independent of the sprite size), default is 1.0f and takes up the 32x32 pixels </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a334729b3c9b86cf7ee99b908f100a043" name="a334729b3c9b86cf7ee99b908f100a043"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a334729b3c9b86cf7ee99b908f100a043">&#9670;&#160;</a></span>getCollider()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">SDL_Rect &amp; ColliderComponent::getCollider </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>the collider of the entity </dd></dl>
</div>
</div>
<a id="a4438054178328402309cf72589f4f163" name="a4438054178328402309cf72589f4f163"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4438054178328402309cf72589f4f163">&#9670;&#160;</a></span>getTag()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const char * ColliderComponent::getTag </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>the tag of the entity </dd></dl>
</div>
</div>
<a id="a916be6c5f07a15fbd4f198be4c3c5a5f" name="a916be6c5f07a15fbd4f198be4c3c5a5f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a916be6c5f07a15fbd4f198be4c3c5a5f">&#9670;&#160;</a></span>hasCollision()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool ColliderComponent::hasCollision </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>the collision state of the entity </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>include/<a class="el" href="ColliderComponent_8h_source.html">ColliderComponent.h</a></li>
<li>src/<b>ColliderComponent.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="classColliderComponent.html">ColliderComponent</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>
View Git Blame Copy Permalink