Scarfski/entt
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
7cf7699bab13f2e0414dd4dda6a29591dd8b5686
entt/classentt_1_1basic__continuous__loader.html
Michele Caini 7cf7699bab API reference v3.12.0
2023-06-15 11:47:04 +02:00

586 lines
32 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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.6"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>EnTT: entt::basic_continuous_loader&lt; Registry &gt; Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">EnTT<span id="projectnumber">&#160;3.12.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.6 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceentt.html">entt</a></li><li class="navelem"><a class="el" href="classentt_1_1basic__continuous__loader.html">basic_continuous_loader</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="classentt_1_1basic__continuous__loader-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">entt::basic_continuous_loader&lt; Registry &gt; Class Template Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Utility class for <em>continuous loading</em>.
<a href="classentt_1_1basic__continuous__loader.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="snapshot_8hpp_source.html">snapshot.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:ae51ed38dcfbae0c059aeed260b4d7dee"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__continuous__loader.html#ae51ed38dcfbae0c059aeed260b4d7dee">registry_type</a> = Registry</td></tr>
<tr class="separator:ae51ed38dcfbae0c059aeed260b4d7dee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8ec9043a725da1ddb4f16ce6cb635011"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__continuous__loader.html#a8ec9043a725da1ddb4f16ce6cb635011">entity_type</a> = typename registry_type::entity_type</td></tr>
<tr class="memdesc:a8ec9043a725da1ddb4f16ce6cb635011"><td class="mdescLeft">&#160;</td><td class="mdescRight">Underlying entity identifier. <br /></td></tr>
<tr class="separator:a8ec9043a725da1ddb4f16ce6cb635011"><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:a4546c59ad6f12d4c071e99215790873f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__continuous__loader.html#a4546c59ad6f12d4c071e99215790873f">basic_continuous_loader</a> (<a class="el" href="classentt_1_1basic__continuous__loader.html#ae51ed38dcfbae0c059aeed260b4d7dee">registry_type</a> &amp;source) noexcept</td></tr>
<tr class="memdesc:a4546c59ad6f12d4c071e99215790873f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs an instance that is bound to a given registry. <br /></td></tr>
<tr class="separator:a4546c59ad6f12d4c071e99215790873f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3a2f7e188f8d903b44a972998f4050bf"><td class="memItemLeft" align="right" valign="top"><a id="a3a2f7e188f8d903b44a972998f4050bf" name="a3a2f7e188f8d903b44a972998f4050bf"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>basic_continuous_loader</b> (<a class="el" href="classentt_1_1basic__continuous__loader.html">basic_continuous_loader</a> &amp;&amp;)=default</td></tr>
<tr class="memdesc:a3a2f7e188f8d903b44a972998f4050bf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default move constructor. <br /></td></tr>
<tr class="separator:a3a2f7e188f8d903b44a972998f4050bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0dd7ab08396cc51ddbbf1f3331b0bc87"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1basic__continuous__loader.html">basic_continuous_loader</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__continuous__loader.html#a0dd7ab08396cc51ddbbf1f3331b0bc87">operator=</a> (<a class="el" href="classentt_1_1basic__continuous__loader.html">basic_continuous_loader</a> &amp;&amp;)=default</td></tr>
<tr class="memdesc:a0dd7ab08396cc51ddbbf1f3331b0bc87"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default move assignment operator. <br /></td></tr>
<tr class="separator:a0dd7ab08396cc51ddbbf1f3331b0bc87"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad4962b919dc91a9f6dfc223bcf983376"><td class="memTemplParams" colspan="2">template&lt;typename Type , typename Archive &gt; </td></tr>
<tr class="memitem:ad4962b919dc91a9f6dfc223bcf983376"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1basic__continuous__loader.html">basic_continuous_loader</a> &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__continuous__loader.html#ad4962b919dc91a9f6dfc223bcf983376">get</a> (Archive &amp;archive, const <a class="el" href="namespaceentt.html#a13e040e7b38a8f86d1ab2f096f37b627">id_type</a> id=<a class="el" href="structentt_1_1type__hash.html">type_hash</a>&lt; Type &gt;::value())</td></tr>
<tr class="memdesc:ad4962b919dc91a9f6dfc223bcf983376"><td class="mdescLeft">&#160;</td><td class="mdescRight">Restores all elements of a type with associated identifiers. <br /></td></tr>
<tr class="separator:ad4962b919dc91a9f6dfc223bcf983376"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad7bd2bd28969dc136e8b37190899d8ed"><td class="memTemplParams" colspan="2">template&lt;typename Archive &gt; </td></tr>
<tr class="memitem:ad7bd2bd28969dc136e8b37190899d8ed"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1basic__continuous__loader.html">basic_continuous_loader</a> &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__continuous__loader.html#ad7bd2bd28969dc136e8b37190899d8ed">entities</a> (Archive &amp;archive)</td></tr>
<tr class="memdesc:ad7bd2bd28969dc136e8b37190899d8ed"><td class="mdescLeft">&#160;</td><td class="mdescRight">Restores all identifiers, including those to be recycled. <br /></td></tr>
<tr class="separator:ad7bd2bd28969dc136e8b37190899d8ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a70c5bfa8a26f68f39026aa358bcb5011"><td class="memTemplParams" colspan="2">template&lt;typename... Component, typename Archive , typename... Member, typename... Clazz&gt; </td></tr>
<tr class="memitem:a70c5bfa8a26f68f39026aa358bcb5011"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1basic__continuous__loader.html">basic_continuous_loader</a> &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__continuous__loader.html#a70c5bfa8a26f68f39026aa358bcb5011">component</a> (Archive &amp;archive, Member Clazz::*...member)</td></tr>
<tr class="memdesc:a70c5bfa8a26f68f39026aa358bcb5011"><td class="mdescLeft">&#160;</td><td class="mdescRight">Serializes all elements of a type with associated identifiers. <br /></td></tr>
<tr class="separator:a70c5bfa8a26f68f39026aa358bcb5011"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a24069c48eaae7155b0bc09af93e88506"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1basic__continuous__loader.html">basic_continuous_loader</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__continuous__loader.html#a24069c48eaae7155b0bc09af93e88506">shrink</a> ()</td></tr>
<tr class="memdesc:a24069c48eaae7155b0bc09af93e88506"><td class="mdescLeft">&#160;</td><td class="mdescRight">Helps to purge entities that no longer have a counterpart. <br /></td></tr>
<tr class="separator:a24069c48eaae7155b0bc09af93e88506"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae497e30cd8fa96978a067bb0f4dee5cd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1basic__continuous__loader.html">basic_continuous_loader</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__continuous__loader.html#ae497e30cd8fa96978a067bb0f4dee5cd">orphans</a> ()</td></tr>
<tr class="memdesc:ae497e30cd8fa96978a067bb0f4dee5cd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroys those entities that have no components. <br /></td></tr>
<tr class="separator:ae497e30cd8fa96978a067bb0f4dee5cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab682c079d9ddf61f04e121d6fab421d7"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__continuous__loader.html#ab682c079d9ddf61f04e121d6fab421d7">contains</a> (<a class="el" href="classentt_1_1basic__continuous__loader.html#a8ec9043a725da1ddb4f16ce6cb635011">entity_type</a> entt) const noexcept</td></tr>
<tr class="memdesc:ab682c079d9ddf61f04e121d6fab421d7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tests if a loader knows about a given entity. <br /></td></tr>
<tr class="separator:ab682c079d9ddf61f04e121d6fab421d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac243f6a783ffe8839fd864d887ea0153"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1basic__continuous__loader.html#a8ec9043a725da1ddb4f16ce6cb635011">entity_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__continuous__loader.html#ac243f6a783ffe8839fd864d887ea0153">map</a> (<a class="el" href="classentt_1_1basic__continuous__loader.html#a8ec9043a725da1ddb4f16ce6cb635011">entity_type</a> entt) const noexcept</td></tr>
<tr class="memdesc:ac243f6a783ffe8839fd864d887ea0153"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the identifier to which an entity refers. <br /></td></tr>
<tr class="separator:ac243f6a783ffe8839fd864d887ea0153"><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&gt;<br />
class entt::basic_continuous_loader&lt; Registry &gt;</div><p>Utility class for <em>continuous loading</em>. </p>
<p>A <em>continuous loader</em> is designed to load data from a source registry to a (possibly) non-empty destination. The loader can accommodate in a registry more than one snapshot in a sort of <em>continuous loading</em> that updates the destination one step at a time.<br />
Identifiers that entities originally had are not transferred to the target. Instead, the loader maps remote identifiers to local ones while restoring a snapshot.<br />
An example of use is the implementation of a client-server application with the requirement of transferring somehow parts of the representation side to side.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Registry</td><td>Basic registry type. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="snapshot_8hpp_source.html#l00334">334</a> of file <a class="el" href="snapshot_8hpp_source.html">snapshot.hpp</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="a8ec9043a725da1ddb4f16ce6cb635011" name="a8ec9043a725da1ddb4f16ce6cb635011"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8ec9043a725da1ddb4f16ce6cb635011">&#9670;&#160;</a></span>entity_type</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Registry &gt; </div>
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classentt_1_1basic__continuous__loader.html">entt::basic_continuous_loader</a>&lt; Registry &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="snapshot_8hpp_source.html#l00397">397</a> of file <a class="el" href="snapshot_8hpp_source.html">snapshot.hpp</a>.</p>
</div>
</div>
<a id="ae51ed38dcfbae0c059aeed260b4d7dee" name="ae51ed38dcfbae0c059aeed260b4d7dee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae51ed38dcfbae0c059aeed260b4d7dee">&#9670;&#160;</a></span>registry_type</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Registry &gt; </div>
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classentt_1_1basic__continuous__loader.html">entt::basic_continuous_loader</a>&lt; Registry &gt;::registry_type = Registry</td>
</tr>
</table>
</div><div class="memdoc">
<p>Basic registry type. </p>
<p class="definition">Definition at line <a class="el" href="snapshot_8hpp_source.html#l00395">395</a> of file <a class="el" href="snapshot_8hpp_source.html">snapshot.hpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a4546c59ad6f12d4c071e99215790873f" name="a4546c59ad6f12d4c071e99215790873f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4546c59ad6f12d4c071e99215790873f">&#9670;&#160;</a></span>basic_continuous_loader()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Registry &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classentt_1_1basic__continuous__loader.html">entt::basic_continuous_loader</a>&lt; Registry &gt;::basic_continuous_loader </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classentt_1_1basic__continuous__loader.html#ae51ed38dcfbae0c059aeed260b4d7dee">registry_type</a> &amp;&#160;</td>
<td class="paramname"><em>source</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>Constructs an instance that is bound to a given registry. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">source</td><td>A valid reference to a registry. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="snapshot_8hpp_source.html#l00403">403</a> of file <a class="el" href="snapshot_8hpp_source.html">snapshot.hpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a70c5bfa8a26f68f39026aa358bcb5011" name="a70c5bfa8a26f68f39026aa358bcb5011"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a70c5bfa8a26f68f39026aa358bcb5011">&#9670;&#160;</a></span>component()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Registry &gt; </div>
<div class="memtemplate">
template&lt;typename... Component, typename Archive , typename... Member, typename... Clazz&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classentt_1_1basic__continuous__loader.html">basic_continuous_loader</a> &amp; <a class="el" href="classentt_1_1basic__continuous__loader.html">entt::basic_continuous_loader</a>&lt; Registry &gt;::component </td>
<td>(</td>
<td class="paramtype">Archive &amp;&#160;</td>
<td class="paramname"><em>archive</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Member Clazz::*...&#160;</td>
<td class="paramname"><em>member</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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Serializes all elements of a type with associated identifiers. </p>
<p>It creates local counterparts for remote elements as needed.<br />
Members are either data members of type entity_type or containers of entities. In both cases, a loader visits them and replaces entities with their local counterpart.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Component</td><td>Type of component to restore. </td></tr>
<tr><td class="paramname">Archive</td><td>Type of input archive. </td></tr>
<tr><td class="paramname">Member</td><td>Types of members to update with their local counterparts. </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">archive</td><td>A valid reference to an input archive. </td></tr>
<tr><td class="paramname">member</td><td>Members to update with their local counterparts. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A non-const reference to this loader. </dd></dl>
<p class="definition">Definition at line <a class="el" href="snapshot_8hpp_source.html#l00508">508</a> of file <a class="el" href="snapshot_8hpp_source.html">snapshot.hpp</a>.</p>
</div>
</div>
<a id="ab682c079d9ddf61f04e121d6fab421d7" name="ab682c079d9ddf61f04e121d6fab421d7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab682c079d9ddf61f04e121d6fab421d7">&#9670;&#160;</a></span>contains()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Registry &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classentt_1_1basic__continuous__loader.html">entt::basic_continuous_loader</a>&lt; Registry &gt;::contains </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classentt_1_1basic__continuous__loader.html#a8ec9043a725da1ddb4f16ce6cb635011">entity_type</a>&#160;</td>
<td class="paramname"><em>entt</em></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>Tests if a loader knows about a given entity. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">entt</td><td>A valid identifier. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if <code>entity</code> is managed by the loader, false otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="snapshot_8hpp_source.html#l00570">570</a> of file <a class="el" href="snapshot_8hpp_source.html">snapshot.hpp</a>.</p>
</div>
</div>
<a id="ad7bd2bd28969dc136e8b37190899d8ed" name="ad7bd2bd28969dc136e8b37190899d8ed"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad7bd2bd28969dc136e8b37190899d8ed">&#9670;&#160;</a></span>entities()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Registry &gt; </div>
<div class="memtemplate">
template&lt;typename Archive &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classentt_1_1basic__continuous__loader.html">basic_continuous_loader</a> &amp; <a class="el" href="classentt_1_1basic__continuous__loader.html">entt::basic_continuous_loader</a>&lt; Registry &gt;::entities </td>
<td>(</td>
<td class="paramtype">Archive &amp;&#160;</td>
<td class="paramname"><em>archive</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>Restores all identifiers, including those to be recycled. </p>
<p>It creates local counterparts for remote elements as needed.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Archive</td><td>Type of input archive. </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">archive</td><td>A valid reference to an input archive. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A non-const reference to this loader. </dd></dl>
<p class="definition">Definition at line <a class="el" href="snapshot_8hpp_source.html#l00488">488</a> of file <a class="el" href="snapshot_8hpp_source.html">snapshot.hpp</a>.</p>
</div>
</div>
<a id="ad4962b919dc91a9f6dfc223bcf983376" name="ad4962b919dc91a9f6dfc223bcf983376"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad4962b919dc91a9f6dfc223bcf983376">&#9670;&#160;</a></span>get()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Registry &gt; </div>
<div class="memtemplate">
template&lt;typename Type , typename Archive &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classentt_1_1basic__continuous__loader.html">basic_continuous_loader</a> &amp; <a class="el" href="classentt_1_1basic__continuous__loader.html">entt::basic_continuous_loader</a>&lt; Registry &gt;::get </td>
<td>(</td>
<td class="paramtype">Archive &amp;&#160;</td>
<td class="paramname"><em>archive</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="namespaceentt.html#a13e040e7b38a8f86d1ab2f096f37b627">id_type</a>&#160;</td>
<td class="paramname"><em>id</em> = <code><a class="el" href="structentt_1_1type__hash.html">type_hash</a>&lt;Type&gt;::value()</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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Restores all elements of a type with associated identifiers. </p>
<p>It creates local counterparts for remote elements as needed.<br />
Members are either data members of type entity_type or containers of entities. In both cases, a loader visits them and replaces entities with their local counterpart.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Type</td><td>Type of elements to restore. </td></tr>
<tr><td class="paramname">Archive</td><td>Type of input archive. </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">archive</td><td>A valid reference to an input archive. </td></tr>
<tr><td class="paramname">id</td><td>Optional name used to map the storage within the registry. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A valid loader to continue restoring data. </dd></dl>
<p class="definition">Definition at line <a class="el" href="snapshot_8hpp_source.html#l00428">428</a> of file <a class="el" href="snapshot_8hpp_source.html">snapshot.hpp</a>.</p>
</div>
</div>
<a id="ac243f6a783ffe8839fd864d887ea0153" name="ac243f6a783ffe8839fd864d887ea0153"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac243f6a783ffe8839fd864d887ea0153">&#9670;&#160;</a></span>map()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Registry &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classentt_1_1basic__continuous__loader.html#a8ec9043a725da1ddb4f16ce6cb635011">entity_type</a> <a class="el" href="classentt_1_1basic__continuous__loader.html">entt::basic_continuous_loader</a>&lt; Registry &gt;::map </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classentt_1_1basic__continuous__loader.html#a8ec9043a725da1ddb4f16ce6cb635011">entity_type</a>&#160;</td>
<td class="paramname"><em>entt</em></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 identifier to which an entity refers. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">entt</td><td>A valid identifier. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The local identifier if any, the null entity otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="snapshot_8hpp_source.html#l00580">580</a> of file <a class="el" href="snapshot_8hpp_source.html">snapshot.hpp</a>.</p>
</div>
</div>
<a id="a0dd7ab08396cc51ddbbf1f3331b0bc87" name="a0dd7ab08396cc51ddbbf1f3331b0bc87"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0dd7ab08396cc51ddbbf1f3331b0bc87">&#9670;&#160;</a></span>operator=()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Registry &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classentt_1_1basic__continuous__loader.html">basic_continuous_loader</a> &amp; <a class="el" href="classentt_1_1basic__continuous__loader.html">entt::basic_continuous_loader</a>&lt; Registry &gt;::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classentt_1_1basic__continuous__loader.html">basic_continuous_loader</a>&lt; Registry &gt; &amp;&amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Default move assignment operator. </p>
<dl class="section return"><dt>Returns</dt><dd>This loader. </dd></dl>
</div>
</div>
<a id="ae497e30cd8fa96978a067bb0f4dee5cd" name="ae497e30cd8fa96978a067bb0f4dee5cd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae497e30cd8fa96978a067bb0f4dee5cd">&#9670;&#160;</a></span>orphans()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Registry &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classentt_1_1basic__continuous__loader.html">basic_continuous_loader</a> &amp; <a class="el" href="classentt_1_1basic__continuous__loader.html">entt::basic_continuous_loader</a>&lt; Registry &gt;::orphans </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 those entities that have no components. </p>
<p>In case all the entities were serialized but only part of the components was saved, it could happen that some of the entities have no components once restored.<br />
This function helps to identify and destroy those entities.</p>
<dl class="section return"><dt>Returns</dt><dd>A non-const reference to this loader. </dd></dl>
<p class="definition">Definition at line <a class="el" href="snapshot_8hpp_source.html#l00560">560</a> of file <a class="el" href="snapshot_8hpp_source.html">snapshot.hpp</a>.</p>
</div>
</div>
<a id="a24069c48eaae7155b0bc09af93e88506" name="a24069c48eaae7155b0bc09af93e88506"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a24069c48eaae7155b0bc09af93e88506">&#9670;&#160;</a></span>shrink()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Registry &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classentt_1_1basic__continuous__loader.html">basic_continuous_loader</a> &amp; <a class="el" href="classentt_1_1basic__continuous__loader.html">entt::basic_continuous_loader</a>&lt; Registry &gt;::shrink </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>Helps to purge entities that no longer have a counterpart. </p>
<p>Users should invoke this member function after restoring each snapshot, unless they know exactly what they are doing.</p>
<dl class="section return"><dt>Returns</dt><dd>A non-const reference to this loader. </dd></dl>
<p class="definition">Definition at line <a class="el" href="snapshot_8hpp_source.html#l00546">546</a> of file <a class="el" href="snapshot_8hpp_source.html">snapshot.hpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>src/entt/entity/<a class="el" href="entity_2fwd_8hpp_source.html">fwd.hpp</a></li>
<li>src/entt/entity/<a class="el" href="snapshot_8hpp_source.html">snapshot.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.6
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink