571 lines
32 KiB
HTML
571 lines
32 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::IdentityComponent 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&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('classecs_1_1_identity_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> |
|
|
<a href="#pub-static-methods">Static Public Member Functions</a> |
|
|
<a href="classecs_1_1_identity_component-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">ecs::IdentityComponent Class Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="dynheader">
|
|
Inheritance diagram for ecs::IdentityComponent:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="classecs_1_1_identity_component.png" usemap="#ecs::IdentityComponent_map" alt=""/>
|
|
<map id="ecs::IdentityComponent_map" name="ecs::IdentityComponent_map">
|
|
<area href="classecs_1_1_component.html" alt="ecs::Component" shape="rect" coords="0,0,141,24"/>
|
|
</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:a253122e10cbe22c42831d250d48a8316" id="r_a253122e10cbe22c42831d250d48a8316"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a253122e10cbe22c42831d250d48a8316">IdentityComponent</a> ()</td></tr>
|
|
<tr class="separator:a253122e10cbe22c42831d250d48a8316"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a99226afd520c616f5f2a04074e076acc" id="r_a99226afd520c616f5f2a04074e076acc"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a99226afd520c616f5f2a04074e076acc">IdentityComponent</a> (int id)</td></tr>
|
|
<tr class="separator:a99226afd520c616f5f2a04074e076acc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2dd90b29ef25585a52f93383b8e00632" id="r_a2dd90b29ef25585a52f93383b8e00632"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a2dd90b29ef25585a52f93383b8e00632">IdentityComponent</a> (int id, const std::string &name)</td></tr>
|
|
<tr class="separator:a2dd90b29ef25585a52f93383b8e00632"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a04b2bb43ccf6c4842704f30463033b3b" id="r_a04b2bb43ccf6c4842704f30463033b3b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a04b2bb43ccf6c4842704f30463033b3b">Initialize</a> () override</td></tr>
|
|
<tr class="separator:a04b2bb43ccf6c4842704f30463033b3b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af7fcece7aaa148512ba153d1d3a4cc1c" id="r_af7fcece7aaa148512ba153d1d3a4cc1c"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#af7fcece7aaa148512ba153d1d3a4cc1c">GetId</a> () const</td></tr>
|
|
<tr class="separator:af7fcece7aaa148512ba153d1d3a4cc1c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a69797f6d9f9926293d2e0b4e84e3bbb3" id="r_a69797f6d9f9926293d2e0b4e84e3bbb3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a69797f6d9f9926293d2e0b4e84e3bbb3">SetId</a> (int id)</td></tr>
|
|
<tr class="separator:a69797f6d9f9926293d2e0b4e84e3bbb3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6f97e89a74db7fda99f144c66c17935f" id="r_a6f97e89a74db7fda99f144c66c17935f"><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="#a6f97e89a74db7fda99f144c66c17935f">GetName</a> () const</td></tr>
|
|
<tr class="separator:a6f97e89a74db7fda99f144c66c17935f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa04b3e5f2e40271ba50dfd35c3217013" id="r_aa04b3e5f2e40271ba50dfd35c3217013"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#aa04b3e5f2e40271ba50dfd35c3217013">SetName</a> (const std::string &name)</td></tr>
|
|
<tr class="separator:aa04b3e5f2e40271ba50dfd35c3217013"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abc33d5a325706c7c115b88fd9635a4cd" id="r_abc33d5a325706c7c115b88fd9635a4cd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceecs.html#ab36dd172176a3da5558233694cbad4ae">ObjectType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#abc33d5a325706c7c115b88fd9635a4cd">GetType</a> () const</td></tr>
|
|
<tr class="separator:abc33d5a325706c7c115b88fd9635a4cd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7cbca5e7e2c877b45c900df4660c0e35" id="r_a7cbca5e7e2c877b45c900df4660c0e35"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a7cbca5e7e2c877b45c900df4660c0e35">SetType</a> (<a class="el" href="namespaceecs.html#ab36dd172176a3da5558233694cbad4ae">ObjectType</a> type)</td></tr>
|
|
<tr class="separator:a7cbca5e7e2c877b45c900df4660c0e35"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_classecs_1_1_component"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_classecs_1_1_component')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classecs_1_1_component.html">ecs::Component</a></td></tr>
|
|
<tr class="memitem:a8dbee43fa54890ad07145aa1160b0b09 inherit pub_methods_classecs_1_1_component" id="r_a8dbee43fa54890ad07145aa1160b0b09"><td class="memItemLeft" align="right" valign="top">
|
|
 </td><td class="memItemRight" valign="bottom"><b>Component</b> (const <a class="el" href="classecs_1_1_component.html">Component</a> &)=delete</td></tr>
|
|
<tr class="separator:a8dbee43fa54890ad07145aa1160b0b09 inherit pub_methods_classecs_1_1_component"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a34000da33471994c2550e416505026ad inherit pub_methods_classecs_1_1_component" id="r_a34000da33471994c2550e416505026ad"><td class="memItemLeft" align="right" valign="top">
|
|
<a class="el" href="classecs_1_1_component.html">Component</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classecs_1_1_component.html">Component</a> &)=delete</td></tr>
|
|
<tr class="separator:a34000da33471994c2550e416505026ad inherit pub_methods_classecs_1_1_component"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a213cfa3482dca1ffc458b9cf020b4814 inherit pub_methods_classecs_1_1_component" id="r_a213cfa3482dca1ffc458b9cf020b4814"><td class="memItemLeft" align="right" valign="top">
|
|
 </td><td class="memItemRight" valign="bottom"><b>Component</b> (<a class="el" href="classecs_1_1_component.html">Component</a> &&)=default</td></tr>
|
|
<tr class="separator:a213cfa3482dca1ffc458b9cf020b4814 inherit pub_methods_classecs_1_1_component"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8089d7e43f9ac2a6eedd3b0598c46694 inherit pub_methods_classecs_1_1_component" id="r_a8089d7e43f9ac2a6eedd3b0598c46694"><td class="memItemLeft" align="right" valign="top">
|
|
<a class="el" href="classecs_1_1_component.html">Component</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="classecs_1_1_component.html">Component</a> &&)=default</td></tr>
|
|
<tr class="separator:a8089d7e43f9ac2a6eedd3b0598c46694 inherit pub_methods_classecs_1_1_component"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a59c0f739c4ff19227e27ed7b9f6352e0 inherit pub_methods_classecs_1_1_component" id="r_a59c0f739c4ff19227e27ed7b9f6352e0"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classecs_1_1_component.html#a59c0f739c4ff19227e27ed7b9f6352e0">Update</a> (float deltaTime)</td></tr>
|
|
<tr class="separator:a59c0f739c4ff19227e27ed7b9f6352e0 inherit pub_methods_classecs_1_1_component"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
|
|
Static Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a46f22b04d81b17bea5807d5b9d32b328" id="r_a46f22b04d81b17bea5807d5b9d32b328"><td class="memItemLeft" align="right" valign="top">static std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="#a46f22b04d81b17bea5807d5b9d32b328">ObjectTypeToString</a> (<a class="el" href="namespaceecs.html#ab36dd172176a3da5558233694cbad4ae">ObjectType</a> type)</td></tr>
|
|
<tr class="separator:a46f22b04d81b17bea5807d5b9d32b328"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9a92b2a27ec5399096a3ad196d2dec3f" id="r_a9a92b2a27ec5399096a3ad196d2dec3f"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="namespaceecs.html#ab36dd172176a3da5558233694cbad4ae">ObjectType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a9a92b2a27ec5399096a3ad196d2dec3f">StringToObjectType</a> (const std::string &str)</td></tr>
|
|
<tr class="separator:a9a92b2a27ec5399096a3ad196d2dec3f"><td class="memSeparator" colspan="2"> </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="identity__component_8h_source.html#l00018">18</a> of file <a class="el" href="identity__component_8h_source.html">identity_component.h</a>.</p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a253122e10cbe22c42831d250d48a8316" name="a253122e10cbe22c42831d250d48a8316"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a253122e10cbe22c42831d250d48a8316">◆ </a></span>IdentityComponent() <span class="overload">[1/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ecs::IdentityComponent::IdentityComponent </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> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Builder for the <a class="el" href="classecs_1_1_identity_component.html">IdentityComponent</a> class. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="identity__component_8h_source.html#l00023">23</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"> 23</span>: m_id(0), m_type(ObjectType::Unknown) {}</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="a99226afd520c616f5f2a04074e076acc" name="a99226afd520c616f5f2a04074e076acc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a99226afd520c616f5f2a04074e076acc">◆ </a></span>IdentityComponent() <span class="overload">[2/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ecs::IdentityComponent::IdentityComponent </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>id</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">explicit</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="identity__component_8h_source.html#l00024">24</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"> 24</span>: m_id(<span class="keywordtype">id</span>), m_type(ObjectType::Unknown) {}</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="a2dd90b29ef25585a52f93383b8e00632" name="a2dd90b29ef25585a52f93383b8e00632"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2dd90b29ef25585a52f93383b8e00632">◆ </a></span>IdentityComponent() <span class="overload">[3/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ecs::IdentityComponent::IdentityComponent </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::string &</td> <td class="paramname"><span class="paramname"><em>name</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="identity__component_8h_source.html#l00025">25</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"> 25</span>: m_id(<span class="keywordtype">id</span>), m_name(name), m_type(ObjectType::Unknown) {}</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="af7fcece7aaa148512ba153d1d3a4cc1c" name="af7fcece7aaa148512ba153d1d3a4cc1c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af7fcece7aaa148512ba153d1d3a4cc1c">◆ </a></span>GetId()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int ecs::IdentityComponent::GetId </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</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Get the ID stored by the component. </p><dl class="section return"><dt>Returns</dt><dd>The ID as an int. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="identity__component_8h_source.html#l00040">40</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"> 40</span>{ <span class="keywordflow">return</span> m_id; }</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="a6f97e89a74db7fda99f144c66c17935f" name="a6f97e89a74db7fda99f144c66c17935f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6f97e89a74db7fda99f144c66c17935f">◆ </a></span>GetName()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const std::string & ecs::IdentityComponent::GetName </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</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Get the name of the object. </p><dl class="section return"><dt>Returns</dt><dd>The name as a string. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="identity__component_8h_source.html#l00051">51</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"> 51</span>{ <span class="keywordflow">return</span> m_name; }</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="abc33d5a325706c7c115b88fd9635a4cd" name="abc33d5a325706c7c115b88fd9635a4cd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abc33d5a325706c7c115b88fd9635a4cd">◆ </a></span>GetType()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="namespaceecs.html#ab36dd172176a3da5558233694cbad4ae">ObjectType</a> ecs::IdentityComponent::GetType </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</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Get the type of the object. </p><dl class="section return"><dt>Returns</dt><dd>The type as an ObjectType enum. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="identity__component_8h_source.html#l00062">62</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"> 62</span>{ <span class="keywordflow">return</span> m_type; }</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="a04b2bb43ccf6c4842704f30463033b3b" name="a04b2bb43ccf6c4842704f30463033b3b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a04b2bb43ccf6c4842704f30463033b3b">◆ </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">void ecs::IdentityComponent::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">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Initialize the component. This method is called when the component is added to an entity. It can be used to set up initial values or perform any necessary setup. </p>
|
|
|
|
<p>Reimplemented from <a class="el" href="classecs_1_1_component.html#a9372874f51e5f63584d65fc378d39459">ecs::Component</a>.</p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="identity__component_8h_source.html#l00033">33</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"> 33</span>{}</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="a46f22b04d81b17bea5807d5b9d32b328" name="a46f22b04d81b17bea5807d5b9d32b328"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a46f22b04d81b17bea5807d5b9d32b328">◆ </a></span>ObjectTypeToString()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static std::string ecs::IdentityComponent::ObjectTypeToString </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="namespaceecs.html#ab36dd172176a3da5558233694cbad4ae">ObjectType</a></td> <td class="paramname"><span class="paramname"><em>type</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">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Convert an ObjectType to a string representation. </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">type</td><td>The ObjectType to convert. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A string representation of the ObjectType. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="identity__component_8h_source.html#l00074">74</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"> 74</span> {</div>
|
|
<div class="line"><span class="lineno"> 75</span> <span class="keywordflow">switch</span> (type) {</div>
|
|
<div class="line"><span class="lineno"> 76</span> <span class="keywordflow">case</span> ObjectType::Cube: <span class="keywordflow">return</span> <span class="stringliteral">"Cube"</span>;</div>
|
|
<div class="line"><span class="lineno"> 77</span> <span class="keywordflow">case</span> ObjectType::Sphere: <span class="keywordflow">return</span> <span class="stringliteral">"Sphere"</span>;</div>
|
|
<div class="line"><span class="lineno"> 78</span> <span class="keywordflow">case</span> ObjectType::Terrain: <span class="keywordflow">return</span> <span class="stringliteral">"Terrain"</span>;</div>
|
|
<div class="line"><span class="lineno"> 79</span> <span class="keywordflow">default</span>: <span class="keywordflow">return</span> <span class="stringliteral">"Unknown"</span>;</div>
|
|
<div class="line"><span class="lineno"> 80</span> }</div>
|
|
<div class="line"><span class="lineno"> 81</span> }</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="a69797f6d9f9926293d2e0b4e84e3bbb3" name="a69797f6d9f9926293d2e0b4e84e3bbb3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a69797f6d9f9926293d2e0b4e84e3bbb3">◆ </a></span>SetId()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ecs::IdentityComponent::SetId </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>id</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Set the ID for the component. </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">id</td><td>The ID to set. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="identity__component_8h_source.html#l00045">45</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"> 45</span>{ m_id = id; }</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="aa04b3e5f2e40271ba50dfd35c3217013" name="aa04b3e5f2e40271ba50dfd35c3217013"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa04b3e5f2e40271ba50dfd35c3217013">◆ </a></span>SetName()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ecs::IdentityComponent::SetName </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string &</td> <td class="paramname"><span class="paramname"><em>name</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Set the name of the object. </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">name</td><td>The name to set. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="identity__component_8h_source.html#l00056">56</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"> 56</span>{ m_name = name; }</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="a7cbca5e7e2c877b45c900df4660c0e35" name="a7cbca5e7e2c877b45c900df4660c0e35"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7cbca5e7e2c877b45c900df4660c0e35">◆ </a></span>SetType()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ecs::IdentityComponent::SetType </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="namespaceecs.html#ab36dd172176a3da5558233694cbad4ae">ObjectType</a></td> <td class="paramname"><span class="paramname"><em>type</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Set the type of the object. </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">type</td><td>The type to set as an ObjectType enum. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="identity__component_8h_source.html#l00067">67</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"> 67</span>{ m_type = type; }</div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="a9a92b2a27ec5399096a3ad196d2dec3f" name="a9a92b2a27ec5399096a3ad196d2dec3f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9a92b2a27ec5399096a3ad196d2dec3f">◆ </a></span>StringToObjectType()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static <a class="el" href="namespaceecs.html#ab36dd172176a3da5558233694cbad4ae">ObjectType</a> ecs::IdentityComponent::StringToObjectType </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string &</td> <td class="paramname"><span class="paramname"><em>str</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">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Convert a string representation to an ObjectType. </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">str</td><td>The string to convert. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The corresponding ObjectType, or Unknown if the string does not match any type. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="identity__component_8h_source.html#l00088">88</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"> 88</span> {</div>
|
|
<div class="line"><span class="lineno"> 89</span> <span class="keywordflow">if</span> (str == <span class="stringliteral">"Cube"</span>) <span class="keywordflow">return</span> ObjectType::Cube;</div>
|
|
<div class="line"><span class="lineno"> 90</span> <span class="keywordflow">if</span> (str == <span class="stringliteral">"Sphere"</span>) <span class="keywordflow">return</span> ObjectType::Sphere;</div>
|
|
<div class="line"><span class="lineno"> 91</span> <span class="keywordflow">if</span> (str == <span class="stringliteral">"Terrain"</span>) <span class="keywordflow">return</span> ObjectType::Terrain;</div>
|
|
<div class="line"><span class="lineno"> 92</span> <span class="keywordflow">return</span> ObjectType::Unknown;</div>
|
|
<div class="line"><span class="lineno"> 93</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/components/<a class="el" href="identity__component_8h_source.html">identity_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_identity_component.html">IdentityComponent</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>
|