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

252 lines
12 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::as_group&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_1as__group.html">as_group</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_1as__group-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">entt::as_group&lt; Registry &gt; Class Template Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Converts a registry to a group.
<a href="classentt_1_1as__group.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="helper_8hpp_source.html">helper.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:a181c04aa4d53d5fef0f90b33e000f8d1"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1as__group.html#a181c04aa4d53d5fef0f90b33e000f8d1">registry_type</a> = Registry</td></tr>
<tr class="memdesc:a181c04aa4d53d5fef0f90b33e000f8d1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type of registry to convert. <br /></td></tr>
<tr class="separator:a181c04aa4d53d5fef0f90b33e000f8d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a01a68f9e8552b14f9bc2e1a48c665c70"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1as__group.html#a01a68f9e8552b14f9bc2e1a48c665c70">entity_type</a> = typename registry_type::entity_type</td></tr>
<tr class="memdesc:a01a68f9e8552b14f9bc2e1a48c665c70"><td class="mdescLeft">&#160;</td><td class="mdescRight">Underlying entity identifier. <br /></td></tr>
<tr class="separator:a01a68f9e8552b14f9bc2e1a48c665c70"><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:a2ec8b1a86b502a9649cd9db3f90680a0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1as__group.html#a2ec8b1a86b502a9649cd9db3f90680a0">as_group</a> (<a class="el" href="classentt_1_1as__group.html#a181c04aa4d53d5fef0f90b33e000f8d1">registry_type</a> &amp;source) noexcept</td></tr>
<tr class="memdesc:a2ec8b1a86b502a9649cd9db3f90680a0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a converter for a given registry. <br /></td></tr>
<tr class="separator:a2ec8b1a86b502a9649cd9db3f90680a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab252f9fcd1a370a52dd8abfd7f32cec8"><td class="memTemplParams" colspan="2">template&lt;typename Owned , typename Get , typename Exclude &gt; </td></tr>
<tr class="memitem:ab252f9fcd1a370a52dd8abfd7f32cec8"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classentt_1_1as__group.html#ab252f9fcd1a370a52dd8abfd7f32cec8">operator basic_group&lt; Owned, Get, Exclude &gt;</a> () const</td></tr>
<tr class="memdesc:ab252f9fcd1a370a52dd8abfd7f32cec8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Conversion function from a registry to a group. <br /></td></tr>
<tr class="separator:ab252f9fcd1a370a52dd8abfd7f32cec8"><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::as_group&lt; Registry &gt;</div><p>Converts a registry to a group. </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="helper_8hpp_source.html#l00060">60</a> of file <a class="el" href="helper_8hpp_source.html">helper.hpp</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="a01a68f9e8552b14f9bc2e1a48c665c70" name="a01a68f9e8552b14f9bc2e1a48c665c70"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a01a68f9e8552b14f9bc2e1a48c665c70">&#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_1as__group.html">entt::as_group</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="helper_8hpp_source.html#l00074">74</a> of file <a class="el" href="helper_8hpp_source.html">helper.hpp</a>.</p>
</div>
</div>
<a id="a181c04aa4d53d5fef0f90b33e000f8d1" name="a181c04aa4d53d5fef0f90b33e000f8d1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a181c04aa4d53d5fef0f90b33e000f8d1">&#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_1as__group.html">entt::as_group</a>&lt; Registry &gt;::registry_type = Registry</td>
</tr>
</table>
</div><div class="memdoc">
<p>Type of registry to convert. </p>
<p class="definition">Definition at line <a class="el" href="helper_8hpp_source.html#l00072">72</a> of file <a class="el" href="helper_8hpp_source.html">helper.hpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a2ec8b1a86b502a9649cd9db3f90680a0" name="a2ec8b1a86b502a9649cd9db3f90680a0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2ec8b1a86b502a9649cd9db3f90680a0">&#9670;&#160;</a></span>as_group()</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_1as__group.html">entt::as_group</a>&lt; Registry &gt;::as_group </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classentt_1_1as__group.html#a181c04aa4d53d5fef0f90b33e000f8d1">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 a converter for 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="helper_8hpp_source.html#l00080">80</a> of file <a class="el" href="helper_8hpp_source.html">helper.hpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ab252f9fcd1a370a52dd8abfd7f32cec8" name="ab252f9fcd1a370a52dd8abfd7f32cec8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab252f9fcd1a370a52dd8abfd7f32cec8">&#9670;&#160;</a></span>operator basic_group&lt; Owned, Get, Exclude &gt;()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Registry &gt; </div>
<div class="memtemplate">
template&lt;typename Owned , typename Get , typename Exclude &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classentt_1_1as__group.html">entt::as_group</a>&lt; Registry &gt;::operator <a class="el" href="classentt_1_1basic__group.html">basic_group</a>&lt; Owned, Get, Exclude &gt; </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Conversion function from a registry to a group. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Owned</td><td>Types of <em>owned</em> by the group. </td></tr>
<tr><td class="paramname">Get</td><td>Types of storage <em>observed</em> by the group. </td></tr>
<tr><td class="paramname">Exclude</td><td>Types of storage used to filter the group. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A newly created group. </dd></dl>
<p class="definition">Definition at line <a class="el" href="helper_8hpp_source.html#l00091">91</a> of file <a class="el" href="helper_8hpp_source.html">helper.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="helper_8hpp_source.html">helper.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