khaotic-engine-Reborn/doxygen_docs/html/classecs_1_1_component.html

224 lines
12 KiB
HTML

<!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::Component 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>
<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('classecs_1_1_component.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="classecs_1_1_component-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ecs::Component Class Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Inheritance diagram for ecs::Component:</div>
<div class="dyncontent">
<div class="center">
<img src="classecs_1_1_component.png" usemap="#ecs::Component_map" alt=""/>
<map id="ecs::Component_map" name="ecs::Component_map">
<area href="classecs_1_1_identity_component.html" alt="ecs::IdentityComponent" shape="rect" coords="0,56,161,80"/>
<area href="classecs_1_1_model_path_component.html" alt="ecs::ModelPathComponent" shape="rect" coords="171,56,332,80"/>
<area href="classecs_1_1_physics_component.html" alt="ecs::PhysicsComponent" shape="rect" coords="342,56,503,80"/>
<area href="classecs_1_1_render_component.html" alt="ecs::RenderComponent" shape="rect" coords="513,56,674,80"/>
<area href="classecs_1_1_shader_component.html" alt="ecs::ShaderComponent" shape="rect" coords="684,56,845,80"/>
<area href="classecs_1_1_transform_component.html" alt="ecs::TransformComponent" shape="rect" coords="855,56,1016,80"/>
</map>
</div></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:a8dbee43fa54890ad07145aa1160b0b09" id="r_a8dbee43fa54890ad07145aa1160b0b09"><td class="memItemLeft" align="right" valign="top"><a id="a8dbee43fa54890ad07145aa1160b0b09" name="a8dbee43fa54890ad07145aa1160b0b09"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>Component</b> (const <a class="el" href="classecs_1_1_component.html">Component</a> &amp;)=delete</td></tr>
<tr class="separator:a8dbee43fa54890ad07145aa1160b0b09"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a34000da33471994c2550e416505026ad" id="r_a34000da33471994c2550e416505026ad"><td class="memItemLeft" align="right" valign="top"><a id="a34000da33471994c2550e416505026ad" name="a34000da33471994c2550e416505026ad"></a>
<a class="el" href="classecs_1_1_component.html">Component</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classecs_1_1_component.html">Component</a> &amp;)=delete</td></tr>
<tr class="separator:a34000da33471994c2550e416505026ad"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a213cfa3482dca1ffc458b9cf020b4814" id="r_a213cfa3482dca1ffc458b9cf020b4814"><td class="memItemLeft" align="right" valign="top"><a id="a213cfa3482dca1ffc458b9cf020b4814" name="a213cfa3482dca1ffc458b9cf020b4814"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>Component</b> (<a class="el" href="classecs_1_1_component.html">Component</a> &amp;&amp;)=default</td></tr>
<tr class="separator:a213cfa3482dca1ffc458b9cf020b4814"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8089d7e43f9ac2a6eedd3b0598c46694" id="r_a8089d7e43f9ac2a6eedd3b0598c46694"><td class="memItemLeft" align="right" valign="top"><a id="a8089d7e43f9ac2a6eedd3b0598c46694" name="a8089d7e43f9ac2a6eedd3b0598c46694"></a>
<a class="el" href="classecs_1_1_component.html">Component</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="classecs_1_1_component.html">Component</a> &amp;&amp;)=default</td></tr>
<tr class="separator:a8089d7e43f9ac2a6eedd3b0598c46694"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9372874f51e5f63584d65fc378d39459" id="r_a9372874f51e5f63584d65fc378d39459"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9372874f51e5f63584d65fc378d39459">Initialize</a> ()</td></tr>
<tr class="separator:a9372874f51e5f63584d65fc378d39459"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a59c0f739c4ff19227e27ed7b9f6352e0" id="r_a59c0f739c4ff19227e27ed7b9f6352e0"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a59c0f739c4ff19227e27ed7b9f6352e0">Update</a> (float deltaTime)</td></tr>
<tr class="separator:a59c0f739c4ff19227e27ed7b9f6352e0"><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 class="definition">Definition at line <a class="el" href="component_8h_source.html#l00012">12</a> of file <a class="el" href="component_8h_source.html">component.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a9372874f51e5f63584d65fc378d39459" name="a9372874f51e5f63584d65fc378d39459"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9372874f51e5f63584d65fc378d39459">&#9670;&#160;</a></span>Initialize()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void ecs::Component::Initialize </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</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Virtual function to initialize the component. </p>
<p>Reimplemented in <a class="el" href="classecs_1_1_identity_component.html#a04b2bb43ccf6c4842704f30463033b3b">ecs::IdentityComponent</a>, <a class="el" href="classecs_1_1_model_path_component.html#a8819a3be58b6748ced6763a598e2f7f8">ecs::ModelPathComponent</a>, <a class="el" href="classecs_1_1_physics_component.html#ab58952fc61030f1047beb2d6dbec82cf">ecs::PhysicsComponent</a>, <a class="el" href="classecs_1_1_render_component.html#aa92950c4ebad0379f626493bda1a79bb">ecs::RenderComponent</a>, and <a class="el" href="classecs_1_1_shader_component.html#a69a5ca163458465936525b14270fe46e">ecs::ShaderComponent</a>.</p>
<p class="definition">Definition at line <a class="el" href="component_8h_source.html#l00028">28</a> of file <a class="el" href="component_8h_source.html">component.h</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 28</span>{}</div>
</div><!-- fragment -->
</div>
</div>
<a id="a59c0f739c4ff19227e27ed7b9f6352e0" name="a59c0f739c4ff19227e27ed7b9f6352e0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a59c0f739c4ff19227e27ed7b9f6352e0">&#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">virtual void ecs::Component::Update </td>
<td>(</td>
<td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>deltaTime</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Virtual function to update the component. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">deltaTime</td><td>Time since the last update. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented in <a class="el" href="classecs_1_1_model_path_component.html#a64d1c1fa22bb222e6c85f5312ea8795b">ecs::ModelPathComponent</a>, <a class="el" href="classecs_1_1_physics_component.html#a83aaa878464b8ef2dbc0e7a927689d79">ecs::PhysicsComponent</a>, <a class="el" href="classecs_1_1_render_component.html#a6cfff9944a89629f5f7a7d1451446f0d">ecs::RenderComponent</a>, and <a class="el" href="classecs_1_1_shader_component.html#a2ebc1ef592626fc729884677c771ccbf">ecs::ShaderComponent</a>.</p>
<p class="definition">Definition at line <a class="el" href="component_8h_source.html#l00034">34</a> of file <a class="el" href="component_8h_source.html">component.h</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 34</span>{}</div>
</div><!-- fragment -->
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>enginecustom/src/inc/system/ecs/<a class="el" href="component_8h_source.html">component.h</a></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="namespaceecs.html">ecs</a></li><li class="navelem"><a class="el" href="classecs_1_1_component.html">Component</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>