ShibaGit/khaotic-engine-Reborn
ShibaGit/khaotic-engine-Reborn
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 11 Wiki Activity
khaotic-engine-Reborn/doxygen_docs/html/namespaceecs.html

374 lines
20 KiB
HTML
Raw Blame History

<!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.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Khaotic Engine Reborn: ecs Namespace 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>
<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" />
</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">Khaotic Engine Reborn
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.12.0 -->
<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('namespaceecs.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> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">ecs Namespace Reference</div></div>
</div><!--header-->
<div class="contents">
<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">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classecs_1_1_component.html">Component</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classecs_1_1_entity.html">Entity</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classecs_1_1_entity_manager.html">EntityManager</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classecs_1_1_identity_component.html">IdentityComponent</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classecs_1_1_model_path_component.html">ModelPathComponent</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classecs_1_1_physics_component.html">PhysicsComponent</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classecs_1_1_render_component.html">RenderComponent</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classecs_1_1_render_system.html">RenderSystem</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classecs_1_1_shader_component.html">ShaderComponent</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classecs_1_1_transform_component.html">TransformComponent</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a42f956eb2e8f1c7becf039180c466677" id="r_a42f956eb2e8f1c7becf039180c466677"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a42f956eb2e8f1c7becf039180c466677">ComponentPtr</a> = std::shared_ptr&lt;<a class="el" href="classecs_1_1_component.html">Component</a>&gt;</td></tr>
<tr class="separator:a42f956eb2e8f1c7becf039180c466677"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a94d754c47297d56ce57eb14784809efc" id="r_a94d754c47297d56ce57eb14784809efc"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a94d754c47297d56ce57eb14784809efc">ComponentTypeID</a> = std::type_index</td></tr>
<tr class="separator:a94d754c47297d56ce57eb14784809efc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af256e267ca18f2601f8e804fd95e9358" id="r_af256e267ca18f2601f8e804fd95e9358"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af256e267ca18f2601f8e804fd95e9358">EntityID</a> = uint32_t</td></tr>
<tr class="separator:af256e267ca18f2601f8e804fd95e9358"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ab36dd172176a3da5558233694cbad4ae" id="r_ab36dd172176a3da5558233694cbad4ae"><td class="memItemLeft" align="right" valign="top">enum class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab36dd172176a3da5558233694cbad4ae">ObjectType</a> { <b>Sphere</b>
, <b>Cube</b>
, <b>Terrain</b>
, <b>Unknown</b>
}</td></tr>
<tr class="separator:ab36dd172176a3da5558233694cbad4ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6e9ad0276f69474fe9498437b7d1a8f2" id="r_a6e9ad0276f69474fe9498437b7d1a8f2"><td class="memItemLeft" align="right" valign="top">enum class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6e9ad0276f69474fe9498437b7d1a8f2">TextureType</a> { <br />
&#160;&#160;<b>Diffuse</b>
, <b>Normal</b>
, <b>Specular</b>
, <b>Alpha</b>
, <br />
&#160;&#160;<b>Reflection</b>
<br />
}</td></tr>
<tr class="separator:a6e9ad0276f69474fe9498437b7d1a8f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a80994feeebc2747495a80b5d4b2a8440" id="r_a80994feeebc2747495a80b5d4b2a8440"><td class="memItemLeft" align="right" valign="top">enum class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a80994feeebc2747495a80b5d4b2a8440">ShaderType</a> { <br />
&#160;&#160;<b>CEL_SHADING</b>
, <b>LIGHTING</b>
, <b>NORMAL_MAPPING</b>
, <b>SPECULAR_MAPPING</b>
, <br />
&#160;&#160;<b>REFLECTION</b>
, <b>REFRACTION</b>
, <b>TEXTURE</b>
, <b>SKYBOX</b>
, <br />
&#160;&#160;<b>SUNLIGHT</b>
, <b>ALPHA_MAPPING</b>
<br />
}</td></tr>
<tr class="separator:a80994feeebc2747495a80b5d4b2a8440"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ae98a9f77225416bebd93a559a68a92eb" id="r_ae98a9f77225416bebd93a559a68a92eb"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:ae98a9f77225416bebd93a559a68a92eb"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="#a94d754c47297d56ce57eb14784809efc">ComponentTypeID</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#ae98a9f77225416bebd93a559a68a92eb">GetComponentTypeID</a> ()</td></tr>
<tr class="separator:ae98a9f77225416bebd93a559a68a92eb"><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>namespace for the Entity-Component-System (ECS) </p>
</div><h2 class="groupheader">Typedef Documentation</h2>
<a id="a42f956eb2e8f1c7becf039180c466677" name="a42f956eb2e8f1c7becf039180c466677"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a42f956eb2e8f1c7becf039180c466677">&#9670;&#160;</a></span>ComponentPtr</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="#a42f956eb2e8f1c7becf039180c466677">ecs::ComponentPtr</a> = std::shared_ptr&lt;<a class="el" href="classecs_1_1_component.html">Component</a>&gt;</td>
</tr>
</table>
</div><div class="memdoc">
<p>Type alias for a shared pointer to a <a class="el" href="classecs_1_1_component.html">Component</a>. </p>
<p class="definition">Definition at line <a class="el" href="component_8h_source.html#l00043">43</a> of file <a class="el" href="component_8h_source.html">component.h</a>.</p>
</div>
</div>
<a id="a94d754c47297d56ce57eb14784809efc" name="a94d754c47297d56ce57eb14784809efc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a94d754c47297d56ce57eb14784809efc">&#9670;&#160;</a></span>ComponentTypeID</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="#a94d754c47297d56ce57eb14784809efc">ecs::ComponentTypeID</a> = std::type_index</td>
</tr>
</table>
</div><div class="memdoc">
<p>Type alias for a unique identifier for a component type. </p>
<p class="definition">Definition at line <a class="el" href="component_8h_source.html#l00048">48</a> of file <a class="el" href="component_8h_source.html">component.h</a>.</p>
</div>
</div>
<a id="af256e267ca18f2601f8e804fd95e9358" name="af256e267ca18f2601f8e804fd95e9358"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af256e267ca18f2601f8e804fd95e9358">&#9670;&#160;</a></span>EntityID</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="#af256e267ca18f2601f8e804fd95e9358">ecs::EntityID</a> = uint32_t</td>
</tr>
</table>
</div><div class="memdoc">
<p>Type alias for a unique identifier for an entity. </p>
<p class="definition">Definition at line <a class="el" href="entity_8h_source.html#l00013">13</a> of file <a class="el" href="entity_8h_source.html">entity.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="ab36dd172176a3da5558233694cbad4ae" name="ab36dd172176a3da5558233694cbad4ae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab36dd172176a3da5558233694cbad4ae">&#9670;&#160;</a></span>ObjectType</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">enum class <a class="el" href="#ab36dd172176a3da5558233694cbad4ae">ecs::ObjectType</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">strong</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Enum for different types of objects in the ECS. The object types is used to specify the collision type of the object. </p>
<p class="definition">Definition at line <a class="el" href="identity__component_8h_source.html#l00010">10</a> of file <a class="el" href="identity__component_8h_source.html">identity_component.h</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 11</span> {</div>
<div class="line"><span class="lineno"> 12</span> Sphere,</div>
<div class="line"><span class="lineno"> 13</span> Cube,</div>
<div class="line"><span class="lineno"> 14</span> Terrain,</div>
<div class="line"><span class="lineno"> 15</span> Unknown</div>
<div class="line"><span class="lineno"> 16</span> };</div>
</div><!-- fragment -->
</div>
</div>
<a id="a80994feeebc2747495a80b5d4b2a8440" name="a80994feeebc2747495a80b5d4b2a8440"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a80994feeebc2747495a80b5d4b2a8440">&#9670;&#160;</a></span>ShaderType</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">enum class <a class="el" href="#a80994feeebc2747495a80b5d4b2a8440">ecs::ShaderType</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">strong</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Enum for different shader types used in rendering. This enum is used to specify the type of shader to be applied to a model. </p>
<p class="definition">Definition at line <a class="el" href="shader__component_8h_source.html#l00010">10</a> of file <a class="el" href="shader__component_8h_source.html">shader_component.h</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 11</span>{</div>
<div class="line"><span class="lineno"> 12</span> CEL_SHADING,</div>
<div class="line"><span class="lineno"> 13</span> LIGHTING,</div>
<div class="line"><span class="lineno"> 14</span> NORMAL_MAPPING,</div>
<div class="line"><span class="lineno"> 15</span> SPECULAR_MAPPING,</div>
<div class="line"><span class="lineno"> 16</span> REFLECTION,</div>
<div class="line"><span class="lineno"> 17</span> REFRACTION,</div>
<div class="line"><span class="lineno"> 18</span> TEXTURE,</div>
<div class="line"><span class="lineno"> 19</span> SKYBOX,</div>
<div class="line"><span class="lineno"> 20</span> SUNLIGHT,</div>
<div class="line"><span class="lineno"> 21</span> ALPHA_MAPPING</div>
<div class="line"><span class="lineno"> 22</span>};</div>
</div><!-- fragment -->
</div>
</div>
<a id="a6e9ad0276f69474fe9498437b7d1a8f2" name="a6e9ad0276f69474fe9498437b7d1a8f2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6e9ad0276f69474fe9498437b7d1a8f2">&#9670;&#160;</a></span>TextureType</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">enum class <a class="el" href="#a6e9ad0276f69474fe9498437b7d1a8f2">ecs::TextureType</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">strong</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Enum for different types of textures used in rendering. </p>
<p class="definition">Definition at line <a class="el" href="render__component_8h_source.html#l00020">20</a> of file <a class="el" href="render__component_8h_source.html">render_component.h</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 21</span> {</div>
<div class="line"><span class="lineno"> 22</span> Diffuse,</div>
<div class="line"><span class="lineno"> 23</span> Normal,</div>
<div class="line"><span class="lineno"> 24</span> Specular,</div>
<div class="line"><span class="lineno"> 25</span> Alpha,</div>
<div class="line"><span class="lineno"> 26</span> Reflection</div>
<div class="line"><span class="lineno"> 27</span> };</div>
</div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ae98a9f77225416bebd93a559a68a92eb" name="ae98a9f77225416bebd93a559a68a92eb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae98a9f77225416bebd93a559a68a92eb">&#9670;&#160;</a></span>GetComponentTypeID()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="#a94d754c47297d56ce57eb14784809efc">ComponentTypeID</a> ecs::GetComponentTypeID </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Function to get the unique type ID for a component type. </p>
<p class="definition">Definition at line <a class="el" href="component_8h_source.html#l00054">54</a> of file <a class="el" href="component_8h_source.html">component.h</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 54</span> {</div>
<div class="line"><span class="lineno"> 55</span> <span class="keyword">static_assert</span>(std::is_base_of&lt;Component, T&gt;::value, <span class="stringliteral">&quot;T must derive from Component&quot;</span>);</div>
<div class="line"><span class="lineno"> 56</span> <span class="keywordflow">return</span> std::type_index(<span class="keyword">typeid</span>(T));</div>
<div class="line"><span class="lineno"> 57</span>}</div>
</div><!-- fragment -->
</div>
</div>
</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="namespaceecs.html">ecs</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.12.0 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink