93 lines
22 KiB
HTML
93 lines
22 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.13"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>entt: src/entt/entity/actor.hpp Source File</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>
|
|
<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 style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">entt
|
|
 <span id="projectnumber">2.4.0</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.13 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
<!-- 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">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_66e9674e8206a335795995fa32a03c91.html">entt</a></li><li class="navelem"><a class="el" href="dir_e3a7bb56c55e5c2286e2fe96e197d4f5.html">entity</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">actor.hpp</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#ifndef ENTT_ENTITY_ACTOR_HPP</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define ENTT_ENTITY_ACTOR_HPP</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> </div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> </div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#include <utility></span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#include "registry.hpp"</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> </div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> </div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="keyword">namespace </span><a class="code" href="namespaceentt.html">entt</a> {</div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> </div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> </div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="keyword">template</span><<span class="keyword">typename</span> Entity, <span class="keyword">typename</span> Delta></div><div class="line"><a name="l00022"></a><span class="lineno"><a class="line" href="structentt_1_1Actor.html"> 22</a></span> <span class="keyword">struct </span><a class="code" href="structentt_1_1Actor.html">Actor</a> {</div><div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="structentt_1_1Actor.html#a985b72f734944acd3691a8f22da886e4"> 24</a></span>  <span class="keyword">using</span> <a class="code" href="classentt_1_1Registry.html">registry_type</a> = <a class="code" href="classentt_1_1Registry.html">Registry<Entity></a>;</div><div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="structentt_1_1Actor.html#a681204f0400537f8ca6b0ad0cfcdaa52"> 26</a></span>  <span class="keyword">using</span> <a class="code" href="structentt_1_1Actor.html#a681204f0400537f8ca6b0ad0cfcdaa52">delta_type</a> = Delta;</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div><div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="structentt_1_1Actor.html#aa55414e7e6ad064d9f72d391d3a0884b"> 32</a></span>  <a class="code" href="structentt_1_1Actor.html#aa55414e7e6ad064d9f72d391d3a0884b">Actor</a>(<a class="code" href="classentt_1_1Registry.html">Registry<Entity></a> &reg)</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  : reg{reg}, entity{reg.<a class="code" href="classentt_1_1Registry.html#a68363417c654ab36e68606c13deb850e">create</a>()}</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  {}</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="structentt_1_1Actor.html#abbc1727eba50bf378bca0a8d50fcf779"> 37</a></span>  <span class="keyword">virtual</span> <a class="code" href="structentt_1_1Actor.html#abbc1727eba50bf378bca0a8d50fcf779">~Actor</a>() {</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  reg.<a class="code" href="classentt_1_1Registry.html#afe1fc933ce101207a49b6bdeafa2ce41">destroy</a>(entity);</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  }</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <a class="code" href="structentt_1_1Actor.html#aa55414e7e6ad064d9f72d391d3a0884b">Actor</a>(<span class="keyword">const</span> <a class="code" href="structentt_1_1Actor.html">Actor</a> &) = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <a class="code" href="structentt_1_1Actor.html#aa55414e7e6ad064d9f72d391d3a0884b">Actor</a>(<a class="code" href="structentt_1_1Actor.html">Actor</a> &&) = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <a class="code" href="structentt_1_1Actor.html">Actor</a> & <a class="code" href="structentt_1_1Actor.html#a834298175f56e310cf6de3215fe41bdc">operator=</a>(<span class="keyword">const</span> <a class="code" href="structentt_1_1Actor.html">Actor</a> &) = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <a class="code" href="structentt_1_1Actor.html">Actor</a> & <a class="code" href="structentt_1_1Actor.html#a834298175f56e310cf6de3215fe41bdc">operator=</a>(<a class="code" href="structentt_1_1Actor.html">Actor</a> &&) = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keyword">template</span><<span class="keyword">typename</span> Component, <span class="keyword">typename</span>... Args></div><div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="structentt_1_1Actor.html#a1055479e21732516c67615e906c76bc3"> 66</a></span>  Component & <span class="keyword">set</span>(Args&&... args) {</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keywordflow">return</span> reg.template accomodate<Component>(entity, std::forward<Args>(args)...);</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  }</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keyword">template</span><<span class="keyword">typename</span> Component></div><div class="line"><a name="l00075"></a><span class="lineno"><a class="line" href="structentt_1_1Actor.html#a8d655b4e1afe76293b4ef7524f51d81a"> 75</a></span>  <span class="keywordtype">void</span> <a class="code" href="structentt_1_1Actor.html#a8d655b4e1afe76293b4ef7524f51d81a">unset</a>() {</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  reg.template remove<Component>(entity);</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  }</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keyword">template</span><<span class="keyword">typename</span> Component></div><div class="line"><a name="l00085"></a><span class="lineno"><a class="line" href="structentt_1_1Actor.html#aec49ed1965b977a9b9b1169cc6596f48"> 85</a></span>  <span class="keywordtype">bool</span> <a class="code" href="structentt_1_1Actor.html#aec49ed1965b977a9b9b1169cc6596f48">has</a>() const noexcept {</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keywordflow">return</span> reg.template has<Component>(entity);</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  }</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> </div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keyword">template</span><<span class="keyword">typename</span> Component></div><div class="line"><a name="l00095"></a><span class="lineno"><a class="line" href="structentt_1_1Actor.html#a995069fd7c86bd152e1eaac811fb56dd"> 95</a></span>  <span class="keyword">const</span> Component & <span class="keyword">get</span>() <span class="keyword">const</span> noexcept {</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keywordflow">return</span> reg.template get<Component>(entity);</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  }</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> </div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <span class="keyword">template</span><<span class="keyword">typename</span> Component></div><div class="line"><a name="l00105"></a><span class="lineno"><a class="line" href="structentt_1_1Actor.html#ae5f572a978820e9055a9778774221104"> 105</a></span>  Component & <span class="keyword">get</span>() noexcept {</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <span class="keywordflow">return</span> <span class="keyword">const_cast<</span>Component &<span class="keyword">></span>(<span class="keyword">const_cast<</span><span class="keyword">const </span><a class="code" href="structentt_1_1Actor.html">Actor</a> *<span class="keyword">></span>(<span class="keyword">this</span>)->get<Component>());</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  }</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> </div><div class="line"><a name="l00113"></a><span class="lineno"><a class="line" href="structentt_1_1Actor.html#a3fe052f3501732231e6ae3e02f57f68b"> 113</a></span>  <span class="keyword">const</span> <a class="code" href="classentt_1_1Registry.html">registry_type</a> & <a class="code" href="structentt_1_1Actor.html#a3fe052f3501732231e6ae3e02f57f68b">registry</a>() const noexcept {</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  <span class="keywordflow">return</span> reg;</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  }</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> </div><div class="line"><a name="l00121"></a><span class="lineno"><a class="line" href="structentt_1_1Actor.html#a15b718300c2868451394a9af0f7cc254"> 121</a></span>  <a class="code" href="classentt_1_1Registry.html">registry_type</a> & <a class="code" href="structentt_1_1Actor.html#a15b718300c2868451394a9af0f7cc254">registry</a>() noexcept {</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  <span class="keywordflow">return</span> <span class="keyword">const_cast<</span><a class="code" href="classentt_1_1Registry.html">registry_type</a> &<span class="keyword">></span>(<span class="keyword">const_cast<</span><span class="keyword">const </span><a class="code" href="structentt_1_1Actor.html">Actor</a> *<span class="keyword">></span>(<span class="keyword">this</span>)-><a class="code" href="structentt_1_1Actor.html#a3fe052f3501732231e6ae3e02f57f68b">registry</a>());</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  }</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> </div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structentt_1_1Actor.html#ac83169b04dcdb12d8c3288eb48261ac6">update</a>(<a class="code" href="structentt_1_1Actor.html#a681204f0400537f8ca6b0ad0cfcdaa52">delta_type</a> delta) = 0;</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span> </div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  <a class="code" href="classentt_1_1Registry.html">registry_type</a> &reg;</div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  Entity entity;</div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span> };</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span> </div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span> </div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="keyword">template</span><<span class="keyword">typename</span> Delta></div><div class="line"><a name="l00146"></a><span class="lineno"><a class="line" href="namespaceentt.html#a480627ee5041c0b6e34a03307eaf9ec5"> 146</a></span> <span class="keyword">using</span> <a class="code" href="structentt_1_1Actor.html">DefaultActor</a> = <a class="code" href="structentt_1_1Actor.html">Actor<std::uint32_t, Delta></a>;</div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span> </div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span> </div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span> }</div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span> </div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span> </div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="preprocessor">#endif // ENTT_ENTITY_ACTOR_HPP</span></div><div class="ttc" id="classentt_1_1Registry_html"><div class="ttname"><a href="classentt_1_1Registry.html">entt::Registry</a></div><div class="ttdoc">Fast and reliable entity-component system. </div><div class="ttdef"><b>Definition:</b> <a href="registry_8hpp_source.html#l00032">registry.hpp:32</a></div></div>
|
|
<div class="ttc" id="namespaceentt_html"><div class="ttname"><a href="namespaceentt.html">entt</a></div><div class="ttdoc">EnTT default namespace. </div><div class="ttdef"><b>Definition:</b> <a href="family_8hpp_source.html#l00009">family.hpp:9</a></div></div>
|
|
<div class="ttc" id="structentt_1_1Actor_html_a834298175f56e310cf6de3215fe41bdc"><div class="ttname"><a href="structentt_1_1Actor.html#a834298175f56e310cf6de3215fe41bdc">entt::Actor::operator=</a></div><div class="ttdeci">Actor & operator=(const Actor &)=default</div><div class="ttdoc">Default copy assignment operator. </div></div>
|
|
<div class="ttc" id="structentt_1_1Actor_html_ac83169b04dcdb12d8c3288eb48261ac6"><div class="ttname"><a href="structentt_1_1Actor.html#ac83169b04dcdb12d8c3288eb48261ac6">entt::Actor::update</a></div><div class="ttdeci">virtual void update(delta_type delta)=0</div><div class="ttdoc">Updates an actor, whatever it means to update it. </div></div>
|
|
<div class="ttc" id="structentt_1_1Actor_html_aa55414e7e6ad064d9f72d391d3a0884b"><div class="ttname"><a href="structentt_1_1Actor.html#aa55414e7e6ad064d9f72d391d3a0884b">entt::Actor::Actor</a></div><div class="ttdeci">Actor(Registry< Entity > &reg)</div><div class="ttdoc">Constructs an actor by using the given registry. </div><div class="ttdef"><b>Definition:</b> <a href="actor_8hpp_source.html#l00032">actor.hpp:32</a></div></div>
|
|
<div class="ttc" id="structentt_1_1Actor_html_a681204f0400537f8ca6b0ad0cfcdaa52"><div class="ttname"><a href="structentt_1_1Actor.html#a681204f0400537f8ca6b0ad0cfcdaa52">entt::Actor::delta_type</a></div><div class="ttdeci">Delta delta_type</div><div class="ttdoc">Type used to provide elapsed time. </div><div class="ttdef"><b>Definition:</b> <a href="actor_8hpp_source.html#l00026">actor.hpp:26</a></div></div>
|
|
<div class="ttc" id="classentt_1_1Registry_html_a68363417c654ab36e68606c13deb850e"><div class="ttname"><a href="classentt_1_1Registry.html#a68363417c654ab36e68606c13deb850e">entt::Registry::create</a></div><div class="ttdeci">entity_type create(Component &&... components) noexcept</div><div class="ttdoc">Returns a new entity initialized with the given components. </div><div class="ttdef"><b>Definition:</b> <a href="registry_8hpp_source.html#l00354">registry.hpp:354</a></div></div>
|
|
<div class="ttc" id="structentt_1_1Actor_html"><div class="ttname"><a href="structentt_1_1Actor.html">entt::Actor</a></div><div class="ttdoc">Dedicated to those who aren&#39;t confident with entity-component systems. </div><div class="ttdef"><b>Definition:</b> <a href="actor_8hpp_source.html#l00022">actor.hpp:22</a></div></div>
|
|
<div class="ttc" id="structentt_1_1Actor_html_aec49ed1965b977a9b9b1169cc6596f48"><div class="ttname"><a href="structentt_1_1Actor.html#aec49ed1965b977a9b9b1169cc6596f48">entt::Actor::has</a></div><div class="ttdeci">bool has() const noexcept</div><div class="ttdoc">Checks if an actor has the given component. </div><div class="ttdef"><b>Definition:</b> <a href="actor_8hpp_source.html#l00085">actor.hpp:85</a></div></div>
|
|
<div class="ttc" id="structentt_1_1Actor_html_a3fe052f3501732231e6ae3e02f57f68b"><div class="ttname"><a href="structentt_1_1Actor.html#a3fe052f3501732231e6ae3e02f57f68b">entt::Actor::registry</a></div><div class="ttdeci">const registry_type & registry() const noexcept</div><div class="ttdoc">Returns a reference to the underlying registry. </div><div class="ttdef"><b>Definition:</b> <a href="actor_8hpp_source.html#l00113">actor.hpp:113</a></div></div>
|
|
<div class="ttc" id="classentt_1_1Registry_html_afe1fc933ce101207a49b6bdeafa2ce41"><div class="ttname"><a href="classentt_1_1Registry.html#afe1fc933ce101207a49b6bdeafa2ce41">entt::Registry::destroy</a></div><div class="ttdeci">void destroy(entity_type entity)</div><div class="ttdoc">Destroys an entity and lets the registry recycle the identifier. </div><div class="ttdef"><b>Definition:</b> <a href="registry_8hpp_source.html#l00437">registry.hpp:437</a></div></div>
|
|
<div class="ttc" id="structentt_1_1Actor_html_abbc1727eba50bf378bca0a8d50fcf779"><div class="ttname"><a href="structentt_1_1Actor.html#abbc1727eba50bf378bca0a8d50fcf779">entt::Actor::~Actor</a></div><div class="ttdeci">virtual ~Actor()</div><div class="ttdoc">Default destructor. </div><div class="ttdef"><b>Definition:</b> <a href="actor_8hpp_source.html#l00037">actor.hpp:37</a></div></div>
|
|
<div class="ttc" id="structentt_1_1Actor_html_a8d655b4e1afe76293b4ef7524f51d81a"><div class="ttname"><a href="structentt_1_1Actor.html#a8d655b4e1afe76293b4ef7524f51d81a">entt::Actor::unset</a></div><div class="ttdeci">void unset()</div><div class="ttdoc">Removes the given component from an actor. </div><div class="ttdef"><b>Definition:</b> <a href="actor_8hpp_source.html#l00075">actor.hpp:75</a></div></div>
|
|
<div class="ttc" id="structentt_1_1Actor_html_a15b718300c2868451394a9af0f7cc254"><div class="ttname"><a href="structentt_1_1Actor.html#a15b718300c2868451394a9af0f7cc254">entt::Actor::registry</a></div><div class="ttdeci">registry_type & registry() noexcept</div><div class="ttdoc">Returns a reference to the underlying registry. </div><div class="ttdef"><b>Definition:</b> <a href="actor_8hpp_source.html#l00121">actor.hpp:121</a></div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.13
|
|
</small></address>
|
|
</body>
|
|
</html>
|