mirror of
https://github.com/Nimac0/SDL_Minigame
synced 2026-01-12 09:03:42 +00:00
338 lines
19 KiB
HTML
338 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"> 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('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> |
|
|
<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">
|
|
|
|
<p><a class="el" href="classSpriteComponent.html" title="SpriteComponent class to handle sprite rendering and animation of entities.">SpriteComponent</a> class to handle sprite rendering and animation of entities.
|
|
<a href="#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="SpriteComponent_8h_source.html">SpriteComponent.h</a>></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:a986be57e30c06ed8df1479394d185563" id="r_a986be57e30c06ed8df1479394d185563"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a986be57e30c06ed8df1479394d185563">SpriteComponent</a> (<a class="el" href="classTextures.html">Textures</a> texture, int zIndex, int xOffset=0, int yOffset=0)</td></tr>
|
|
<tr class="separator:a986be57e30c06ed8df1479394d185563"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a776a161c30dbfd0f7dc7d42d477b45bb" id="r_a776a161c30dbfd0f7dc7d42d477b45bb"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a776a161c30dbfd0f7dc7d42d477b45bb">SpriteComponent</a> (const char *path, int zIndex, int xOffset=0, int yOffset=0)</td></tr>
|
|
<tr class="separator:a776a161c30dbfd0f7dc7d42d477b45bb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2c60f55924b1d18b9e6fb530b5c5346a" id="r_a2c60f55924b1d18b9e6fb530b5c5346a"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a2c60f55924b1d18b9e6fb530b5c5346a">SpriteComponent</a> (<a class="el" href="classTextures.html">Textures</a> texture, bool isAnimated, std::map< std::string, std::unique_ptr< <a class="el" href="structAnimation.html">Animation</a> > > *animationList, std::string defaultAnimation, int zIndex, int xOffset=0, int yOffset=0)</td></tr>
|
|
<tr class="memdesc:a2c60f55924b1d18b9e6fb530b5c5346a"><td class="mdescLeft"> </td><td class="mdescRight">Constructor used for <b>animated</b> sprites. <br /></td></tr>
|
|
<tr class="separator:a2c60f55924b1d18b9e6fb530b5c5346a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa4ebb6763d8b994f412dec66ecf58c59" id="r_aa4ebb6763d8b994f412dec66ecf58c59"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#aa4ebb6763d8b994f412dec66ecf58c59">playAnimation</a> (std::string type)</td></tr>
|
|
<tr class="memdesc:aa4ebb6763d8b994f412dec66ecf58c59"><td class="mdescLeft"> </td><td class="mdescRight">By name select which animation should be played (gets looped) <br /></td></tr>
|
|
<tr class="separator:aa4ebb6763d8b994f412dec66ecf58c59"><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="classSpriteComponent.html" title="SpriteComponent class to handle sprite rendering and animation of entities.">SpriteComponent</a> class to handle sprite rendering and animation of entities. </p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a986be57e30c06ed8df1479394d185563" name="a986be57e30c06ed8df1479394d185563"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a986be57e30c06ed8df1479394d185563">◆ </a></span>SpriteComponent() <span class="overload">[1/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">SpriteComponent::SpriteComponent </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classTextures.html">Textures</a></td> <td class="paramname"><span class="paramname"><em>texture</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>zIndex</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>xOffset</em></span><span class="paramdefsep"> = </span><span class="paramdefval">0</span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>yOffset</em></span><span class="paramdefsep"> = </span><span class="paramdefval">0</span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">texture</td><td>The texture to be used for the sprite, must be a Texture enum </td></tr>
|
|
<tr><td class="paramname">xOffset</td><td>The x offset of the sprite relative to the transform component position, used for rendering position </td></tr>
|
|
<tr><td class="paramname">yOffset</td><td>The y offset of the sprite relative to the transform component position, used for rendering position </td></tr>
|
|
<tr><td class="paramname">zIndex</td><td>The z-index of the sprite, used for rendering order, in order to show up on the map, the zIndex must be higher than the layer you want it to show up on </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a776a161c30dbfd0f7dc7d42d477b45bb" name="a776a161c30dbfd0f7dc7d42d477b45bb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a776a161c30dbfd0f7dc7d42d477b45bb">◆ </a></span>SpriteComponent() <span class="overload">[2/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">SpriteComponent::SpriteComponent </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>path</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>zIndex</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>xOffset</em></span><span class="paramdefsep"> = </span><span class="paramdefval">0</span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>yOffset</em></span><span class="paramdefsep"> = </span><span class="paramdefval">0</span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">path</td><td>The path to the texture to be used for the entity (for performance reasons, prefer enums instead) </td></tr>
|
|
<tr><td class="paramname">xOffset</td><td>The x offset of the sprite relative to the transform component position, used for rendering position </td></tr>
|
|
<tr><td class="paramname">yOffset</td><td>The y offset of the sprite relative to the transform component position, used for rendering position </td></tr>
|
|
<tr><td class="paramname">zIndex</td><td>The z-index of the sprite, used for rendering order, in order to show up on the map, the zIndex must be higher than the layer you want it to show up on </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2c60f55924b1d18b9e6fb530b5c5346a" name="a2c60f55924b1d18b9e6fb530b5c5346a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2c60f55924b1d18b9e6fb530b5c5346a">◆ </a></span>SpriteComponent() <span class="overload">[3/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">SpriteComponent::SpriteComponent </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classTextures.html">Textures</a></td> <td class="paramname"><span class="paramname"><em>texture</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool</td> <td class="paramname"><span class="paramname"><em>isAnimated</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">std::map< std::string, std::unique_ptr< <a class="el" href="structAnimation.html">Animation</a> > > *</td> <td class="paramname"><span class="paramname"><em>animationList</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">std::string</td> <td class="paramname"><span class="paramname"><em>defaultAnimation</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>zIndex</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>xOffset</em></span><span class="paramdefsep"> = </span><span class="paramdefval">0</span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>yOffset</em></span><span class="paramdefsep"> = </span><span class="paramdefval">0</span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Constructor used for <b>animated</b> sprites. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">texture</td><td>The texture to be used for the sprite, must be a Texture enum </td></tr>
|
|
<tr><td class="paramname">isAnimated</td><td>Whether the sprite is animated or not </td></tr>
|
|
<tr><td class="paramname">animationList</td><td>The list of animations to be used for the sprite (list of maps mapping a string to an <a class="el" href="structAnimation.html">Animation</a> struct) </td></tr>
|
|
<tr><td class="paramname">defaultAnimation</td><td>The default animation to be used for the sprite when it first gets loaded </td></tr>
|
|
<tr><td class="paramname">zIndex</td><td>The z-index of the sprite, used for rendering order, in order to show up on the map, the zIndex must be higher than the layer you want it to show up on </td></tr>
|
|
<tr><td class="paramname">xOffset</td><td>The x offset of the sprite relative to the transform component position, used for rendering position </td></tr>
|
|
<tr><td class="paramname">yOffset</td><td>The y offset of the sprite relative to the transform component position, used for rendering position </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<h3><a class="anchor" id="autotoc_md0"></a>
|
|
How to spritesheet animation:</h3>
|
|
<p>An animation sprite sheet consists of multiple sprites of the specified size (library supports 32x32) arranged in a grid. Each row of the grid represents one animation, and each column in a row is one frame of the animation. If a sprite sheet contains multiple animations with different frame counts, you can just leave the rest of the row blank. Be aware to specify the correct frame count in the animation struct! </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="structAnimation.html" title="Animation struct to hold animation data.">Animation</a></dd></dl>
|
|
<div class="image">
|
|
<img src="Animations1.jpg" alt=""/>
|
|
<div class="caption">
|
|
Example of a sprite sheet with 2 animations of 2 frames each</div></div>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="aa4ebb6763d8b994f412dec66ecf58c59" name="aa4ebb6763d8b994f412dec66ecf58c59"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa4ebb6763d8b994f412dec66ecf58c59">◆ </a></span>playAnimation()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void SpriteComponent::playAnimation </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::string</td> <td class="paramname"><span class="paramname"><em>type</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>By name select which animation should be played (gets looped) </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">type</td><td>name previously set to an animation in animationList </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="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>
|