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

194 lines
9.4 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_collector&lt;&gt; Struct 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="structentt_1_1basic__collector_3_4.html">basic_collector&lt;&gt;</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="structentt_1_1basic__collector_3_4-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">entt::basic_collector&lt;&gt; Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Collector.
<a href="structentt_1_1basic__collector_3_4.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="observer_8hpp_source.html">observer.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a718ff87ec2db7fa4332b2b3d47a7998f"><td class="memTemplParams" colspan="2">template&lt;typename... AllOf, typename... NoneOf&gt; </td></tr>
<tr class="memitem:a718ff87ec2db7fa4332b2b3d47a7998f"><td class="memTemplItemLeft" align="right" valign="top">static constexpr auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__collector_3_4.html#a718ff87ec2db7fa4332b2b3d47a7998f">group</a> (<a class="el" href="structentt_1_1exclude__t.html">exclude_t</a>&lt; NoneOf... &gt;=<a class="el" href="structentt_1_1exclude__t.html">exclude_t</a>{}) noexcept</td></tr>
<tr class="memdesc:a718ff87ec2db7fa4332b2b3d47a7998f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds a grouping matcher to the collector. <br /></td></tr>
<tr class="separator:a718ff87ec2db7fa4332b2b3d47a7998f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a13ce2f2ee1d5e8c852fa055cb693a210"><td class="memTemplParams" colspan="2">template&lt;typename AnyOf &gt; </td></tr>
<tr class="memitem:a13ce2f2ee1d5e8c852fa055cb693a210"><td class="memTemplItemLeft" align="right" valign="top">static constexpr auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__collector_3_4.html#a13ce2f2ee1d5e8c852fa055cb693a210">update</a> () noexcept</td></tr>
<tr class="memdesc:a13ce2f2ee1d5e8c852fa055cb693a210"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds an observing matcher to the collector. <br /></td></tr>
<tr class="separator:a13ce2f2ee1d5e8c852fa055cb693a210"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Collector. </p>
<p>A collector contains a set of rules (literally, matchers) to use to track entities.<br />
Its main purpose is to generate a descriptor that allows an observer to know how to connect to a registry. </p>
<p class="definition">Definition at line <a class="el" href="observer_8hpp_source.html#l00038">38</a> of file <a class="el" href="observer_8hpp_source.html">observer.hpp</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a718ff87ec2db7fa4332b2b3d47a7998f" name="a718ff87ec2db7fa4332b2b3d47a7998f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a718ff87ec2db7fa4332b2b3d47a7998f">&#9670;&#160;</a></span>group()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename... AllOf, typename... NoneOf&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static constexpr auto <a class="el" href="structentt_1_1basic__collector.html">entt::basic_collector</a>&lt;&gt;::group </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structentt_1_1exclude__t.html">exclude_t</a>&lt; NoneOf... &gt;&#160;</td>
<td class="paramname"> = <code><a class="el" href="structentt_1_1exclude__t.html">exclude_t</a>{}</code></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">constexpr</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Adds a grouping matcher to the collector. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">AllOf</td><td>Types of components tracked by the matcher. </td></tr>
<tr><td class="paramname">NoneOf</td><td>Types of components used to filter out entities. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The updated collector. </dd></dl>
<p class="definition">Definition at line <a class="el" href="observer_8hpp_source.html#l00046">46</a> of file <a class="el" href="observer_8hpp_source.html">observer.hpp</a>.</p>
</div>
</div>
<a id="a13ce2f2ee1d5e8c852fa055cb693a210" name="a13ce2f2ee1d5e8c852fa055cb693a210"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a13ce2f2ee1d5e8c852fa055cb693a210">&#9670;&#160;</a></span>update()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename AnyOf &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static constexpr auto <a class="el" href="structentt_1_1basic__collector.html">entt::basic_collector</a>&lt;&gt;::update </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">constexpr</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Adds an observing matcher to the collector. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">AnyOf</td><td>Type of component for which changes should be detected. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The updated collector. </dd></dl>
<p class="definition">Definition at line <a class="el" href="observer_8hpp_source.html#l00056">56</a> of file <a class="el" href="observer_8hpp_source.html">observer.hpp</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>src/entt/entity/<a class="el" href="observer_8hpp_source.html">observer.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