Scarfski/entt
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
4594898b8e232451e3854cedc4202b0b4e96861c
entt/classentt_1_1Snapshot.html
Michele Caini 4594898b8e API reference v2.7.1
2018-07-10 16:37:27 +02:00

582 lines
31 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>entt: entt::Snapshot&lt; Entity &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.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">2.7.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</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="classentt_1_1Snapshot.html">Snapshot</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="classentt_1_1Snapshot-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">entt::Snapshot&lt; Entity &gt; Class Template Reference<span class="mlabels"><span class="mlabel">final</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Utility class to create snapshots from a registry.
<a href="classentt_1_1Snapshot.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 name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a80f9a56ce8667a5d9947cdaac686fd8d"><td class="memItemLeft" align="right" valign="top"><a id="a80f9a56ce8667a5d9947cdaac686fd8d"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1Snapshot.html#a80f9a56ce8667a5d9947cdaac686fd8d">Snapshot</a> (const <a class="el" href="classentt_1_1Snapshot.html">Snapshot</a> &amp;)=delete</td></tr>
<tr class="memdesc:a80f9a56ce8667a5d9947cdaac686fd8d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copying a snapshot isn't allowed. <br /></td></tr>
<tr class="separator:a80f9a56ce8667a5d9947cdaac686fd8d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3682df1db11f032bfa9ead93c0cec479"><td class="memItemLeft" align="right" valign="top"><a id="a3682df1db11f032bfa9ead93c0cec479"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1Snapshot.html#a3682df1db11f032bfa9ead93c0cec479">Snapshot</a> (<a class="el" href="classentt_1_1Snapshot.html">Snapshot</a> &amp;&amp;)=default</td></tr>
<tr class="memdesc:a3682df1db11f032bfa9ead93c0cec479"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default move constructor. <br /></td></tr>
<tr class="separator:a3682df1db11f032bfa9ead93c0cec479"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3375f7d701d086fc21e04e6077c954fc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1Snapshot.html">Snapshot</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1Snapshot.html#a3375f7d701d086fc21e04e6077c954fc">operator=</a> (const <a class="el" href="classentt_1_1Snapshot.html">Snapshot</a> &amp;)=delete</td></tr>
<tr class="memdesc:a3375f7d701d086fc21e04e6077c954fc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copying a snapshot isn't allowed. <a href="#a3375f7d701d086fc21e04e6077c954fc">More...</a><br /></td></tr>
<tr class="separator:a3375f7d701d086fc21e04e6077c954fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a627c0ea635facdd8b8246d1b97de11e3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1Snapshot.html">Snapshot</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1Snapshot.html#a627c0ea635facdd8b8246d1b97de11e3">operator=</a> (<a class="el" href="classentt_1_1Snapshot.html">Snapshot</a> &amp;&amp;)=default</td></tr>
<tr class="memdesc:a627c0ea635facdd8b8246d1b97de11e3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default move assignment operator. <a href="#a627c0ea635facdd8b8246d1b97de11e3">More...</a><br /></td></tr>
<tr class="separator:a627c0ea635facdd8b8246d1b97de11e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa77d63e06c40969adca662fca3a2ca08"><td class="memTemplParams" colspan="2">template&lt;typename Archive &gt; </td></tr>
<tr class="memitem:aa77d63e06c40969adca662fca3a2ca08"><td class="memTemplItemLeft" align="right" valign="top">const <a class="el" href="classentt_1_1Snapshot.html">Snapshot</a> &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classentt_1_1Snapshot.html#aa77d63e06c40969adca662fca3a2ca08">entities</a> (Archive &amp;archive) const</td></tr>
<tr class="memdesc:aa77d63e06c40969adca662fca3a2ca08"><td class="mdescLeft">&#160;</td><td class="mdescRight">Puts aside all the entities that are still in use. <a href="#aa77d63e06c40969adca662fca3a2ca08">More...</a><br /></td></tr>
<tr class="separator:aa77d63e06c40969adca662fca3a2ca08"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac7d571f0901df2476451e2fd26d9dab9"><td class="memTemplParams" colspan="2">template&lt;typename Archive &gt; </td></tr>
<tr class="memitem:ac7d571f0901df2476451e2fd26d9dab9"><td class="memTemplItemLeft" align="right" valign="top">const <a class="el" href="classentt_1_1Snapshot.html">Snapshot</a> &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classentt_1_1Snapshot.html#ac7d571f0901df2476451e2fd26d9dab9">destroyed</a> (Archive &amp;archive) const</td></tr>
<tr class="memdesc:ac7d571f0901df2476451e2fd26d9dab9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Puts aside destroyed entities. <a href="#ac7d571f0901df2476451e2fd26d9dab9">More...</a><br /></td></tr>
<tr class="separator:ac7d571f0901df2476451e2fd26d9dab9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a336288f5faaeb5f49831e3a0b4445bb0"><td class="memTemplParams" colspan="2">template&lt;typename Component , typename Archive &gt; </td></tr>
<tr class="memitem:a336288f5faaeb5f49831e3a0b4445bb0"><td class="memTemplItemLeft" align="right" valign="top">const <a class="el" href="classentt_1_1Snapshot.html">Snapshot</a> &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classentt_1_1Snapshot.html#a336288f5faaeb5f49831e3a0b4445bb0">component</a> (Archive &amp;archive) const</td></tr>
<tr class="memdesc:a336288f5faaeb5f49831e3a0b4445bb0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Puts aside the given component. <a href="#a336288f5faaeb5f49831e3a0b4445bb0">More...</a><br /></td></tr>
<tr class="separator:a336288f5faaeb5f49831e3a0b4445bb0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4aa8df6d1e59c4f441e472f63f5ee580"><td class="memTemplParams" colspan="2">template&lt;typename... Component, typename Archive &gt; </td></tr>
<tr class="memitem:a4aa8df6d1e59c4f441e472f63f5ee580"><td class="memTemplItemLeft" align="right" valign="top">std::enable_if_t&lt;(sizeof...(Component) &gt; 1), const <a class="el" href="classentt_1_1Snapshot.html">Snapshot</a> &amp; &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classentt_1_1Snapshot.html#a4aa8df6d1e59c4f441e472f63f5ee580">component</a> (Archive &amp;archive) const</td></tr>
<tr class="memdesc:a4aa8df6d1e59c4f441e472f63f5ee580"><td class="mdescLeft">&#160;</td><td class="mdescRight">Puts aside the given components. <a href="#a4aa8df6d1e59c4f441e472f63f5ee580">More...</a><br /></td></tr>
<tr class="separator:a4aa8df6d1e59c4f441e472f63f5ee580"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a98433fc64a9935e744a4c1b1f5d6e630"><td class="memTemplParams" colspan="2">template&lt;typename... Component, typename Archive , typename It &gt; </td></tr>
<tr class="memitem:a98433fc64a9935e744a4c1b1f5d6e630"><td class="memTemplItemLeft" align="right" valign="top">const <a class="el" href="classentt_1_1Snapshot.html">Snapshot</a> &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classentt_1_1Snapshot.html#a98433fc64a9935e744a4c1b1f5d6e630">component</a> (Archive &amp;archive, It first, It last) const</td></tr>
<tr class="memdesc:a98433fc64a9935e744a4c1b1f5d6e630"><td class="mdescLeft">&#160;</td><td class="mdescRight">Puts aside the given components for the entities in a range. <a href="#a98433fc64a9935e744a4c1b1f5d6e630">More...</a><br /></td></tr>
<tr class="separator:a98433fc64a9935e744a4c1b1f5d6e630"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac13d5fe79511e27f7b935e84c112e051"><td class="memTemplParams" colspan="2">template&lt;typename Tag , typename Archive &gt; </td></tr>
<tr class="memitem:ac13d5fe79511e27f7b935e84c112e051"><td class="memTemplItemLeft" align="right" valign="top">const <a class="el" href="classentt_1_1Snapshot.html">Snapshot</a> &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classentt_1_1Snapshot.html#ac13d5fe79511e27f7b935e84c112e051">tag</a> (Archive &amp;archive) const</td></tr>
<tr class="memdesc:ac13d5fe79511e27f7b935e84c112e051"><td class="mdescLeft">&#160;</td><td class="mdescRight">Puts aside the given tag. <a href="#ac13d5fe79511e27f7b935e84c112e051">More...</a><br /></td></tr>
<tr class="separator:ac13d5fe79511e27f7b935e84c112e051"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a960471c2f13bc1c693a9c58396e63b93"><td class="memTemplParams" colspan="2">template&lt;typename... Tag, typename Archive &gt; </td></tr>
<tr class="memitem:a960471c2f13bc1c693a9c58396e63b93"><td class="memTemplItemLeft" align="right" valign="top">std::enable_if_t&lt;(sizeof...(Tag) &gt; 1), const <a class="el" href="classentt_1_1Snapshot.html">Snapshot</a> &amp; &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classentt_1_1Snapshot.html#a960471c2f13bc1c693a9c58396e63b93">tag</a> (Archive &amp;archive) const</td></tr>
<tr class="memdesc:a960471c2f13bc1c693a9c58396e63b93"><td class="mdescLeft">&#160;</td><td class="mdescRight">Puts aside the given tags. <a href="#a960471c2f13bc1c693a9c58396e63b93">More...</a><br /></td></tr>
<tr class="separator:a960471c2f13bc1c693a9c58396e63b93"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a200646cfe88496da691aab5f61c0fa69"><td class="memItemLeft" align="right" valign="top"><a id="a200646cfe88496da691aab5f61c0fa69"></a>
class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1Snapshot.html#a200646cfe88496da691aab5f61c0fa69">Registry&lt; Entity &gt;</a></td></tr>
<tr class="memdesc:a200646cfe88496da691aab5f61c0fa69"><td class="mdescLeft">&#160;</td><td class="mdescRight">A registry is allowed to create snapshots. <br /></td></tr>
<tr class="separator:a200646cfe88496da691aab5f61c0fa69"><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 />
class entt::Snapshot&lt; Entity &gt;</h3>
<p>Utility class to create snapshots from a registry. </p>
<p>A <em>snapshot</em> can be either a dump of the entire registry or a narrower selection of components and tags of interest.<br />
This type can be used in both cases if provided with a correctly configured output archive.</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="snapshot_8hpp_source.html#l00038">38</a> of file <a class="el" href="snapshot_8hpp_source.html">snapshot.hpp</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a336288f5faaeb5f49831e3a0b4445bb0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a336288f5faaeb5f49831e3a0b4445bb0">&#9670;&nbsp;</a></span>component() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity &gt; </div>
<div class="memtemplate">
template&lt;typename Component , typename Archive &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classentt_1_1Snapshot.html">Snapshot</a>&amp; <a class="el" href="classentt_1_1Snapshot.html">entt::Snapshot</a>&lt; Entity &gt;::component </td>
<td>(</td>
<td class="paramtype">Archive &amp;&#160;</td>
<td class="paramname"><em>archive</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>Puts aside the given component. </p>
<p>Each instance is serialized together with the entity to which it belongs. Entities are serialized along with their versions.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Component</td><td>Type of component to serialize. </td></tr>
<tr><td class="paramname">Archive</td><td>Type of output 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 output archive. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>An object of this type to continue creating the snapshot. </dd></dl>
<p class="definition">Definition at line <a class="el" href="snapshot_8hpp_source.html#l00144">144</a> of file <a class="el" href="snapshot_8hpp_source.html">snapshot.hpp</a>.</p>
</div>
</div>
<a id="a4aa8df6d1e59c4f441e472f63f5ee580"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4aa8df6d1e59c4f441e472f63f5ee580">&#9670;&nbsp;</a></span>component() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity &gt; </div>
<div class="memtemplate">
template&lt;typename... Component, typename Archive &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::enable_if_t&lt;(sizeof...(Component) &gt; 1), const <a class="el" href="classentt_1_1Snapshot.html">Snapshot</a> &amp;&gt; <a class="el" href="classentt_1_1Snapshot.html">entt::Snapshot</a>&lt; Entity &gt;::component </td>
<td>(</td>
<td class="paramtype">Archive &amp;&#160;</td>
<td class="paramname"><em>archive</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>Puts aside the given components. </p>
<p>Each instance is serialized together with the entity to which it belongs. Entities are serialized along with their versions.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Component</td><td>Types of components to serialize. </td></tr>
<tr><td class="paramname">Archive</td><td>Type of output 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 output archive. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>An object of this type to continue creating the snapshot. </dd></dl>
<p class="definition">Definition at line <a class="el" href="snapshot_8hpp_source.html#l00171">171</a> of file <a class="el" href="snapshot_8hpp_source.html">snapshot.hpp</a>.</p>
</div>
</div>
<a id="a98433fc64a9935e744a4c1b1f5d6e630"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a98433fc64a9935e744a4c1b1f5d6e630">&#9670;&nbsp;</a></span>component() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity &gt; </div>
<div class="memtemplate">
template&lt;typename... Component, typename Archive , typename It &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classentt_1_1Snapshot.html">Snapshot</a>&amp; <a class="el" href="classentt_1_1Snapshot.html">entt::Snapshot</a>&lt; Entity &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">It&#160;</td>
<td class="paramname"><em>first</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">It&#160;</td>
<td class="paramname"><em>last</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</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>Puts aside the given components for the entities in a range. </p>
<p>Each instance is serialized together with the entity to which it belongs. Entities are serialized along with their versions.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Component</td><td>Types of components to serialize. </td></tr>
<tr><td class="paramname">Archive</td><td>Type of output archive. </td></tr>
<tr><td class="paramname">It</td><td>Type of input iterator. </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">archive</td><td>A valid reference to an output archive. </td></tr>
<tr><td class="paramname">first</td><td>An iterator to the first element of the range to serialize. </td></tr>
<tr><td class="paramname">last</td><td>An iterator past the last element of the range to serialize. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>An object of this type to continue creating the snapshot. </dd></dl>
<p class="definition">Definition at line <a class="el" href="snapshot_8hpp_source.html#l00193">193</a> of file <a class="el" href="snapshot_8hpp_source.html">snapshot.hpp</a>.</p>
</div>
</div>
<a id="ac7d571f0901df2476451e2fd26d9dab9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac7d571f0901df2476451e2fd26d9dab9">&#9670;&nbsp;</a></span>destroyed()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity &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">const <a class="el" href="classentt_1_1Snapshot.html">Snapshot</a>&amp; <a class="el" href="classentt_1_1Snapshot.html">entt::Snapshot</a>&lt; Entity &gt;::destroyed </td>
<td>(</td>
<td class="paramtype">Archive &amp;&#160;</td>
<td class="paramname"><em>archive</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>Puts aside destroyed entities. </p>
<p>Entities are serialized along with their versions. Entities that are still in use are not taken in consideration by this function.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Archive</td><td>Type of output 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 output archive. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>An object of this type to continue creating the snapshot. </dd></dl>
<p class="definition">Definition at line <a class="el" href="snapshot_8hpp_source.html#l00119">119</a> of file <a class="el" href="snapshot_8hpp_source.html">snapshot.hpp</a>.</p>
</div>
</div>
<a id="aa77d63e06c40969adca662fca3a2ca08"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa77d63e06c40969adca662fca3a2ca08">&#9670;&nbsp;</a></span>entities()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity &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">const <a class="el" href="classentt_1_1Snapshot.html">Snapshot</a>&amp; <a class="el" href="classentt_1_1Snapshot.html">entt::Snapshot</a>&lt; Entity &gt;::entities </td>
<td>(</td>
<td class="paramtype">Archive &amp;&#160;</td>
<td class="paramname"><em>archive</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>Puts aside all the entities that are still in use. </p>
<p>Entities are serialized along with their versions. Destroyed entities are not taken in consideration by this function.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Archive</td><td>Type of output 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 output archive. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>An object of this type to continue creating the snapshot. </dd></dl>
<p class="definition">Definition at line <a class="el" href="snapshot_8hpp_source.html#l00102">102</a> of file <a class="el" href="snapshot_8hpp_source.html">snapshot.hpp</a>.</p>
</div>
</div>
<a id="a3375f7d701d086fc21e04e6077c954fc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3375f7d701d086fc21e04e6077c954fc">&#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="classentt_1_1Snapshot.html">Snapshot</a>&amp; <a class="el" href="classentt_1_1Snapshot.html">entt::Snapshot</a>&lt; Entity &gt;::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classentt_1_1Snapshot.html">Snapshot</a>&lt; Entity &gt; &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Copying a snapshot isn't allowed. </p>
<dl class="section return"><dt>Returns</dt><dd>This snapshot. </dd></dl>
</div>
</div>
<a id="a627c0ea635facdd8b8246d1b97de11e3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a627c0ea635facdd8b8246d1b97de11e3">&#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="classentt_1_1Snapshot.html">Snapshot</a>&amp; <a class="el" href="classentt_1_1Snapshot.html">entt::Snapshot</a>&lt; Entity &gt;::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classentt_1_1Snapshot.html">Snapshot</a>&lt; Entity &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 snapshot. </dd></dl>
</div>
</div>
<a id="ac13d5fe79511e27f7b935e84c112e051"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac13d5fe79511e27f7b935e84c112e051">&#9670;&nbsp;</a></span>tag() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity &gt; </div>
<div class="memtemplate">
template&lt;typename Tag , typename Archive &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classentt_1_1Snapshot.html">Snapshot</a>&amp; <a class="el" href="classentt_1_1Snapshot.html">entt::Snapshot</a>&lt; Entity &gt;::tag </td>
<td>(</td>
<td class="paramtype">Archive &amp;&#160;</td>
<td class="paramname"><em>archive</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>Puts aside the given tag. </p>
<p>Each instance is serialized together with the entity to which it belongs. Entities are serialized along with their versions.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Tag</td><td>Type of tag to serialize. </td></tr>
<tr><td class="paramname">Archive</td><td>Type of output 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 output archive. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>An object of this type to continue creating the snapshot. </dd></dl>
<p class="definition">Definition at line <a class="el" href="snapshot_8hpp_source.html#l00210">210</a> of file <a class="el" href="snapshot_8hpp_source.html">snapshot.hpp</a>.</p>
</div>
</div>
<a id="a960471c2f13bc1c693a9c58396e63b93"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a960471c2f13bc1c693a9c58396e63b93">&#9670;&nbsp;</a></span>tag() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity &gt; </div>
<div class="memtemplate">
template&lt;typename... Tag, typename Archive &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::enable_if_t&lt;(sizeof...(Tag) &gt; 1), const <a class="el" href="classentt_1_1Snapshot.html">Snapshot</a> &amp;&gt; <a class="el" href="classentt_1_1Snapshot.html">entt::Snapshot</a>&lt; Entity &gt;::tag </td>
<td>(</td>
<td class="paramtype">Archive &amp;&#160;</td>
<td class="paramname"><em>archive</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>Puts aside the given tags. </p>
<p>Each instance is serialized together with the entity to which it belongs. Entities are serialized along with their versions.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Tag</td><td>Types of tags to serialize. </td></tr>
<tr><td class="paramname">Archive</td><td>Type of output 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 output archive. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>An object of this type to continue creating the snapshot. </dd></dl>
<p class="definition">Definition at line <a class="el" href="snapshot_8hpp_source.html#l00236">236</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 file:<ul>
<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="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink