Scarfski/entt
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
78795e2da08e43872083363ec7c09bfba628120d
entt/structentt_1_1basic__handle.html
Michele Caini 78795e2da0 API reference v3.5.0
2020-09-01 00:18:55 +02:00

1086 lines
59 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=9"/>
<meta name="generator" content="Doxygen 1.8.18"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>EnTT: entt::basic_handle&lt; Entity &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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">EnTT
&#160;<span id="projectnumber">3.5.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.18 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="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; Entity &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="entity_2handle_8hpp_source.html">handle.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:afb6c2e78a876663dfee62aee4d989226"><td class="memItemLeft" align="right" valign="top"><a id="afb6c2e78a876663dfee62aee4d989226"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__handle.html#afb6c2e78a876663dfee62aee4d989226">entity_type</a> = std::remove_const_t&lt; Entity &gt;</td></tr>
<tr class="memdesc:afb6c2e78a876663dfee62aee4d989226"><td class="mdescLeft">&#160;</td><td class="mdescRight">Underlying entity identifier. <br /></td></tr>
<tr class="separator:afb6c2e78a876663dfee62aee4d989226"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad22a94a5add23583cdda3ee291bdcf3c"><td class="memItemLeft" align="right" valign="top"><a id="ad22a94a5add23583cdda3ee291bdcf3c"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__handle.html#ad22a94a5add23583cdda3ee291bdcf3c">registry_type</a> = std::conditional_t&lt; std::is_const_v&lt; Entity &gt;, const <a class="el" href="classentt_1_1basic__registry.html">basic_registry</a>&lt; <a class="el" href="structentt_1_1basic__handle.html#afb6c2e78a876663dfee62aee4d989226">entity_type</a> &gt;, <a class="el" href="classentt_1_1basic__registry.html">basic_registry</a>&lt; <a class="el" href="structentt_1_1basic__handle.html#afb6c2e78a876663dfee62aee4d989226">entity_type</a> &gt; &gt;</td></tr>
<tr class="memdesc:ad22a94a5add23583cdda3ee291bdcf3c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type of registry accepted by the handle. <br /></td></tr>
<tr class="separator:ad22a94a5add23583cdda3ee291bdcf3c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ac101da0421db31eabe56854f106976d6"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__handle.html#ac101da0421db31eabe56854f106976d6">basic_handle</a> (<a class="el" href="structentt_1_1basic__handle.html#ad22a94a5add23583cdda3ee291bdcf3c">registry_type</a> &amp;ref, <a class="el" href="structentt_1_1basic__handle.html#afb6c2e78a876663dfee62aee4d989226">entity_type</a> value=<a class="el" href="namespaceentt.html#a2f0c0a1c1d953ea991591748744cdd8b">null</a>) noexcept</td></tr>
<tr class="memdesc:ac101da0421db31eabe56854f106976d6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a handle from a given registry and entity. <a href="structentt_1_1basic__handle.html#ac101da0421db31eabe56854f106976d6">More...</a><br /></td></tr>
<tr class="separator:ac101da0421db31eabe56854f106976d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a172116427af01cdef90b0aa512ae29fb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structentt_1_1basic__handle.html">basic_handle</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__handle.html#a172116427af01cdef90b0aa512ae29fb">operator=</a> (const <a class="el" href="structentt_1_1basic__handle.html#afb6c2e78a876663dfee62aee4d989226">entity_type</a> value) noexcept</td></tr>
<tr class="memdesc:a172116427af01cdef90b0aa512ae29fb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Assigns an entity to a handle. <a href="structentt_1_1basic__handle.html#a172116427af01cdef90b0aa512ae29fb">More...</a><br /></td></tr>
<tr class="separator:a172116427af01cdef90b0aa512ae29fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4312ae1b3548a06b5132fd13ab7d880f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structentt_1_1basic__handle.html">basic_handle</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__handle.html#a4312ae1b3548a06b5132fd13ab7d880f">operator=</a> (<a class="el" href="structentt_1_1null__t.html">null_t</a>) noexcept</td></tr>
<tr class="memdesc:a4312ae1b3548a06b5132fd13ab7d880f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Assigns the null object to a handle. <a href="structentt_1_1basic__handle.html#a4312ae1b3548a06b5132fd13ab7d880f">More...</a><br /></td></tr>
<tr class="separator:a4312ae1b3548a06b5132fd13ab7d880f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a884a19f60a96f2276b0d416c817171ca"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__handle.html#a884a19f60a96f2276b0d416c817171ca">operator basic_handle&lt; const entity_type &gt;</a> () const noexcept</td></tr>
<tr class="memdesc:a884a19f60a96f2276b0d416c817171ca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a const handle from a non-const one. <a href="structentt_1_1basic__handle.html#a884a19f60a96f2276b0d416c817171ca">More...</a><br /></td></tr>
<tr class="separator:a884a19f60a96f2276b0d416c817171ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae704d7df9242eea8f6c1b20c23b38041"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__handle.html#ae704d7df9242eea8f6c1b20c23b38041">operator entity_type</a> () const noexcept</td></tr>
<tr class="memdesc:ae704d7df9242eea8f6c1b20c23b38041"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts a handle to its underlying entity. <a href="structentt_1_1basic__handle.html#ae704d7df9242eea8f6c1b20c23b38041">More...</a><br /></td></tr>
<tr class="separator:ae704d7df9242eea8f6c1b20c23b38041"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a96f1d26b9fba0fb90827950774432ec3"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__handle.html#a96f1d26b9fba0fb90827950774432ec3">operator bool</a> () const</td></tr>
<tr class="memdesc:a96f1d26b9fba0fb90827950774432ec3"><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#a96f1d26b9fba0fb90827950774432ec3">More...</a><br /></td></tr>
<tr class="separator:a96f1d26b9fba0fb90827950774432ec3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a80804dfe5834cc10472959d181e82bc6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structentt_1_1basic__handle.html#ad22a94a5add23583cdda3ee291bdcf3c">registry_type</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__handle.html#a80804dfe5834cc10472959d181e82bc6">registry</a> () const noexcept</td></tr>
<tr class="memdesc:a80804dfe5834cc10472959d181e82bc6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a reference to the underlying registry. <a href="structentt_1_1basic__handle.html#a80804dfe5834cc10472959d181e82bc6">More...</a><br /></td></tr>
<tr class="separator:a80804dfe5834cc10472959d181e82bc6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aed33d23b97606e21d614ae48e0eed547"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structentt_1_1basic__handle.html#afb6c2e78a876663dfee62aee4d989226">entity_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__handle.html#aed33d23b97606e21d614ae48e0eed547">entity</a> () const noexcept</td></tr>
<tr class="memdesc:aed33d23b97606e21d614ae48e0eed547"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the entity associated with a handle. <a href="structentt_1_1basic__handle.html#aed33d23b97606e21d614ae48e0eed547">More...</a><br /></td></tr>
<tr class="separator:aed33d23b97606e21d614ae48e0eed547"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2b53b81f1b5712379cbfb3c36dae6900"><td class="memTemplParams" colspan="2">template&lt;typename Component , typename... Args&gt; </td></tr>
<tr class="memitem:a2b53b81f1b5712379cbfb3c36dae6900"><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#a2b53b81f1b5712379cbfb3c36dae6900">emplace</a> (Args &amp;&amp;... args) const</td></tr>
<tr class="memdesc:a2b53b81f1b5712379cbfb3c36dae6900"><td class="mdescLeft">&#160;</td><td class="mdescRight">Assigns the given component to a handle. <a href="structentt_1_1basic__handle.html#a2b53b81f1b5712379cbfb3c36dae6900">More...</a><br /></td></tr>
<tr class="separator:a2b53b81f1b5712379cbfb3c36dae6900"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a488891cec44b2b7f7f4a7a02d3f7c5cc"><td class="memTemplParams" colspan="2">template&lt;typename Component , typename... Args&gt; </td></tr>
<tr class="memitem:a488891cec44b2b7f7f4a7a02d3f7c5cc"><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#a488891cec44b2b7f7f4a7a02d3f7c5cc">emplace_or_replace</a> (Args &amp;&amp;... args) const</td></tr>
<tr class="memdesc:a488891cec44b2b7f7f4a7a02d3f7c5cc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Assigns or replaces the given component for a handle. <a href="structentt_1_1basic__handle.html#a488891cec44b2b7f7f4a7a02d3f7c5cc">More...</a><br /></td></tr>
<tr class="separator:a488891cec44b2b7f7f4a7a02d3f7c5cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a03d02ea23c40489ce7d5b8ec35662181"><td class="memTemplParams" colspan="2">template&lt;typename Component , typename... Func&gt; </td></tr>
<tr class="memitem:a03d02ea23c40489ce7d5b8ec35662181"><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#a03d02ea23c40489ce7d5b8ec35662181">patch</a> (Func &amp;&amp;... func) const</td></tr>
<tr class="memdesc:a03d02ea23c40489ce7d5b8ec35662181"><td class="mdescLeft">&#160;</td><td class="mdescRight">Patches the given component for a handle. <a href="structentt_1_1basic__handle.html#a03d02ea23c40489ce7d5b8ec35662181">More...</a><br /></td></tr>
<tr class="separator:a03d02ea23c40489ce7d5b8ec35662181"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7c0f93c6494d9c3d8f35c9c5de375f89"><td class="memTemplParams" colspan="2">template&lt;typename Component , typename... Args&gt; </td></tr>
<tr class="memitem:a7c0f93c6494d9c3d8f35c9c5de375f89"><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#a7c0f93c6494d9c3d8f35c9c5de375f89">replace</a> (Args &amp;&amp;... args) const</td></tr>
<tr class="memdesc:a7c0f93c6494d9c3d8f35c9c5de375f89"><td class="mdescLeft">&#160;</td><td class="mdescRight">Replaces the given component for a handle. <a href="structentt_1_1basic__handle.html#a7c0f93c6494d9c3d8f35c9c5de375f89">More...</a><br /></td></tr>
<tr class="separator:a7c0f93c6494d9c3d8f35c9c5de375f89"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1dc2593d3ba53137ecf8371348204af8"><td class="memTemplParams" colspan="2">template&lt;typename... Components&gt; </td></tr>
<tr class="memitem:a1dc2593d3ba53137ecf8371348204af8"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__handle.html#a1dc2593d3ba53137ecf8371348204af8">remove</a> () const</td></tr>
<tr class="memdesc:a1dc2593d3ba53137ecf8371348204af8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Removes the given components from a handle. <a href="structentt_1_1basic__handle.html#a1dc2593d3ba53137ecf8371348204af8">More...</a><br /></td></tr>
<tr class="separator:a1dc2593d3ba53137ecf8371348204af8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a06f1ac32d958ae10aafee3c52b4b7f56"><td class="memTemplParams" colspan="2">template&lt;typename... Components&gt; </td></tr>
<tr class="memitem:a06f1ac32d958ae10aafee3c52b4b7f56"><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#a06f1ac32d958ae10aafee3c52b4b7f56">remove_if_exists</a> () const</td></tr>
<tr class="memdesc:a06f1ac32d958ae10aafee3c52b4b7f56"><td class="mdescLeft">&#160;</td><td class="mdescRight">Removes the given components from a handle. <a href="structentt_1_1basic__handle.html#a06f1ac32d958ae10aafee3c52b4b7f56">More...</a><br /></td></tr>
<tr class="separator:a06f1ac32d958ae10aafee3c52b4b7f56"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a86d05141208b7b1780834f90bce7a845"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__handle.html#a86d05141208b7b1780834f90bce7a845">remove_all</a> () const</td></tr>
<tr class="memdesc:a86d05141208b7b1780834f90bce7a845"><td class="mdescLeft">&#160;</td><td class="mdescRight">Removes all the components from a handle and makes it orphaned. <a href="structentt_1_1basic__handle.html#a86d05141208b7b1780834f90bce7a845">More...</a><br /></td></tr>
<tr class="separator:a86d05141208b7b1780834f90bce7a845"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad38512325db1669152af8168f920bde1"><td class="memTemplParams" colspan="2">template&lt;typename... Components&gt; </td></tr>
<tr class="memitem:ad38512325db1669152af8168f920bde1"><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#ad38512325db1669152af8168f920bde1">has</a> () const</td></tr>
<tr class="memdesc:ad38512325db1669152af8168f920bde1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if a handle has all the given components. <a href="structentt_1_1basic__handle.html#ad38512325db1669152af8168f920bde1">More...</a><br /></td></tr>
<tr class="separator:ad38512325db1669152af8168f920bde1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0c72d2e062cb825c38d9ac53094dda35"><td class="memTemplParams" colspan="2">template&lt;typename... Components&gt; </td></tr>
<tr class="memitem:a0c72d2e062cb825c38d9ac53094dda35"><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#a0c72d2e062cb825c38d9ac53094dda35">any</a> () const</td></tr>
<tr class="memdesc:a0c72d2e062cb825c38d9ac53094dda35"><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#a0c72d2e062cb825c38d9ac53094dda35">More...</a><br /></td></tr>
<tr class="separator:a0c72d2e062cb825c38d9ac53094dda35"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0ef680044c31ef1e0cc6663338c2cb0a"><td class="memTemplParams" colspan="2">template&lt;typename... Components&gt; </td></tr>
<tr class="memitem:a0ef680044c31ef1e0cc6663338c2cb0a"><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#a0ef680044c31ef1e0cc6663338c2cb0a">get</a> () const</td></tr>
<tr class="memdesc:a0ef680044c31ef1e0cc6663338c2cb0a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns references to the given components for a handle. <a href="structentt_1_1basic__handle.html#a0ef680044c31ef1e0cc6663338c2cb0a">More...</a><br /></td></tr>
<tr class="separator:a0ef680044c31ef1e0cc6663338c2cb0a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab2a7202c3a8366d919a6c00a1f809014"><td class="memTemplParams" colspan="2">template&lt;typename Component , typename... Args&gt; </td></tr>
<tr class="memitem:ab2a7202c3a8366d919a6c00a1f809014"><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#ab2a7202c3a8366d919a6c00a1f809014">get_or_emplace</a> (Args &amp;&amp;... args) const</td></tr>
<tr class="memdesc:ab2a7202c3a8366d919a6c00a1f809014"><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#ab2a7202c3a8366d919a6c00a1f809014">More...</a><br /></td></tr>
<tr class="separator:ab2a7202c3a8366d919a6c00a1f809014"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6564e44b444db487d61b567b23c7724a"><td class="memTemplParams" colspan="2">template&lt;typename... Components&gt; </td></tr>
<tr class="memitem:a6564e44b444db487d61b567b23c7724a"><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#a6564e44b444db487d61b567b23c7724a">try_get</a> () const</td></tr>
<tr class="memdesc:a6564e44b444db487d61b567b23c7724a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns pointers to the given components for a handle. <a href="structentt_1_1basic__handle.html#a6564e44b444db487d61b567b23c7724a">More...</a><br /></td></tr>
<tr class="separator:a6564e44b444db487d61b567b23c7724a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a602e2745070b9a5fb51d082a57f4948c"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__handle.html#a602e2745070b9a5fb51d082a57f4948c">orphan</a> () const</td></tr>
<tr class="memdesc:a602e2745070b9a5fb51d082a57f4948c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if a handle has components assigned. <a href="structentt_1_1basic__handle.html#a602e2745070b9a5fb51d082a57f4948c">More...</a><br /></td></tr>
<tr class="separator:a602e2745070b9a5fb51d082a57f4948c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a287aec975a094713c0a89101abfd4b01"><td class="memTemplParams" colspan="2">template&lt;typename Func &gt; </td></tr>
<tr class="memitem:a287aec975a094713c0a89101abfd4b01"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__handle.html#a287aec975a094713c0a89101abfd4b01">visit</a> (Func &amp;&amp;func) const</td></tr>
<tr class="memdesc:a287aec975a094713c0a89101abfd4b01"><td class="mdescLeft">&#160;</td><td class="mdescRight">Visits a handle and returns the types for its components. <a href="structentt_1_1basic__handle.html#a287aec975a094713c0a89101abfd4b01">More...</a><br /></td></tr>
<tr class="separator:a287aec975a094713c0a89101abfd4b01"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename Entity&gt;<br />
struct entt::basic_handle&lt; Entity &gt;</h3>
<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">Entity</td><td>A valid entity type (see <a class="el" href="structentt_1_1entt__traits.html" title="Entity traits.">entt_traits</a> for more details). </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="entity_2fwd_8hpp_source.html#l00036">36</a> of file <a class="el" href="entity_2fwd_8hpp_source.html">fwd.hpp</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ac101da0421db31eabe56854f106976d6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac101da0421db31eabe56854f106976d6">&#9670;&nbsp;</a></span>basic_handle()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity &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; Entity &gt;::<a class="el" href="structentt_1_1basic__handle.html">basic_handle</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structentt_1_1basic__handle.html#ad22a94a5add23583cdda3ee291bdcf3c">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#afb6c2e78a876663dfee62aee4d989226">entity_type</a>&#160;</td>
<td class="paramname"><em>value</em> = <code><a class="el" href="namespaceentt.html#a2f0c0a1c1d953ea991591748744cdd8b">null</a></code>&#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>An entity identifier. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="entity_2handle_8hpp_source.html#l00035">35</a> of file <a class="el" href="entity_2handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a0c72d2e062cb825c38d9ac53094dda35"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0c72d2e062cb825c38d9ac53094dda35">&#9670;&nbsp;</a></span>any()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity &gt; </div>
<div class="memtemplate">
template&lt;typename... Components&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; Entity &gt;::any </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="section see"><dt>See also</dt><dd><a class="el" href="classentt_1_1basic__registry.html#ab0f856eae9b92a4c97689540968c6bde" title="Checks if an entity has at least one of the given components.">basic_registry::any</a> </dd></dl>
<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="entity_2handle_8hpp_source.html#l00197">197</a> of file <a class="el" href="entity_2handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
<a id="a2b53b81f1b5712379cbfb3c36dae6900"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2b53b81f1b5712379cbfb3c36dae6900">&#9670;&nbsp;</a></span>emplace()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity &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; Entity &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="section see"><dt>See also</dt><dd><a class="el" href="classentt_1_1basic__registry.html#ac138930f54716e2b31907586e45367be" title="Assigns the given component to an entity.">basic_registry::emplace</a> </dd></dl>
<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="entity_2handle_8hpp_source.html#l00106">106</a> of file <a class="el" href="entity_2handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
<a id="a488891cec44b2b7f7f4a7a02d3f7c5cc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a488891cec44b2b7f7f4a7a02d3f7c5cc">&#9670;&nbsp;</a></span>emplace_or_replace()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity &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; Entity &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="section see"><dt>See also</dt><dd><a class="el" href="classentt_1_1basic__registry.html#a5c768fb13e23109823e1dc217eee100a" title="Assigns or replaces the given component for an entity.">basic_registry::emplace_or_replace</a> </dd></dl>
<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="entity_2handle_8hpp_source.html#l00119">119</a> of file <a class="el" href="entity_2handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
<a id="aed33d23b97606e21d614ae48e0eed547"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aed33d23b97606e21d614ae48e0eed547">&#9670;&nbsp;</a></span>entity()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity &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#afb6c2e78a876663dfee62aee4d989226">entity_type</a> <a class="el" href="structentt_1_1basic__handle.html">entt::basic_handle</a>&lt; Entity &gt;::<a class="el" href="namespaceentt.html#a0b54e231d069e8a231e14b223388808a">entity</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>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="entity_2handle_8hpp_source.html#l00093">93</a> of file <a class="el" href="entity_2handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
<a id="a0ef680044c31ef1e0cc6663338c2cb0a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0ef680044c31ef1e0cc6663338c2cb0a">&#9670;&nbsp;</a></span>get()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity &gt; </div>
<div class="memtemplate">
template&lt;typename... Components&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; Entity &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="section see"><dt>See also</dt><dd><a class="el" href="classentt_1_1basic__registry.html#a3a683bb33971cc5a0bbbf4a9409208df" title="Returns references to the given components for an entity.">basic_registry::get</a> </dd></dl>
<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="entity_2handle_8hpp_source.html#l00208">208</a> of file <a class="el" href="entity_2handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
<a id="ab2a7202c3a8366d919a6c00a1f809014"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab2a7202c3a8366d919a6c00a1f809014">&#9670;&nbsp;</a></span>get_or_emplace()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity &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; Entity &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="section see"><dt>See also</dt><dd><a class="el" href="classentt_1_1basic__registry.html#ae8b86324fa88b9162050daf599d0f094" title="Returns a reference to the given component for an entity.">basic_registry::get_or_emplace</a> </dd></dl>
<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="entity_2handle_8hpp_source.html#l00221">221</a> of file <a class="el" href="entity_2handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
<a id="ad38512325db1669152af8168f920bde1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad38512325db1669152af8168f920bde1">&#9670;&nbsp;</a></span>has()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity &gt; </div>
<div class="memtemplate">
template&lt;typename... Components&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; Entity &gt;::has </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="section see"><dt>See also</dt><dd><a class="el" href="classentt_1_1basic__registry.html#ae0948bfee43711e2df12946a63a2b258" title="Checks if an entity has all the given components.">basic_registry::has</a> </dd></dl>
<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="entity_2handle_8hpp_source.html#l00185">185</a> of file <a class="el" href="entity_2handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
<a id="a884a19f60a96f2276b0d416c817171ca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a884a19f60a96f2276b0d416c817171ca">&#9670;&nbsp;</a></span>operator basic_handle&lt; const entity_type &gt;()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity &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; Entity &gt;::operator <a class="el" href="structentt_1_1basic__handle.html">basic_handle</a>&lt; const <a class="el" href="structentt_1_1basic__handle.html#afb6c2e78a876663dfee62aee4d989226">entity_type</a> &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="section return"><dt>Returns</dt><dd>A const handle referring to the same entity. </dd></dl>
<p class="definition">Definition at line <a class="el" href="entity_2handle_8hpp_source.html#l00061">61</a> of file <a class="el" href="entity_2handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
<a id="a96f1d26b9fba0fb90827950774432ec3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a96f1d26b9fba0fb90827950774432ec3">&#9670;&nbsp;</a></span>operator bool()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity &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; Entity &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> </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="entity_2handle_8hpp_source.html#l00077">77</a> of file <a class="el" href="entity_2handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
<a id="ae704d7df9242eea8f6c1b20c23b38041"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae704d7df9242eea8f6c1b20c23b38041">&#9670;&nbsp;</a></span>operator entity_type()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity &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; Entity &gt;::operator <a class="el" href="structentt_1_1basic__handle.html#afb6c2e78a876663dfee62aee4d989226">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>An entity identifier. </dd></dl>
<p class="definition">Definition at line <a class="el" href="entity_2handle_8hpp_source.html#l00069">69</a> of file <a class="el" href="entity_2handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
<a id="a172116427af01cdef90b0aa512ae29fb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a172116427af01cdef90b0aa512ae29fb">&#9670;&nbsp;</a></span>operator=() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity &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">basic_handle</a>&amp; <a class="el" href="structentt_1_1basic__handle.html">entt::basic_handle</a>&lt; Entity &gt;::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structentt_1_1basic__handle.html#afb6c2e78a876663dfee62aee4d989226">entity_type</a>&#160;</td>
<td class="paramname"><em>value</em></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>Assigns an entity to a handle. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>An entity identifier. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>This handle. </dd></dl>
<p class="definition">Definition at line <a class="el" href="entity_2handle_8hpp_source.html#l00044">44</a> of file <a class="el" href="entity_2handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
<a id="a4312ae1b3548a06b5132fd13ab7d880f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4312ae1b3548a06b5132fd13ab7d880f">&#9670;&nbsp;</a></span>operator=() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity &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">basic_handle</a>&amp; <a class="el" href="structentt_1_1basic__handle.html">entt::basic_handle</a>&lt; Entity &gt;::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structentt_1_1null__t.html">null_t</a>&#160;</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>Assigns the null object to a handle. </p>
<dl class="section return"><dt>Returns</dt><dd>This handle. </dd></dl>
<p class="definition">Definition at line <a class="el" href="entity_2handle_8hpp_source.html#l00053">53</a> of file <a class="el" href="entity_2handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
<a id="a602e2745070b9a5fb51d082a57f4948c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a602e2745070b9a5fb51d082a57f4948c">&#9670;&nbsp;</a></span>orphan()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity &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; Entity &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="entity_2handle_8hpp_source.html#l00240">240</a> of file <a class="el" href="entity_2handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
<a id="a03d02ea23c40489ce7d5b8ec35662181"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a03d02ea23c40489ce7d5b8ec35662181">&#9670;&nbsp;</a></span>patch()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity &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; Entity &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="section see"><dt>See also</dt><dd><a class="el" href="classentt_1_1basic__registry.html#a4e83139f8d6774092bb4e0d14446f875" title="Patches the given component for an entity.">basic_registry::patch</a> </dd></dl>
<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="entity_2handle_8hpp_source.html#l00132">132</a> of file <a class="el" href="entity_2handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
<a id="a80804dfe5834cc10472959d181e82bc6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a80804dfe5834cc10472959d181e82bc6">&#9670;&nbsp;</a></span>registry()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity &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#ad22a94a5add23583cdda3ee291bdcf3c">registry_type</a>&amp; <a class="el" href="structentt_1_1basic__handle.html">entt::basic_handle</a>&lt; Entity &gt;::<a class="el" href="namespaceentt.html#a292643317d1dbb13e45824f757bd1086">registry</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>Returns a reference to the underlying registry. </p>
<dl class="section return"><dt>Returns</dt><dd>A reference to the underlying registry. </dd></dl>
<p class="definition">Definition at line <a class="el" href="entity_2handle_8hpp_source.html#l00085">85</a> of file <a class="el" href="entity_2handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
<a id="a1dc2593d3ba53137ecf8371348204af8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1dc2593d3ba53137ecf8371348204af8">&#9670;&nbsp;</a></span>remove()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity &gt; </div>
<div class="memtemplate">
template&lt;typename... Components&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; Entity &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="section see"><dt>See also</dt><dd><a class="el" href="classentt_1_1basic__registry.html#a44f5eac6fa4d1999a121f55e67a36c24" title="Removes the given components from an entity.">basic_registry::remove</a> </dd></dl>
<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>
<p class="definition">Definition at line <a class="el" href="entity_2handle_8hpp_source.html#l00155">155</a> of file <a class="el" href="entity_2handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
<a id="a86d05141208b7b1780834f90bce7a845"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a86d05141208b7b1780834f90bce7a845">&#9670;&nbsp;</a></span>remove_all()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity &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; Entity &gt;::remove_all </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 all the components from a handle and makes it orphaned. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classentt_1_1basic__registry.html#a46d948137afacbb1e4e79b72c917c5ea" title="Removes all the components from an entity and makes it orphaned.">basic_registry::remove_all</a> </dd></dl>
<p class="definition">Definition at line <a class="el" href="entity_2handle_8hpp_source.html#l00174">174</a> of file <a class="el" href="entity_2handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
<a id="a06f1ac32d958ae10aafee3c52b4b7f56"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a06f1ac32d958ae10aafee3c52b4b7f56">&#9670;&nbsp;</a></span>remove_if_exists()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity &gt; </div>
<div class="memtemplate">
template&lt;typename... Components&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; Entity &gt;::remove_if_exists </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="section see"><dt>See also</dt><dd><a class="el" href="classentt_1_1basic__registry.html#ad2c2d2f9d5f79186215919e3d0c00565" title="Removes the given components from an entity.">basic_registry::remove_if_exists</a> </dd></dl>
<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="entity_2handle_8hpp_source.html#l00166">166</a> of file <a class="el" href="entity_2handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
<a id="a7c0f93c6494d9c3d8f35c9c5de375f89"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7c0f93c6494d9c3d8f35c9c5de375f89">&#9670;&nbsp;</a></span>replace()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity &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; Entity &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="section see"><dt>See also</dt><dd><a class="el" href="classentt_1_1basic__registry.html#a0411735fcddcc942613463c5401dd661" title="Replaces the given component for an entity.">basic_registry::replace</a> </dd></dl>
<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="entity_2handle_8hpp_source.html#l00145">145</a> of file <a class="el" href="entity_2handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
<a id="a6564e44b444db487d61b567b23c7724a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6564e44b444db487d61b567b23c7724a">&#9670;&nbsp;</a></span>try_get()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity &gt; </div>
<div class="memtemplate">
template&lt;typename... Components&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; Entity &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="section see"><dt>See also</dt><dd><a class="el" href="classentt_1_1basic__registry.html#a9a01c958149b6c0d5b233a1a7c3c3bb3" title="Returns pointers to the given components for an entity.">basic_registry::try_get</a> </dd></dl>
<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="entity_2handle_8hpp_source.html#l00232">232</a> of file <a class="el" href="entity_2handle_8hpp_source.html">handle.hpp</a>.</p>
</div>
</div>
<a id="a287aec975a094713c0a89101abfd4b01"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a287aec975a094713c0a89101abfd4b01">&#9670;&nbsp;</a></span>visit()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity &gt; </div>
<div class="memtemplate">
template&lt;typename Func &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; Entity &gt;::visit </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>Visits a handle and returns the types for its components. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classentt_1_1basic__registry.html#aef8bac41fdb48e3c8c589dee21b96980" title="Visits an entity and returns the types for its components.">basic_registry::visit</a> </dd></dl>
<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">func</td><td>A valid function object. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="entity_2handle_8hpp_source.html#l00251">251</a> of file <a class="el" href="entity_2handle_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="entity_2handle_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="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.18
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink