247 lines
41 KiB
HTML
247 lines
41 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">
|
|
<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.18"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>EnTT: src/entt/entity/handle.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">3.5.0</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.18 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</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">handle.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_HANDLE_HPP</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define ENTT_ENTITY_HANDLE_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 "registry.hpp"</span></div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</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> <span class="keyword">namespace </span><a class="code" href="namespaceentt.html">entt</a> {</div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>  </div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>  </div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="keyword">template</span><<span class="keyword">typename</span> Entity></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="keyword">struct </span><a class="code" href="namespaceentt.html#a288ec07d4e87a28179d43b367ff11eab">basic_handle</a> {</div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="structentt_1_1basic__handle.html#afb6c2e78a876663dfee62aee4d989226"> 21</a></span>  <span class="keyword">using</span> <a class="code" href="structentt_1_1basic__handle.html#afb6c2e78a876663dfee62aee4d989226">entity_type</a> = std::remove_const_t<Entity>;</div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  </div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="structentt_1_1basic__handle.html#ad22a94a5add23583cdda3ee291bdcf3c"> 24</a></span>  <span class="keyword">using</span> <a class="code" href="structentt_1_1basic__handle.html#ad22a94a5add23583cdda3ee291bdcf3c">registry_type</a> = std::conditional_t<</div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  std::is_const_v<Entity>,</div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  <span class="keyword">const</span> <a class="code" href="classentt_1_1basic__registry.html">basic_registry<entity_type></a>,</div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <a class="code" href="classentt_1_1basic__registry.html">basic_registry<entity_type></a></div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  >;</div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  </div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="structentt_1_1basic__handle.html#ac101da0421db31eabe56854f106976d6"> 35</a></span>  <a class="code" href="structentt_1_1basic__handle.html#ac101da0421db31eabe56854f106976d6">basic_handle</a>(<a class="code" href="structentt_1_1basic__handle.html#ad22a94a5add23583cdda3ee291bdcf3c">registry_type</a> &ref, <a class="code" href="structentt_1_1basic__handle.html#afb6c2e78a876663dfee62aee4d989226">entity_type</a> value = <span class="keyword">null</span>) ENTT_NOEXCEPT</div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  : reg{&ref}, <a class="code" href="namespaceentt.html">entt</a>{value}</div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  {}</div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  </div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="structentt_1_1basic__handle.html#a172116427af01cdef90b0aa512ae29fb"> 44</a></span>  <a class="code" href="structentt_1_1basic__handle.html">basic_handle</a> & <a class="code" href="structentt_1_1basic__handle.html#a172116427af01cdef90b0aa512ae29fb">operator=</a>(<span class="keyword">const</span> <a class="code" href="structentt_1_1basic__handle.html#afb6c2e78a876663dfee62aee4d989226">entity_type</a> value) ENTT_NOEXCEPT {</div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <a class="code" href="namespaceentt.html">entt</a> = value;</div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keywordflow">return</span> *<span class="keyword">this</span>;</div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  }</div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  </div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="structentt_1_1basic__handle.html#a4312ae1b3548a06b5132fd13ab7d880f"> 53</a></span>  <a class="code" href="structentt_1_1basic__handle.html">basic_handle</a> & <a class="code" href="structentt_1_1basic__handle.html#a4312ae1b3548a06b5132fd13ab7d880f">operator=</a>(<a class="code" href="structentt_1_1null__t.html">null_t</a>) ENTT_NOEXCEPT {</div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keywordflow">return</span> (*<span class="keyword">this</span> = <span class="keyword">static_cast<</span><a class="code" href="structentt_1_1basic__handle.html#afb6c2e78a876663dfee62aee4d989226">entity_type</a><span class="keyword">></span>(<span class="keyword">null</span>));</div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  }</div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  </div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="structentt_1_1basic__handle.html#a884a19f60a96f2276b0d416c817171ca"> 61</a></span>  [[nodiscard]] <span class="keyword">operator</span> <a class="code" href="structentt_1_1basic__handle.html">basic_handle<const entity_type></a>() const ENTT_NOEXCEPT {</div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keywordflow">return</span> {*reg, <a class="code" href="namespaceentt.html">entt</a>};</div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  }</div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  </div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"><a class="line" href="structentt_1_1basic__handle.html#ae704d7df9242eea8f6c1b20c23b38041"> 69</a></span>  [[nodiscard]] <span class="keyword">operator</span> <a class="code" href="structentt_1_1basic__handle.html#afb6c2e78a876663dfee62aee4d989226">entity_type</a>() const ENTT_NOEXCEPT {</div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keywordflow">return</span> <a class="code" href="structentt_1_1basic__handle.html#aed33d23b97606e21d614ae48e0eed547">entity</a>();</div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  }</div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  </div>
|
|
<div class="line"><a name="l00077"></a><span class="lineno"><a class="line" href="structentt_1_1basic__handle.html#a96f1d26b9fba0fb90827950774432ec3"> 77</a></span>  [[nodiscard]] <span class="keyword">explicit</span> <span class="keyword">operator</span> bool()<span class="keyword"> const </span>{</div>
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keywordflow">return</span> reg->valid(<a class="code" href="namespaceentt.html">entt</a>);</div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  }</div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  </div>
|
|
<div class="line"><a name="l00085"></a><span class="lineno"><a class="line" href="structentt_1_1basic__handle.html#a80804dfe5834cc10472959d181e82bc6"> 85</a></span>  [[nodiscard]] <a class="code" href="structentt_1_1basic__handle.html#ad22a94a5add23583cdda3ee291bdcf3c">registry_type</a> & <a class="code" href="structentt_1_1basic__handle.html#a80804dfe5834cc10472959d181e82bc6">registry</a>() const ENTT_NOEXCEPT {</div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keywordflow">return</span> *reg;</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="l00093"></a><span class="lineno"><a class="line" href="structentt_1_1basic__handle.html#aed33d23b97606e21d614ae48e0eed547"> 93</a></span>  [[nodiscard]] <a class="code" href="structentt_1_1basic__handle.html#afb6c2e78a876663dfee62aee4d989226">entity_type</a> <a class="code" href="structentt_1_1basic__handle.html#aed33d23b97606e21d614ae48e0eed547">entity</a>() const ENTT_NOEXCEPT {</div>
|
|
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keywordflow">return</span> <a class="code" href="namespaceentt.html">entt</a>;</div>
|
|
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  }</div>
|
|
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  </div>
|
|
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="keyword">template</span><<span class="keyword">typename</span> Component, <span class="keyword">typename</span>... Args></div>
|
|
<div class="line"><a name="l00106"></a><span class="lineno"><a class="line" href="structentt_1_1basic__handle.html#a2b53b81f1b5712379cbfb3c36dae6900"> 106</a></span>  decltype(<span class="keyword">auto</span>) <a class="code" href="structentt_1_1basic__handle.html#a2b53b81f1b5712379cbfb3c36dae6900">emplace</a>(Args &&... args)<span class="keyword"> const </span>{</div>
|
|
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  <span class="keywordflow">return</span> reg->template emplace<Component>(<a class="code" href="namespaceentt.html">entt</a>, std::forward<Args>(args)...);</div>
|
|
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  }</div>
|
|
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  </div>
|
|
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  <span class="keyword">template</span><<span class="keyword">typename</span> Component, <span class="keyword">typename</span>... Args></div>
|
|
<div class="line"><a name="l00119"></a><span class="lineno"><a class="line" href="structentt_1_1basic__handle.html#a488891cec44b2b7f7f4a7a02d3f7c5cc"> 119</a></span>  decltype(<span class="keyword">auto</span>) <a class="code" href="structentt_1_1basic__handle.html#a488891cec44b2b7f7f4a7a02d3f7c5cc">emplace_or_replace</a>(Args &&... args)<span class="keyword"> const </span>{</div>
|
|
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  <span class="keywordflow">return</span> reg->template emplace_or_replace<Component>(<a class="code" href="namespaceentt.html">entt</a>, std::forward<Args>(args)...);</div>
|
|
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  }</div>
|
|
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  </div>
|
|
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  <span class="keyword">template</span><<span class="keyword">typename</span> Component, <span class="keyword">typename</span>... Func></div>
|
|
<div class="line"><a name="l00132"></a><span class="lineno"><a class="line" href="structentt_1_1basic__handle.html#a03d02ea23c40489ce7d5b8ec35662181"> 132</a></span>  decltype(<span class="keyword">auto</span>) <a class="code" href="structentt_1_1basic__handle.html#a03d02ea23c40489ce7d5b8ec35662181">patch</a>(Func &&... func)<span class="keyword"> const </span>{</div>
|
|
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  <span class="keywordflow">return</span> reg->template patch<Component>(<a class="code" href="namespaceentt.html">entt</a>, std::forward<Func>(func)...);</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="l00144"></a><span class="lineno"> 144</span>  <span class="keyword">template</span><<span class="keyword">typename</span> Component, <span class="keyword">typename</span>... Args></div>
|
|
<div class="line"><a name="l00145"></a><span class="lineno"><a class="line" href="structentt_1_1basic__handle.html#a7c0f93c6494d9c3d8f35c9c5de375f89"> 145</a></span>  decltype(<span class="keyword">auto</span>) <a class="code" href="structentt_1_1basic__handle.html#a7c0f93c6494d9c3d8f35c9c5de375f89">replace</a>(Args &&... args)<span class="keyword"> const </span>{</div>
|
|
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>  <span class="keywordflow">return</span> reg->template replace<Component>(<a class="code" href="namespaceentt.html">entt</a>, std::forward<Args>(args)...);</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="l00154"></a><span class="lineno"> 154</span>  <span class="keyword">template</span><<span class="keyword">typename</span>... Components></div>
|
|
<div class="line"><a name="l00155"></a><span class="lineno"><a class="line" href="structentt_1_1basic__handle.html#a1dc2593d3ba53137ecf8371348204af8"> 155</a></span>  <span class="keywordtype">void</span> <a class="code" href="structentt_1_1basic__handle.html#a1dc2593d3ba53137ecf8371348204af8">remove</a>()<span class="keyword"> const </span>{</div>
|
|
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  reg->template <a class="code" href="structentt_1_1basic__handle.html#a1dc2593d3ba53137ecf8371348204af8">remove</a><Components...>(<a class="code" href="namespaceentt.html">entt</a>);</div>
|
|
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  }</div>
|
|
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  </div>
|
|
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span>  <span class="keyword">template</span><<span class="keyword">typename</span>... Components></div>
|
|
<div class="line"><a name="l00166"></a><span class="lineno"><a class="line" href="structentt_1_1basic__handle.html#a06f1ac32d958ae10aafee3c52b4b7f56"> 166</a></span>  decltype(<span class="keyword">auto</span>) <a class="code" href="structentt_1_1basic__handle.html#a06f1ac32d958ae10aafee3c52b4b7f56">remove_if_exists</a>()<span class="keyword"> const </span>{</div>
|
|
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span>  <span class="keywordflow">return</span> reg->template <a class="code" href="structentt_1_1basic__handle.html#a06f1ac32d958ae10aafee3c52b4b7f56">remove_if_exists</a><Components...>(<a class="code" href="namespaceentt.html">entt</a>);</div>
|
|
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span>  }</div>
|
|
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span>  </div>
|
|
<div class="line"><a name="l00174"></a><span class="lineno"><a class="line" href="structentt_1_1basic__handle.html#a86d05141208b7b1780834f90bce7a845"> 174</a></span>  <span class="keywordtype">void</span> <a class="code" href="structentt_1_1basic__handle.html#a86d05141208b7b1780834f90bce7a845">remove_all</a>()<span class="keyword"> const </span>{</div>
|
|
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span>  reg->remove_all(<a class="code" href="namespaceentt.html">entt</a>);</div>
|
|
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span>  }</div>
|
|
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span>  </div>
|
|
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span>  <span class="keyword">template</span><<span class="keyword">typename</span>... Components></div>
|
|
<div class="line"><a name="l00185"></a><span class="lineno"><a class="line" href="structentt_1_1basic__handle.html#ad38512325db1669152af8168f920bde1"> 185</a></span>  [[nodiscard]] decltype(<span class="keyword">auto</span>) <a class="code" href="structentt_1_1basic__handle.html#ad38512325db1669152af8168f920bde1">has</a>()<span class="keyword"> const </span>{</div>
|
|
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span>  <span class="keywordflow">return</span> reg->template <a class="code" href="structentt_1_1basic__handle.html#ad38512325db1669152af8168f920bde1">has</a><Components...>(<a class="code" href="namespaceentt.html">entt</a>);</div>
|
|
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span>  }</div>
|
|
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span>  </div>
|
|
<div class="line"><a name="l00196"></a><span class="lineno"> 196</span>  <span class="keyword">template</span><<span class="keyword">typename</span>... Components></div>
|
|
<div class="line"><a name="l00197"></a><span class="lineno"><a class="line" href="structentt_1_1basic__handle.html#a0c72d2e062cb825c38d9ac53094dda35"> 197</a></span>  [[nodiscard]] decltype(<span class="keyword">auto</span>) <a class="code" href="structentt_1_1basic__handle.html#a0c72d2e062cb825c38d9ac53094dda35">any</a>()<span class="keyword"> const </span>{</div>
|
|
<div class="line"><a name="l00198"></a><span class="lineno"> 198</span>  <span class="keywordflow">return</span> reg->template <a class="code" href="structentt_1_1basic__handle.html#a0c72d2e062cb825c38d9ac53094dda35">any</a><Components...>(<a class="code" href="namespaceentt.html">entt</a>);</div>
|
|
<div class="line"><a name="l00199"></a><span class="lineno"> 199</span>  }</div>
|
|
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span>  </div>
|
|
<div class="line"><a name="l00207"></a><span class="lineno"> 207</span>  <span class="keyword">template</span><<span class="keyword">typename</span>... Components></div>
|
|
<div class="line"><a name="l00208"></a><span class="lineno"><a class="line" href="structentt_1_1basic__handle.html#a0ef680044c31ef1e0cc6663338c2cb0a"> 208</a></span>  [[nodiscard]] decltype(<span class="keyword">auto</span>) <a class="code" href="structentt_1_1basic__handle.html#a0ef680044c31ef1e0cc6663338c2cb0a">get</a>()<span class="keyword"> const </span>{</div>
|
|
<div class="line"><a name="l00209"></a><span class="lineno"> 209</span>  <span class="keywordflow">return</span> reg->template <a class="code" href="structentt_1_1basic__handle.html#a0ef680044c31ef1e0cc6663338c2cb0a">get</a><Components...>(<a class="code" href="namespaceentt.html">entt</a>);</div>
|
|
<div class="line"><a name="l00210"></a><span class="lineno"> 210</span>  }</div>
|
|
<div class="line"><a name="l00211"></a><span class="lineno"> 211</span>  </div>
|
|
<div class="line"><a name="l00220"></a><span class="lineno"> 220</span>  <span class="keyword">template</span><<span class="keyword">typename</span> Component, <span class="keyword">typename</span>... Args></div>
|
|
<div class="line"><a name="l00221"></a><span class="lineno"><a class="line" href="structentt_1_1basic__handle.html#ab2a7202c3a8366d919a6c00a1f809014"> 221</a></span>  [[nodiscard]] decltype(<span class="keyword">auto</span>) <a class="code" href="structentt_1_1basic__handle.html#ab2a7202c3a8366d919a6c00a1f809014">get_or_emplace</a>(Args &&... args)<span class="keyword"> const </span>{</div>
|
|
<div class="line"><a name="l00222"></a><span class="lineno"> 222</span>  <span class="keywordflow">return</span> reg->template get_or_emplace<Component>(<a class="code" href="namespaceentt.html">entt</a>, std::forward<Args>(args)...);</div>
|
|
<div class="line"><a name="l00223"></a><span class="lineno"> 223</span>  }</div>
|
|
<div class="line"><a name="l00224"></a><span class="lineno"> 224</span>  </div>
|
|
<div class="line"><a name="l00231"></a><span class="lineno"> 231</span>  <span class="keyword">template</span><<span class="keyword">typename</span>... Components></div>
|
|
<div class="line"><a name="l00232"></a><span class="lineno"><a class="line" href="structentt_1_1basic__handle.html#a6564e44b444db487d61b567b23c7724a"> 232</a></span>  [[nodiscard]] decltype(<span class="keyword">auto</span>) <a class="code" href="structentt_1_1basic__handle.html#a6564e44b444db487d61b567b23c7724a">try_get</a>()<span class="keyword"> const </span>{</div>
|
|
<div class="line"><a name="l00233"></a><span class="lineno"> 233</span>  <span class="keywordflow">return</span> reg->template <a class="code" href="structentt_1_1basic__handle.html#a6564e44b444db487d61b567b23c7724a">try_get</a><Components...>(<a class="code" href="namespaceentt.html">entt</a>);</div>
|
|
<div class="line"><a name="l00234"></a><span class="lineno"> 234</span>  }</div>
|
|
<div class="line"><a name="l00235"></a><span class="lineno"> 235</span>  </div>
|
|
<div class="line"><a name="l00240"></a><span class="lineno"><a class="line" href="structentt_1_1basic__handle.html#a602e2745070b9a5fb51d082a57f4948c"> 240</a></span>  [[nodiscard]] <span class="keywordtype">bool</span> <a class="code" href="structentt_1_1basic__handle.html#a602e2745070b9a5fb51d082a57f4948c">orphan</a>()<span class="keyword"> const </span>{</div>
|
|
<div class="line"><a name="l00241"></a><span class="lineno"> 241</span>  <span class="keywordflow">return</span> reg->orphan(<a class="code" href="namespaceentt.html">entt</a>);</div>
|
|
<div class="line"><a name="l00242"></a><span class="lineno"> 242</span>  }</div>
|
|
<div class="line"><a name="l00243"></a><span class="lineno"> 243</span>  </div>
|
|
<div class="line"><a name="l00250"></a><span class="lineno"> 250</span>  <span class="keyword">template</span><<span class="keyword">typename</span> Func></div>
|
|
<div class="line"><a name="l00251"></a><span class="lineno"><a class="line" href="structentt_1_1basic__handle.html#a287aec975a094713c0a89101abfd4b01"> 251</a></span>  <span class="keywordtype">void</span> <a class="code" href="structentt_1_1basic__handle.html#a287aec975a094713c0a89101abfd4b01">visit</a>(Func &&func)<span class="keyword"> const </span>{</div>
|
|
<div class="line"><a name="l00252"></a><span class="lineno"> 252</span>  reg->visit(<a class="code" href="namespaceentt.html">entt</a>, std::forward<Func>(func));</div>
|
|
<div class="line"><a name="l00253"></a><span class="lineno"> 253</span>  }</div>
|
|
<div class="line"><a name="l00254"></a><span class="lineno"> 254</span>  </div>
|
|
<div class="line"><a name="l00255"></a><span class="lineno"> 255</span> <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00256"></a><span class="lineno"> 256</span>  <a class="code" href="structentt_1_1basic__handle.html#ad22a94a5add23583cdda3ee291bdcf3c">registry_type</a> *reg;</div>
|
|
<div class="line"><a name="l00257"></a><span class="lineno"> 257</span>  <a class="code" href="structentt_1_1basic__handle.html#afb6c2e78a876663dfee62aee4d989226">entity_type</a> <a class="code" href="namespaceentt.html">entt</a>;</div>
|
|
<div class="line"><a name="l00258"></a><span class="lineno"> 258</span> };</div>
|
|
<div class="line"><a name="l00259"></a><span class="lineno"> 259</span>  </div>
|
|
<div class="line"><a name="l00260"></a><span class="lineno"> 260</span>  </div>
|
|
<div class="line"><a name="l00265"></a><span class="lineno"> 265</span> <span class="keyword">template</span><<span class="keyword">typename</span> Entity></div>
|
|
<div class="line"><a name="l00266"></a><span class="lineno"><a class="line" href="namespaceentt.html#a288ec07d4e87a28179d43b367ff11eab"> 266</a></span> <a class="code" href="namespaceentt.html#a288ec07d4e87a28179d43b367ff11eab">basic_handle</a>(<a class="code" href="classentt_1_1basic__registry.html">basic_registry<Entity></a> &, Entity) -> <a class="code" href="structentt_1_1basic__handle.html">basic_handle<Entity></a>;</div>
|
|
<div class="line"><a name="l00267"></a><span class="lineno"> 267</span>  </div>
|
|
<div class="line"><a name="l00268"></a><span class="lineno"> 268</span>  </div>
|
|
<div class="line"><a name="l00273"></a><span class="lineno"> 273</span> <span class="keyword">template</span><<span class="keyword">typename</span> Entity></div>
|
|
<div class="line"><a name="l00274"></a><span class="lineno"><a class="line" href="namespaceentt.html#a6de052205bafd99d67afde880b67a4e8"> 274</a></span> <a class="code" href="namespaceentt.html#a288ec07d4e87a28179d43b367ff11eab">basic_handle</a>(<span class="keyword">const</span> <a class="code" href="classentt_1_1basic__registry.html">basic_registry<Entity></a> &, Entity) -> <a class="code" href="structentt_1_1basic__handle.html">basic_handle<const Entity></a>;</div>
|
|
<div class="line"><a name="l00275"></a><span class="lineno"> 275</span>  </div>
|
|
<div class="line"><a name="l00276"></a><span class="lineno"> 276</span>  </div>
|
|
<div class="line"><a name="l00277"></a><span class="lineno"> 277</span> }</div>
|
|
<div class="line"><a name="l00278"></a><span class="lineno"> 278</span>  </div>
|
|
<div class="line"><a name="l00279"></a><span class="lineno"> 279</span>  </div>
|
|
<div class="line"><a name="l00280"></a><span class="lineno"> 280</span> <span class="preprocessor">#endif</span></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<div class="ttc" id="astructentt_1_1basic__handle_html_a86d05141208b7b1780834f90bce7a845"><div class="ttname"><a href="structentt_1_1basic__handle.html#a86d05141208b7b1780834f90bce7a845">entt::basic_handle::remove_all</a></div><div class="ttdeci">void remove_all() const</div><div class="ttdoc">Removes all the components from a handle and makes it orphaned.</div><div class="ttdef"><b>Definition:</b> <a href="entity_2handle_8hpp_source.html#l00174">handle.hpp:174</a></div></div>
|
|
<div class="ttc" id="astructentt_1_1basic__handle_html"><div class="ttname"><a href="structentt_1_1basic__handle.html">entt::basic_handle</a></div><div class="ttdoc">Non-owning handle to an entity.</div><div class="ttdef"><b>Definition:</b> <a href="entity_2fwd_8hpp_source.html#l00036">fwd.hpp:36</a></div></div>
|
|
<div class="ttc" id="astructentt_1_1null__t_html"><div class="ttname"><a href="structentt_1_1null__t.html">entt::null_t</a></div><div class="ttdoc">Null object for all entity identifiers.</div><div class="ttdef"><b>Definition:</b> <a href="entity_8hpp_source.html#l00125">entity.hpp:125</a></div></div>
|
|
<div class="ttc" id="astructentt_1_1basic__handle_html_a488891cec44b2b7f7f4a7a02d3f7c5cc"><div class="ttname"><a href="structentt_1_1basic__handle.html#a488891cec44b2b7f7f4a7a02d3f7c5cc">entt::basic_handle::emplace_or_replace</a></div><div class="ttdeci">decltype(auto) emplace_or_replace(Args &&... args) const</div><div class="ttdoc">Assigns or replaces the given component for a handle.</div><div class="ttdef"><b>Definition:</b> <a href="entity_2handle_8hpp_source.html#l00119">handle.hpp:119</a></div></div>
|
|
<div class="ttc" id="astructentt_1_1basic__handle_html_a1dc2593d3ba53137ecf8371348204af8"><div class="ttname"><a href="structentt_1_1basic__handle.html#a1dc2593d3ba53137ecf8371348204af8">entt::basic_handle::remove</a></div><div class="ttdeci">void remove() const</div><div class="ttdoc">Removes the given components from a handle.</div><div class="ttdef"><b>Definition:</b> <a href="entity_2handle_8hpp_source.html#l00155">handle.hpp:155</a></div></div>
|
|
<div class="ttc" id="astructentt_1_1basic__handle_html_a06f1ac32d958ae10aafee3c52b4b7f56"><div class="ttname"><a href="structentt_1_1basic__handle.html#a06f1ac32d958ae10aafee3c52b4b7f56">entt::basic_handle::remove_if_exists</a></div><div class="ttdeci">decltype(auto) remove_if_exists() const</div><div class="ttdoc">Removes the given components from a handle.</div><div class="ttdef"><b>Definition:</b> <a href="entity_2handle_8hpp_source.html#l00166">handle.hpp:166</a></div></div>
|
|
<div class="ttc" id="astructentt_1_1basic__handle_html_a03d02ea23c40489ce7d5b8ec35662181"><div class="ttname"><a href="structentt_1_1basic__handle.html#a03d02ea23c40489ce7d5b8ec35662181">entt::basic_handle::patch</a></div><div class="ttdeci">decltype(auto) patch(Func &&... func) const</div><div class="ttdoc">Patches the given component for a handle.</div><div class="ttdef"><b>Definition:</b> <a href="entity_2handle_8hpp_source.html#l00132">handle.hpp:132</a></div></div>
|
|
<div class="ttc" id="astructentt_1_1basic__handle_html_ac101da0421db31eabe56854f106976d6"><div class="ttname"><a href="structentt_1_1basic__handle.html#ac101da0421db31eabe56854f106976d6">entt::basic_handle::basic_handle</a></div><div class="ttdeci">basic_handle(registry_type &ref, entity_type value=null) noexcept</div><div class="ttdoc">Constructs a handle from a given registry and entity.</div><div class="ttdef"><b>Definition:</b> <a href="entity_2handle_8hpp_source.html#l00035">handle.hpp:35</a></div></div>
|
|
<div class="ttc" id="astructentt_1_1basic__handle_html_a0c72d2e062cb825c38d9ac53094dda35"><div class="ttname"><a href="structentt_1_1basic__handle.html#a0c72d2e062cb825c38d9ac53094dda35">entt::basic_handle::any</a></div><div class="ttdeci">decltype(auto) any() const</div><div class="ttdoc">Checks if a handle has at least one of the given components.</div><div class="ttdef"><b>Definition:</b> <a href="entity_2handle_8hpp_source.html#l00197">handle.hpp:197</a></div></div>
|
|
<div class="ttc" id="anamespaceentt_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="algorithm_8hpp_source.html#l00013">algorithm.hpp:13</a></div></div>
|
|
<div class="ttc" id="astructentt_1_1basic__handle_html_a6564e44b444db487d61b567b23c7724a"><div class="ttname"><a href="structentt_1_1basic__handle.html#a6564e44b444db487d61b567b23c7724a">entt::basic_handle::try_get</a></div><div class="ttdeci">decltype(auto) try_get() const</div><div class="ttdoc">Returns pointers to the given components for a handle.</div><div class="ttdef"><b>Definition:</b> <a href="entity_2handle_8hpp_source.html#l00232">handle.hpp:232</a></div></div>
|
|
<div class="ttc" id="astructentt_1_1basic__handle_html_ad38512325db1669152af8168f920bde1"><div class="ttname"><a href="structentt_1_1basic__handle.html#ad38512325db1669152af8168f920bde1">entt::basic_handle::has</a></div><div class="ttdeci">decltype(auto) has() const</div><div class="ttdoc">Checks if a handle has all the given components.</div><div class="ttdef"><b>Definition:</b> <a href="entity_2handle_8hpp_source.html#l00185">handle.hpp:185</a></div></div>
|
|
<div class="ttc" id="astructentt_1_1basic__handle_html_a602e2745070b9a5fb51d082a57f4948c"><div class="ttname"><a href="structentt_1_1basic__handle.html#a602e2745070b9a5fb51d082a57f4948c">entt::basic_handle::orphan</a></div><div class="ttdeci">bool orphan() const</div><div class="ttdoc">Checks if a handle has components assigned.</div><div class="ttdef"><b>Definition:</b> <a href="entity_2handle_8hpp_source.html#l00240">handle.hpp:240</a></div></div>
|
|
<div class="ttc" id="astructentt_1_1basic__handle_html_a2b53b81f1b5712379cbfb3c36dae6900"><div class="ttname"><a href="structentt_1_1basic__handle.html#a2b53b81f1b5712379cbfb3c36dae6900">entt::basic_handle::emplace</a></div><div class="ttdeci">decltype(auto) emplace(Args &&... args) const</div><div class="ttdoc">Assigns the given component to a handle.</div><div class="ttdef"><b>Definition:</b> <a href="entity_2handle_8hpp_source.html#l00106">handle.hpp:106</a></div></div>
|
|
<div class="ttc" id="astructentt_1_1basic__handle_html_a7c0f93c6494d9c3d8f35c9c5de375f89"><div class="ttname"><a href="structentt_1_1basic__handle.html#a7c0f93c6494d9c3d8f35c9c5de375f89">entt::basic_handle::replace</a></div><div class="ttdeci">decltype(auto) replace(Args &&... args) const</div><div class="ttdoc">Replaces the given component for a handle.</div><div class="ttdef"><b>Definition:</b> <a href="entity_2handle_8hpp_source.html#l00145">handle.hpp:145</a></div></div>
|
|
<div class="ttc" id="astructentt_1_1basic__handle_html_a4312ae1b3548a06b5132fd13ab7d880f"><div class="ttname"><a href="structentt_1_1basic__handle.html#a4312ae1b3548a06b5132fd13ab7d880f">entt::basic_handle::operator=</a></div><div class="ttdeci">basic_handle & operator=(null_t) noexcept</div><div class="ttdoc">Assigns the null object to a handle.</div><div class="ttdef"><b>Definition:</b> <a href="entity_2handle_8hpp_source.html#l00053">handle.hpp:53</a></div></div>
|
|
<div class="ttc" id="astructentt_1_1basic__handle_html_aed33d23b97606e21d614ae48e0eed547"><div class="ttname"><a href="structentt_1_1basic__handle.html#aed33d23b97606e21d614ae48e0eed547">entt::basic_handle::entity</a></div><div class="ttdeci">entity_type entity() const noexcept</div><div class="ttdoc">Returns the entity associated with a handle.</div><div class="ttdef"><b>Definition:</b> <a href="entity_2handle_8hpp_source.html#l00093">handle.hpp:93</a></div></div>
|
|
<div class="ttc" id="anamespaceentt_html_a288ec07d4e87a28179d43b367ff11eab"><div class="ttname"><a href="namespaceentt.html#a288ec07d4e87a28179d43b367ff11eab">entt::basic_handle</a></div><div class="ttdeci">basic_handle(basic_registry< Entity > &, Entity) -> basic_handle< Entity ></div><div class="ttdoc">Deduction guide.</div></div>
|
|
<div class="ttc" id="astructentt_1_1basic__handle_html_a287aec975a094713c0a89101abfd4b01"><div class="ttname"><a href="structentt_1_1basic__handle.html#a287aec975a094713c0a89101abfd4b01">entt::basic_handle::visit</a></div><div class="ttdeci">void visit(Func &&func) const</div><div class="ttdoc">Visits a handle and returns the types for its components.</div><div class="ttdef"><b>Definition:</b> <a href="entity_2handle_8hpp_source.html#l00251">handle.hpp:251</a></div></div>
|
|
<div class="ttc" id="astructentt_1_1basic__handle_html_a0ef680044c31ef1e0cc6663338c2cb0a"><div class="ttname"><a href="structentt_1_1basic__handle.html#a0ef680044c31ef1e0cc6663338c2cb0a">entt::basic_handle::get</a></div><div class="ttdeci">decltype(auto) get() const</div><div class="ttdoc">Returns references to the given components for a handle.</div><div class="ttdef"><b>Definition:</b> <a href="entity_2handle_8hpp_source.html#l00208">handle.hpp:208</a></div></div>
|
|
<div class="ttc" id="aclassentt_1_1basic__registry_html"><div class="ttname"><a href="classentt_1_1basic__registry.html">entt::basic_registry< entity_type ></a></div></div>
|
|
<div class="ttc" id="astructentt_1_1basic__handle_html_a172116427af01cdef90b0aa512ae29fb"><div class="ttname"><a href="structentt_1_1basic__handle.html#a172116427af01cdef90b0aa512ae29fb">entt::basic_handle::operator=</a></div><div class="ttdeci">basic_handle & operator=(const entity_type value) noexcept</div><div class="ttdoc">Assigns an entity to a handle.</div><div class="ttdef"><b>Definition:</b> <a href="entity_2handle_8hpp_source.html#l00044">handle.hpp:44</a></div></div>
|
|
<div class="ttc" id="astructentt_1_1basic__handle_html_a80804dfe5834cc10472959d181e82bc6"><div class="ttname"><a href="structentt_1_1basic__handle.html#a80804dfe5834cc10472959d181e82bc6">entt::basic_handle::registry</a></div><div class="ttdeci">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="entity_2handle_8hpp_source.html#l00085">handle.hpp:85</a></div></div>
|
|
<div class="ttc" id="astructentt_1_1basic__handle_html_ad22a94a5add23583cdda3ee291bdcf3c"><div class="ttname"><a href="structentt_1_1basic__handle.html#ad22a94a5add23583cdda3ee291bdcf3c">entt::basic_handle::registry_type</a></div><div class="ttdeci">std::conditional_t< std::is_const_v< Entity >, const basic_registry< entity_type >, basic_registry< entity_type > > registry_type</div><div class="ttdoc">Type of registry accepted by the handle.</div><div class="ttdef"><b>Definition:</b> <a href="entity_2handle_8hpp_source.html#l00024">handle.hpp:28</a></div></div>
|
|
<div class="ttc" id="astructentt_1_1basic__handle_html_ab2a7202c3a8366d919a6c00a1f809014"><div class="ttname"><a href="structentt_1_1basic__handle.html#ab2a7202c3a8366d919a6c00a1f809014">entt::basic_handle::get_or_emplace</a></div><div class="ttdeci">decltype(auto) get_or_emplace(Args &&... args) const</div><div class="ttdoc">Returns a reference to the given component for a handle.</div><div class="ttdef"><b>Definition:</b> <a href="entity_2handle_8hpp_source.html#l00221">handle.hpp:221</a></div></div>
|
|
<div class="ttc" id="astructentt_1_1basic__handle_html_afb6c2e78a876663dfee62aee4d989226"><div class="ttname"><a href="structentt_1_1basic__handle.html#afb6c2e78a876663dfee62aee4d989226">entt::basic_handle::entity_type</a></div><div class="ttdeci">std::remove_const_t< Entity > entity_type</div><div class="ttdoc">Underlying entity identifier.</div><div class="ttdef"><b>Definition:</b> <a href="entity_2handle_8hpp_source.html#l00021">handle.hpp:21</a></div></div>
|
|
<!-- 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.18
|
|
</small></address>
|
|
</body>
|
|
</html>
|