160 lines
18 KiB
HTML
160 lines
18 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.16"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>EnTT: src/entt/entity/helper.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.3.0</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.16 -->
|
|
<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">helper.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_HELPER_HPP</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define ENTT_ENTITY_HELPER_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 <type_traits></span></div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#include "../core/type_traits.hpp"</span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#include "../config/config.h"</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#include "registry.hpp"</span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#include "fwd.hpp"</span></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="l00012"></a><span class="lineno"> 12</span> <span class="keyword">namespace </span><a class="code" href="namespaceentt.html">entt</a> {</div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>  </div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>  </div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="keyword">template</span><<span class="keywordtype">bool</span> Const, <span class="keyword">typename</span> Entity></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="structentt_1_1as__view.html"> 21</a></span> <span class="keyword">struct </span><a class="code" href="structentt_1_1as__view.html">as_view</a> {</div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="structentt_1_1as__view.html#a458942b049c7ef96d45600337d57a70b"> 23</a></span>  <span class="keyword">using</span> <a class="code" href="structentt_1_1as__view.html#a458942b049c7ef96d45600337d57a70b">registry_type</a> = std::conditional_t<Const, const entt::basic_registry<Entity>, <a class="code" href="classentt_1_1basic__registry.html">entt::basic_registry<Entity></a>>;</div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  </div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="structentt_1_1as__view.html#a820ab4da509a0fb60c4edf8ea24b748a"> 29</a></span>  <a class="code" href="structentt_1_1as__view.html#a820ab4da509a0fb60c4edf8ea24b748a">as_view</a>(<a class="code" href="structentt_1_1as__view.html#a458942b049c7ef96d45600337d57a70b">registry_type</a> &source) ENTT_NOEXCEPT: reg{source} {}</div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  </div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="keyword">template</span><<span class="keyword">typename</span> Exclude, <span class="keyword">typename</span>... Component></div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="structentt_1_1as__view.html#aac140def0e18cd8dc04c486f6d5813da"> 38</a></span>  <span class="keyword">operator</span> <a class="code" href="classentt_1_1basic__view.html">entt::basic_view</a><Entity, Exclude, Component...>() <span class="keyword">const</span> {</div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keywordflow">return</span> reg.template <a class="code" href="classentt_1_1basic__view.html">view</a><Component...>(Exclude{});</div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  }</div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  </div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <a class="code" href="structentt_1_1as__view.html#a458942b049c7ef96d45600337d57a70b">registry_type</a> &reg;</div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> };</div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  </div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  </div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="keyword">template</span><<span class="keyword">typename</span> Entity></div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <a class="code" href="namespaceentt.html#a3fee75741468f7807d3d48dd807ee024">as_view</a>(basic_registry<Entity> &) ENTT_NOEXCEPT -> as_view<false, Entity>;</div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  </div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  </div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="keyword">template</span><<span class="keyword">typename</span> Entity></div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <a class="code" href="namespaceentt.html#a3fee75741468f7807d3d48dd807ee024">as_view</a>(<span class="keyword">const</span> basic_registry<Entity> &) ENTT_NOEXCEPT -> as_view<true, Entity>;</div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  </div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  </div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="keyword">template</span><<span class="keywordtype">bool</span> Const, <span class="keyword">typename</span> Entity></div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"><a class="line" href="structentt_1_1as__group.html"> 70</a></span> <span class="keyword">struct </span><a class="code" href="structentt_1_1as__group.html">as_group</a> {</div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"><a class="line" href="structentt_1_1as__group.html#a7ede36514bf64187bc93d3d295fe0123"> 72</a></span>  <span class="keyword">using</span> <a class="code" href="structentt_1_1as__group.html#a7ede36514bf64187bc93d3d295fe0123">registry_type</a> = std::conditional_t<Const, const entt::basic_registry<Entity>, <a class="code" href="classentt_1_1basic__registry.html">entt::basic_registry<Entity></a>>;</div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  </div>
|
|
<div class="line"><a name="l00078"></a><span class="lineno"><a class="line" href="structentt_1_1as__group.html#a7ebe095efa7c1e00e2f156ad7930d9a9"> 78</a></span>  <a class="code" href="structentt_1_1as__group.html#a7ebe095efa7c1e00e2f156ad7930d9a9">as_group</a>(<a class="code" href="structentt_1_1as__group.html#a7ede36514bf64187bc93d3d295fe0123">registry_type</a> &source) ENTT_NOEXCEPT: reg{source} {}</div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  </div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keyword">template</span><<span class="keyword">typename</span> Exclude, <span class="keyword">typename</span> Get, <span class="keyword">typename</span>... Owned></div>
|
|
<div class="line"><a name="l00088"></a><span class="lineno"><a class="line" href="structentt_1_1as__group.html#a5bc540042a69aee98c28c8446152a47f"> 88</a></span>  <span class="keyword">operator</span> <a class="code" href="classentt_1_1basic__group.html">entt::basic_group</a><Entity, Exclude, Get, Owned...>() <span class="keyword">const</span> {</div>
|
|
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keywordflow">return</span> reg.template <a class="code" href="classentt_1_1basic__group.html">group</a><Owned...>(Get{}, Exclude{});</div>
|
|
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  }</div>
|
|
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  </div>
|
|
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <a class="code" href="structentt_1_1as__group.html#a7ede36514bf64187bc93d3d295fe0123">registry_type</a> &reg;</div>
|
|
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> };</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> Entity></div>
|
|
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <a class="code" href="namespaceentt.html#a6609f31d6ab3f544ebf7d0413d007ead">as_group</a>(basic_registry<Entity> &) ENTT_NOEXCEPT -> as_group<false, Entity>;</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="l00110"></a><span class="lineno"> 110</span> <span class="keyword">template</span><<span class="keyword">typename</span> Entity></div>
|
|
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <a class="code" href="namespaceentt.html#a6609f31d6ab3f544ebf7d0413d007ead">as_group</a>(<span class="keyword">const</span> basic_registry<Entity> &) ENTT_NOEXCEPT -> as_group<true, Entity>;</div>
|
|
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  </div>
|
|
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  </div>
|
|
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> }</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="l00117"></a><span class="lineno"> 117</span> <span class="preprocessor">#endif</span></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<div class="ttc" id="astructentt_1_1as__group_html"><div class="ttname"><a href="structentt_1_1as__group.html">entt::as_group</a></div><div class="ttdoc">Converts a registry to a group.</div><div class="ttdef"><b>Definition:</b> <a href="helper_8hpp_source.html#l00070">helper.hpp:70</a></div></div>
|
|
<div class="ttc" id="astructentt_1_1as__group_html_a7ede36514bf64187bc93d3d295fe0123"><div class="ttname"><a href="structentt_1_1as__group.html#a7ede36514bf64187bc93d3d295fe0123">entt::as_group::registry_type</a></div><div class="ttdeci">std::conditional_t< Const, const entt::basic_registry< Entity >, entt::basic_registry< Entity > > registry_type</div><div class="ttdoc">Type of registry to convert.</div><div class="ttdef"><b>Definition:</b> <a href="helper_8hpp_source.html#l00072">helper.hpp:72</a></div></div>
|
|
<div class="ttc" id="astructentt_1_1as__view_html_a458942b049c7ef96d45600337d57a70b"><div class="ttname"><a href="structentt_1_1as__view.html#a458942b049c7ef96d45600337d57a70b">entt::as_view::registry_type</a></div><div class="ttdeci">std::conditional_t< Const, const entt::basic_registry< Entity >, entt::basic_registry< Entity > > registry_type</div><div class="ttdoc">Type of registry to convert.</div><div class="ttdef"><b>Definition:</b> <a href="helper_8hpp_source.html#l00023">helper.hpp:23</a></div></div>
|
|
<div class="ttc" id="aclassentt_1_1basic__group_html"><div class="ttname"><a href="classentt_1_1basic__group.html">entt::basic_group</a></div><div class="ttdoc">Group.</div><div class="ttdef"><b>Definition:</b> <a href="entity_2fwd_8hpp_source.html#l00058">fwd.hpp:58</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_1as__view_html_a820ab4da509a0fb60c4edf8ea24b748a"><div class="ttname"><a href="structentt_1_1as__view.html#a820ab4da509a0fb60c4edf8ea24b748a">entt::as_view::as_view</a></div><div class="ttdeci">as_view(registry_type &source) ENTT_NOEXCEPT</div><div class="ttdoc">Constructs a converter for a given registry.</div><div class="ttdef"><b>Definition:</b> <a href="helper_8hpp_source.html#l00029">helper.hpp:29</a></div></div>
|
|
<div class="ttc" id="anamespaceentt_html_a3fee75741468f7807d3d48dd807ee024"><div class="ttname"><a href="namespaceentt.html#a3fee75741468f7807d3d48dd807ee024">entt::as_view</a></div><div class="ttdeci">as_view(basic_registry< Entity > &) ENTT_NOEXCEPT -> as_view< false, Entity ></div><div class="ttdoc">Deduction guide.</div></div>
|
|
<div class="ttc" id="aclassentt_1_1basic__registry_html"><div class="ttname"><a href="classentt_1_1basic__registry.html">entt::basic_registry</a></div><div class="ttdoc">Fast and reliable entity-component system.</div><div class="ttdef"><b>Definition:</b> <a href="entity_2fwd_8hpp_source.html#l00046">fwd.hpp:46</a></div></div>
|
|
<div class="ttc" id="astructentt_1_1as__group_html_a7ebe095efa7c1e00e2f156ad7930d9a9"><div class="ttname"><a href="structentt_1_1as__group.html#a7ebe095efa7c1e00e2f156ad7930d9a9">entt::as_group::as_group</a></div><div class="ttdeci">as_group(registry_type &source) ENTT_NOEXCEPT</div><div class="ttdoc">Constructs a converter for a given registry.</div><div class="ttdef"><b>Definition:</b> <a href="helper_8hpp_source.html#l00078">helper.hpp:78</a></div></div>
|
|
<div class="ttc" id="astructentt_1_1as__view_html"><div class="ttname"><a href="structentt_1_1as__view.html">entt::as_view</a></div><div class="ttdoc">Converts a registry to a view.</div><div class="ttdef"><b>Definition:</b> <a href="helper_8hpp_source.html#l00021">helper.hpp:21</a></div></div>
|
|
<div class="ttc" id="aclassentt_1_1basic__view_html"><div class="ttname"><a href="classentt_1_1basic__view.html">entt::basic_view</a></div><div class="ttdoc">View.</div><div class="ttdef"><b>Definition:</b> <a href="entity_2fwd_8hpp_source.html#l00050">fwd.hpp:50</a></div></div>
|
|
<div class="ttc" id="anamespaceentt_html_a6609f31d6ab3f544ebf7d0413d007ead"><div class="ttname"><a href="namespaceentt.html#a6609f31d6ab3f544ebf7d0413d007ead">entt::as_group</a></div><div class="ttdeci">as_group(basic_registry< Entity > &) ENTT_NOEXCEPT -> as_group< false, Entity ></div><div class="ttdoc">Deduction guide.</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.16
|
|
</small></address>
|
|
</body>
|
|
</html>
|