Scarfski/entt
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
d914ed4a8117d28aad071d75fbea9bc4f285ace9
entt/structentt_1_1basic__handle.html
Michele Caini d914ed4a81 API reference v3.11.0
2022-11-09 12:39:12 +01:00

1183 lines
63 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>EnTT: entt::basic_handle&lt; Registry, Scope &gt; Struct 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>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">EnTT<span id="projectnumber">&#160;3.11.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @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&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceentt.html">entt</a></li><li class="navelem"><a class="el" href="structentt_1_1basic__handle.html">basic_handle</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="structentt_1_1basic__handle-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">entt::basic_handle&lt; Registry, Scope &gt; Struct Template Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Non-owning handle to an entity.
<a href="structentt_1_1basic__handle.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="handle_8hpp_source.html">handle.hpp</a>&gt;</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:ae0a96c4e65b652ef8e6c0764a31d7707"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__handle.html#ae0a96c4e65b652ef8e6c0764a31d7707">registry_type</a> = Registry</td></tr>
<tr class="memdesc:ae0a96c4e65b652ef8e6c0764a31d7707"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type of registry accepted by the handle. <a href="structentt_1_1basic__handle.html#ae0a96c4e65b652ef8e6c0764a31d7707">More...</a><br /></td></tr>
<tr class="separator:ae0a96c4e65b652ef8e6c0764a31d7707"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0f963971542b960b00ea13ea769c5b94"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__handle.html#a0f963971542b960b00ea13ea769c5b94">entity_type</a> = typename registry_type::entity_type</td></tr>
<tr class="memdesc:a0f963971542b960b00ea13ea769c5b94"><td class="mdescLeft">&#160;</td><td class="mdescRight">Underlying entity identifier. <a href="structentt_1_1basic__handle.html#a0f963971542b960b00ea13ea769c5b94">More...</a><br /></td></tr>
<tr class="separator:a0f963971542b960b00ea13ea769c5b94"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a943aa37b15f48113047909ce40ac2aa8"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__handle.html#a943aa37b15f48113047909ce40ac2aa8">version_type</a> = typename registry_type::version_type</td></tr>
<tr class="memdesc:a943aa37b15f48113047909ce40ac2aa8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Underlying version type. <a href="structentt_1_1basic__handle.html#a943aa37b15f48113047909ce40ac2aa8">More...</a><br /></td></tr>
<tr class="separator:a943aa37b15f48113047909ce40ac2aa8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa764b913c9a70f2af10175a5eed0643b"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__handle.html#aa764b913c9a70f2af10175a5eed0643b">size_type</a> = typename registry_type::size_type</td></tr>
<tr class="memdesc:aa764b913c9a70f2af10175a5eed0643b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unsigned integer type. <a href="structentt_1_1basic__handle.html#aa764b913c9a70f2af10175a5eed0643b">More...</a><br /></td></tr>
<tr class="separator:aa764b913c9a70f2af10175a5eed0643b"><td class="memSeparator" colspan="2">&#160;</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:a626e946763abe4c6471f8a367e6be42e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__handle.html#a626e946763abe4c6471f8a367e6be42e">basic_handle</a> () noexcept</td></tr>
<tr class="memdesc:a626e946763abe4c6471f8a367e6be42e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs an invalid handle. <a href="structentt_1_1basic__handle.html#a626e946763abe4c6471f8a367e6be42e">More...</a><br /></td></tr>
<tr class="separator:a626e946763abe4c6471f8a367e6be42e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a76c7232a30b5cee98b05409c8ef10727"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__handle.html#a76c7232a30b5cee98b05409c8ef10727">basic_handle</a> (<a class="el" href="structentt_1_1basic__handle.html#ae0a96c4e65b652ef8e6c0764a31d7707">registry_type</a> &amp;ref, <a class="el" href="structentt_1_1basic__handle.html#a0f963971542b960b00ea13ea769c5b94">entity_type</a> value) noexcept</td></tr>
<tr class="memdesc:a76c7232a30b5cee98b05409c8ef10727"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a handle from a given registry and entity. <a href="structentt_1_1basic__handle.html#a76c7232a30b5cee98b05409c8ef10727">More...</a><br /></td></tr>
<tr class="separator:a76c7232a30b5cee98b05409c8ef10727"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adae782b5d23ccc5a9130cd870b28fba2"><td class="memItemLeft" align="right" valign="top">auto&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__handle.html#adae782b5d23ccc5a9130cd870b28fba2">storage</a> () const noexcept</td></tr>
<tr class="memdesc:adae782b5d23ccc5a9130cd870b28fba2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns an iterable object to use to <em>visit</em> a handle. <a href="structentt_1_1basic__handle.html#adae782b5d23ccc5a9130cd870b28fba2">More...</a><br /></td></tr>
<tr class="separator:adae782b5d23ccc5a9130cd870b28fba2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac1c8add27af60e420f5f0d1d2fd078db"><td class="memTemplParams" colspan="2">template&lt;typename Other , typename... Args&gt; </td></tr>
<tr class="memitem:ac1c8add27af60e420f5f0d1d2fd078db"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__handle.html#ac1c8add27af60e420f5f0d1d2fd078db">operator basic_handle&lt; Other, Args... &gt;</a> () const noexcept</td></tr>
<tr class="memdesc:ac1c8add27af60e420f5f0d1d2fd078db"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a const handle from a non-const one. <a href="structentt_1_1basic__handle.html#ac1c8add27af60e420f5f0d1d2fd078db">More...</a><br /></td></tr>
<tr class="separator:ac1c8add27af60e420f5f0d1d2fd078db"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a309c43b46efbd454f2c2c22b0a23b71f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__handle.html#a309c43b46efbd454f2c2c22b0a23b71f">operator entity_type</a> () const noexcept</td></tr>
<tr class="memdesc:a309c43b46efbd454f2c2c22b0a23b71f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts a handle to its underlying entity. <a href="structentt_1_1basic__handle.html#a309c43b46efbd454f2c2c22b0a23b71f">More...</a><br /></td></tr>
<tr class="separator:a309c43b46efbd454f2c2c22b0a23b71f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9d6c1f30cb7e6eed039de66b6ed05163"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__handle.html#a9d6c1f30cb7e6eed039de66b6ed05163">operator bool</a> () const noexcept</td></tr>
<tr class="memdesc:a9d6c1f30cb7e6eed039de66b6ed05163"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if a handle refers to non-null registry pointer and entity. <a href="structentt_1_1basic__handle.html#a9d6c1f30cb7e6eed039de66b6ed05163">More...</a><br /></td></tr>
<tr class="separator:a9d6c1f30cb7e6eed039de66b6ed05163"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad95bbdd34812aef5f4d492d40c1b7815"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__handle.html#ad95bbdd34812aef5f4d492d40c1b7815">valid</a> () const</td></tr>
<tr class="memdesc:ad95bbdd34812aef5f4d492d40c1b7815"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if a handle refers to a valid entity or not. <a href="structentt_1_1basic__handle.html#ad95bbdd34812aef5f4d492d40c1b7815">More...</a><br /></td></tr>
<tr class="separator:ad95bbdd34812aef5f4d492d40c1b7815"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae22e78cbaa51a4eb7070761ad4af4830"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structentt_1_1basic__handle.html#ae0a96c4e65b652ef8e6c0764a31d7707">registry_type</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__handle.html#ae22e78cbaa51a4eb7070761ad4af4830">registry</a> () const noexcept</td></tr>
<tr class="memdesc:ae22e78cbaa51a4eb7070761ad4af4830"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a pointer to the underlying registry, if any. <a href="structentt_1_1basic__handle.html#ae22e78cbaa51a4eb7070761ad4af4830">More...</a><br /></td></tr>
<tr class="separator:ae22e78cbaa51a4eb7070761ad4af4830"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adfe5f3adcfed0c66e72919b6ba1c98a7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structentt_1_1basic__handle.html#a0f963971542b960b00ea13ea769c5b94">entity_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__handle.html#adfe5f3adcfed0c66e72919b6ba1c98a7">entity</a> () const noexcept</td></tr>
<tr class="memdesc:adfe5f3adcfed0c66e72919b6ba1c98a7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the entity associated with a handle. <a href="structentt_1_1basic__handle.html#adfe5f3adcfed0c66e72919b6ba1c98a7">More...</a><br /></td></tr>
<tr class="separator:adfe5f3adcfed0c66e72919b6ba1c98a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a010d60402134ca3ecc2b1665b338c99b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__handle.html#a010d60402134ca3ecc2b1665b338c99b">destroy</a> ()</td></tr>
<tr class="memdesc:a010d60402134ca3ecc2b1665b338c99b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroys the entity associated with a handle. <a href="structentt_1_1basic__handle.html#a010d60402134ca3ecc2b1665b338c99b">More...</a><br /></td></tr>
<tr class="separator:a010d60402134ca3ecc2b1665b338c99b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a776a7e37785c0cf6e30885e3153375ba"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__handle.html#a776a7e37785c0cf6e30885e3153375ba">destroy</a> (const <a class="el" href="structentt_1_1basic__handle.html#a943aa37b15f48113047909ce40ac2aa8">version_type</a> version)</td></tr>
<tr class="memdesc:a776a7e37785c0cf6e30885e3153375ba"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroys the entity associated with a handle. <a href="structentt_1_1basic__handle.html#a776a7e37785c0cf6e30885e3153375ba">More...</a><br /></td></tr>
<tr class="separator:a776a7e37785c0cf6e30885e3153375ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5850a2de85b4977302811d60d4365b03"><td class="memTemplParams" colspan="2">template&lt;typename Component , typename... Args&gt; </td></tr>
<tr class="memitem:a5850a2de85b4977302811d60d4365b03"><td class="memTemplItemLeft" align="right" valign="top">decltype(auto)&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__handle.html#a5850a2de85b4977302811d60d4365b03">emplace</a> (Args &amp;&amp;...args) const</td></tr>
<tr class="memdesc:a5850a2de85b4977302811d60d4365b03"><td class="mdescLeft">&#160;</td><td class="mdescRight">Assigns the given component to a handle. <a href="structentt_1_1basic__handle.html#a5850a2de85b4977302811d60d4365b03">More...</a><br /></td></tr>
<tr class="separator:a5850a2de85b4977302811d60d4365b03"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a798fb3d599ec98c2667c004ae4dbdb04"><td class="memTemplParams" colspan="2">template&lt;typename Component , typename... Args&gt; </td></tr>
<tr class="memitem:a798fb3d599ec98c2667c004ae4dbdb04"><td class="memTemplItemLeft" align="right" valign="top">decltype(auto)&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__handle.html#a798fb3d599ec98c2667c004ae4dbdb04">emplace_or_replace</a> (Args &amp;&amp;...args) const</td></tr>
<tr class="memdesc:a798fb3d599ec98c2667c004ae4dbdb04"><td class="mdescLeft">&#160;</td><td class="mdescRight">Assigns or replaces the given component for a handle. <a href="structentt_1_1basic__handle.html#a798fb3d599ec98c2667c004ae4dbdb04">More...</a><br /></td></tr>
<tr class="separator:a798fb3d599ec98c2667c004ae4dbdb04"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a464d4084991529843c7c5a88d56e12cd"><td class="memTemplParams" colspan="2">template&lt;typename Component , typename... Func&gt; </td></tr>
<tr class="memitem:a464d4084991529843c7c5a88d56e12cd"><td class="memTemplItemLeft" align="right" valign="top">decltype(auto)&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__handle.html#a464d4084991529843c7c5a88d56e12cd">patch</a> (Func &amp;&amp;...func) const</td></tr>
<tr class="memdesc:a464d4084991529843c7c5a88d56e12cd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Patches the given component for a handle. <a href="structentt_1_1basic__handle.html#a464d4084991529843c7c5a88d56e12cd">More...</a><br /></td></tr>
<tr class="separator:a464d4084991529843c7c5a88d56e12cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a16534840f1d298cbd6eef5fa813173a3"><td class="memTemplParams" colspan="2">template&lt;typename Component , typename... Args&gt; </td></tr>
<tr class="memitem:a16534840f1d298cbd6eef5fa813173a3"><td class="memTemplItemLeft" align="right" valign="top">decltype(auto)&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__handle.html#a16534840f1d298cbd6eef5fa813173a3">replace</a> (Args &amp;&amp;...args) const</td></tr>
<tr class="memdesc:a16534840f1d298cbd6eef5fa813173a3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Replaces the given component for a handle. <a href="structentt_1_1basic__handle.html#a16534840f1d298cbd6eef5fa813173a3">More...</a><br /></td></tr>
<tr class="separator:a16534840f1d298cbd6eef5fa813173a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a927411244a87196f3db80d7514217011"><td class="memTemplParams" colspan="2">template&lt;typename... Component&gt; </td></tr>
<tr class="memitem:a927411244a87196f3db80d7514217011"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="structentt_1_1basic__handle.html#aa764b913c9a70f2af10175a5eed0643b">size_type</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__handle.html#a927411244a87196f3db80d7514217011">remove</a> () const</td></tr>
<tr class="memdesc:a927411244a87196f3db80d7514217011"><td class="mdescLeft">&#160;</td><td class="mdescRight">Removes the given components from a handle. <a href="structentt_1_1basic__handle.html#a927411244a87196f3db80d7514217011">More...</a><br /></td></tr>
<tr class="separator:a927411244a87196f3db80d7514217011"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0759182fbb0890e816fb0504ca99e9a0"><td class="memTemplParams" colspan="2">template&lt;typename... Component&gt; </td></tr>
<tr class="memitem:a0759182fbb0890e816fb0504ca99e9a0"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__handle.html#a0759182fbb0890e816fb0504ca99e9a0">erase</a> () const</td></tr>
<tr class="memdesc:a0759182fbb0890e816fb0504ca99e9a0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Erases the given components from a handle. <a href="structentt_1_1basic__handle.html#a0759182fbb0890e816fb0504ca99e9a0">More...</a><br /></td></tr>
<tr class="separator:a0759182fbb0890e816fb0504ca99e9a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2e65e9950e934dcf08b8562620b2afd6"><td class="memTemplParams" colspan="2">template&lt;typename... Component&gt; </td></tr>
<tr class="memitem:a2e65e9950e934dcf08b8562620b2afd6"><td class="memTemplItemLeft" align="right" valign="top">decltype(auto)&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__handle.html#a2e65e9950e934dcf08b8562620b2afd6">all_of</a> () const</td></tr>
<tr class="memdesc:a2e65e9950e934dcf08b8562620b2afd6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if a handle has all the given components. <a href="structentt_1_1basic__handle.html#a2e65e9950e934dcf08b8562620b2afd6">More...</a><br /></td></tr>
<tr class="separator:a2e65e9950e934dcf08b8562620b2afd6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1eab45b657f193edcef7cbc7951e8251"><td class="memTemplParams" colspan="2">template&lt;typename... Component&gt; </td></tr>
<tr class="memitem:a1eab45b657f193edcef7cbc7951e8251"><td class="memTemplItemLeft" align="right" valign="top">decltype(auto)&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__handle.html#a1eab45b657f193edcef7cbc7951e8251">any_of</a> () const</td></tr>
<tr class="memdesc:a1eab45b657f193edcef7cbc7951e8251"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if a handle has at least one of the given components. <a href="structentt_1_1basic__handle.html#a1eab45b657f193edcef7cbc7951e8251">More...</a><br /></td></tr>
<tr class="separator:a1eab45b657f193edcef7cbc7951e8251"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1991e05e46cc0426d2556c3c3dab4b0f"><td class="memTemplParams" colspan="2">template&lt;typename... Component&gt; </td></tr>
<tr class="memitem:a1991e05e46cc0426d2556c3c3dab4b0f"><td class="memTemplItemLeft" align="right" valign="top">decltype(auto)&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__handle.html#a1991e05e46cc0426d2556c3c3dab4b0f">get</a> () const</td></tr>
<tr class="memdesc:a1991e05e46cc0426d2556c3c3dab4b0f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns references to the given components for a handle. <a href="structentt_1_1basic__handle.html#a1991e05e46cc0426d2556c3c3dab4b0f">More...</a><br /></td></tr>
<tr class="separator:a1991e05e46cc0426d2556c3c3dab4b0f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa6226287fd3b506b4a095cc38ceb7792"><td class="memTemplParams" colspan="2">template&lt;typename Component , typename... Args&gt; </td></tr>
<tr class="memitem:aa6226287fd3b506b4a095cc38ceb7792"><td class="memTemplItemLeft" align="right" valign="top">decltype(auto)&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__handle.html#aa6226287fd3b506b4a095cc38ceb7792">get_or_emplace</a> (Args &amp;&amp;...args) const</td></tr>
<tr class="memdesc:aa6226287fd3b506b4a095cc38ceb7792"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a reference to the given component for a handle. <a href="structentt_1_1basic__handle.html#aa6226287fd3b506b4a095cc38ceb7792">More...</a><br /></td></tr>
<tr class="separator:aa6226287fd3b506b4a095cc38ceb7792"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8c9b0405cd213ff5ca7b935a6a55e636"><td class="memTemplParams" colspan="2">template&lt;typename... Component&gt; </td></tr>
<tr class="memitem:a8c9b0405cd213ff5ca7b935a6a55e636"><td class="memTemplItemLeft" align="right" valign="top">auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__handle.html#a8c9b0405cd213ff5ca7b935a6a55e636">try_get</a> () const</td></tr>
<tr class="memdesc:a8c9b0405cd213ff5ca7b935a6a55e636"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns pointers to the given components for a handle. <a href="structentt_1_1basic__handle.html#a8c9b0405cd213ff5ca7b935a6a55e636">More...</a><br /></td></tr>
<tr class="separator:a8c9b0405cd213ff5ca7b935a6a55e636"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7ed6c2bcefa06c826c90013abf9c15f2"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__handle.html#a7ed6c2bcefa06c826c90013abf9c15f2">orphan</a> () const</td></tr>
<tr class="memdesc:a7ed6c2bcefa06c826c90013abf9c15f2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if a handle has components assigned. <a href="structentt_1_1basic__handle.html#a7ed6c2bcefa06c826c90013abf9c15f2">More...</a><br /></td></tr>
<tr class="separator:a7ed6c2bcefa06c826c90013abf9c15f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><div class="compoundTemplParams">template&lt;typename Registry, typename... Scope&gt;<br />
struct entt::basic_handle&lt; Registry, Scope &gt;</div><p >Non-owning handle to an entity. </p>
<p >Tiny wrapper around a registry and an entity.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Registry</td><td>Basic registry type. </td></tr>
<tr><td class="paramname">Scope</td><td>Types to which to restrict the scope of a handle. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00102">102</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="a0f963971542b960b00ea13ea769c5b94" name="a0f963971542b960b00ea13ea769c5b94"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0f963971542b960b00ea13ea769c5b94">&#9670;&nbsp;</a></span>entity_type</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Registry , typename... Scope&gt; </div>
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="structentt_1_1basic__handle.html">entt::basic_handle</a>&lt; Registry, Scope &gt;::entity_type = typename registry_type::entity_type</td>
</tr>
</table>
</div><div class="memdoc">
<p>Underlying entity identifier. </p>
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00106">106</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
<a id="ae0a96c4e65b652ef8e6c0764a31d7707" name="ae0a96c4e65b652ef8e6c0764a31d7707"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae0a96c4e65b652ef8e6c0764a31d7707">&#9670;&nbsp;</a></span>registry_type</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Registry , typename... Scope&gt; </div>
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="structentt_1_1basic__handle.html">entt::basic_handle</a>&lt; Registry, Scope &gt;::registry_type = Registry</td>
</tr>
</table>
</div><div class="memdoc">
<p>Type of registry accepted by the handle. </p>
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00104">104</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
<a id="aa764b913c9a70f2af10175a5eed0643b" name="aa764b913c9a70f2af10175a5eed0643b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa764b913c9a70f2af10175a5eed0643b">&#9670;&nbsp;</a></span>size_type</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Registry , typename... Scope&gt; </div>
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="structentt_1_1basic__handle.html">entt::basic_handle</a>&lt; Registry, Scope &gt;::size_type = typename registry_type::size_type</td>
</tr>
</table>
</div><div class="memdoc">
<p>Unsigned integer type. </p>
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00110">110</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
<a id="a943aa37b15f48113047909ce40ac2aa8" name="a943aa37b15f48113047909ce40ac2aa8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a943aa37b15f48113047909ce40ac2aa8">&#9670;&nbsp;</a></span>version_type</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Registry , typename... Scope&gt; </div>
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="structentt_1_1basic__handle.html">entt::basic_handle</a>&lt; Registry, Scope &gt;::version_type = typename registry_type::version_type</td>
</tr>
</table>
</div><div class="memdoc">
<p>Underlying version type. </p>
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00108">108</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a626e946763abe4c6471f8a367e6be42e" name="a626e946763abe4c6471f8a367e6be42e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a626e946763abe4c6471f8a367e6be42e">&#9670;&nbsp;</a></span>basic_handle() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Registry , typename... Scope&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structentt_1_1basic__handle.html">entt::basic_handle</a>&lt; Registry, Scope &gt;::basic_handle </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs an invalid handle. </p>
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00113">113</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
<a id="a76c7232a30b5cee98b05409c8ef10727" name="a76c7232a30b5cee98b05409c8ef10727"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a76c7232a30b5cee98b05409c8ef10727">&#9670;&nbsp;</a></span>basic_handle() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Registry , typename... Scope&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structentt_1_1basic__handle.html">entt::basic_handle</a>&lt; Registry, Scope &gt;::basic_handle </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structentt_1_1basic__handle.html#ae0a96c4e65b652ef8e6c0764a31d7707">registry_type</a> &amp;&#160;</td>
<td class="paramname"><em>ref</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structentt_1_1basic__handle.html#a0f963971542b960b00ea13ea769c5b94">entity_type</a>&#160;</td>
<td class="paramname"><em>value</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs a handle from a given registry and entity. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ref</td><td>An instance of the registry class. </td></tr>
<tr><td class="paramname">value</td><td>A valid identifier. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00122">122</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a2e65e9950e934dcf08b8562620b2afd6" name="a2e65e9950e934dcf08b8562620b2afd6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2e65e9950e934dcf08b8562620b2afd6">&#9670;&nbsp;</a></span>all_of()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Registry , typename... Scope&gt; </div>
<div class="memtemplate">
template&lt;typename... Component&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">decltype(auto) <a class="el" href="structentt_1_1basic__handle.html">entt::basic_handle</a>&lt; Registry, Scope &gt;::all_of </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks if a handle has all the given components. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Component</td><td>Components for which to perform the check. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if the handle has all the components, false otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00289">289</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
<a id="a1eab45b657f193edcef7cbc7951e8251" name="a1eab45b657f193edcef7cbc7951e8251"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1eab45b657f193edcef7cbc7951e8251">&#9670;&nbsp;</a></span>any_of()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Registry , typename... Scope&gt; </div>
<div class="memtemplate">
template&lt;typename... Component&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">decltype(auto) <a class="el" href="structentt_1_1basic__handle.html">entt::basic_handle</a>&lt; Registry, Scope &gt;::any_of </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks if a handle has at least one of the given components. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Component</td><td>Components for which to perform the check. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if the handle has at least one of the given components, false otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00300">300</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
<a id="a010d60402134ca3ecc2b1665b338c99b" name="a010d60402134ca3ecc2b1665b338c99b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a010d60402134ca3ecc2b1665b338c99b">&#9670;&nbsp;</a></span>destroy() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Registry , typename... Scope&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="structentt_1_1basic__handle.html">entt::basic_handle</a>&lt; Registry, Scope &gt;::destroy </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Destroys the entity associated with a handle. </p>
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00198">198</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
<a id="a776a7e37785c0cf6e30885e3153375ba" name="a776a7e37785c0cf6e30885e3153375ba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a776a7e37785c0cf6e30885e3153375ba">&#9670;&nbsp;</a></span>destroy() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Registry , typename... Scope&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="structentt_1_1basic__handle.html">entt::basic_handle</a>&lt; Registry, Scope &gt;::destroy </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structentt_1_1basic__handle.html#a943aa37b15f48113047909ce40ac2aa8">version_type</a>&#160;</td>
<td class="paramname"><em>version</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Destroys the entity associated with a handle. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">version</td><td>A desired version upon destruction. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00206">206</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
<a id="a5850a2de85b4977302811d60d4365b03" name="a5850a2de85b4977302811d60d4365b03"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5850a2de85b4977302811d60d4365b03">&#9670;&nbsp;</a></span>emplace()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Registry , typename... Scope&gt; </div>
<div class="memtemplate">
template&lt;typename Component , typename... Args&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">decltype(auto) <a class="el" href="structentt_1_1basic__handle.html">entt::basic_handle</a>&lt; Registry, Scope &gt;::emplace </td>
<td>(</td>
<td class="paramtype">Args &amp;&amp;...&#160;</td>
<td class="paramname"><em>args</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Assigns the given component to a handle. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Component</td><td>Type of component to create. </td></tr>
<tr><td class="paramname">Args</td><td>Types of arguments to use to construct the component. </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">args</td><td>Parameters to use to initialize the component. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A reference to the newly created component. </dd></dl>
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00218">218</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
<a id="a798fb3d599ec98c2667c004ae4dbdb04" name="a798fb3d599ec98c2667c004ae4dbdb04"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a798fb3d599ec98c2667c004ae4dbdb04">&#9670;&nbsp;</a></span>emplace_or_replace()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Registry , typename... Scope&gt; </div>
<div class="memtemplate">
template&lt;typename Component , typename... Args&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">decltype(auto) <a class="el" href="structentt_1_1basic__handle.html">entt::basic_handle</a>&lt; Registry, Scope &gt;::emplace_or_replace </td>
<td>(</td>
<td class="paramtype">Args &amp;&amp;...&#160;</td>
<td class="paramname"><em>args</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Assigns or replaces the given component for a handle. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Component</td><td>Type of component to assign or replace. </td></tr>
<tr><td class="paramname">Args</td><td>Types of arguments to use to construct the component. </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">args</td><td>Parameters to use to initialize the component. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A reference to the newly created component. </dd></dl>
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00231">231</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
<a id="adfe5f3adcfed0c66e72919b6ba1c98a7" name="adfe5f3adcfed0c66e72919b6ba1c98a7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adfe5f3adcfed0c66e72919b6ba1c98a7">&#9670;&nbsp;</a></span>entity()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Registry , typename... Scope&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structentt_1_1basic__handle.html#a0f963971542b960b00ea13ea769c5b94">entity_type</a> <a class="el" href="structentt_1_1basic__handle.html">entt::basic_handle</a>&lt; Registry, Scope &gt;::entity </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the entity associated with a handle. </p>
<dl class="section return"><dt>Returns</dt><dd>The entity associated with the handle. </dd></dl>
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00193">193</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
<a id="a0759182fbb0890e816fb0504ca99e9a0" name="a0759182fbb0890e816fb0504ca99e9a0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0759182fbb0890e816fb0504ca99e9a0">&#9670;&nbsp;</a></span>erase()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Registry , typename... Scope&gt; </div>
<div class="memtemplate">
template&lt;typename... Component&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="structentt_1_1basic__handle.html">entt::basic_handle</a>&lt; Registry, Scope &gt;::erase </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Erases the given components from a handle. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Component</td><td>Types of components to erase. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00278">278</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
<a id="a1991e05e46cc0426d2556c3c3dab4b0f" name="a1991e05e46cc0426d2556c3c3dab4b0f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1991e05e46cc0426d2556c3c3dab4b0f">&#9670;&nbsp;</a></span>get()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Registry , typename... Scope&gt; </div>
<div class="memtemplate">
template&lt;typename... Component&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">decltype(auto) <a class="el" href="structentt_1_1basic__handle.html">entt::basic_handle</a>&lt; Registry, Scope &gt;::get </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns references to the given components for a handle. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Component</td><td>Types of components to get. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>References to the components owned by the handle. </dd></dl>
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00310">310</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
<a id="aa6226287fd3b506b4a095cc38ceb7792" name="aa6226287fd3b506b4a095cc38ceb7792"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa6226287fd3b506b4a095cc38ceb7792">&#9670;&nbsp;</a></span>get_or_emplace()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Registry , typename... Scope&gt; </div>
<div class="memtemplate">
template&lt;typename Component , typename... Args&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">decltype(auto) <a class="el" href="structentt_1_1basic__handle.html">entt::basic_handle</a>&lt; Registry, Scope &gt;::get_or_emplace </td>
<td>(</td>
<td class="paramtype">Args &amp;&amp;...&#160;</td>
<td class="paramname"><em>args</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a reference to the given component for a handle. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Component</td><td>Type of component to get. </td></tr>
<tr><td class="paramname">Args</td><td>Types of arguments to use to construct the component. </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">args</td><td>Parameters to use to initialize the component. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Reference to the component owned by the handle. </dd></dl>
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00323">323</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
<a id="ac1c8add27af60e420f5f0d1d2fd078db" name="ac1c8add27af60e420f5f0d1d2fd078db"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac1c8add27af60e420f5f0d1d2fd078db">&#9670;&nbsp;</a></span>operator basic_handle&lt; Other, Args... &gt;()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Registry , typename... Scope&gt; </div>
<div class="memtemplate">
template&lt;typename Other , typename... Args&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structentt_1_1basic__handle.html">entt::basic_handle</a>&lt; Registry, Scope &gt;::operator <a class="el" href="structentt_1_1basic__handle.html">basic_handle</a>&lt; Other, Args... &gt; </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs a const handle from a non-const one. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Other</td><td>A valid entity type (see <a class="el" href="classentt_1_1entt__traits.html" title="Entity traits.">entt_traits</a> for more details). </td></tr>
<tr><td class="paramname">Args</td><td>Scope of the handle to construct. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A const handle referring to the same registry and the same entity. </dd></dl>
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00150">150</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
<a id="a9d6c1f30cb7e6eed039de66b6ed05163" name="a9d6c1f30cb7e6eed039de66b6ed05163"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9d6c1f30cb7e6eed039de66b6ed05163">&#9670;&nbsp;</a></span>operator bool()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Registry , typename... Scope&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structentt_1_1basic__handle.html">entt::basic_handle</a>&lt; Registry, Scope &gt;::operator bool </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks if a handle refers to non-null registry pointer and entity. </p>
<dl class="section return"><dt>Returns</dt><dd>True if the handle refers to non-null registry and entity, false otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00169">169</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
<a id="a309c43b46efbd454f2c2c22b0a23b71f" name="a309c43b46efbd454f2c2c22b0a23b71f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a309c43b46efbd454f2c2c22b0a23b71f">&#9670;&nbsp;</a></span>operator entity_type()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Registry , typename... Scope&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structentt_1_1basic__handle.html">entt::basic_handle</a>&lt; Registry, Scope &gt;::operator <a class="el" href="structentt_1_1basic__handle.html#a0f963971542b960b00ea13ea769c5b94">entity_type</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Converts a handle to its underlying entity. </p>
<dl class="section return"><dt>Returns</dt><dd>The contained identifier. </dd></dl>
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00161">161</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
<a id="a7ed6c2bcefa06c826c90013abf9c15f2" name="a7ed6c2bcefa06c826c90013abf9c15f2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7ed6c2bcefa06c826c90013abf9c15f2">&#9670;&nbsp;</a></span>orphan()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Registry , typename... Scope&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="structentt_1_1basic__handle.html">entt::basic_handle</a>&lt; Registry, Scope &gt;::orphan </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks if a handle has components assigned. </p>
<dl class="section return"><dt>Returns</dt><dd>True if the handle has no components assigned, false otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00343">343</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
<a id="a464d4084991529843c7c5a88d56e12cd" name="a464d4084991529843c7c5a88d56e12cd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a464d4084991529843c7c5a88d56e12cd">&#9670;&nbsp;</a></span>patch()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Registry , typename... Scope&gt; </div>
<div class="memtemplate">
template&lt;typename Component , typename... Func&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">decltype(auto) <a class="el" href="structentt_1_1basic__handle.html">entt::basic_handle</a>&lt; Registry, Scope &gt;::patch </td>
<td>(</td>
<td class="paramtype">Func &amp;&amp;...&#160;</td>
<td class="paramname"><em>func</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Patches the given component for a handle. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Component</td><td>Type of component 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">func</td><td>Valid function objects. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A reference to the patched component. </dd></dl>
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00244">244</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
<a id="ae22e78cbaa51a4eb7070761ad4af4830" name="ae22e78cbaa51a4eb7070761ad4af4830"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae22e78cbaa51a4eb7070761ad4af4830">&#9670;&nbsp;</a></span>registry()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Registry , typename... Scope&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structentt_1_1basic__handle.html#ae0a96c4e65b652ef8e6c0764a31d7707">registry_type</a> * <a class="el" href="structentt_1_1basic__handle.html">entt::basic_handle</a>&lt; Registry, Scope &gt;::registry </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a pointer to the underlying registry, if any. </p>
<dl class="section return"><dt>Returns</dt><dd>A pointer to the underlying registry, if any. </dd></dl>
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00185">185</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
<a id="a927411244a87196f3db80d7514217011" name="a927411244a87196f3db80d7514217011"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a927411244a87196f3db80d7514217011">&#9670;&nbsp;</a></span>remove()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Registry , typename... Scope&gt; </div>
<div class="memtemplate">
template&lt;typename... Component&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structentt_1_1basic__handle.html#aa764b913c9a70f2af10175a5eed0643b">size_type</a> <a class="el" href="structentt_1_1basic__handle.html">entt::basic_handle</a>&lt; Registry, Scope &gt;::remove </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Removes the given components from a handle. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Component</td><td>Types of components to remove. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The number of components actually removed. </dd></dl>
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00268">268</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
<a id="a16534840f1d298cbd6eef5fa813173a3" name="a16534840f1d298cbd6eef5fa813173a3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a16534840f1d298cbd6eef5fa813173a3">&#9670;&nbsp;</a></span>replace()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Registry , typename... Scope&gt; </div>
<div class="memtemplate">
template&lt;typename Component , typename... Args&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">decltype(auto) <a class="el" href="structentt_1_1basic__handle.html">entt::basic_handle</a>&lt; Registry, Scope &gt;::replace </td>
<td>(</td>
<td class="paramtype">Args &amp;&amp;...&#160;</td>
<td class="paramname"><em>args</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Replaces the given component for a handle. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Component</td><td>Type of component to replace. </td></tr>
<tr><td class="paramname">Args</td><td>Types of arguments to use to construct the component. </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">args</td><td>Parameters to use to initialize the component. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A reference to the component being replaced. </dd></dl>
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00257">257</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
<a id="adae782b5d23ccc5a9130cd870b28fba2" name="adae782b5d23ccc5a9130cd870b28fba2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adae782b5d23ccc5a9130cd870b28fba2">&#9670;&nbsp;</a></span>storage()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Registry , typename... Scope&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">auto <a class="el" href="structentt_1_1basic__handle.html">entt::basic_handle</a>&lt; Registry, Scope &gt;::storage </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns an iterable object to use to <em>visit</em> a handle. </p>
<p >The iterable object returns a pair that contains the name and a reference to the current storage.<br />
Returned storage are those that contain the entity associated with the handle.</p>
<dl class="section return"><dt>Returns</dt><dd>An iterable object to use to <em>visit</em> the handle. </dd></dl>
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00136">136</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
<a id="a8c9b0405cd213ff5ca7b935a6a55e636" name="a8c9b0405cd213ff5ca7b935a6a55e636"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8c9b0405cd213ff5ca7b935a6a55e636">&#9670;&nbsp;</a></span>try_get()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Registry , typename... Scope&gt; </div>
<div class="memtemplate">
template&lt;typename... Component&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">auto <a class="el" href="structentt_1_1basic__handle.html">entt::basic_handle</a>&lt; Registry, Scope &gt;::try_get </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns pointers to the given components for a handle. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Component</td><td>Types of components to get. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Pointers to the components owned by the handle. </dd></dl>
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00334">334</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
<a id="ad95bbdd34812aef5f4d492d40c1b7815" name="ad95bbdd34812aef5f4d492d40c1b7815"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad95bbdd34812aef5f4d492d40c1b7815">&#9670;&nbsp;</a></span>valid()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Registry , typename... Scope&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="structentt_1_1basic__handle.html">entt::basic_handle</a>&lt; Registry, Scope &gt;::valid </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks if a handle refers to a valid entity or not. </p>
<dl class="section return"><dt>Returns</dt><dd>True if the handle refers to a valid entity, false otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="handle_8hpp_source.html#l00177">177</a> of file <a class="el" href="handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
<hr/>The documentation for this struct 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="handle_8hpp_source.html">handle.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink