208 lines
10 KiB
HTML
208 lines
10 KiB
HTML
<!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">
|
|
<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.16"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>EnTT: entt::as_group< Const, Entity > Struct 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
|
|
 <span id="projectnumber">3.3.0</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.16 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(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">
|
|
<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="structentt_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> |
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="structentt_1_1as__group-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">entt::as_group< Const, Entity > Struct Template Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Converts a registry to a group.
|
|
<a href="structentt_1_1as__group.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="helper_8hpp_source.html">helper.hpp</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
|
|
Public Types</h2></td></tr>
|
|
<tr class="memitem:a7ede36514bf64187bc93d3d295fe0123"><td class="memItemLeft" align="right" valign="top"><a id="a7ede36514bf64187bc93d3d295fe0123"></a>
|
|
using </td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1as__group.html#a7ede36514bf64187bc93d3d295fe0123">registry_type</a> = std::conditional_t< Const, const <a class="el" href="classentt_1_1basic__registry.html">entt::basic_registry</a>< Entity >, <a class="el" href="classentt_1_1basic__registry.html">entt::basic_registry</a>< Entity > ></td></tr>
|
|
<tr class="memdesc:a7ede36514bf64187bc93d3d295fe0123"><td class="mdescLeft"> </td><td class="mdescRight">Type of registry to convert. <br /></td></tr>
|
|
<tr class="separator:a7ede36514bf64187bc93d3d295fe0123"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><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:a7ebe095efa7c1e00e2f156ad7930d9a9"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1as__group.html#a7ebe095efa7c1e00e2f156ad7930d9a9">as_group</a> (<a class="el" href="structentt_1_1as__group.html#a7ede36514bf64187bc93d3d295fe0123">registry_type</a> &source) ENTT_NOEXCEPT</td></tr>
|
|
<tr class="memdesc:a7ebe095efa7c1e00e2f156ad7930d9a9"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a converter for a given registry. <a href="structentt_1_1as__group.html#a7ebe095efa7c1e00e2f156ad7930d9a9">More...</a><br /></td></tr>
|
|
<tr class="separator:a7ebe095efa7c1e00e2f156ad7930d9a9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5bc540042a69aee98c28c8446152a47f"><td class="memTemplParams" colspan="2">template<typename Exclude , typename Get , typename... Owned> </td></tr>
|
|
<tr class="memitem:a5bc540042a69aee98c28c8446152a47f"><td class="memTemplItemLeft" align="right" valign="top"> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structentt_1_1as__group.html#a5bc540042a69aee98c28c8446152a47f">operator entt::basic_group< Entity, Exclude, Get, Owned... ></a> () const</td></tr>
|
|
<tr class="memdesc:a5bc540042a69aee98c28c8446152a47f"><td class="mdescLeft"> </td><td class="mdescRight">Conversion function from a registry to a group. <a href="structentt_1_1as__group.html#a5bc540042a69aee98c28c8446152a47f">More...</a><br /></td></tr>
|
|
<tr class="separator:a5bc540042a69aee98c28c8446152a47f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><h3>template<bool Const, typename Entity><br />
|
|
struct entt::as_group< Const, Entity ></h3>
|
|
|
|
<p>Converts a registry to a group. </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">Const</td><td>Constness of the accepted registry. </td></tr>
|
|
<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="helper_8hpp_source.html#l00070">70</a> of file <a class="el" href="helper_8hpp_source.html">helper.hpp</a>.</p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a7ebe095efa7c1e00e2f156ad7930d9a9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7ebe095efa7c1e00e2f156ad7930d9a9">◆ </a></span>as_group()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<bool Const, typename Entity > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="structentt_1_1as__group.html">entt::as_group</a>< Const, Entity >::<a class="el" href="structentt_1_1as__group.html">as_group</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structentt_1_1as__group.html#a7ede36514bf64187bc93d3d295fe0123">registry_type</a> & </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> </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#l00078">78</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="a5bc540042a69aee98c28c8446152a47f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5bc540042a69aee98c28c8446152a47f">◆ </a></span>operator entt::basic_group< Entity, Exclude, Get, Owned... >()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<bool Const, typename Entity > </div>
|
|
<div class="memtemplate">
|
|
template<typename Exclude , typename Get , typename... Owned> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="structentt_1_1as__group.html">entt::as_group</a>< Const, Entity >::operator <a class="el" href="classentt_1_1basic__group.html">entt::basic_group</a>< Entity, Exclude, Get, Owned... > </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">Exclude</td><td>Types of components used to filter the group. </td></tr>
|
|
<tr><td class="paramname">Get</td><td>Types of components observed by the group. </td></tr>
|
|
<tr><td class="paramname">Owned</td><td>Types of components owned by 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#l00088">88</a> of file <a class="el" href="helper_8hpp_source.html">helper.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="helper_8hpp_source.html">helper.hpp</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.16
|
|
</small></address>
|
|
</body>
|
|
</html>
|