Scarfski/entt
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
1e23a1131122fef897be4ffffd08bca00a7d291b
entt/classentt_1_1basic__continuous__loader.html
Michele Caini 1e23a11311 API reference v3.15.0
2025-03-19 15:49:42 +01:00

478 lines
28 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.13.2"/>
<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>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">EnTT<span id="projectnumber">&#160;3.15.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.13.2 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',false);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){ initResizable(false); });
/* @license-end */
</script>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceentt.html">entt</a></li><li class="navelem"><a class="el" href="classentt_1_1basic__continuous__loader.html">basic_continuous_loader</a></li> </ul>
</div>
</div><!-- top -->
<div id="doc-content">
<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="#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" id="r_ae51ed38dcfbae0c059aeed260b4d7dee"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae51ed38dcfbae0c059aeed260b4d7dee">registry_type</a> = Registry</td></tr>
<tr class="separator:ae51ed38dcfbae0c059aeed260b4d7dee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8ec9043a725da1ddb4f16ce6cb635011" id="r_a8ec9043a725da1ddb4f16ce6cb635011"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#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" id="r_a4546c59ad6f12d4c071e99215790873f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4546c59ad6f12d4c071e99215790873f">basic_continuous_loader</a> (<a class="el" href="#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:a251ef8adbb329c667b5fe1857bac0078" id="r_a251ef8adbb329c667b5fe1857bac0078"><td class="memItemLeft" align="right" valign="top"><a id="a251ef8adbb329c667b5fe1857bac0078" name="a251ef8adbb329c667b5fe1857bac0078"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>basic_continuous_loader</b> (const <a class="el" href="classentt_1_1basic__continuous__loader.html">basic_continuous_loader</a> &amp;)=delete</td></tr>
<tr class="memdesc:a251ef8adbb329c667b5fe1857bac0078"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default copy constructor, deleted on purpose. <br /></td></tr>
<tr class="separator:a251ef8adbb329c667b5fe1857bac0078"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5e29f22ee49b992ea16d352d3f1041d9" id="r_a5e29f22ee49b992ea16d352d3f1041d9"><td class="memItemLeft" align="right" valign="top"><a id="a5e29f22ee49b992ea16d352d3f1041d9" name="a5e29f22ee49b992ea16d352d3f1041d9"></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;) noexcept=default</td></tr>
<tr class="memdesc:a5e29f22ee49b992ea16d352d3f1041d9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default move constructor. <br /></td></tr>
<tr class="separator:a5e29f22ee49b992ea16d352d3f1041d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a34d2417a1dc1fe8804ff6bbe184e16a1" id="r_a34d2417a1dc1fe8804ff6bbe184e16a1"><td class="memItemLeft" align="right" valign="top"><a id="a34d2417a1dc1fe8804ff6bbe184e16a1" name="a34d2417a1dc1fe8804ff6bbe184e16a1"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>~basic_continuous_loader</b> ()=default</td></tr>
<tr class="memdesc:a34d2417a1dc1fe8804ff6bbe184e16a1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default destructor. <br /></td></tr>
<tr class="separator:a34d2417a1dc1fe8804ff6bbe184e16a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a55ad0d865e74ea3d53cd67812fe2c4e1" id="r_a55ad0d865e74ea3d53cd67812fe2c4e1"><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="#a55ad0d865e74ea3d53cd67812fe2c4e1">operator=</a> (const <a class="el" href="classentt_1_1basic__continuous__loader.html">basic_continuous_loader</a> &amp;)=delete</td></tr>
<tr class="memdesc:a55ad0d865e74ea3d53cd67812fe2c4e1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default copy assignment operator, deleted on purpose. <br /></td></tr>
<tr class="separator:a55ad0d865e74ea3d53cd67812fe2c4e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ade392e168f1b045c70608544283ff7cc" id="r_ade392e168f1b045c70608544283ff7cc"><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="#ade392e168f1b045c70608544283ff7cc">operator=</a> (<a class="el" href="classentt_1_1basic__continuous__loader.html">basic_continuous_loader</a> &amp;&amp;) noexcept=default</td></tr>
<tr class="memdesc:ade392e168f1b045c70608544283ff7cc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default move assignment operator. <br /></td></tr>
<tr class="separator:ade392e168f1b045c70608544283ff7cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad4962b919dc91a9f6dfc223bcf983376" id="r_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="#ad4962b919dc91a9f6dfc223bcf983376">get</a> (Archive &amp;archive, const <a class="el" href="namespaceentt.html#a620d583c0e6d64acf3d394524bb72303">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:ae497e30cd8fa96978a067bb0f4dee5cd" id="r_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="#ae497e30cd8fa96978a067bb0f4dee5cd">orphans</a> ()</td></tr>
<tr class="memdesc:ae497e30cd8fa96978a067bb0f4dee5cd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroys those entities that have no elements. <br /></td></tr>
<tr class="separator:ae497e30cd8fa96978a067bb0f4dee5cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab682c079d9ddf61f04e121d6fab421d7" id="r_ab682c079d9ddf61f04e121d6fab421d7"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab682c079d9ddf61f04e121d6fab421d7">contains</a> (<a class="el" href="#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" id="r_ac243f6a783ffe8839fd864d887ea0153"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a8ec9043a725da1ddb4f16ce6cb635011">entity_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac243f6a783ffe8839fd864d887ea0153">map</a> (<a class="el" href="#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#l00306">306</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#l00369">369</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#l00367">367</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="#ae51ed38dcfbae0c059aeed260b4d7dee">registry_type</a> &amp;</td> <td class="paramname"><span class="paramname"><em>source</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel noexcept">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>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#l00375">375</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="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="#a8ec9043a725da1ddb4f16ce6cb635011">entity_type</a></td> <td class="paramname"><span class="paramname"><em>entt</em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel nodiscard">nodiscard</span><span class="mlabel noexcept">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#l00487">487</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;</td> <td class="paramname"><span class="paramname"><em>archive</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="namespaceentt.html#a620d583c0e6d64acf3d394524bb72303">id_type</a></td> <td class="paramname"><span class="paramname"><em>id</em></span><span class="paramdefsep"> = </span><span class="paramdefval"><a class="el" href="structentt_1_1type__hash.html">type_hash</a>&lt;Type&gt;::value()</span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>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 <a class="el" href="#a8ec9043a725da1ddb4f16ce6cb635011" title="Underlying entity identifier.">entity_type</a> 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#l00415">415</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="#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="#a8ec9043a725da1ddb4f16ce6cb635011">entity_type</a></td> <td class="paramname"><span class="paramname"><em>entt</em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel nodiscard">nodiscard</span><span class="mlabel noexcept">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#l00497">497</a> of file <a class="el" href="snapshot_8hpp_source.html">snapshot.hpp</a>.</p>
</div>
</div>
<a id="ade392e168f1b045c70608544283ff7cc" name="ade392e168f1b045c70608544283ff7cc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ade392e168f1b045c70608544283ff7cc">&#9670;&#160;</a></span>operator=() <span class="overload">[1/2]</span></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;</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel default">default</span><span class="mlabel noexcept">noexcept</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="a55ad0d865e74ea3d53cd67812fe2c4e1" name="a55ad0d865e74ea3d53cd67812fe2c4e1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a55ad0d865e74ea3d53cd67812fe2c4e1">&#9670;&#160;</a></span>operator=() <span class="overload">[2/2]</span></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">const <a class="el" href="classentt_1_1basic__continuous__loader.html">basic_continuous_loader</a>&lt; Registry &gt; &amp;</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel delete">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Default copy assignment operator, deleted on purpose. </p>
<dl class="section return"><dt>Returns</dt><dd>This 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"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Destroys those entities that have no elements. </p>
<p>In case all the entities were serialized but only part of the elements was saved, it could happen that some of the entities have no elements 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#l00477">477</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.13.2
</small></address>
</div><!-- doc-content -->
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink