0
0
mirror of https://github.com/Nimac0/SDL_Minigame synced 2026-01-12 12:33:43 +00:00
SDL_Minigame/classSpriteComponent.html

300 lines
19 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: SpriteComponent 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('classSpriteComponent.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="#pub-attribs">Public Attributes</a> &#124;
<a href="classSpriteComponent-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">SpriteComponent Class Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Inheritance diagram for SpriteComponent:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classSpriteComponent__inherit__graph.svg" width="222" height="111"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for SpriteComponent:</div>
<div class="dyncontent">
<div class="center"><div class="zoom"><iframe scrolling="no" frameborder="0" src="classSpriteComponent__coll__graph.svg" width="100%" height="600"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div></div>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<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:ac68b80d474dfd6e04893d38d0db3adb6" id="r_ac68b80d474dfd6e04893d38d0db3adb6"><td class="memItemLeft" align="right" valign="top"><a id="ac68b80d474dfd6e04893d38d0db3adb6" name="ac68b80d474dfd6e04893d38d0db3adb6"></a>
<a class="el" href="classTextures.html">Textures</a>&#160;</td><td class="memItemRight" valign="bottom"><b>getTexture</b> ()</td></tr>
<tr class="separator:ac68b80d474dfd6e04893d38d0db3adb6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af767b0da914fc583613626ac58505d58" id="r_af767b0da914fc583613626ac58505d58"><td class="memItemLeft" align="right" valign="top"><a id="af767b0da914fc583613626ac58505d58" name="af767b0da914fc583613626ac58505d58"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>SpriteComponent</b> (<a class="el" href="classTextures.html">Textures</a> texture, int zIndex)</td></tr>
<tr class="separator:af767b0da914fc583613626ac58505d58"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2c2b0ac3fc6418bb475d257597905e66" id="r_a2c2b0ac3fc6418bb475d257597905e66"><td class="memItemLeft" align="right" valign="top"><a id="a2c2b0ac3fc6418bb475d257597905e66" name="a2c2b0ac3fc6418bb475d257597905e66"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>SpriteComponent</b> (<a class="el" href="classTextures.html">Textures</a> texture, int xOffset, int yOffset, int zIndex)</td></tr>
<tr class="separator:a2c2b0ac3fc6418bb475d257597905e66"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5987774516010e021703a02a37d0509b" id="r_a5987774516010e021703a02a37d0509b"><td class="memItemLeft" align="right" valign="top"><a id="a5987774516010e021703a02a37d0509b" name="a5987774516010e021703a02a37d0509b"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>SpriteComponent</b> (const char *path, int xOffset, int yOffset, int zIndex)</td></tr>
<tr class="separator:a5987774516010e021703a02a37d0509b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0af0ea0070ffc60b3b8d0e1c1f13b5f2" id="r_a0af0ea0070ffc60b3b8d0e1c1f13b5f2"><td class="memItemLeft" align="right" valign="top"><a id="a0af0ea0070ffc60b3b8d0e1c1f13b5f2" name="a0af0ea0070ffc60b3b8d0e1c1f13b5f2"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>SpriteComponent</b> (<a class="el" href="classTextures.html">Textures</a> texture, bool isAnimated, std::map&lt; std::string, std::unique_ptr&lt; <a class="el" href="structAnimation.html">Animation</a> &gt; &gt; *animationList, std::string defaultAnimation, int zIndex)</td></tr>
<tr class="separator:a0af0ea0070ffc60b3b8d0e1c1f13b5f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afeaae71095db93e7ceb4ef5ed4f0e9e9" id="r_afeaae71095db93e7ceb4ef5ed4f0e9e9"><td class="memItemLeft" align="right" valign="top"><a id="afeaae71095db93e7ceb4ef5ed4f0e9e9" name="afeaae71095db93e7ceb4ef5ed4f0e9e9"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>setTexture</b> (<a class="el" href="classTextures.html">Textures</a> texture)</td></tr>
<tr class="separator:afeaae71095db93e7ceb4ef5ed4f0e9e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a90e697b25ea5afc2b1ddc7aff9db86df" id="r_a90e697b25ea5afc2b1ddc7aff9db86df"><td class="memItemLeft" align="right" valign="top"><a id="a90e697b25ea5afc2b1ddc7aff9db86df" name="a90e697b25ea5afc2b1ddc7aff9db86df"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>setMapTileTexture</b> (const char *path)</td></tr>
<tr class="separator:a90e697b25ea5afc2b1ddc7aff9db86df"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:addac0e2d311e76cf9413599c92d7a76a" id="r_addac0e2d311e76cf9413599c92d7a76a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#addac0e2d311e76cf9413599c92d7a76a">init</a> () override</td></tr>
<tr class="separator:addac0e2d311e76cf9413599c92d7a76a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acd1630e84a99aa9cb4e55b0302048714" id="r_acd1630e84a99aa9cb4e55b0302048714"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#acd1630e84a99aa9cb4e55b0302048714">update</a> (uint_fast16_t diffTime) override</td></tr>
<tr class="separator:acd1630e84a99aa9cb4e55b0302048714"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afb6423d6a6a6da8e4dfb7178985c8ddd" id="r_afb6423d6a6a6da8e4dfb7178985c8ddd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#afb6423d6a6a6da8e4dfb7178985c8ddd">draw</a> () override</td></tr>
<tr class="separator:afb6423d6a6a6da8e4dfb7178985c8ddd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa4ebb6763d8b994f412dec66ecf58c59" id="r_aa4ebb6763d8b994f412dec66ecf58c59"><td class="memItemLeft" align="right" valign="top"><a id="aa4ebb6763d8b994f412dec66ecf58c59" name="aa4ebb6763d8b994f412dec66ecf58c59"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>playAnimation</b> (std::string type)</td></tr>
<tr class="separator:aa4ebb6763d8b994f412dec66ecf58c59"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a00d678efb6ba9f63a393d8b742afaf23" id="r_a00d678efb6ba9f63a393d8b742afaf23"><td class="memItemLeft" align="right" valign="top"><a id="a00d678efb6ba9f63a393d8b742afaf23" name="a00d678efb6ba9f63a393d8b742afaf23"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>setDirection</b> (Direction direction)</td></tr>
<tr class="separator:a00d678efb6ba9f63a393d8b742afaf23"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classRenderObject"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_classRenderObject')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classRenderObject.html">RenderObject</a></td></tr>
<tr class="memitem:a61164a98c9bdbb7bf98dc980ce811e0f inherit pub_methods_classRenderObject" id="r_a61164a98c9bdbb7bf98dc980ce811e0f"><td class="memItemLeft" align="right" valign="top">
&#160;</td><td class="memItemRight" valign="bottom"><b>RenderObject</b> (int zIndex, <a class="el" href="classRenderManager.html">RenderManager</a> *renderManager)</td></tr>
<tr class="separator:a61164a98c9bdbb7bf98dc980ce811e0f inherit pub_methods_classRenderObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aea1283a9a95c1e0edcfdf4bbcc714b10 inherit pub_methods_classRenderObject" id="r_aea1283a9a95c1e0edcfdf4bbcc714b10"><td class="memItemLeft" align="right" valign="top">
int&#160;</td><td class="memItemRight" valign="bottom"><b>getZIndex</b> ()</td></tr>
<tr class="separator:aea1283a9a95c1e0edcfdf4bbcc714b10 inherit pub_methods_classRenderObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:afcaaee9062703493cb77343cd0985bb5" id="r_afcaaee9062703493cb77343cd0985bb5"><td class="memItemLeft" align="right" valign="top"><a id="afcaaee9062703493cb77343cd0985bb5" name="afcaaee9062703493cb77343cd0985bb5"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>animationIndex</b> = 0</td></tr>
<tr class="separator:afcaaee9062703493cb77343cd0985bb5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0bd4d1e8329f4a1a8dd9ca1c2cbece9e" id="r_a0bd4d1e8329f4a1a8dd9ca1c2cbece9e"><td class="memItemLeft" align="right" valign="top"><a id="a0bd4d1e8329f4a1a8dd9ca1c2cbece9e" name="a0bd4d1e8329f4a1a8dd9ca1c2cbece9e"></a>
std::map&lt; std::string, std::unique_ptr&lt; <a class="el" href="structAnimation.html">Animation</a> &gt; &gt; *&#160;</td><td class="memItemRight" valign="bottom"><b>animations</b> = nullptr</td></tr>
<tr class="separator:a0bd4d1e8329f4a1a8dd9ca1c2cbece9e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_attribs_classComponent"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_attribs_classComponent')"><img src="closed.png" alt="-"/>&#160;Public Attributes inherited from <a class="el" href="classComponent.html">Component</a></td></tr>
<tr class="memitem:a6acb3f00c9d114d961c8763ede390d2c inherit pub_attribs_classComponent" id="r_a6acb3f00c9d114d961c8763ede390d2c"><td class="memItemLeft" align="right" valign="top">
<a class="el" href="classEntity.html">Entity</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>entity</b></td></tr>
<tr class="separator:a6acb3f00c9d114d961c8763ede390d2c inherit pub_attribs_classComponent"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_attribs_classRenderObject"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pro_attribs_classRenderObject')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="classRenderObject.html">RenderObject</a></td></tr>
<tr class="memitem:a02bb4ae8ebd8b0271b6a4d73debcacb4 inherit pro_attribs_classRenderObject" id="r_a02bb4ae8ebd8b0271b6a4d73debcacb4"><td class="memItemLeft" align="right" valign="top">
<a class="el" href="classRenderManager.html">RenderManager</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>renderManager</b></td></tr>
<tr class="separator:a02bb4ae8ebd8b0271b6a4d73debcacb4 inherit pro_attribs_classRenderObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="afb6423d6a6a6da8e4dfb7178985c8ddd" name="afb6423d6a6a6da8e4dfb7178985c8ddd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afb6423d6a6a6da8e4dfb7178985c8ddd">&#9670;&#160;</a></span>draw()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void SpriteComponent::draw </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 override">override</span><span class="mlabel virtual">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implements <a class="el" href="classRenderObject.html">RenderObject</a>.</p>
</div>
</div>
<a id="addac0e2d311e76cf9413599c92d7a76a" name="addac0e2d311e76cf9413599c92d7a76a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#addac0e2d311e76cf9413599c92d7a76a">&#9670;&#160;</a></span>init()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void SpriteComponent::init </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 override">override</span><span class="mlabel virtual">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reimplemented from <a class="el" href="classComponent.html">Component</a>.</p>
</div>
</div>
<a id="acd1630e84a99aa9cb4e55b0302048714" name="acd1630e84a99aa9cb4e55b0302048714"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acd1630e84a99aa9cb4e55b0302048714">&#9670;&#160;</a></span>update()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void SpriteComponent::update </td>
<td>(</td>
<td class="paramtype">uint_fast16_t</td> <td class="paramname"><span class="paramname"><em>diffTime</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel override">override</span><span class="mlabel virtual">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reimplemented from <a class="el" href="classComponent.html">Component</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>include/<a class="el" href="SpriteComponent_8h_source.html">SpriteComponent.h</a></li>
<li>src/<b>SpriteComponent.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="classSpriteComponent.html">SpriteComponent</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>