3041 lines
182 KiB
HTML
3041 lines
182 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.13.2"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>EnTT: entt::basic_registry< Entity, Allocator > Class Template 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="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-awesome.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">EnTT<span id="projectnumber"> 3.15.0</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.13.2 -->
|
|
<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',false);
|
|
$(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function(){ initResizable(false); });
|
|
/* @license-end */
|
|
</script>
|
|
<!-- 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 id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="namespaceentt.html">entt</a></li><li class="navelem"><a class="el" href="classentt_1_1basic__registry.html">basic_registry</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div id="doc-content">
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-types">Public Types</a> |
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="classentt_1_1basic__registry-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">entt::basic_registry< Entity, Allocator > Class Template Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Fast and reliable entity-component system.
|
|
<a href="#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="registry_8hpp_source.html">registry.hpp</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
|
|
Public Types</h2></td></tr>
|
|
<tr class="memitem:a9ce6e0e7aa3c23f3819290c41e78c023" id="r_a9ce6e0e7aa3c23f3819290c41e78c023"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="#a9ce6e0e7aa3c23f3819290c41e78c023">allocator_type</a> = Allocator</td></tr>
|
|
<tr class="memdesc:a9ce6e0e7aa3c23f3819290c41e78c023"><td class="mdescLeft"> </td><td class="mdescRight">Allocator type. <br /></td></tr>
|
|
<tr class="separator:a9ce6e0e7aa3c23f3819290c41e78c023"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abdeb17d13b9834969282c5e8a930656d" id="r_abdeb17d13b9834969282c5e8a930656d"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="#abdeb17d13b9834969282c5e8a930656d">entity_type</a> = typename <a class="el" href="classentt_1_1basic__entt__traits.html#a8d3ccdc302fc7dc567541fa12eca6b4e">traits_type::value_type</a></td></tr>
|
|
<tr class="memdesc:abdeb17d13b9834969282c5e8a930656d"><td class="mdescLeft"> </td><td class="mdescRight">Underlying entity identifier. <br /></td></tr>
|
|
<tr class="separator:abdeb17d13b9834969282c5e8a930656d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a49c533b43c29fad4b52bc10e4f390107" id="r_a49c533b43c29fad4b52bc10e4f390107"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="#a49c533b43c29fad4b52bc10e4f390107">version_type</a> = typename <a class="el" href="classentt_1_1basic__entt__traits.html#aa3fe33d19b228d07c5560b907f910c10">traits_type::version_type</a></td></tr>
|
|
<tr class="memdesc:a49c533b43c29fad4b52bc10e4f390107"><td class="mdescLeft"> </td><td class="mdescRight">Underlying version type. <br /></td></tr>
|
|
<tr class="separator:a49c533b43c29fad4b52bc10e4f390107"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abfa63598b862f2cb713db6f9779656c7" id="r_abfa63598b862f2cb713db6f9779656c7"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="#abfa63598b862f2cb713db6f9779656c7">size_type</a> = std::size_t</td></tr>
|
|
<tr class="memdesc:abfa63598b862f2cb713db6f9779656c7"><td class="mdescLeft"> </td><td class="mdescRight">Unsigned integer type. <br /></td></tr>
|
|
<tr class="separator:abfa63598b862f2cb713db6f9779656c7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4d204691f73d602c9f46f3127caf8c81" id="r_a4d204691f73d602c9f46f3127caf8c81"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="#a4d204691f73d602c9f46f3127caf8c81">common_type</a> = <a class="el" href="classentt_1_1basic__sparse__set.html">base_type</a></td></tr>
|
|
<tr class="memdesc:a4d204691f73d602c9f46f3127caf8c81"><td class="mdescLeft"> </td><td class="mdescRight">Common type among all storage types. <br /></td></tr>
|
|
<tr class="separator:a4d204691f73d602c9f46f3127caf8c81"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af26a23d71ff7ba51457dc54021b41be7" id="r_af26a23d71ff7ba51457dc54021b41be7"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="#af26a23d71ff7ba51457dc54021b41be7">context</a> = internal::registry_context<<a class="el" href="#a9ce6e0e7aa3c23f3819290c41e78c023">allocator_type</a>></td></tr>
|
|
<tr class="memdesc:af26a23d71ff7ba51457dc54021b41be7"><td class="mdescLeft"> </td><td class="mdescRight">Context type. <br /></td></tr>
|
|
<tr class="separator:af26a23d71ff7ba51457dc54021b41be7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3b46298ebd98b1f89b3b8910838ea0eb" id="r_a3b46298ebd98b1f89b3b8910838ea0eb"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="#a3b46298ebd98b1f89b3b8910838ea0eb">iterable</a> = <a class="el" href="structentt_1_1iterable__adaptor.html">iterable_adaptor</a><internal::registry_storage_iterator<typename <a class="el" href="classentt_1_1dense__map.html#acc07b299f15a57db885089cc1a31322d">pool_container_type::iterator</a>>></td></tr>
|
|
<tr class="memdesc:a3b46298ebd98b1f89b3b8910838ea0eb"><td class="mdescLeft"> </td><td class="mdescRight">Iterable registry type. <br /></td></tr>
|
|
<tr class="separator:a3b46298ebd98b1f89b3b8910838ea0eb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af28295b4eed2182fe6c7fd6287e98d8e" id="r_af28295b4eed2182fe6c7fd6287e98d8e"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="#af28295b4eed2182fe6c7fd6287e98d8e">const_iterable</a> = <a class="el" href="structentt_1_1iterable__adaptor.html">iterable_adaptor</a><internal::registry_storage_iterator<typename <a class="el" href="classentt_1_1dense__map.html#a5c236223418b9ef327397424e2df24f8">pool_container_type::const_iterator</a>>></td></tr>
|
|
<tr class="memdesc:af28295b4eed2182fe6c7fd6287e98d8e"><td class="mdescLeft"> </td><td class="mdescRight">Constant iterable registry type. <br /></td></tr>
|
|
<tr class="separator:af28295b4eed2182fe6c7fd6287e98d8e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a99e000856991d365d5a8a9e619b5fd03" id="r_a99e000856991d365d5a8a9e619b5fd03"><td class="memTemplParams" colspan="2">template<typename Type> </td></tr>
|
|
<tr class="memitem:a99e000856991d365d5a8a9e619b5fd03"><td class="memTemplItemLeft" align="right" valign="top">using </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a99e000856991d365d5a8a9e619b5fd03">storage_for_type</a> = typename <a class="el" href="structentt_1_1storage__for.html">storage_for</a><Type, Entity, typename alloc_traits::template rebind_alloc<std::remove_const_t<Type>>>::type</td></tr>
|
|
<tr class="separator:a99e000856991d365d5a8a9e619b5fd03"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><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:afb2496f183300f9f9b7ae24617df0a3c" id="r_afb2496f183300f9f9b7ae24617df0a3c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#afb2496f183300f9f9b7ae24617df0a3c">basic_registry</a> ()</td></tr>
|
|
<tr class="memdesc:afb2496f183300f9f9b7ae24617df0a3c"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br /></td></tr>
|
|
<tr class="separator:afb2496f183300f9f9b7ae24617df0a3c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab66e63c6c5398d5a0c9fc40d2fe8201f" id="r_ab66e63c6c5398d5a0c9fc40d2fe8201f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ab66e63c6c5398d5a0c9fc40d2fe8201f">basic_registry</a> (const <a class="el" href="#a9ce6e0e7aa3c23f3819290c41e78c023">allocator_type</a> &allocator)</td></tr>
|
|
<tr class="memdesc:ab66e63c6c5398d5a0c9fc40d2fe8201f"><td class="mdescLeft"> </td><td class="mdescRight">Constructs an empty registry with a given allocator. <br /></td></tr>
|
|
<tr class="separator:ab66e63c6c5398d5a0c9fc40d2fe8201f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1b6c762063ff48a0f4ca8efa063ebd53" id="r_a1b6c762063ff48a0f4ca8efa063ebd53"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a1b6c762063ff48a0f4ca8efa063ebd53">basic_registry</a> (const <a class="el" href="#abfa63598b862f2cb713db6f9779656c7">size_type</a> count, const <a class="el" href="#a9ce6e0e7aa3c23f3819290c41e78c023">allocator_type</a> &allocator=<a class="el" href="#a9ce6e0e7aa3c23f3819290c41e78c023">allocator_type</a>{})</td></tr>
|
|
<tr class="memdesc:a1b6c762063ff48a0f4ca8efa063ebd53"><td class="mdescLeft"> </td><td class="mdescRight">Allocates enough memory upon construction to store <code>count</code> pools. <br /></td></tr>
|
|
<tr class="separator:a1b6c762063ff48a0f4ca8efa063ebd53"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af096d2149b6cc869875319aa22066e69" id="r_af096d2149b6cc869875319aa22066e69"><td class="memItemLeft" align="right" valign="top"><a id="af096d2149b6cc869875319aa22066e69" name="af096d2149b6cc869875319aa22066e69"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>basic_registry</b> (const <a class="el" href="classentt_1_1basic__registry.html">basic_registry</a> &)=delete</td></tr>
|
|
<tr class="memdesc:af096d2149b6cc869875319aa22066e69"><td class="mdescLeft"> </td><td class="mdescRight">Default copy constructor, deleted on purpose. <br /></td></tr>
|
|
<tr class="separator:af096d2149b6cc869875319aa22066e69"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac5cfdf43791119f4ab2d6976bec62644" id="r_ac5cfdf43791119f4ab2d6976bec62644"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ac5cfdf43791119f4ab2d6976bec62644">basic_registry</a> (<a class="el" href="classentt_1_1basic__registry.html">basic_registry</a> &&other) noexcept</td></tr>
|
|
<tr class="memdesc:ac5cfdf43791119f4ab2d6976bec62644"><td class="mdescLeft"> </td><td class="mdescRight">Move constructor. <br /></td></tr>
|
|
<tr class="separator:ac5cfdf43791119f4ab2d6976bec62644"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad1a40bc7886d5e9382fc2d74d5c4574e" id="r_ad1a40bc7886d5e9382fc2d74d5c4574e"><td class="memItemLeft" align="right" valign="top"><a id="ad1a40bc7886d5e9382fc2d74d5c4574e" name="ad1a40bc7886d5e9382fc2d74d5c4574e"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>~basic_registry</b> ()=default</td></tr>
|
|
<tr class="memdesc:ad1a40bc7886d5e9382fc2d74d5c4574e"><td class="mdescLeft"> </td><td class="mdescRight">Default destructor. <br /></td></tr>
|
|
<tr class="separator:ad1a40bc7886d5e9382fc2d74d5c4574e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aaf838797891c1fe058679f96bd88f473" id="r_aaf838797891c1fe058679f96bd88f473"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1basic__registry.html">basic_registry</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#aaf838797891c1fe058679f96bd88f473">operator=</a> (const <a class="el" href="classentt_1_1basic__registry.html">basic_registry</a> &)=delete</td></tr>
|
|
<tr class="memdesc:aaf838797891c1fe058679f96bd88f473"><td class="mdescLeft"> </td><td class="mdescRight">Default copy assignment operator, deleted on purpose. <br /></td></tr>
|
|
<tr class="separator:aaf838797891c1fe058679f96bd88f473"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a825a977af35627faca20c0ea388d10fa" id="r_a825a977af35627faca20c0ea388d10fa"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1basic__registry.html">basic_registry</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#a825a977af35627faca20c0ea388d10fa">operator=</a> (<a class="el" href="classentt_1_1basic__registry.html">basic_registry</a> &&other) noexcept</td></tr>
|
|
<tr class="memdesc:a825a977af35627faca20c0ea388d10fa"><td class="mdescLeft"> </td><td class="mdescRight">Move assignment operator. <br /></td></tr>
|
|
<tr class="separator:a825a977af35627faca20c0ea388d10fa"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a394e38341a21d75194555e9ed57fe5ae" id="r_a394e38341a21d75194555e9ed57fe5ae"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a394e38341a21d75194555e9ed57fe5ae">swap</a> (<a class="el" href="classentt_1_1basic__registry.html">basic_registry</a> &other) noexcept</td></tr>
|
|
<tr class="memdesc:a394e38341a21d75194555e9ed57fe5ae"><td class="mdescLeft"> </td><td class="mdescRight">Exchanges the contents with those of a given registry. <br /></td></tr>
|
|
<tr class="separator:a394e38341a21d75194555e9ed57fe5ae"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa0db3b1ef8738ee88b164f0f9530961b" id="r_aa0db3b1ef8738ee88b164f0f9530961b"><td class="memItemLeft" align="right" valign="top">constexpr <a class="el" href="#a9ce6e0e7aa3c23f3819290c41e78c023">allocator_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#aa0db3b1ef8738ee88b164f0f9530961b">get_allocator</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:aa0db3b1ef8738ee88b164f0f9530961b"><td class="mdescLeft"> </td><td class="mdescRight">Returns the associated allocator. <br /></td></tr>
|
|
<tr class="separator:aa0db3b1ef8738ee88b164f0f9530961b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3ffe409b0f7201456b1c1d32c0850474" id="r_a3ffe409b0f7201456b1c1d32c0850474"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a3b46298ebd98b1f89b3b8910838ea0eb">iterable</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a3ffe409b0f7201456b1c1d32c0850474">storage</a> () noexcept</td></tr>
|
|
<tr class="memdesc:a3ffe409b0f7201456b1c1d32c0850474"><td class="mdescLeft"> </td><td class="mdescRight">Returns an iterable object to use to <em>visit</em> a registry. <br /></td></tr>
|
|
<tr class="separator:a3ffe409b0f7201456b1c1d32c0850474"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ace5a18c1fe5b72dbdbf53cb981c00879" id="r_ace5a18c1fe5b72dbdbf53cb981c00879"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#af28295b4eed2182fe6c7fd6287e98d8e">const_iterable</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ace5a18c1fe5b72dbdbf53cb981c00879">storage</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:ace5a18c1fe5b72dbdbf53cb981c00879"><td class="mdescLeft"> </td><td class="mdescRight">Returns an iterable object to use to <em>visit</em> a registry. <br /></td></tr>
|
|
<tr class="separator:ace5a18c1fe5b72dbdbf53cb981c00879"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a901e410db646d5318aa6ac7cabfe6218" id="r_a901e410db646d5318aa6ac7cabfe6218"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a4d204691f73d602c9f46f3127caf8c81">common_type</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="#a901e410db646d5318aa6ac7cabfe6218">storage</a> (const <a class="el" href="namespaceentt.html#a620d583c0e6d64acf3d394524bb72303">id_type</a> id)</td></tr>
|
|
<tr class="memdesc:a901e410db646d5318aa6ac7cabfe6218"><td class="mdescLeft"> </td><td class="mdescRight">Finds the storage associated with a given name, if any. <br /></td></tr>
|
|
<tr class="separator:a901e410db646d5318aa6ac7cabfe6218"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2bdc9d44e99459d93d2f43bdd1ca5df4" id="r_a2bdc9d44e99459d93d2f43bdd1ca5df4"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="#a4d204691f73d602c9f46f3127caf8c81">common_type</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="#a2bdc9d44e99459d93d2f43bdd1ca5df4">storage</a> (const <a class="el" href="namespaceentt.html#a620d583c0e6d64acf3d394524bb72303">id_type</a> id) const</td></tr>
|
|
<tr class="memdesc:a2bdc9d44e99459d93d2f43bdd1ca5df4"><td class="mdescLeft"> </td><td class="mdescRight">Finds the storage associated with a given name, if any. <br /></td></tr>
|
|
<tr class="separator:a2bdc9d44e99459d93d2f43bdd1ca5df4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abb07bad50fa0f5bad0aabffe8ce24414" id="r_abb07bad50fa0f5bad0aabffe8ce24414"><td class="memTemplParams" colspan="2">template<typename Type> </td></tr>
|
|
<tr class="memitem:abb07bad50fa0f5bad0aabffe8ce24414"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="#a99e000856991d365d5a8a9e619b5fd03">storage_for_type</a>< Type > & </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#abb07bad50fa0f5bad0aabffe8ce24414">storage</a> (const <a class="el" href="namespaceentt.html#a620d583c0e6d64acf3d394524bb72303">id_type</a> id=<a class="el" href="structentt_1_1type__hash.html">type_hash</a>< Type >::value())</td></tr>
|
|
<tr class="memdesc:abb07bad50fa0f5bad0aabffe8ce24414"><td class="mdescLeft"> </td><td class="mdescRight">Returns the storage for a given element type. <br /></td></tr>
|
|
<tr class="separator:abb07bad50fa0f5bad0aabffe8ce24414"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae414ee7b5315313e9987525727f6320b" id="r_ae414ee7b5315313e9987525727f6320b"><td class="memTemplParams" colspan="2">template<typename Type> </td></tr>
|
|
<tr class="memitem:ae414ee7b5315313e9987525727f6320b"><td class="memTemplItemLeft" align="right" valign="top">const <a class="el" href="#a99e000856991d365d5a8a9e619b5fd03">storage_for_type</a>< Type > * </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#ae414ee7b5315313e9987525727f6320b">storage</a> (const <a class="el" href="namespaceentt.html#a620d583c0e6d64acf3d394524bb72303">id_type</a> id=<a class="el" href="structentt_1_1type__hash.html">type_hash</a>< Type >::value()) const</td></tr>
|
|
<tr class="memdesc:ae414ee7b5315313e9987525727f6320b"><td class="mdescLeft"> </td><td class="mdescRight">Returns the storage for a given element type, if any. <br /></td></tr>
|
|
<tr class="separator:ae414ee7b5315313e9987525727f6320b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6f2548bae0c7a80e4adf8b8ad4e4cc11" id="r_a6f2548bae0c7a80e4adf8b8ad4e4cc11"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#a6f2548bae0c7a80e4adf8b8ad4e4cc11">reset</a> (const <a class="el" href="namespaceentt.html#a620d583c0e6d64acf3d394524bb72303">id_type</a> id)</td></tr>
|
|
<tr class="memdesc:a6f2548bae0c7a80e4adf8b8ad4e4cc11"><td class="mdescLeft"> </td><td class="mdescRight">Discards the storage associated with a given name, if any. <br /></td></tr>
|
|
<tr class="separator:a6f2548bae0c7a80e4adf8b8ad4e4cc11"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a40d41cd623d5bf7ad95d75aef5e70a65" id="r_a40d41cd623d5bf7ad95d75aef5e70a65"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#a40d41cd623d5bf7ad95d75aef5e70a65">valid</a> (const <a class="el" href="#abdeb17d13b9834969282c5e8a930656d">entity_type</a> entt) const</td></tr>
|
|
<tr class="memdesc:a40d41cd623d5bf7ad95d75aef5e70a65"><td class="mdescLeft"> </td><td class="mdescRight">Checks if an identifier refers to a valid entity. <br /></td></tr>
|
|
<tr class="separator:a40d41cd623d5bf7ad95d75aef5e70a65"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad953b537b28f0f8d590e77b81faa1941" id="r_ad953b537b28f0f8d590e77b81faa1941"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a49c533b43c29fad4b52bc10e4f390107">version_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ad953b537b28f0f8d590e77b81faa1941">current</a> (const <a class="el" href="#abdeb17d13b9834969282c5e8a930656d">entity_type</a> entt) const</td></tr>
|
|
<tr class="memdesc:ad953b537b28f0f8d590e77b81faa1941"><td class="mdescLeft"> </td><td class="mdescRight">Returns the actual version for an identifier. <br /></td></tr>
|
|
<tr class="separator:ad953b537b28f0f8d590e77b81faa1941"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4ab0e3ed31fb0c455c07d0541941108a" id="r_a4ab0e3ed31fb0c455c07d0541941108a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#abdeb17d13b9834969282c5e8a930656d">entity_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a4ab0e3ed31fb0c455c07d0541941108a">create</a> ()</td></tr>
|
|
<tr class="memdesc:a4ab0e3ed31fb0c455c07d0541941108a"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new entity or recycles a destroyed one. <br /></td></tr>
|
|
<tr class="separator:a4ab0e3ed31fb0c455c07d0541941108a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6366705dc2f7db448434ce17e1403884" id="r_a6366705dc2f7db448434ce17e1403884"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#abdeb17d13b9834969282c5e8a930656d">entity_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a6366705dc2f7db448434ce17e1403884">create</a> (const <a class="el" href="#abdeb17d13b9834969282c5e8a930656d">entity_type</a> hint)</td></tr>
|
|
<tr class="memdesc:a6366705dc2f7db448434ce17e1403884"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new entity or recycles a destroyed one. <br /></td></tr>
|
|
<tr class="separator:a6366705dc2f7db448434ce17e1403884"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5dee7d7c5329e5fd29bcfbe4a5a4842a" id="r_a5dee7d7c5329e5fd29bcfbe4a5a4842a"><td class="memTemplParams" colspan="2">template<typename It> </td></tr>
|
|
<tr class="memitem:a5dee7d7c5329e5fd29bcfbe4a5a4842a"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a5dee7d7c5329e5fd29bcfbe4a5a4842a">create</a> (It first, It last)</td></tr>
|
|
<tr class="memdesc:a5dee7d7c5329e5fd29bcfbe4a5a4842a"><td class="mdescLeft"> </td><td class="mdescRight">Assigns each element in a range an identifier. <br /></td></tr>
|
|
<tr class="separator:a5dee7d7c5329e5fd29bcfbe4a5a4842a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4849d0fe9d6008431239c93c57551d10" id="r_a4849d0fe9d6008431239c93c57551d10"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a49c533b43c29fad4b52bc10e4f390107">version_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a4849d0fe9d6008431239c93c57551d10">destroy</a> (const <a class="el" href="#abdeb17d13b9834969282c5e8a930656d">entity_type</a> entt)</td></tr>
|
|
<tr class="memdesc:a4849d0fe9d6008431239c93c57551d10"><td class="mdescLeft"> </td><td class="mdescRight">Destroys an entity and releases its identifier. <br /></td></tr>
|
|
<tr class="separator:a4849d0fe9d6008431239c93c57551d10"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4e957182d72fd24e436afda55ec25e33" id="r_a4e957182d72fd24e436afda55ec25e33"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a49c533b43c29fad4b52bc10e4f390107">version_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a4e957182d72fd24e436afda55ec25e33">destroy</a> (const <a class="el" href="#abdeb17d13b9834969282c5e8a930656d">entity_type</a> entt, const <a class="el" href="#a49c533b43c29fad4b52bc10e4f390107">version_type</a> version)</td></tr>
|
|
<tr class="memdesc:a4e957182d72fd24e436afda55ec25e33"><td class="mdescLeft"> </td><td class="mdescRight">Destroys an entity and releases its identifier. <br /></td></tr>
|
|
<tr class="separator:a4e957182d72fd24e436afda55ec25e33"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a90f87bda5906f0a26d118a4d058f376d" id="r_a90f87bda5906f0a26d118a4d058f376d"><td class="memTemplParams" colspan="2">template<typename It> </td></tr>
|
|
<tr class="memitem:a90f87bda5906f0a26d118a4d058f376d"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a90f87bda5906f0a26d118a4d058f376d">destroy</a> (It first, It last)</td></tr>
|
|
<tr class="memdesc:a90f87bda5906f0a26d118a4d058f376d"><td class="mdescLeft"> </td><td class="mdescRight">Destroys all entities in a range and releases their identifiers. <br /></td></tr>
|
|
<tr class="separator:a90f87bda5906f0a26d118a4d058f376d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa3cd5a28e32c30e5c69965c52781bf98" id="r_aa3cd5a28e32c30e5c69965c52781bf98"><td class="memTemplParams" colspan="2">template<typename Type, typename... Args> </td></tr>
|
|
<tr class="memitem:aa3cd5a28e32c30e5c69965c52781bf98"><td class="memTemplItemLeft" align="right" valign="top">decltype(auto) </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#aa3cd5a28e32c30e5c69965c52781bf98">emplace</a> (const <a class="el" href="#abdeb17d13b9834969282c5e8a930656d">entity_type</a> entt, Args &&...args)</td></tr>
|
|
<tr class="memdesc:aa3cd5a28e32c30e5c69965c52781bf98"><td class="mdescLeft"> </td><td class="mdescRight">Assigns the given element to an entity. <br /></td></tr>
|
|
<tr class="separator:aa3cd5a28e32c30e5c69965c52781bf98"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae299b32827f0667903d8564e10ca6774" id="r_ae299b32827f0667903d8564e10ca6774"><td class="memTemplParams" colspan="2">template<typename Type, typename It> </td></tr>
|
|
<tr class="memitem:ae299b32827f0667903d8564e10ca6774"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#ae299b32827f0667903d8564e10ca6774">insert</a> (It first, It last, const Type &value={})</td></tr>
|
|
<tr class="memdesc:ae299b32827f0667903d8564e10ca6774"><td class="mdescLeft"> </td><td class="mdescRight">Assigns each entity in a range the given element. <br /></td></tr>
|
|
<tr class="separator:ae299b32827f0667903d8564e10ca6774"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae4630a45e531d05669da84aa4a5e9778" id="r_ae4630a45e531d05669da84aa4a5e9778"><td class="memTemplParams" colspan="2">template<typename Type, typename EIt, typename CIt, typename = std::enable_if_t<std::is_same_v<typename std::iterator_traits<CIt>::value_type, Type>>> </td></tr>
|
|
<tr class="memitem:ae4630a45e531d05669da84aa4a5e9778"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#ae4630a45e531d05669da84aa4a5e9778">insert</a> (EIt first, EIt last, CIt from)</td></tr>
|
|
<tr class="memdesc:ae4630a45e531d05669da84aa4a5e9778"><td class="mdescLeft"> </td><td class="mdescRight">Assigns each entity in a range the given elements. <br /></td></tr>
|
|
<tr class="separator:ae4630a45e531d05669da84aa4a5e9778"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3ebfbe0d897e77cf0f24bc994a796b15" id="r_a3ebfbe0d897e77cf0f24bc994a796b15"><td class="memTemplParams" colspan="2">template<typename Type, typename... Args> </td></tr>
|
|
<tr class="memitem:a3ebfbe0d897e77cf0f24bc994a796b15"><td class="memTemplItemLeft" align="right" valign="top">decltype(auto) </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a3ebfbe0d897e77cf0f24bc994a796b15">emplace_or_replace</a> (const <a class="el" href="#abdeb17d13b9834969282c5e8a930656d">entity_type</a> entt, Args &&...args)</td></tr>
|
|
<tr class="memdesc:a3ebfbe0d897e77cf0f24bc994a796b15"><td class="mdescLeft"> </td><td class="mdescRight">Assigns or replaces the given element for an entity. <br /></td></tr>
|
|
<tr class="separator:a3ebfbe0d897e77cf0f24bc994a796b15"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a77c108caf74d8fcce9f3fb94906cd4db" id="r_a77c108caf74d8fcce9f3fb94906cd4db"><td class="memTemplParams" colspan="2">template<typename Type, typename... Func> </td></tr>
|
|
<tr class="memitem:a77c108caf74d8fcce9f3fb94906cd4db"><td class="memTemplItemLeft" align="right" valign="top">decltype(auto) </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a77c108caf74d8fcce9f3fb94906cd4db">patch</a> (const <a class="el" href="#abdeb17d13b9834969282c5e8a930656d">entity_type</a> entt, Func &&...func)</td></tr>
|
|
<tr class="memdesc:a77c108caf74d8fcce9f3fb94906cd4db"><td class="mdescLeft"> </td><td class="mdescRight">Patches the given element for an entity. <br /></td></tr>
|
|
<tr class="separator:a77c108caf74d8fcce9f3fb94906cd4db"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1b4f1cccd495d17c550711fdc9606d4f" id="r_a1b4f1cccd495d17c550711fdc9606d4f"><td class="memTemplParams" colspan="2">template<typename Type, typename... Args> </td></tr>
|
|
<tr class="memitem:a1b4f1cccd495d17c550711fdc9606d4f"><td class="memTemplItemLeft" align="right" valign="top">decltype(auto) </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a1b4f1cccd495d17c550711fdc9606d4f">replace</a> (const <a class="el" href="#abdeb17d13b9834969282c5e8a930656d">entity_type</a> entt, Args &&...args)</td></tr>
|
|
<tr class="memdesc:a1b4f1cccd495d17c550711fdc9606d4f"><td class="mdescLeft"> </td><td class="mdescRight">Replaces the given element for an entity. <br /></td></tr>
|
|
<tr class="separator:a1b4f1cccd495d17c550711fdc9606d4f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7eb97ddee1a5ee98a722329fe39417ce" id="r_a7eb97ddee1a5ee98a722329fe39417ce"><td class="memTemplParams" colspan="2">template<typename Type, typename... Other> </td></tr>
|
|
<tr class="memitem:a7eb97ddee1a5ee98a722329fe39417ce"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="#abfa63598b862f2cb713db6f9779656c7">size_type</a> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a7eb97ddee1a5ee98a722329fe39417ce">remove</a> (const <a class="el" href="#abdeb17d13b9834969282c5e8a930656d">entity_type</a> entt)</td></tr>
|
|
<tr class="memdesc:a7eb97ddee1a5ee98a722329fe39417ce"><td class="mdescLeft"> </td><td class="mdescRight">Removes the given elements from an entity. <br /></td></tr>
|
|
<tr class="separator:a7eb97ddee1a5ee98a722329fe39417ce"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5f458b3df51b800632c350961947a2bb" id="r_a5f458b3df51b800632c350961947a2bb"><td class="memTemplParams" colspan="2">template<typename Type, typename... Other, typename It> </td></tr>
|
|
<tr class="memitem:a5f458b3df51b800632c350961947a2bb"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="#abfa63598b862f2cb713db6f9779656c7">size_type</a> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a5f458b3df51b800632c350961947a2bb">remove</a> (It first, It last)</td></tr>
|
|
<tr class="memdesc:a5f458b3df51b800632c350961947a2bb"><td class="mdescLeft"> </td><td class="mdescRight">Removes the given elements from all the entities in a range. <br /></td></tr>
|
|
<tr class="separator:a5f458b3df51b800632c350961947a2bb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afc89c98a7fdc0d6083b2ae23682bc4a9" id="r_afc89c98a7fdc0d6083b2ae23682bc4a9"><td class="memTemplParams" colspan="2">template<typename Type, typename... Other> </td></tr>
|
|
<tr class="memitem:afc89c98a7fdc0d6083b2ae23682bc4a9"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#afc89c98a7fdc0d6083b2ae23682bc4a9">erase</a> (const <a class="el" href="#abdeb17d13b9834969282c5e8a930656d">entity_type</a> entt)</td></tr>
|
|
<tr class="memdesc:afc89c98a7fdc0d6083b2ae23682bc4a9"><td class="mdescLeft"> </td><td class="mdescRight">Erases the given elements from an entity. <br /></td></tr>
|
|
<tr class="separator:afc89c98a7fdc0d6083b2ae23682bc4a9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9b66704f3f810bc45996802c9197b0d6" id="r_a9b66704f3f810bc45996802c9197b0d6"><td class="memTemplParams" colspan="2">template<typename Type, typename... Other, typename It> </td></tr>
|
|
<tr class="memitem:a9b66704f3f810bc45996802c9197b0d6"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a9b66704f3f810bc45996802c9197b0d6">erase</a> (It first, It last)</td></tr>
|
|
<tr class="memdesc:a9b66704f3f810bc45996802c9197b0d6"><td class="mdescLeft"> </td><td class="mdescRight">Erases the given elements from all the entities in a range. <br /></td></tr>
|
|
<tr class="separator:a9b66704f3f810bc45996802c9197b0d6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a477abaa59c9e8a9a965c3bcbae103341" id="r_a477abaa59c9e8a9a965c3bcbae103341"><td class="memTemplParams" colspan="2">template<typename Func> </td></tr>
|
|
<tr class="memitem:a477abaa59c9e8a9a965c3bcbae103341"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a477abaa59c9e8a9a965c3bcbae103341">erase_if</a> (const <a class="el" href="#abdeb17d13b9834969282c5e8a930656d">entity_type</a> entt, Func func)</td></tr>
|
|
<tr class="memdesc:a477abaa59c9e8a9a965c3bcbae103341"><td class="mdescLeft"> </td><td class="mdescRight">Erases elements satisfying specific criteria from an entity. <br /></td></tr>
|
|
<tr class="separator:a477abaa59c9e8a9a965c3bcbae103341"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac9008dbd303d18cccf1ef7f279637347" id="r_ac9008dbd303d18cccf1ef7f279637347"><td class="memTemplParams" colspan="2">template<typename... Type> </td></tr>
|
|
<tr class="memitem:ac9008dbd303d18cccf1ef7f279637347"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#ac9008dbd303d18cccf1ef7f279637347">compact</a> ()</td></tr>
|
|
<tr class="memdesc:ac9008dbd303d18cccf1ef7f279637347"><td class="mdescLeft"> </td><td class="mdescRight">Removes all tombstones from a registry or only the pools for the given elements. <br /></td></tr>
|
|
<tr class="separator:ac9008dbd303d18cccf1ef7f279637347"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a463b15da6bfe18744e595c082ef70bac" id="r_a463b15da6bfe18744e595c082ef70bac"><td class="memTemplParams" colspan="2">template<typename... Type> </td></tr>
|
|
<tr class="memitem:a463b15da6bfe18744e595c082ef70bac"><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a463b15da6bfe18744e595c082ef70bac">all_of</a> (const <a class="el" href="#abdeb17d13b9834969282c5e8a930656d">entity_type</a> entt) const</td></tr>
|
|
<tr class="memdesc:a463b15da6bfe18744e595c082ef70bac"><td class="mdescLeft"> </td><td class="mdescRight">Check if an entity is part of all the given storage. <br /></td></tr>
|
|
<tr class="separator:a463b15da6bfe18744e595c082ef70bac"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0bcc0d120d7bbe348242a1c3227af8fc" id="r_a0bcc0d120d7bbe348242a1c3227af8fc"><td class="memTemplParams" colspan="2">template<typename... Type> </td></tr>
|
|
<tr class="memitem:a0bcc0d120d7bbe348242a1c3227af8fc"><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a0bcc0d120d7bbe348242a1c3227af8fc">any_of</a> (const <a class="el" href="#abdeb17d13b9834969282c5e8a930656d">entity_type</a> entt) const</td></tr>
|
|
<tr class="memdesc:a0bcc0d120d7bbe348242a1c3227af8fc"><td class="mdescLeft"> </td><td class="mdescRight">Check if an entity is part of at least one given storage. <br /></td></tr>
|
|
<tr class="separator:a0bcc0d120d7bbe348242a1c3227af8fc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abe347a879e04298df37c19b757f6ab08" id="r_abe347a879e04298df37c19b757f6ab08"><td class="memTemplParams" colspan="2">template<typename... Type> </td></tr>
|
|
<tr class="memitem:abe347a879e04298df37c19b757f6ab08"><td class="memTemplItemLeft" align="right" valign="top">decltype(auto) </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#abe347a879e04298df37c19b757f6ab08">get</a> (const <a class="el" href="#abdeb17d13b9834969282c5e8a930656d">entity_type</a> entt) const</td></tr>
|
|
<tr class="memdesc:abe347a879e04298df37c19b757f6ab08"><td class="mdescLeft"> </td><td class="mdescRight">Returns references to the given elements for an entity. <br /></td></tr>
|
|
<tr class="separator:abe347a879e04298df37c19b757f6ab08"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a96d520486439b2017faef0c7c399ea11" id="r_a96d520486439b2017faef0c7c399ea11"><td class="memTemplParams" colspan="2">template<typename... Type> </td></tr>
|
|
<tr class="memitem:a96d520486439b2017faef0c7c399ea11"><td class="memTemplItemLeft" align="right" valign="top">decltype(auto) </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a96d520486439b2017faef0c7c399ea11">get</a> (const <a class="el" href="#abdeb17d13b9834969282c5e8a930656d">entity_type</a> entt)</td></tr>
|
|
<tr class="memdesc:a96d520486439b2017faef0c7c399ea11"><td class="mdescLeft"> </td><td class="mdescRight">Returns references to the given elements for an entity. <br /></td></tr>
|
|
<tr class="separator:a96d520486439b2017faef0c7c399ea11"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a13eee32008020e19e15ccc87f4025a2e" id="r_a13eee32008020e19e15ccc87f4025a2e"><td class="memTemplParams" colspan="2">template<typename Type, typename... Args> </td></tr>
|
|
<tr class="memitem:a13eee32008020e19e15ccc87f4025a2e"><td class="memTemplItemLeft" align="right" valign="top">decltype(auto) </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a13eee32008020e19e15ccc87f4025a2e">get_or_emplace</a> (const <a class="el" href="#abdeb17d13b9834969282c5e8a930656d">entity_type</a> entt, Args &&...args)</td></tr>
|
|
<tr class="memdesc:a13eee32008020e19e15ccc87f4025a2e"><td class="mdescLeft"> </td><td class="mdescRight">Returns a reference to the given element for an entity. <br /></td></tr>
|
|
<tr class="separator:a13eee32008020e19e15ccc87f4025a2e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2e423a67d88072b7e8126412d3ce41e5" id="r_a2e423a67d88072b7e8126412d3ce41e5"><td class="memTemplParams" colspan="2">template<typename... Type> </td></tr>
|
|
<tr class="memitem:a2e423a67d88072b7e8126412d3ce41e5"><td class="memTemplItemLeft" align="right" valign="top">auto </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a2e423a67d88072b7e8126412d3ce41e5">try_get</a> (const <a class="el" href="#abdeb17d13b9834969282c5e8a930656d">entity_type</a> entt) const</td></tr>
|
|
<tr class="memdesc:a2e423a67d88072b7e8126412d3ce41e5"><td class="mdescLeft"> </td><td class="mdescRight">Returns pointers to the given elements for an entity. <br /></td></tr>
|
|
<tr class="separator:a2e423a67d88072b7e8126412d3ce41e5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a88615f35264fae0e05f25766eab624fb" id="r_a88615f35264fae0e05f25766eab624fb"><td class="memTemplParams" colspan="2">template<typename... Type> </td></tr>
|
|
<tr class="memitem:a88615f35264fae0e05f25766eab624fb"><td class="memTemplItemLeft" align="right" valign="top">auto </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a88615f35264fae0e05f25766eab624fb">try_get</a> (const <a class="el" href="#abdeb17d13b9834969282c5e8a930656d">entity_type</a> entt)</td></tr>
|
|
<tr class="memdesc:a88615f35264fae0e05f25766eab624fb"><td class="mdescLeft"> </td><td class="mdescRight">Returns pointers to the given elements for an entity. <br /></td></tr>
|
|
<tr class="separator:a88615f35264fae0e05f25766eab624fb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a65ae6a29493a09a3c19e83748bae6a7e" id="r_a65ae6a29493a09a3c19e83748bae6a7e"><td class="memTemplParams" colspan="2">template<typename... Type> </td></tr>
|
|
<tr class="memitem:a65ae6a29493a09a3c19e83748bae6a7e"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a65ae6a29493a09a3c19e83748bae6a7e">clear</a> ()</td></tr>
|
|
<tr class="memdesc:a65ae6a29493a09a3c19e83748bae6a7e"><td class="mdescLeft"> </td><td class="mdescRight">Clears a whole registry or the pools for the given elements. <br /></td></tr>
|
|
<tr class="separator:a65ae6a29493a09a3c19e83748bae6a7e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1b36843b380e02019ad88c455d6e6d17" id="r_a1b36843b380e02019ad88c455d6e6d17"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#a1b36843b380e02019ad88c455d6e6d17">orphan</a> (const <a class="el" href="#abdeb17d13b9834969282c5e8a930656d">entity_type</a> entt) const</td></tr>
|
|
<tr class="memdesc:a1b36843b380e02019ad88c455d6e6d17"><td class="mdescLeft"> </td><td class="mdescRight">Checks if an entity has elements assigned. <br /></td></tr>
|
|
<tr class="separator:a1b36843b380e02019ad88c455d6e6d17"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab68c1ba5692d30350d30121663203aea" id="r_ab68c1ba5692d30350d30121663203aea"><td class="memTemplParams" colspan="2">template<typename Type> </td></tr>
|
|
<tr class="memitem:ab68c1ba5692d30350d30121663203aea"><td class="memTemplItemLeft" align="right" valign="top">auto </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#ab68c1ba5692d30350d30121663203aea">on_construct</a> (const <a class="el" href="namespaceentt.html#a620d583c0e6d64acf3d394524bb72303">id_type</a> id=<a class="el" href="structentt_1_1type__hash.html">type_hash</a>< Type >::value())</td></tr>
|
|
<tr class="memdesc:ab68c1ba5692d30350d30121663203aea"><td class="mdescLeft"> </td><td class="mdescRight">Returns a sink object for the given element. <br /></td></tr>
|
|
<tr class="separator:ab68c1ba5692d30350d30121663203aea"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1b83f8586cfb519b7b966751094c5381" id="r_a1b83f8586cfb519b7b966751094c5381"><td class="memTemplParams" colspan="2">template<typename Type> </td></tr>
|
|
<tr class="memitem:a1b83f8586cfb519b7b966751094c5381"><td class="memTemplItemLeft" align="right" valign="top">auto </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a1b83f8586cfb519b7b966751094c5381">on_update</a> (const <a class="el" href="namespaceentt.html#a620d583c0e6d64acf3d394524bb72303">id_type</a> id=<a class="el" href="structentt_1_1type__hash.html">type_hash</a>< Type >::value())</td></tr>
|
|
<tr class="memdesc:a1b83f8586cfb519b7b966751094c5381"><td class="mdescLeft"> </td><td class="mdescRight">Returns a sink object for the given element. <br /></td></tr>
|
|
<tr class="separator:a1b83f8586cfb519b7b966751094c5381"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0984ffe101cfef78d7e755bbaed5842e" id="r_a0984ffe101cfef78d7e755bbaed5842e"><td class="memTemplParams" colspan="2">template<typename Type> </td></tr>
|
|
<tr class="memitem:a0984ffe101cfef78d7e755bbaed5842e"><td class="memTemplItemLeft" align="right" valign="top">auto </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a0984ffe101cfef78d7e755bbaed5842e">on_destroy</a> (const <a class="el" href="namespaceentt.html#a620d583c0e6d64acf3d394524bb72303">id_type</a> id=<a class="el" href="structentt_1_1type__hash.html">type_hash</a>< Type >::value())</td></tr>
|
|
<tr class="memdesc:a0984ffe101cfef78d7e755bbaed5842e"><td class="mdescLeft"> </td><td class="mdescRight">Returns a sink object for the given element. <br /></td></tr>
|
|
<tr class="separator:a0984ffe101cfef78d7e755bbaed5842e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a563374eb952f575470291d2a574176dc" id="r_a563374eb952f575470291d2a574176dc"><td class="memTemplParams" colspan="2">template<typename Type, typename... Other, typename... Exclude> </td></tr>
|
|
<tr class="memitem:a563374eb952f575470291d2a574176dc"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1basic__view.html">basic_view</a>< <a class="el" href="structentt_1_1get__t.html">get_t</a>< <a class="el" href="#a99e000856991d365d5a8a9e619b5fd03">storage_for_type</a>< const Type >, <a class="el" href="#a99e000856991d365d5a8a9e619b5fd03">storage_for_type</a>< const Other >... >, <a class="el" href="structentt_1_1exclude__t.html">exclude_t</a>< <a class="el" href="#a99e000856991d365d5a8a9e619b5fd03">storage_for_type</a>< const Exclude >... > > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a563374eb952f575470291d2a574176dc">view</a> (<a class="el" href="structentt_1_1exclude__t.html">exclude_t</a>< Exclude... >=<a class="el" href="structentt_1_1exclude__t.html">exclude_t</a>{}) const</td></tr>
|
|
<tr class="memdesc:a563374eb952f575470291d2a574176dc"><td class="mdescLeft"> </td><td class="mdescRight">Returns a view for the given elements. <br /></td></tr>
|
|
<tr class="separator:a563374eb952f575470291d2a574176dc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8388faa0bbae4dc1b1c74e2dff4af17f" id="r_a8388faa0bbae4dc1b1c74e2dff4af17f"><td class="memTemplParams" colspan="2">template<typename Type, typename... Other, typename... Exclude> </td></tr>
|
|
<tr class="memitem:a8388faa0bbae4dc1b1c74e2dff4af17f"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1basic__view.html">basic_view</a>< <a class="el" href="structentt_1_1get__t.html">get_t</a>< <a class="el" href="#a99e000856991d365d5a8a9e619b5fd03">storage_for_type</a>< Type >, <a class="el" href="#a99e000856991d365d5a8a9e619b5fd03">storage_for_type</a>< Other >... >, <a class="el" href="structentt_1_1exclude__t.html">exclude_t</a>< <a class="el" href="#a99e000856991d365d5a8a9e619b5fd03">storage_for_type</a>< Exclude >... > > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a8388faa0bbae4dc1b1c74e2dff4af17f">view</a> (<a class="el" href="structentt_1_1exclude__t.html">exclude_t</a>< Exclude... >=<a class="el" href="structentt_1_1exclude__t.html">exclude_t</a>{})</td></tr>
|
|
<tr class="memdesc:a8388faa0bbae4dc1b1c74e2dff4af17f"><td class="mdescLeft"> </td><td class="mdescRight">Returns a view for the given elements. <br /></td></tr>
|
|
<tr class="separator:a8388faa0bbae4dc1b1c74e2dff4af17f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ade9bff8409333c2e85c33411b09998f1" id="r_ade9bff8409333c2e85c33411b09998f1"><td class="memTemplParams" colspan="2">template<typename... Owned, typename... Get, typename... Exclude> </td></tr>
|
|
<tr class="memitem:ade9bff8409333c2e85c33411b09998f1"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1basic__group.html">basic_group</a>< <a class="el" href="structentt_1_1owned__t.html">owned_t</a>< <a class="el" href="#a99e000856991d365d5a8a9e619b5fd03">storage_for_type</a>< Owned >... >, <a class="el" href="structentt_1_1get__t.html">get_t</a>< <a class="el" href="#a99e000856991d365d5a8a9e619b5fd03">storage_for_type</a>< Get >... >, <a class="el" href="structentt_1_1exclude__t.html">exclude_t</a>< <a class="el" href="#a99e000856991d365d5a8a9e619b5fd03">storage_for_type</a>< Exclude >... > > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#ade9bff8409333c2e85c33411b09998f1">group</a> (<a class="el" href="structentt_1_1get__t.html">get_t</a>< Get... >=<a class="el" href="structentt_1_1get__t.html">get_t</a>{}, <a class="el" href="structentt_1_1exclude__t.html">exclude_t</a>< Exclude... >=<a class="el" href="structentt_1_1exclude__t.html">exclude_t</a>{})</td></tr>
|
|
<tr class="memdesc:ade9bff8409333c2e85c33411b09998f1"><td class="mdescLeft"> </td><td class="mdescRight">Returns a group for the given elements. <br /></td></tr>
|
|
<tr class="separator:ade9bff8409333c2e85c33411b09998f1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7e1bde3245d81f921be211cef7df5c7f" id="r_a7e1bde3245d81f921be211cef7df5c7f"><td class="memTemplParams" colspan="2">template<typename... Owned, typename... Get, typename... Exclude> </td></tr>
|
|
<tr class="memitem:a7e1bde3245d81f921be211cef7df5c7f"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1basic__group.html">basic_group</a>< <a class="el" href="structentt_1_1owned__t.html">owned_t</a>< <a class="el" href="#a99e000856991d365d5a8a9e619b5fd03">storage_for_type</a>< const Owned >... >, <a class="el" href="structentt_1_1get__t.html">get_t</a>< <a class="el" href="#a99e000856991d365d5a8a9e619b5fd03">storage_for_type</a>< const Get >... >, <a class="el" href="structentt_1_1exclude__t.html">exclude_t</a>< <a class="el" href="#a99e000856991d365d5a8a9e619b5fd03">storage_for_type</a>< const Exclude >... > > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a7e1bde3245d81f921be211cef7df5c7f">group_if_exists</a> (<a class="el" href="structentt_1_1get__t.html">get_t</a>< Get... >=<a class="el" href="structentt_1_1get__t.html">get_t</a>{}, <a class="el" href="structentt_1_1exclude__t.html">exclude_t</a>< Exclude... >=<a class="el" href="structentt_1_1exclude__t.html">exclude_t</a>{}) const</td></tr>
|
|
<tr class="memdesc:a7e1bde3245d81f921be211cef7df5c7f"><td class="mdescLeft"> </td><td class="mdescRight">Returns a group for the given elements. <br /></td></tr>
|
|
<tr class="separator:a7e1bde3245d81f921be211cef7df5c7f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0da9b805673a9753a4c9f6f1609e0d87" id="r_a0da9b805673a9753a4c9f6f1609e0d87"><td class="memTemplParams" colspan="2">template<typename... Type> </td></tr>
|
|
<tr class="memitem:a0da9b805673a9753a4c9f6f1609e0d87"><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a0da9b805673a9753a4c9f6f1609e0d87">owned</a> () const</td></tr>
|
|
<tr class="memdesc:a0da9b805673a9753a4c9f6f1609e0d87"><td class="mdescLeft"> </td><td class="mdescRight">Checks whether the given elements belong to any group. <br /></td></tr>
|
|
<tr class="separator:a0da9b805673a9753a4c9f6f1609e0d87"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9f8467476bc59f55a9297bd4e93f4914" id="r_a9f8467476bc59f55a9297bd4e93f4914"><td class="memTemplParams" colspan="2">template<typename Type, typename Compare, typename Sort = std_sort, typename... Args> </td></tr>
|
|
<tr class="memitem:a9f8467476bc59f55a9297bd4e93f4914"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a9f8467476bc59f55a9297bd4e93f4914">sort</a> (Compare compare, Sort algo=Sort{}, Args &&...args)</td></tr>
|
|
<tr class="memdesc:a9f8467476bc59f55a9297bd4e93f4914"><td class="mdescLeft"> </td><td class="mdescRight">Sorts the elements of a given element. <br /></td></tr>
|
|
<tr class="separator:a9f8467476bc59f55a9297bd4e93f4914"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4bf0e6bf722ed1eae4bd9f7777378ca6" id="r_a4bf0e6bf722ed1eae4bd9f7777378ca6"><td class="memTemplParams" colspan="2">template<typename To, typename From> </td></tr>
|
|
<tr class="memitem:a4bf0e6bf722ed1eae4bd9f7777378ca6"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a4bf0e6bf722ed1eae4bd9f7777378ca6">sort</a> ()</td></tr>
|
|
<tr class="memdesc:a4bf0e6bf722ed1eae4bd9f7777378ca6"><td class="mdescLeft"> </td><td class="mdescRight">Sorts two pools of elements in the same way. <br /></td></tr>
|
|
<tr class="separator:a4bf0e6bf722ed1eae4bd9f7777378ca6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a063e7f4879b50fcd332702bc8cc0fa61" id="r_a063e7f4879b50fcd332702bc8cc0fa61"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#af26a23d71ff7ba51457dc54021b41be7">context</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#a063e7f4879b50fcd332702bc8cc0fa61">ctx</a> () noexcept</td></tr>
|
|
<tr class="memdesc:a063e7f4879b50fcd332702bc8cc0fa61"><td class="mdescLeft"> </td><td class="mdescRight">Returns the context object, that is, a general purpose container. <br /></td></tr>
|
|
<tr class="separator:a063e7f4879b50fcd332702bc8cc0fa61"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4ad88b333d9c2ac606b322532a921e40" id="r_a4ad88b333d9c2ac606b322532a921e40"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="#af26a23d71ff7ba51457dc54021b41be7">context</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#a4ad88b333d9c2ac606b322532a921e40">ctx</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a4ad88b333d9c2ac606b322532a921e40"><td class="mdescLeft"> </td><td class="mdescRight">Returns the context object, that is, a general purpose container. <br /></td></tr>
|
|
<tr class="separator:a4ad88b333d9c2ac606b322532a921e40"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><div class="compoundTemplParams">template<typename Entity, typename Allocator><br />
|
|
class entt::basic_registry< Entity, Allocator ></div><p>Fast and reliable entity-component system. </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">Entity</td><td>A valid entity type. </td></tr>
|
|
<tr><td class="paramname">Allocator</td><td>Type of allocator used to manage memory and elements. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="registry_8hpp_source.html#l00234">234</a> of file <a class="el" href="registry_8hpp_source.html">registry.hpp</a>.</p>
|
|
</div><h2 class="groupheader">Member Typedef Documentation</h2>
|
|
<a id="a9ce6e0e7aa3c23f3819290c41e78c023" name="a9ce6e0e7aa3c23f3819290c41e78c023"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9ce6e0e7aa3c23f3819290c41e78c023">◆ </a></span>allocator_type</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity, typename Allocator> </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">using <a class="el" href="classentt_1_1basic__registry.html">entt::basic_registry</a>< Entity, Allocator >::allocator_type = Allocator</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Allocator type. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="registry_8hpp_source.html#l00302">302</a> of file <a class="el" href="registry_8hpp_source.html">registry.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4d204691f73d602c9f46f3127caf8c81" name="a4d204691f73d602c9f46f3127caf8c81"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4d204691f73d602c9f46f3127caf8c81">◆ </a></span>common_type</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity, typename Allocator> </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">using <a class="el" href="classentt_1_1basic__registry.html">entt::basic_registry</a>< Entity, Allocator >::common_type = <a class="el" href="classentt_1_1basic__sparse__set.html">base_type</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Common type among all storage types. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="registry_8hpp_source.html#l00310">310</a> of file <a class="el" href="registry_8hpp_source.html">registry.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af28295b4eed2182fe6c7fd6287e98d8e" name="af28295b4eed2182fe6c7fd6287e98d8e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af28295b4eed2182fe6c7fd6287e98d8e">◆ </a></span>const_iterable</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity, typename Allocator> </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">using <a class="el" href="classentt_1_1basic__registry.html">entt::basic_registry</a>< Entity, Allocator >::const_iterable = <a class="el" href="structentt_1_1iterable__adaptor.html">iterable_adaptor</a><internal::registry_storage_iterator<typename <a class="el" href="classentt_1_1dense__map.html#a5c236223418b9ef327397424e2df24f8">pool_container_type::const_iterator</a>>></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Constant iterable registry type. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="registry_8hpp_source.html#l00316">316</a> of file <a class="el" href="registry_8hpp_source.html">registry.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af26a23d71ff7ba51457dc54021b41be7" name="af26a23d71ff7ba51457dc54021b41be7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af26a23d71ff7ba51457dc54021b41be7">◆ </a></span>context</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity, typename Allocator> </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">using <a class="el" href="classentt_1_1basic__registry.html">entt::basic_registry</a>< Entity, Allocator >::context = internal::registry_context<<a class="el" href="#a9ce6e0e7aa3c23f3819290c41e78c023">allocator_type</a>></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Context type. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="registry_8hpp_source.html#l00312">312</a> of file <a class="el" href="registry_8hpp_source.html">registry.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abdeb17d13b9834969282c5e8a930656d" name="abdeb17d13b9834969282c5e8a930656d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abdeb17d13b9834969282c5e8a930656d">◆ </a></span>entity_type</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity, typename Allocator> </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">using <a class="el" href="classentt_1_1basic__registry.html">entt::basic_registry</a>< Entity, Allocator >::entity_type = typename <a class="el" href="classentt_1_1basic__entt__traits.html#a8d3ccdc302fc7dc567541fa12eca6b4e">traits_type::value_type</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Underlying entity identifier. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="registry_8hpp_source.html#l00304">304</a> of file <a class="el" href="registry_8hpp_source.html">registry.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3b46298ebd98b1f89b3b8910838ea0eb" name="a3b46298ebd98b1f89b3b8910838ea0eb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3b46298ebd98b1f89b3b8910838ea0eb">◆ </a></span>iterable</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity, typename Allocator> </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">using <a class="el" href="classentt_1_1basic__registry.html">entt::basic_registry</a>< Entity, Allocator >::iterable = <a class="el" href="structentt_1_1iterable__adaptor.html">iterable_adaptor</a><internal::registry_storage_iterator<typename <a class="el" href="classentt_1_1dense__map.html#acc07b299f15a57db885089cc1a31322d">pool_container_type::iterator</a>>></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Iterable registry type. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="registry_8hpp_source.html#l00314">314</a> of file <a class="el" href="registry_8hpp_source.html">registry.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abfa63598b862f2cb713db6f9779656c7" name="abfa63598b862f2cb713db6f9779656c7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abfa63598b862f2cb713db6f9779656c7">◆ </a></span>size_type</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity, typename Allocator> </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">using <a class="el" href="classentt_1_1basic__registry.html">entt::basic_registry</a>< Entity, Allocator >::size_type = std::size_t</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Unsigned integer type. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="registry_8hpp_source.html#l00308">308</a> of file <a class="el" href="registry_8hpp_source.html">registry.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a99e000856991d365d5a8a9e619b5fd03" name="a99e000856991d365d5a8a9e619b5fd03"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a99e000856991d365d5a8a9e619b5fd03">◆ </a></span>storage_for_type</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity, typename Allocator> </div>
|
|
<div class="memtemplate">
|
|
template<typename Type> </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">using <a class="el" href="classentt_1_1basic__registry.html">entt::basic_registry</a>< Entity, Allocator >::storage_for_type = typename <a class="el" href="structentt_1_1storage__for.html">storage_for</a><Type, Entity, typename alloc_traits::template rebind_alloc<std::remove_const_t<Type>>>::type</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p></p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">Type</td><td>Storage value type, eventually const. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="registry_8hpp_source.html#l00323">323</a> of file <a class="el" href="registry_8hpp_source.html">registry.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a49c533b43c29fad4b52bc10e4f390107" name="a49c533b43c29fad4b52bc10e4f390107"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a49c533b43c29fad4b52bc10e4f390107">◆ </a></span>version_type</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity, typename Allocator> </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">using <a class="el" href="classentt_1_1basic__registry.html">entt::basic_registry</a>< Entity, Allocator >::version_type = typename <a class="el" href="classentt_1_1basic__entt__traits.html#aa3fe33d19b228d07c5560b907f910c10">traits_type::version_type</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Underlying version type. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="registry_8hpp_source.html#l00306">306</a> of file <a class="el" href="registry_8hpp_source.html">registry.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="afb2496f183300f9f9b7ae24617df0a3c" name="afb2496f183300f9f9b7ae24617df0a3c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afb2496f183300f9f9b7ae24617df0a3c">◆ </a></span>basic_registry() <span class="overload">[1/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity, typename Allocator> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1basic__registry.html">entt::basic_registry</a>< Entity, Allocator >::basic_registry </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">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Default constructor. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="registry_8hpp_source.html#l00326">326</a> of file <a class="el" href="registry_8hpp_source.html">registry.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab66e63c6c5398d5a0c9fc40d2fe8201f" name="ab66e63c6c5398d5a0c9fc40d2fe8201f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab66e63c6c5398d5a0c9fc40d2fe8201f">◆ </a></span>basic_registry() <span class="overload">[2/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity, typename Allocator> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1basic__registry.html">entt::basic_registry</a>< Entity, Allocator >::basic_registry </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="#a9ce6e0e7aa3c23f3819290c41e78c023">allocator_type</a> &</td> <td class="paramname"><span class="paramname"><em>allocator</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel explicit">explicit</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Constructs an empty registry with a given allocator. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">allocator</td><td>The allocator to use. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="registry_8hpp_source.html#l00333">333</a> of file <a class="el" href="registry_8hpp_source.html">registry.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1b6c762063ff48a0f4ca8efa063ebd53" name="a1b6c762063ff48a0f4ca8efa063ebd53"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1b6c762063ff48a0f4ca8efa063ebd53">◆ </a></span>basic_registry() <span class="overload">[3/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity, typename Allocator> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1basic__registry.html">entt::basic_registry</a>< Entity, Allocator >::basic_registry </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="#abfa63598b862f2cb713db6f9779656c7">size_type</a></td> <td class="paramname"><span class="paramname"><em>count</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="#a9ce6e0e7aa3c23f3819290c41e78c023">allocator_type</a> &</td> <td class="paramname"><span class="paramname"><em>allocator</em></span><span class="paramdefsep"> = </span><span class="paramdefval"><a class="el" href="#a9ce6e0e7aa3c23f3819290c41e78c023">allocator_type</a>{}</span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Allocates enough memory upon construction to store <code>count</code> pools. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">count</td><td>The number of pools to allocate memory for. </td></tr>
|
|
<tr><td class="paramname">allocator</td><td>The allocator to use. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="registry_8hpp_source.html#l00341">341</a> of file <a class="el" href="registry_8hpp_source.html">registry.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac5cfdf43791119f4ab2d6976bec62644" name="ac5cfdf43791119f4ab2d6976bec62644"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac5cfdf43791119f4ab2d6976bec62644">◆ </a></span>basic_registry() <span class="overload">[4/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity, typename Allocator> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1basic__registry.html">entt::basic_registry</a>< Entity, Allocator >::basic_registry </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classentt_1_1basic__registry.html">basic_registry</a>< Entity, Allocator > &&</td> <td class="paramname"><span class="paramname"><em>other</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel noexcept">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Move constructor. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">other</td><td>The instance to move from. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="registry_8hpp_source.html#l00357">357</a> of file <a class="el" href="registry_8hpp_source.html">registry.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a463b15da6bfe18744e595c082ef70bac" name="a463b15da6bfe18744e595c082ef70bac"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a463b15da6bfe18744e595c082ef70bac">◆ </a></span>all_of()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity, typename Allocator> </div>
|
|
<div class="memtemplate">
|
|
template<typename... Type> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="classentt_1_1basic__registry.html">entt::basic_registry</a>< Entity, Allocator >::all_of </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="#abdeb17d13b9834969282c5e8a930656d">entity_type</a></td> <td class="paramname"><span class="paramname"><em>entt</em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel nodiscard">nodiscard</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Check if an entity is part of all the given storage. </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">Type</td><td>Type of storage to check for. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">entt</td><td>A valid identifier. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if the entity is part of all the storage, false otherwise. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="registry_8hpp_source.html#l00852">852</a> of file <a class="el" href="registry_8hpp_source.html">registry.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0bcc0d120d7bbe348242a1c3227af8fc" name="a0bcc0d120d7bbe348242a1c3227af8fc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0bcc0d120d7bbe348242a1c3227af8fc">◆ </a></span>any_of()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity, typename Allocator> </div>
|
|
<div class="memtemplate">
|
|
template<typename... Type> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="classentt_1_1basic__registry.html">entt::basic_registry</a>< Entity, Allocator >::any_of </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="#abdeb17d13b9834969282c5e8a930656d">entity_type</a></td> <td class="paramname"><span class="paramname"><em>entt</em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel nodiscard">nodiscard</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Check if an entity is part of at least one given storage. </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">Type</td><td>Type of storage to check for. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">entt</td><td>A valid identifier. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if the entity is part of at least one storage, false otherwise. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="registry_8hpp_source.html#l00869">869</a> of file <a class="el" href="registry_8hpp_source.html">registry.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a65ae6a29493a09a3c19e83748bae6a7e" name="a65ae6a29493a09a3c19e83748bae6a7e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a65ae6a29493a09a3c19e83748bae6a7e">◆ </a></span>clear()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity, typename Allocator> </div>
|
|
<div class="memtemplate">
|
|
template<typename... Type> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classentt_1_1basic__registry.html">entt::basic_registry</a>< Entity, Allocator >::clear </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">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Clears a whole registry or the pools for the given elements. </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">Type</td><td>Types of elements to remove from their entities. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="registry_8hpp_source.html#l00960">960</a> of file <a class="el" href="registry_8hpp_source.html">registry.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac9008dbd303d18cccf1ef7f279637347" name="ac9008dbd303d18cccf1ef7f279637347"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac9008dbd303d18cccf1ef7f279637347">◆ </a></span>compact()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity, typename Allocator> </div>
|
|
<div class="memtemplate">
|
|
template<typename... Type> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classentt_1_1basic__registry.html">entt::basic_registry</a>< Entity, Allocator >::compact </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">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Removes all tombstones from a registry or only the pools for the given elements. </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">Type</td><td>Types of elements for which to clear all tombstones. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="registry_8hpp_source.html#l00835">835</a> of file <a class="el" href="registry_8hpp_source.html">registry.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4ab0e3ed31fb0c455c07d0541941108a" name="a4ab0e3ed31fb0c455c07d0541941108a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4ab0e3ed31fb0c455c07d0541941108a">◆ </a></span>create() <span class="overload">[1/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity, typename Allocator> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="#abdeb17d13b9834969282c5e8a930656d">entity_type</a> <a class="el" href="classentt_1_1basic__registry.html">entt::basic_registry</a>< Entity, Allocator >::create </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">inline</span><span class="mlabel nodiscard">nodiscard</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Creates a new entity or recycles a destroyed one. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>A valid identifier. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="registry_8hpp_source.html#l00499">499</a> of file <a class="el" href="registry_8hpp_source.html">registry.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6366705dc2f7db448434ce17e1403884" name="a6366705dc2f7db448434ce17e1403884"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6366705dc2f7db448434ce17e1403884">◆ </a></span>create() <span class="overload">[2/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity, typename Allocator> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="#abdeb17d13b9834969282c5e8a930656d">entity_type</a> <a class="el" href="classentt_1_1basic__registry.html">entt::basic_registry</a>< Entity, Allocator >::create </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="#abdeb17d13b9834969282c5e8a930656d">entity_type</a></td> <td class="paramname"><span class="paramname"><em>hint</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel nodiscard">nodiscard</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Creates a new entity or recycles a destroyed one. </p>
|
|
<p>If the requested entity isn't in use, the suggested identifier is used. Otherwise, a new identifier is generated.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">hint</td><td>Required identifier. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A valid identifier. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="registry_8hpp_source.html#l00512">512</a> of file <a class="el" href="registry_8hpp_source.html">registry.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5dee7d7c5329e5fd29bcfbe4a5a4842a" name="a5dee7d7c5329e5fd29bcfbe4a5a4842a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5dee7d7c5329e5fd29bcfbe4a5a4842a">◆ </a></span>create() <span class="overload">[3/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity, typename Allocator> </div>
|
|
<div class="memtemplate">
|
|
template<typename It> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classentt_1_1basic__registry.html">entt::basic_registry</a>< Entity, Allocator >::create </td>
|
|
<td>(</td>
|
|
<td class="paramtype">It</td> <td class="paramname"><span class="paramname"><em>first</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">It</td> <td class="paramname"><span class="paramname"><em>last</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Assigns each element in a range an identifier. </p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="#a4ab0e3ed31fb0c455c07d0541941108a" title="Creates a new entity or recycles a destroyed one.">create</a></dd></dl>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">It</td><td>Type of forward iterator. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">first</td><td>An iterator to the first element of the range to generate. </td></tr>
|
|
<tr><td class="paramname">last</td><td>An iterator past the last element of the range to generate. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="registry_8hpp_source.html#l00526">526</a> of file <a class="el" href="registry_8hpp_source.html">registry.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4ad88b333d9c2ac606b322532a921e40" name="a4ad88b333d9c2ac606b322532a921e40"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4ad88b333d9c2ac606b322532a921e40">◆ </a></span>ctx() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity, typename Allocator> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const <a class="el" href="#af26a23d71ff7ba51457dc54021b41be7">context</a> & <a class="el" href="classentt_1_1basic__registry.html">entt::basic_registry</a>< Entity, Allocator >::ctx </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">inline</span><span class="mlabel nodiscard">nodiscard</span><span class="mlabel noexcept">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the context object, that is, a general purpose container. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The context object, that is, a general purpose container. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="registry_8hpp_source.html#l01206">1206</a> of file <a class="el" href="registry_8hpp_source.html">registry.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a063e7f4879b50fcd332702bc8cc0fa61" name="a063e7f4879b50fcd332702bc8cc0fa61"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a063e7f4879b50fcd332702bc8cc0fa61">◆ </a></span>ctx() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity, typename Allocator> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="#af26a23d71ff7ba51457dc54021b41be7">context</a> & <a class="el" href="classentt_1_1basic__registry.html">entt::basic_registry</a>< Entity, Allocator >::ctx </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">inline</span><span class="mlabel nodiscard">nodiscard</span><span class="mlabel noexcept">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the context object, that is, a general purpose container. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The context object, that is, a general purpose container. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="registry_8hpp_source.html#l01201">1201</a> of file <a class="el" href="registry_8hpp_source.html">registry.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad953b537b28f0f8d590e77b81faa1941" name="ad953b537b28f0f8d590e77b81faa1941"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad953b537b28f0f8d590e77b81faa1941">◆ </a></span>current()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity, typename Allocator> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="#a49c533b43c29fad4b52bc10e4f390107">version_type</a> <a class="el" href="classentt_1_1basic__registry.html">entt::basic_registry</a>< Entity, Allocator >::current </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="#abdeb17d13b9834969282c5e8a930656d">entity_type</a></td> <td class="paramname"><span class="paramname"><em>entt</em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel nodiscard">nodiscard</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the actual version for an identifier. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">entt</td><td>A valid identifier. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The version for the given identifier if valid, the tombstone version otherwise. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="registry_8hpp_source.html#l00491">491</a> of file <a class="el" href="registry_8hpp_source.html">registry.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4849d0fe9d6008431239c93c57551d10" name="a4849d0fe9d6008431239c93c57551d10"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4849d0fe9d6008431239c93c57551d10">◆ </a></span>destroy() <span class="overload">[1/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity, typename Allocator> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="#a49c533b43c29fad4b52bc10e4f390107">version_type</a> <a class="el" href="classentt_1_1basic__registry.html">entt::basic_registry</a>< Entity, Allocator >::destroy </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="#abdeb17d13b9834969282c5e8a930656d">entity_type</a></td> <td class="paramname"><span class="paramname"><em>entt</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Destroys an entity and releases its identifier. </p>
|
|
<dl class="section warning"><dt>Warning</dt><dd>Adding or removing elements to an entity that is being destroyed can result in undefined behavior.</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">entt</td><td>A valid identifier. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The version of the recycled entity. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="registry_8hpp_source.html#l00540">540</a> of file <a class="el" href="registry_8hpp_source.html">registry.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4e957182d72fd24e436afda55ec25e33" name="a4e957182d72fd24e436afda55ec25e33"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4e957182d72fd24e436afda55ec25e33">◆ </a></span>destroy() <span class="overload">[2/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity, typename Allocator> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="#a49c533b43c29fad4b52bc10e4f390107">version_type</a> <a class="el" href="classentt_1_1basic__registry.html">entt::basic_registry</a>< Entity, Allocator >::destroy </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="#abdeb17d13b9834969282c5e8a930656d">entity_type</a></td> <td class="paramname"><span class="paramname"><em>entt</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="#a49c533b43c29fad4b52bc10e4f390107">version_type</a></td> <td class="paramname"><span class="paramname"><em>version</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Destroys an entity and releases its identifier. </p>
|
|
<p>The suggested version or the valid version closest to the suggested one is used instead of the implicitly generated version.</p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="#a4849d0fe9d6008431239c93c57551d10" title="Destroys an entity and releases its identifier.">destroy</a></dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">entt</td><td>A valid identifier. </td></tr>
|
|
<tr><td class="paramname">version</td><td>A desired version upon destruction. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The version actually assigned to the entity. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="registry_8hpp_source.html#l00561">561</a> of file <a class="el" href="registry_8hpp_source.html">registry.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a90f87bda5906f0a26d118a4d058f376d" name="a90f87bda5906f0a26d118a4d058f376d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a90f87bda5906f0a26d118a4d058f376d">◆ </a></span>destroy() <span class="overload">[3/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity, typename Allocator> </div>
|
|
<div class="memtemplate">
|
|
template<typename It> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classentt_1_1basic__registry.html">entt::basic_registry</a>< Entity, Allocator >::destroy </td>
|
|
<td>(</td>
|
|
<td class="paramtype">It</td> <td class="paramname"><span class="paramname"><em>first</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">It</td> <td class="paramname"><span class="paramname"><em>last</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Destroys all entities in a range and releases their identifiers. </p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="#a4849d0fe9d6008431239c93c57551d10" title="Destroys an entity and releases its identifier.">destroy</a></dd></dl>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">It</td><td>Type of input iterator. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">first</td><td>An iterator to the first element of the range of entities. </td></tr>
|
|
<tr><td class="paramname">last</td><td>An iterator past the last element of the range of entities. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="registry_8hpp_source.html#l00577">577</a> of file <a class="el" href="registry_8hpp_source.html">registry.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa3cd5a28e32c30e5c69965c52781bf98" name="aa3cd5a28e32c30e5c69965c52781bf98"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa3cd5a28e32c30e5c69965c52781bf98">◆ </a></span>emplace()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity, typename Allocator> </div>
|
|
<div class="memtemplate">
|
|
template<typename Type, typename... Args> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">decltype(auto) <a class="el" href="classentt_1_1basic__registry.html">entt::basic_registry</a>< Entity, Allocator >::emplace </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="#abdeb17d13b9834969282c5e8a930656d">entity_type</a></td> <td class="paramname"><span class="paramname"><em>entt</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">Args &&...</td> <td class="paramname"><span class="paramname"><em>args</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Assigns the given element to an entity. </p>
|
|
<p>The element must have a proper constructor or be of aggregate type.</p>
|
|
<dl class="section warning"><dt>Warning</dt><dd>Attempting to assign an element to an entity that already owns it results in undefined behavior.</dd></dl>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">Type</td><td>Type of element to create. </td></tr>
|
|
<tr><td class="paramname">Args</td><td>Types of arguments to use to construct the element. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">entt</td><td>A valid identifier. </td></tr>
|
|
<tr><td class="paramname">args</td><td>Parameters to use to initialize the element. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A reference to the newly created element. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="registry_8hpp_source.html#l00604">604</a> of file <a class="el" href="registry_8hpp_source.html">registry.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3ebfbe0d897e77cf0f24bc994a796b15" name="a3ebfbe0d897e77cf0f24bc994a796b15"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3ebfbe0d897e77cf0f24bc994a796b15">◆ </a></span>emplace_or_replace()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity, typename Allocator> </div>
|
|
<div class="memtemplate">
|
|
template<typename Type, typename... Args> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">decltype(auto) <a class="el" href="classentt_1_1basic__registry.html">entt::basic_registry</a>< Entity, Allocator >::emplace_or_replace </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="#abdeb17d13b9834969282c5e8a930656d">entity_type</a></td> <td class="paramname"><span class="paramname"><em>entt</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">Args &&...</td> <td class="paramname"><span class="paramname"><em>args</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Assigns or replaces the given element for an entity. </p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="#aa3cd5a28e32c30e5c69965c52781bf98" title="Assigns the given element to an entity.">emplace</a> </dd>
|
|
<dd>
|
|
<a class="el" href="#a1b4f1cccd495d17c550711fdc9606d4f" title="Replaces the given element for an entity.">replace</a></dd></dl>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">Type</td><td>Type of element to assign or replace. </td></tr>
|
|
<tr><td class="paramname">Args</td><td>Types of arguments to use to construct the element. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">entt</td><td>A valid identifier. </td></tr>
|
|
<tr><td class="paramname">args</td><td>Parameters to use to initialize the element. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A reference to the newly created element. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="registry_8hpp_source.html#l00657">657</a> of file <a class="el" href="registry_8hpp_source.html">registry.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="afc89c98a7fdc0d6083b2ae23682bc4a9" name="afc89c98a7fdc0d6083b2ae23682bc4a9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afc89c98a7fdc0d6083b2ae23682bc4a9">◆ </a></span>erase() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity, typename Allocator> </div>
|
|
<div class="memtemplate">
|
|
template<typename Type, typename... Other> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classentt_1_1basic__registry.html">entt::basic_registry</a>< Entity, Allocator >::erase </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="#abdeb17d13b9834969282c5e8a930656d">entity_type</a></td> <td class="paramname"><span class="paramname"><em>entt</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Erases the given elements from an entity. </p>
|
|
<dl class="section warning"><dt>Warning</dt><dd>Attempting to erase an element from an entity that doesn't own it results in undefined behavior.</dd></dl>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">Type</td><td>Types of elements to erase. </td></tr>
|
|
<tr><td class="paramname">Other</td><td>Other types of elements to erase. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">entt</td><td>A valid identifier. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="registry_8hpp_source.html#l00769">769</a> of file <a class="el" href="registry_8hpp_source.html">registry.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9b66704f3f810bc45996802c9197b0d6" name="a9b66704f3f810bc45996802c9197b0d6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9b66704f3f810bc45996802c9197b0d6">◆ </a></span>erase() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity, typename Allocator> </div>
|
|
<div class="memtemplate">
|
|
template<typename Type, typename... Other, typename It> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classentt_1_1basic__registry.html">entt::basic_registry</a>< Entity, Allocator >::erase </td>
|
|
<td>(</td>
|
|
<td class="paramtype">It</td> <td class="paramname"><span class="paramname"><em>first</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">It</td> <td class="paramname"><span class="paramname"><em>last</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Erases the given elements from all the entities in a range. </p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="#afc89c98a7fdc0d6083b2ae23682bc4a9" title="Erases the given elements from an entity.">erase</a></dd></dl>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">Type</td><td>Types of elements to erase. </td></tr>
|
|
<tr><td class="paramname">Other</td><td>Other types of elements to erase. </td></tr>
|
|
<tr><td class="paramname">It</td><td>Type of input iterator. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">first</td><td>An iterator to the first element of the range of entities. </td></tr>
|
|
<tr><td class="paramname">last</td><td>An iterator past the last element of the range of entities. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="registry_8hpp_source.html#l00785">785</a> of file <a class="el" href="registry_8hpp_source.html">registry.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a477abaa59c9e8a9a965c3bcbae103341" name="a477abaa59c9e8a9a965c3bcbae103341"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a477abaa59c9e8a9a965c3bcbae103341">◆ </a></span>erase_if()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity, typename Allocator> </div>
|
|
<div class="memtemplate">
|
|
template<typename Func> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classentt_1_1basic__registry.html">entt::basic_registry</a>< Entity, Allocator >::erase_if </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="#abdeb17d13b9834969282c5e8a930656d">entity_type</a></td> <td class="paramname"><span class="paramname"><em>entt</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">Func</td> <td class="paramname"><span class="paramname"><em>func</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Erases elements satisfying specific criteria from an entity. </p>
|
|
<p>The function type is equivalent to:</p>
|
|
<div class="fragment"><div class="line">void(<span class="keyword">const</span> <a class="code hl_typedef" href="namespaceentt.html#a620d583c0e6d64acf3d394524bb72303">id_type</a>, <span class="keyword">typename</span> <a class="code hl_typedef" href="#a4d204691f73d602c9f46f3127caf8c81">basic_registry<Entity>::common_type</a> &);</div>
|
|
<div class="ttc" id="aclassentt_1_1basic__registry_html_a4d204691f73d602c9f46f3127caf8c81"><div class="ttname"><a href="#a4d204691f73d602c9f46f3127caf8c81">entt::basic_registry::common_type</a></div><div class="ttdeci">base_type common_type</div><div class="ttdoc">Common type among all storage types.</div><div class="ttdef"><b>Definition</b> <a href="registry_8hpp_source.html#l00310">registry.hpp:310</a></div></div>
|
|
<div class="ttc" id="anamespaceentt_html_a620d583c0e6d64acf3d394524bb72303"><div class="ttname"><a href="namespaceentt.html#a620d583c0e6d64acf3d394524bb72303">entt::id_type</a></div><div class="ttdeci">std::uint32_t id_type</div><div class="ttdoc">Alias declaration for type identifiers.</div><div class="ttdef"><b>Definition</b> <a href="core_2fwd_8hpp_source.html#l00029">fwd.hpp:29</a></div></div>
|
|
</div><!-- fragment --><p>Only storage where the entity exists are passed to the function.</p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">Func</td><td>Type of the function object to invoke. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">entt</td><td>A valid identifier. </td></tr>
|
|
<tr><td class="paramname">func</td><td>A valid function object. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="registry_8hpp_source.html#l00821">821</a> of file <a class="el" href="registry_8hpp_source.html">registry.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a96d520486439b2017faef0c7c399ea11" name="a96d520486439b2017faef0c7c399ea11"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a96d520486439b2017faef0c7c399ea11">◆ </a></span>get() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity, typename Allocator> </div>
|
|
<div class="memtemplate">
|
|
template<typename... Type> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">decltype(auto) <a class="el" href="classentt_1_1basic__registry.html">entt::basic_registry</a>< Entity, Allocator >::get </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="#abdeb17d13b9834969282c5e8a930656d">entity_type</a></td> <td class="paramname"><span class="paramname"><em>entt</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel nodiscard">nodiscard</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns references to the given elements for an entity. </p>
|
|
<dl class="section warning"><dt>Warning</dt><dd>Attempting to get an element from an entity that doesn't own it results in undefined behavior.</dd></dl>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">Type</td><td>Types of elements to get. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">entt</td><td>A valid identifier. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>References to the elements owned by the entity. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="registry_8hpp_source.html#l00895">895</a> of file <a class="el" href="registry_8hpp_source.html">registry.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abe347a879e04298df37c19b757f6ab08" name="abe347a879e04298df37c19b757f6ab08"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abe347a879e04298df37c19b757f6ab08">◆ </a></span>get() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity, typename Allocator> </div>
|
|
<div class="memtemplate">
|
|
template<typename... Type> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">decltype(auto) <a class="el" href="classentt_1_1basic__registry.html">entt::basic_registry</a>< Entity, Allocator >::get </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="#abdeb17d13b9834969282c5e8a930656d">entity_type</a></td> <td class="paramname"><span class="paramname"><em>entt</em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel nodiscard">nodiscard</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns references to the given elements for an entity. </p>
|
|
<dl class="section warning"><dt>Warning</dt><dd>Attempting to get an element from an entity that doesn't own it results in undefined behavior.</dd></dl>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">Type</td><td>Types of elements to get. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">entt</td><td>A valid identifier. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>References to the elements owned by the entity. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="registry_8hpp_source.html#l00885">885</a> of file <a class="el" href="registry_8hpp_source.html">registry.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa0db3b1ef8738ee88b164f0f9530961b" name="aa0db3b1ef8738ee88b164f0f9530961b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa0db3b1ef8738ee88b164f0f9530961b">◆ </a></span>get_allocator()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity, typename Allocator> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="#a9ce6e0e7aa3c23f3819290c41e78c023">allocator_type</a> <a class="el" href="classentt_1_1basic__registry.html">entt::basic_registry</a>< Entity, Allocator >::get_allocator </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">inline</span><span class="mlabel nodiscard">nodiscard</span><span class="mlabel constexpr">constexpr</span><span class="mlabel noexcept">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the associated allocator. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The associated allocator. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="registry_8hpp_source.html#l00404">404</a> of file <a class="el" href="registry_8hpp_source.html">registry.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a13eee32008020e19e15ccc87f4025a2e" name="a13eee32008020e19e15ccc87f4025a2e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a13eee32008020e19e15ccc87f4025a2e">◆ </a></span>get_or_emplace()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity, typename Allocator> </div>
|
|
<div class="memtemplate">
|
|
template<typename Type, typename... Args> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">decltype(auto) <a class="el" href="classentt_1_1basic__registry.html">entt::basic_registry</a>< Entity, Allocator >::get_or_emplace </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="#abdeb17d13b9834969282c5e8a930656d">entity_type</a></td> <td class="paramname"><span class="paramname"><em>entt</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">Args &&...</td> <td class="paramname"><span class="paramname"><em>args</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel nodiscard">nodiscard</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns a reference to the given element for an entity. </p>
|
|
<p>In case the entity doesn't own the element, the parameters provided are used to construct it.</p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="#abe347a879e04298df37c19b757f6ab08" title="Returns references to the given elements for an entity.">get</a> </dd>
|
|
<dd>
|
|
<a class="el" href="#aa3cd5a28e32c30e5c69965c52781bf98" title="Assigns the given element to an entity.">emplace</a></dd></dl>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">Type</td><td>Type of element to get. </td></tr>
|
|
<tr><td class="paramname">Args</td><td>Types of arguments to use to construct the element. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">entt</td><td>A valid identifier. </td></tr>
|
|
<tr><td class="paramname">args</td><td>Parameters to use to initialize the element. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Reference to the element owned by the entity. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="registry_8hpp_source.html#l00919">919</a> of file <a class="el" href="registry_8hpp_source.html">registry.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ade9bff8409333c2e85c33411b09998f1" name="ade9bff8409333c2e85c33411b09998f1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ade9bff8409333c2e85c33411b09998f1">◆ </a></span>group()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity, typename Allocator> </div>
|
|
<div class="memtemplate">
|
|
template<typename... Owned, typename... Get, typename... Exclude> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1basic__group.html">basic_group</a>< <a class="el" href="structentt_1_1owned__t.html">owned_t</a>< <a class="el" href="#a99e000856991d365d5a8a9e619b5fd03">storage_for_type</a>< Owned >... >, <a class="el" href="structentt_1_1get__t.html">get_t</a>< <a class="el" href="#a99e000856991d365d5a8a9e619b5fd03">storage_for_type</a>< Get >... >, <a class="el" href="structentt_1_1exclude__t.html">exclude_t</a>< <a class="el" href="#a99e000856991d365d5a8a9e619b5fd03">storage_for_type</a>< Exclude >... > > <a class="el" href="classentt_1_1basic__registry.html">entt::basic_registry</a>< Entity, Allocator >::group </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structentt_1_1get__t.html">get_t</a>< Get... ></td> <td class="paramname"><span class="paramname"><em></em></span><span class="paramdefsep"> = </span><span class="paramdefval"><a class="el" href="structentt_1_1get__t.html">get_t</a>{}</span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structentt_1_1exclude__t.html">exclude_t</a>< Exclude... ></td> <td class="paramname"><span class="paramname"><em></em></span><span class="paramdefsep"> = </span><span class="paramdefval"><a class="el" href="structentt_1_1exclude__t.html">exclude_t</a>{}</span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns a group for the given elements. </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">Owned</td><td>Types of storage <em>owned</em> by the group. </td></tr>
|
|
<tr><td class="paramname">Get</td><td>Types of storage <em>observed</em> by the group, if any. </td></tr>
|
|
<tr><td class="paramname">Exclude</td><td>Types of storage used to filter the group, if any. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A newly created group. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="registry_8hpp_source.html#l01085">1085</a> of file <a class="el" href="registry_8hpp_source.html">registry.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7e1bde3245d81f921be211cef7df5c7f" name="a7e1bde3245d81f921be211cef7df5c7f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7e1bde3245d81f921be211cef7df5c7f">◆ </a></span>group_if_exists()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity, typename Allocator> </div>
|
|
<div class="memtemplate">
|
|
template<typename... Owned, typename... Get, typename... Exclude> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1basic__group.html">basic_group</a>< <a class="el" href="structentt_1_1owned__t.html">owned_t</a>< <a class="el" href="#a99e000856991d365d5a8a9e619b5fd03">storage_for_type</a>< const Owned >... >, <a class="el" href="structentt_1_1get__t.html">get_t</a>< <a class="el" href="#a99e000856991d365d5a8a9e619b5fd03">storage_for_type</a>< const Get >... >, <a class="el" href="structentt_1_1exclude__t.html">exclude_t</a>< <a class="el" href="#a99e000856991d365d5a8a9e619b5fd03">storage_for_type</a>< const Exclude >... > > <a class="el" href="classentt_1_1basic__registry.html">entt::basic_registry</a>< Entity, Allocator >::group_if_exists </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structentt_1_1get__t.html">get_t</a>< Get... ></td> <td class="paramname"><span class="paramname"><em></em></span><span class="paramdefsep"> = </span><span class="paramdefval"><a class="el" href="structentt_1_1get__t.html">get_t</a>{}</span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structentt_1_1exclude__t.html">exclude_t</a>< Exclude... ></td> <td class="paramname"><span class="paramname"><em></em></span><span class="paramdefsep"> = </span><span class="paramdefval"><a class="el" href="structentt_1_1exclude__t.html">exclude_t</a>{}</span> ) const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel nodiscard">nodiscard</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns a group for the given elements. </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">Owned</td><td>Types of storage <em>owned</em> by the group. </td></tr>
|
|
<tr><td class="paramname">Get</td><td>Types of storage <em>observed</em> by the group, if any. </td></tr>
|
|
<tr><td class="paramname">Exclude</td><td>Types of storage used to filter the group, if any. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A newly created group. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="registry_8hpp_source.html#l01109">1109</a> of file <a class="el" href="registry_8hpp_source.html">registry.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae4630a45e531d05669da84aa4a5e9778" name="ae4630a45e531d05669da84aa4a5e9778"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae4630a45e531d05669da84aa4a5e9778">◆ </a></span>insert() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity, typename Allocator> </div>
|
|
<div class="memtemplate">
|
|
template<typename Type, typename EIt, typename CIt, typename = std::enable_if_t<std::is_same_v<typename std::iterator_traits<CIt>::value_type, Type>>> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classentt_1_1basic__registry.html">entt::basic_registry</a>< Entity, Allocator >::insert </td>
|
|
<td>(</td>
|
|
<td class="paramtype">EIt</td> <td class="paramname"><span class="paramname"><em>first</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">EIt</td> <td class="paramname"><span class="paramname"><em>last</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">CIt</td> <td class="paramname"><span class="paramname"><em>from</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Assigns each entity in a range the given elements. </p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="#aa3cd5a28e32c30e5c69965c52781bf98" title="Assigns the given element to an entity.">emplace</a></dd></dl>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">Type</td><td>Type of element to create. </td></tr>
|
|
<tr><td class="paramname">EIt</td><td>Type of input iterator. </td></tr>
|
|
<tr><td class="paramname">CIt</td><td>Type of input iterator. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">first</td><td>An iterator to the first element of the range of entities. </td></tr>
|
|
<tr><td class="paramname">last</td><td>An iterator past the last element of the range of entities. </td></tr>
|
|
<tr><td class="paramname">from</td><td>An iterator to the first element of the range of elements. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="registry_8hpp_source.html#l00639">639</a> of file <a class="el" href="registry_8hpp_source.html">registry.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae299b32827f0667903d8564e10ca6774" name="ae299b32827f0667903d8564e10ca6774"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae299b32827f0667903d8564e10ca6774">◆ </a></span>insert() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity, typename Allocator> </div>
|
|
<div class="memtemplate">
|
|
template<typename Type, typename It> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classentt_1_1basic__registry.html">entt::basic_registry</a>< Entity, Allocator >::insert </td>
|
|
<td>(</td>
|
|
<td class="paramtype">It</td> <td class="paramname"><span class="paramname"><em>first</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">It</td> <td class="paramname"><span class="paramname"><em>last</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const Type &</td> <td class="paramname"><span class="paramname"><em>value</em></span><span class="paramdefsep"> = </span><span class="paramdefval">{}</span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Assigns each entity in a range the given element. </p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="#aa3cd5a28e32c30e5c69965c52781bf98" title="Assigns the given element to an entity.">emplace</a></dd></dl>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">Type</td><td>Type of element to create. </td></tr>
|
|
<tr><td class="paramname">It</td><td>Type of input iterator. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">first</td><td>An iterator to the first element of the range of entities. </td></tr>
|
|
<tr><td class="paramname">last</td><td>An iterator past the last element of the range of entities. </td></tr>
|
|
<tr><td class="paramname">value</td><td>An instance of the element to assign. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="registry_8hpp_source.html#l00621">621</a> of file <a class="el" href="registry_8hpp_source.html">registry.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab68c1ba5692d30350d30121663203aea" name="ab68c1ba5692d30350d30121663203aea"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab68c1ba5692d30350d30121663203aea">◆ </a></span>on_construct()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity, typename Allocator> </div>
|
|
<div class="memtemplate">
|
|
template<typename Type> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">auto <a class="el" href="classentt_1_1basic__registry.html">entt::basic_registry</a>< Entity, Allocator >::on_construct </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="namespaceentt.html#a620d583c0e6d64acf3d394524bb72303">id_type</a></td> <td class="paramname"><span class="paramname"><em>id</em></span><span class="paramdefsep"> = </span><span class="paramdefval"><a class="el" href="structentt_1_1type__hash.html">type_hash</a><Type>::value()</span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel nodiscard">nodiscard</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns a sink object for the given element. </p>
|
|
<p>Use this function to receive notifications whenever a new instance of the given element is created and assigned to an entity.<br />
|
|
The function type for a listener is equivalent to:</p>
|
|
<div class="fragment"><div class="line">void(<a class="code hl_function" href="#afb2496f183300f9f9b7ae24617df0a3c">basic_registry<Entity></a> &, Entity);</div>
|
|
<div class="ttc" id="aclassentt_1_1basic__registry_html_afb2496f183300f9f9b7ae24617df0a3c"><div class="ttname"><a href="#afb2496f183300f9f9b7ae24617df0a3c">entt::basic_registry::basic_registry</a></div><div class="ttdeci">basic_registry()</div><div class="ttdoc">Default constructor.</div><div class="ttdef"><b>Definition</b> <a href="registry_8hpp_source.html#l00326">registry.hpp:326</a></div></div>
|
|
</div><!-- fragment --><p>Listeners are invoked <b>after</b> assigning the element to the entity.</p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classentt_1_1sink.html" title="Sink class.">sink</a></dd></dl>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">Type</td><td>Type of element of which to get the sink. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">id</td><td>Optional name used to map the storage within the registry. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A temporary sink object. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="registry_8hpp_source.html#l01002">1002</a> of file <a class="el" href="registry_8hpp_source.html">registry.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0984ffe101cfef78d7e755bbaed5842e" name="a0984ffe101cfef78d7e755bbaed5842e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0984ffe101cfef78d7e755bbaed5842e">◆ </a></span>on_destroy()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity, typename Allocator> </div>
|
|
<div class="memtemplate">
|
|
template<typename Type> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">auto <a class="el" href="classentt_1_1basic__registry.html">entt::basic_registry</a>< Entity, Allocator >::on_destroy </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="namespaceentt.html#a620d583c0e6d64acf3d394524bb72303">id_type</a></td> <td class="paramname"><span class="paramname"><em>id</em></span><span class="paramdefsep"> = </span><span class="paramdefval"><a class="el" href="structentt_1_1type__hash.html">type_hash</a><Type>::value()</span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel nodiscard">nodiscard</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns a sink object for the given element. </p>
|
|
<p>Use this function to receive notifications whenever an instance of the given element is removed from an entity and thus destroyed.<br />
|
|
The function type for a listener is equivalent to:</p>
|
|
<div class="fragment"><div class="line">void(<a class="code hl_function" href="#afb2496f183300f9f9b7ae24617df0a3c">basic_registry<Entity></a> &, Entity);</div>
|
|
</div><!-- fragment --><p>Listeners are invoked <b>before</b> removing the element from the entity.</p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classentt_1_1sink.html" title="Sink class.">sink</a></dd></dl>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">Type</td><td>Type of element of which to get the sink. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">id</td><td>Optional name used to map the storage within the registry. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A temporary sink object. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="registry_8hpp_source.html#l01050">1050</a> of file <a class="el" href="registry_8hpp_source.html">registry.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1b83f8586cfb519b7b966751094c5381" name="a1b83f8586cfb519b7b966751094c5381"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1b83f8586cfb519b7b966751094c5381">◆ </a></span>on_update()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity, typename Allocator> </div>
|
|
<div class="memtemplate">
|
|
template<typename Type> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">auto <a class="el" href="classentt_1_1basic__registry.html">entt::basic_registry</a>< Entity, Allocator >::on_update </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="namespaceentt.html#a620d583c0e6d64acf3d394524bb72303">id_type</a></td> <td class="paramname"><span class="paramname"><em>id</em></span><span class="paramdefsep"> = </span><span class="paramdefval"><a class="el" href="structentt_1_1type__hash.html">type_hash</a><Type>::value()</span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel nodiscard">nodiscard</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns a sink object for the given element. </p>
|
|
<p>Use this function to receive notifications whenever an instance of the given element is explicitly updated.<br />
|
|
The function type for a listener is equivalent to:</p>
|
|
<div class="fragment"><div class="line">void(<a class="code hl_function" href="#afb2496f183300f9f9b7ae24617df0a3c">basic_registry<Entity></a> &, Entity);</div>
|
|
</div><!-- fragment --><p>Listeners are invoked <b>after</b> updating the element.</p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classentt_1_1sink.html" title="Sink class.">sink</a></dd></dl>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">Type</td><td>Type of element of which to get the sink. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">id</td><td>Optional name used to map the storage within the registry. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A temporary sink object. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="registry_8hpp_source.html#l01026">1026</a> of file <a class="el" href="registry_8hpp_source.html">registry.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a825a977af35627faca20c0ea388d10fa" name="a825a977af35627faca20c0ea388d10fa"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a825a977af35627faca20c0ea388d10fa">◆ </a></span>operator=() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity, typename Allocator> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1basic__registry.html">basic_registry</a> & <a class="el" href="classentt_1_1basic__registry.html">entt::basic_registry</a>< Entity, Allocator >::operator= </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classentt_1_1basic__registry.html">basic_registry</a>< Entity, Allocator > &&</td> <td class="paramname"><span class="paramname"><em>other</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel noexcept">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Move assignment operator. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">other</td><td>The instance to move from. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>This registry. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="registry_8hpp_source.html#l00379">379</a> of file <a class="el" href="registry_8hpp_source.html">registry.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aaf838797891c1fe058679f96bd88f473" name="aaf838797891c1fe058679f96bd88f473"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aaf838797891c1fe058679f96bd88f473">◆ </a></span>operator=() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity, typename Allocator> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1basic__registry.html">basic_registry</a> & <a class="el" href="classentt_1_1basic__registry.html">entt::basic_registry</a>< Entity, Allocator >::operator= </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classentt_1_1basic__registry.html">basic_registry</a>< Entity, Allocator > &</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 delete">delete</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Default copy assignment operator, deleted on purpose. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>This mixin. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1b36843b380e02019ad88c455d6e6d17" name="a1b36843b380e02019ad88c455d6e6d17"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1b36843b380e02019ad88c455d6e6d17">◆ </a></span>orphan()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity, typename Allocator> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="classentt_1_1basic__registry.html">entt::basic_registry</a>< Entity, Allocator >::orphan </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="#abdeb17d13b9834969282c5e8a930656d">entity_type</a></td> <td class="paramname"><span class="paramname"><em>entt</em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel nodiscard">nodiscard</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Checks if an entity has elements assigned. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">entt</td><td>A valid identifier. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if the entity has no elements assigned, false otherwise. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="registry_8hpp_source.html#l00978">978</a> of file <a class="el" href="registry_8hpp_source.html">registry.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0da9b805673a9753a4c9f6f1609e0d87" name="a0da9b805673a9753a4c9f6f1609e0d87"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0da9b805673a9753a4c9f6f1609e0d87">◆ </a></span>owned()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity, typename Allocator> </div>
|
|
<div class="memtemplate">
|
|
template<typename... Type> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="classentt_1_1basic__registry.html">entt::basic_registry</a>< Entity, Allocator >::owned </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">inline</span><span class="mlabel nodiscard">nodiscard</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Checks whether the given elements belong to any group. </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">Type</td><td>Types of elements in which one is interested. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if the pools of the given elements are <em>free</em>, false otherwise. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="registry_8hpp_source.html#l01127">1127</a> of file <a class="el" href="registry_8hpp_source.html">registry.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a77c108caf74d8fcce9f3fb94906cd4db" name="a77c108caf74d8fcce9f3fb94906cd4db"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a77c108caf74d8fcce9f3fb94906cd4db">◆ </a></span>patch()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity, typename Allocator> </div>
|
|
<div class="memtemplate">
|
|
template<typename Type, typename... Func> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">decltype(auto) <a class="el" href="classentt_1_1basic__registry.html">entt::basic_registry</a>< Entity, Allocator >::patch </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="#abdeb17d13b9834969282c5e8a930656d">entity_type</a></td> <td class="paramname"><span class="paramname"><em>entt</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">Func &&...</td> <td class="paramname"><span class="paramname"><em>func</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Patches the given element for an entity. </p>
|
|
<p>The signature of the function should be equivalent to the following:</p>
|
|
<div class="fragment"><div class="line">void(Type &);</div>
|
|
</div><!-- fragment --><dl class="section warning"><dt>Warning</dt><dd>Attempting to patch an element of an entity that doesn't own it results in undefined behavior.</dd></dl>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">Type</td><td>Type of element to patch. </td></tr>
|
|
<tr><td class="paramname">Func</td><td>Types of the function objects to invoke. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">entt</td><td>A valid identifier. </td></tr>
|
|
<tr><td class="paramname">func</td><td>Valid function objects. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A reference to the patched element. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="registry_8hpp_source.html#l00683">683</a> of file <a class="el" href="registry_8hpp_source.html">registry.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7eb97ddee1a5ee98a722329fe39417ce" name="a7eb97ddee1a5ee98a722329fe39417ce"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7eb97ddee1a5ee98a722329fe39417ce">◆ </a></span>remove() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity, typename Allocator> </div>
|
|
<div class="memtemplate">
|
|
template<typename Type, typename... Other> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="#abfa63598b862f2cb713db6f9779656c7">size_type</a> <a class="el" href="classentt_1_1basic__registry.html">entt::basic_registry</a>< Entity, Allocator >::remove </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="#abdeb17d13b9834969282c5e8a930656d">entity_type</a></td> <td class="paramname"><span class="paramname"><em>entt</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Removes the given elements from an entity. </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">Type</td><td>Type of element to remove. </td></tr>
|
|
<tr><td class="paramname">Other</td><td>Other types of elements to remove. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">entt</td><td>A valid identifier. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The number of elements actually removed. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="registry_8hpp_source.html#l00715">715</a> of file <a class="el" href="registry_8hpp_source.html">registry.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5f458b3df51b800632c350961947a2bb" name="a5f458b3df51b800632c350961947a2bb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5f458b3df51b800632c350961947a2bb">◆ </a></span>remove() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity, typename Allocator> </div>
|
|
<div class="memtemplate">
|
|
template<typename Type, typename... Other, typename It> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="#abfa63598b862f2cb713db6f9779656c7">size_type</a> <a class="el" href="classentt_1_1basic__registry.html">entt::basic_registry</a>< Entity, Allocator >::remove </td>
|
|
<td>(</td>
|
|
<td class="paramtype">It</td> <td class="paramname"><span class="paramname"><em>first</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">It</td> <td class="paramname"><span class="paramname"><em>last</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Removes the given elements from all the entities in a range. </p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="#a7eb97ddee1a5ee98a722329fe39417ce" title="Removes the given elements from an entity.">remove</a></dd></dl>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">Type</td><td>Type of element to remove. </td></tr>
|
|
<tr><td class="paramname">Other</td><td>Other types of elements to remove. </td></tr>
|
|
<tr><td class="paramname">It</td><td>Type of input iterator. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">first</td><td>An iterator to the first element of the range of entities. </td></tr>
|
|
<tr><td class="paramname">last</td><td>An iterator past the last element of the range of entities. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The number of elements actually removed. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="registry_8hpp_source.html#l00732">732</a> of file <a class="el" href="registry_8hpp_source.html">registry.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1b4f1cccd495d17c550711fdc9606d4f" name="a1b4f1cccd495d17c550711fdc9606d4f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1b4f1cccd495d17c550711fdc9606d4f">◆ </a></span>replace()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity, typename Allocator> </div>
|
|
<div class="memtemplate">
|
|
template<typename Type, typename... Args> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">decltype(auto) <a class="el" href="classentt_1_1basic__registry.html">entt::basic_registry</a>< Entity, Allocator >::replace </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="#abdeb17d13b9834969282c5e8a930656d">entity_type</a></td> <td class="paramname"><span class="paramname"><em>entt</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">Args &&...</td> <td class="paramname"><span class="paramname"><em>args</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Replaces the given element for an entity. </p>
|
|
<p>The element must have a proper constructor or be of aggregate type.</p>
|
|
<dl class="section warning"><dt>Warning</dt><dd>Attempting to replace an element of an entity that doesn't own it results in undefined behavior.</dd></dl>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">Type</td><td>Type of element to replace. </td></tr>
|
|
<tr><td class="paramname">Args</td><td>Types of arguments to use to construct the element. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">entt</td><td>A valid identifier. </td></tr>
|
|
<tr><td class="paramname">args</td><td>Parameters to use to initialize the element. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A reference to the element being replaced. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="registry_8hpp_source.html#l00703">703</a> of file <a class="el" href="registry_8hpp_source.html">registry.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6f2548bae0c7a80e4adf8b8ad4e4cc11" name="a6f2548bae0c7a80e4adf8b8ad4e4cc11"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6f2548bae0c7a80e4adf8b8ad4e4cc11">◆ </a></span>reset()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity, typename Allocator> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="classentt_1_1basic__registry.html">entt::basic_registry</a>< Entity, Allocator >::reset </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="namespaceentt.html#a620d583c0e6d64acf3d394524bb72303">id_type</a></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">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Discards the storage associated with a given name, if any. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">id</td><td>Name used to map the storage within the registry. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>True in case of success, false otherwise. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="registry_8hpp_source.html#l00471">471</a> of file <a class="el" href="registry_8hpp_source.html">registry.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4bf0e6bf722ed1eae4bd9f7777378ca6" name="a4bf0e6bf722ed1eae4bd9f7777378ca6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4bf0e6bf722ed1eae4bd9f7777378ca6">◆ </a></span>sort() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity, typename Allocator> </div>
|
|
<div class="memtemplate">
|
|
template<typename To, typename From> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classentt_1_1basic__registry.html">entt::basic_registry</a>< Entity, Allocator >::sort </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">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sorts two pools of elements in the same way. </p>
|
|
<p>Entities and elements in <code>To</code> which are part of both storage are sorted internally with the order they have in <code>From</code>. The others follow in no particular order.</p>
|
|
<dl class="section warning"><dt>Warning</dt><dd>Pools of elements owned by a group cannot be sorted.</dd></dl>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">To</td><td>Type of elements to sort. </td></tr>
|
|
<tr><td class="paramname">From</td><td>Type of elements to use to sort. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="registry_8hpp_source.html#l01191">1191</a> of file <a class="el" href="registry_8hpp_source.html">registry.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9f8467476bc59f55a9297bd4e93f4914" name="a9f8467476bc59f55a9297bd4e93f4914"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9f8467476bc59f55a9297bd4e93f4914">◆ </a></span>sort() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity, typename Allocator> </div>
|
|
<div class="memtemplate">
|
|
template<typename Type, typename Compare, typename Sort = std_sort, typename... Args> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classentt_1_1basic__registry.html">entt::basic_registry</a>< Entity, Allocator >::sort </td>
|
|
<td>(</td>
|
|
<td class="paramtype">Compare</td> <td class="paramname"><span class="paramname"><em>compare</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">Sort</td> <td class="paramname"><span class="paramname"><em>algo</em></span><span class="paramdefsep"> = </span><span class="paramdefval">Sort{}</span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">Args &&...</td> <td class="paramname"><span class="paramname"><em>args</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sorts the elements of a given element. </p>
|
|
<p>The comparison function object returns <code>true</code> if the first element is <em>less</em> than the second one, <code>false</code> otherwise. Its signature is also equivalent to one of the following:</p>
|
|
<div class="fragment"><div class="line">bool(<span class="keyword">const</span> Entity, <span class="keyword">const</span> Entity);</div>
|
|
<div class="line">bool(<span class="keyword">const</span> Type &, <span class="keyword">const</span> Type &);</div>
|
|
</div><!-- fragment --><p>Moreover, it shall induce a <em>strict weak ordering</em> on the values.<br />
|
|
The sort function object offers an <code>operator()</code> that accepts:</p>
|
|
<ul>
|
|
<li>An iterator to the first element of the range to sort.</li>
|
|
<li>An iterator past the last element of the range to sort.</li>
|
|
<li>A comparison function object to use to compare the elements.</li>
|
|
</ul>
|
|
<p>The comparison function object hasn't necessarily the type of the one passed along with the other parameters to this member function.</p>
|
|
<dl class="section warning"><dt>Warning</dt><dd>Pools of elements owned by a group cannot be sorted.</dd></dl>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">Type</td><td>Type of elements to sort. </td></tr>
|
|
<tr><td class="paramname">Compare</td><td>Type of comparison function object. </td></tr>
|
|
<tr><td class="paramname">Sort</td><td>Type of sort function object. </td></tr>
|
|
<tr><td class="paramname">Args</td><td>Types of arguments to forward to the sort function object. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">compare</td><td>A valid comparison function object. </td></tr>
|
|
<tr><td class="paramname">algo</td><td>A valid sort function object. </td></tr>
|
|
<tr><td class="paramname">args</td><td>Arguments to forward to the sort function object, if any. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="registry_8hpp_source.html#l01165">1165</a> of file <a class="el" href="registry_8hpp_source.html">registry.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ace5a18c1fe5b72dbdbf53cb981c00879" name="ace5a18c1fe5b72dbdbf53cb981c00879"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ace5a18c1fe5b72dbdbf53cb981c00879">◆ </a></span>storage() <span class="overload">[1/6]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity, typename Allocator> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="#af28295b4eed2182fe6c7fd6287e98d8e">const_iterable</a> <a class="el" href="classentt_1_1basic__registry.html">entt::basic_registry</a>< Entity, Allocator >::storage </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">inline</span><span class="mlabel nodiscard">nodiscard</span><span class="mlabel noexcept">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns an iterable object to use to <em>visit</em> a registry. </p>
|
|
<p>The iterable object returns a pair that contains the name and a reference to the current storage.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>An iterable object to use to <em>visit</em> the registry. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="registry_8hpp_source.html#l00421">421</a> of file <a class="el" href="registry_8hpp_source.html">registry.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3ffe409b0f7201456b1c1d32c0850474" name="a3ffe409b0f7201456b1c1d32c0850474"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3ffe409b0f7201456b1c1d32c0850474">◆ </a></span>storage() <span class="overload">[2/6]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity, typename Allocator> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="#a3b46298ebd98b1f89b3b8910838ea0eb">iterable</a> <a class="el" href="classentt_1_1basic__registry.html">entt::basic_registry</a>< Entity, Allocator >::storage </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">inline</span><span class="mlabel nodiscard">nodiscard</span><span class="mlabel noexcept">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns an iterable object to use to <em>visit</em> a registry. </p>
|
|
<p>The iterable object returns a pair that contains the name and a reference to the current storage.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>An iterable object to use to <em>visit</em> the registry. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="registry_8hpp_source.html#l00416">416</a> of file <a class="el" href="registry_8hpp_source.html">registry.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a901e410db646d5318aa6ac7cabfe6218" name="a901e410db646d5318aa6ac7cabfe6218"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a901e410db646d5318aa6ac7cabfe6218">◆ </a></span>storage() <span class="overload">[3/6]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity, typename Allocator> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="#a4d204691f73d602c9f46f3127caf8c81">common_type</a> * <a class="el" href="classentt_1_1basic__registry.html">entt::basic_registry</a>< Entity, Allocator >::storage </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="namespaceentt.html#a620d583c0e6d64acf3d394524bb72303">id_type</a></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">inline</span><span class="mlabel nodiscard">nodiscard</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Finds the storage associated with a given name, if any. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">id</td><td>Name used to map the storage within the registry. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A pointer to the storage if it exists, a null pointer otherwise. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="registry_8hpp_source.html#l00430">430</a> of file <a class="el" href="registry_8hpp_source.html">registry.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2bdc9d44e99459d93d2f43bdd1ca5df4" name="a2bdc9d44e99459d93d2f43bdd1ca5df4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2bdc9d44e99459d93d2f43bdd1ca5df4">◆ </a></span>storage() <span class="overload">[4/6]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity, typename Allocator> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const <a class="el" href="#a4d204691f73d602c9f46f3127caf8c81">common_type</a> * <a class="el" href="classentt_1_1basic__registry.html">entt::basic_registry</a>< Entity, Allocator >::storage </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="namespaceentt.html#a620d583c0e6d64acf3d394524bb72303">id_type</a></td> <td class="paramname"><span class="paramname"><em>id</em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel nodiscard">nodiscard</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Finds the storage associated with a given name, if any. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">id</td><td>Name used to map the storage within the registry. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A pointer to the storage if it exists, a null pointer otherwise. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="registry_8hpp_source.html#l00439">439</a> of file <a class="el" href="registry_8hpp_source.html">registry.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abb07bad50fa0f5bad0aabffe8ce24414" name="abb07bad50fa0f5bad0aabffe8ce24414"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abb07bad50fa0f5bad0aabffe8ce24414">◆ </a></span>storage() <span class="overload">[5/6]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity, typename Allocator> </div>
|
|
<div class="memtemplate">
|
|
template<typename Type> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="#a99e000856991d365d5a8a9e619b5fd03">storage_for_type</a>< Type > & <a class="el" href="classentt_1_1basic__registry.html">entt::basic_registry</a>< Entity, Allocator >::storage </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="namespaceentt.html#a620d583c0e6d64acf3d394524bb72303">id_type</a></td> <td class="paramname"><span class="paramname"><em>id</em></span><span class="paramdefsep"> = </span><span class="paramdefval"><a class="el" href="structentt_1_1type__hash.html">type_hash</a><Type>::value()</span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the storage for a given element type. </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">Type</td><td>Type of element of which to return the storage. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">id</td><td>Optional name used to map the storage within the registry. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The storage for the given element type. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="registry_8hpp_source.html#l00451">451</a> of file <a class="el" href="registry_8hpp_source.html">registry.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae414ee7b5315313e9987525727f6320b" name="ae414ee7b5315313e9987525727f6320b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae414ee7b5315313e9987525727f6320b">◆ </a></span>storage() <span class="overload">[6/6]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity, typename Allocator> </div>
|
|
<div class="memtemplate">
|
|
template<typename Type> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const <a class="el" href="#a99e000856991d365d5a8a9e619b5fd03">storage_for_type</a>< Type > * <a class="el" href="classentt_1_1basic__registry.html">entt::basic_registry</a>< Entity, Allocator >::storage </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="namespaceentt.html#a620d583c0e6d64acf3d394524bb72303">id_type</a></td> <td class="paramname"><span class="paramname"><em>id</em></span><span class="paramdefsep"> = </span><span class="paramdefval"><a class="el" href="structentt_1_1type__hash.html">type_hash</a><Type>::value()</span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel nodiscard">nodiscard</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the storage for a given element type, if any. </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">Type</td><td>Type of element of which to return the storage. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">id</td><td>Optional name used to map the storage within the registry. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The storage for the given element type. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="registry_8hpp_source.html#l00462">462</a> of file <a class="el" href="registry_8hpp_source.html">registry.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a394e38341a21d75194555e9ed57fe5ae" name="a394e38341a21d75194555e9ed57fe5ae"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a394e38341a21d75194555e9ed57fe5ae">◆ </a></span>swap()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity, typename Allocator> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classentt_1_1basic__registry.html">entt::basic_registry</a>< Entity, Allocator >::swap </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classentt_1_1basic__registry.html">basic_registry</a>< Entity, Allocator > &</td> <td class="paramname"><span class="paramname"><em>other</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel noexcept">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Exchanges the contents with those of a given registry. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">other</td><td>Registry to exchange the content with. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="registry_8hpp_source.html#l00388">388</a> of file <a class="el" href="registry_8hpp_source.html">registry.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a88615f35264fae0e05f25766eab624fb" name="a88615f35264fae0e05f25766eab624fb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a88615f35264fae0e05f25766eab624fb">◆ </a></span>try_get() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity, typename Allocator> </div>
|
|
<div class="memtemplate">
|
|
template<typename... Type> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">auto <a class="el" href="classentt_1_1basic__registry.html">entt::basic_registry</a>< Entity, Allocator >::try_get </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="#abdeb17d13b9834969282c5e8a930656d">entity_type</a></td> <td class="paramname"><span class="paramname"><em>entt</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel nodiscard">nodiscard</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns pointers to the given elements for an entity. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>The registry retains ownership of the pointed-to elements.</dd></dl>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">Type</td><td>Types of elements to get. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">entt</td><td>A valid identifier. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Pointers to the elements owned by the entity. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="registry_8hpp_source.html#l00947">947</a> of file <a class="el" href="registry_8hpp_source.html">registry.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2e423a67d88072b7e8126412d3ce41e5" name="a2e423a67d88072b7e8126412d3ce41e5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2e423a67d88072b7e8126412d3ce41e5">◆ </a></span>try_get() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity, typename Allocator> </div>
|
|
<div class="memtemplate">
|
|
template<typename... Type> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">auto <a class="el" href="classentt_1_1basic__registry.html">entt::basic_registry</a>< Entity, Allocator >::try_get </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="#abdeb17d13b9834969282c5e8a930656d">entity_type</a></td> <td class="paramname"><span class="paramname"><em>entt</em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel nodiscard">nodiscard</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns pointers to the given elements for an entity. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>The registry retains ownership of the pointed-to elements.</dd></dl>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">Type</td><td>Types of elements to get. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">entt</td><td>A valid identifier. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Pointers to the elements owned by the entity. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="registry_8hpp_source.html#l00936">936</a> of file <a class="el" href="registry_8hpp_source.html">registry.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a40d41cd623d5bf7ad95d75aef5e70a65" name="a40d41cd623d5bf7ad95d75aef5e70a65"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a40d41cd623d5bf7ad95d75aef5e70a65">◆ </a></span>valid()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity, typename Allocator> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="classentt_1_1basic__registry.html">entt::basic_registry</a>< Entity, Allocator >::valid </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="#abdeb17d13b9834969282c5e8a930656d">entity_type</a></td> <td class="paramname"><span class="paramname"><em>entt</em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel nodiscard">nodiscard</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Checks if an identifier refers to a valid entity. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">entt</td><td>An identifier, either valid or not. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if the identifier is valid, false otherwise. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="registry_8hpp_source.html#l00481">481</a> of file <a class="el" href="registry_8hpp_source.html">registry.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8388faa0bbae4dc1b1c74e2dff4af17f" name="a8388faa0bbae4dc1b1c74e2dff4af17f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8388faa0bbae4dc1b1c74e2dff4af17f">◆ </a></span>view() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity, typename Allocator> </div>
|
|
<div class="memtemplate">
|
|
template<typename Type, typename... Other, typename... Exclude> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1basic__view.html">basic_view</a>< <a class="el" href="structentt_1_1get__t.html">get_t</a>< <a class="el" href="#a99e000856991d365d5a8a9e619b5fd03">storage_for_type</a>< Type >, <a class="el" href="#a99e000856991d365d5a8a9e619b5fd03">storage_for_type</a>< Other >... >, <a class="el" href="structentt_1_1exclude__t.html">exclude_t</a>< <a class="el" href="#a99e000856991d365d5a8a9e619b5fd03">storage_for_type</a>< Exclude >... > > <a class="el" href="classentt_1_1basic__registry.html">entt::basic_registry</a>< Entity, Allocator >::view </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structentt_1_1exclude__t.html">exclude_t</a>< Exclude... ></td> <td class="paramname"><span class="paramname"><em></em></span><span class="paramdefsep"> = </span><span class="paramdefval"><a class="el" href="structentt_1_1exclude__t.html">exclude_t</a>{}</span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel nodiscard">nodiscard</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns a view for the given elements. </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">Type</td><td>Type of element used to construct the view. </td></tr>
|
|
<tr><td class="paramname">Other</td><td>Other types of elements used to construct the view. </td></tr>
|
|
<tr><td class="paramname">Exclude</td><td>Types of elements used to filter the view. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A newly created view. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="registry_8hpp_source.html#l01072">1072</a> of file <a class="el" href="registry_8hpp_source.html">registry.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a563374eb952f575470291d2a574176dc" name="a563374eb952f575470291d2a574176dc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a563374eb952f575470291d2a574176dc">◆ </a></span>view() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Entity, typename Allocator> </div>
|
|
<div class="memtemplate">
|
|
template<typename Type, typename... Other, typename... Exclude> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1basic__view.html">basic_view</a>< <a class="el" href="structentt_1_1get__t.html">get_t</a>< <a class="el" href="#a99e000856991d365d5a8a9e619b5fd03">storage_for_type</a>< const Type >, <a class="el" href="#a99e000856991d365d5a8a9e619b5fd03">storage_for_type</a>< const Other >... >, <a class="el" href="structentt_1_1exclude__t.html">exclude_t</a>< <a class="el" href="#a99e000856991d365d5a8a9e619b5fd03">storage_for_type</a>< const Exclude >... > > <a class="el" href="classentt_1_1basic__registry.html">entt::basic_registry</a>< Entity, Allocator >::view </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structentt_1_1exclude__t.html">exclude_t</a>< Exclude... ></td> <td class="paramname"><span class="paramname"><em></em></span><span class="paramdefsep"> = </span><span class="paramdefval"><a class="el" href="structentt_1_1exclude__t.html">exclude_t</a>{}</span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel nodiscard">nodiscard</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns a view for the given elements. </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">Type</td><td>Type of element used to construct the view. </td></tr>
|
|
<tr><td class="paramname">Other</td><td>Other types of elements used to construct the view. </td></tr>
|
|
<tr><td class="paramname">Exclude</td><td>Types of elements used to filter the view. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A newly created view. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="registry_8hpp_source.html#l01063">1063</a> of file <a class="el" href="registry_8hpp_source.html">registry.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>src/entt/entity/<a class="el" href="entity_2fwd_8hpp_source.html">fwd.hpp</a></li>
|
|
<li>src/entt/entity/<a class="el" href="registry_8hpp_source.html">registry.hpp</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.2
|
|
</small></address>
|
|
</div><!-- doc-content -->
|
|
</body>
|
|
</html>
|