Files
entt/classentt_1_1basic__common__view.html
2024-10-23 15:07:48 +02:00

585 lines
40 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" 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.10.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>EnTT: entt::basic_common_view&lt; Type, Get, Exclude &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>
<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.14.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.10.0 -->
<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');
$(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_1basic__common__view.html">basic_common_view</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="#friends">Friends</a> &#124;
<a href="classentt_1_1basic__common__view-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">entt::basic_common_view&lt; Type, Get, Exclude &gt; Class Template Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Basic storage view implementation.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="view_8hpp_source.html">view.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:a49d50a6ed08c233e75b59bc3aed62e46" id="r_a49d50a6ed08c233e75b59bc3aed62e46"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">using</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a49d50a6ed08c233e75b59bc3aed62e46">common_type</a> = Type</td></tr>
<tr class="memdesc:a49d50a6ed08c233e75b59bc3aed62e46"><td class="mdescLeft">&#160;</td><td class="mdescRight">Common type among all storage types. <br /></td></tr>
<tr class="separator:a49d50a6ed08c233e75b59bc3aed62e46"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adab226b6dd6c5fa0959afe67f17a9c75" id="r_adab226b6dd6c5fa0959afe67f17a9c75"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">using</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#adab226b6dd6c5fa0959afe67f17a9c75">entity_type</a> = <a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">typename</a> Type::entity_type</td></tr>
<tr class="memdesc:adab226b6dd6c5fa0959afe67f17a9c75"><td class="mdescLeft">&#160;</td><td class="mdescRight">Underlying entity identifier. <br /></td></tr>
<tr class="separator:adab226b6dd6c5fa0959afe67f17a9c75"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa9ae1627c27d445f21b8ddf3db3fe78f" id="r_aa9ae1627c27d445f21b8ddf3db3fe78f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">using</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa9ae1627c27d445f21b8ddf3db3fe78f">size_type</a> = std::size_t</td></tr>
<tr class="memdesc:aa9ae1627c27d445f21b8ddf3db3fe78f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unsigned integer type. <br /></td></tr>
<tr class="separator:aa9ae1627c27d445f21b8ddf3db3fe78f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acca0fa3e8c6ca7fb4e3cebb1964ab146" id="r_acca0fa3e8c6ca7fb4e3cebb1964ab146"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">using</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#acca0fa3e8c6ca7fb4e3cebb1964ab146">iterator</a> = internal::view_iterator&lt;<a class="el" href="#a49d50a6ed08c233e75b59bc3aed62e46">common_type</a>, <a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">Get</a>, <a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">Exclude</a>&gt;</td></tr>
<tr class="memdesc:acca0fa3e8c6ca7fb4e3cebb1964ab146"><td class="mdescLeft">&#160;</td><td class="mdescRight">Forward iterator type. <br /></td></tr>
<tr class="separator:acca0fa3e8c6ca7fb4e3cebb1964ab146"><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:a4572fafa94a210f91cea5a97d5dda3b4" id="r_a4572fafa94a210f91cea5a97d5dda3b4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4572fafa94a210f91cea5a97d5dda3b4">refresh</a> () <a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">noexcept</a></td></tr>
<tr class="memdesc:a4572fafa94a210f91cea5a97d5dda3b4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Updates the internal leading view if required. <br /></td></tr>
<tr class="separator:a4572fafa94a210f91cea5a97d5dda3b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4d4caecc5dfcf100b0132198fdfe43b3" id="r_a4d4caecc5dfcf100b0132198fdfe43b3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">const</a> <a class="el" href="#a49d50a6ed08c233e75b59bc3aed62e46">common_type</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4d4caecc5dfcf100b0132198fdfe43b3">handle</a> () <a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">const</a> <a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">noexcept</a></td></tr>
<tr class="memdesc:a4d4caecc5dfcf100b0132198fdfe43b3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the leading storage of a view, if any. <br /></td></tr>
<tr class="separator:a4d4caecc5dfcf100b0132198fdfe43b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a34fdba8fb0d1d16714b473ac31b0f39d" id="r_a34fdba8fb0d1d16714b473ac31b0f39d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#aa9ae1627c27d445f21b8ddf3db3fe78f">size_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a34fdba8fb0d1d16714b473ac31b0f39d">size_hint</a> () <a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">const</a> <a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">noexcept</a></td></tr>
<tr class="memdesc:a34fdba8fb0d1d16714b473ac31b0f39d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Estimates the number of entities iterated by the view. <br /></td></tr>
<tr class="separator:a34fdba8fb0d1d16714b473ac31b0f39d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a51cd2d2c3725b7b4122b594dac974da6" id="r_a51cd2d2c3725b7b4122b594dac974da6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#acca0fa3e8c6ca7fb4e3cebb1964ab146">iterator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a51cd2d2c3725b7b4122b594dac974da6">begin</a> () <a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">const</a> <a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">noexcept</a></td></tr>
<tr class="memdesc:a51cd2d2c3725b7b4122b594dac974da6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns an iterator to the first entity of the view. <br /></td></tr>
<tr class="separator:a51cd2d2c3725b7b4122b594dac974da6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aac1aa2564ab77156936955392053c61d" id="r_aac1aa2564ab77156936955392053c61d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#acca0fa3e8c6ca7fb4e3cebb1964ab146">iterator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aac1aa2564ab77156936955392053c61d">end</a> () <a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">const</a> <a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">noexcept</a></td></tr>
<tr class="memdesc:aac1aa2564ab77156936955392053c61d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns an iterator that is past the last entity of the view. <br /></td></tr>
<tr class="separator:aac1aa2564ab77156936955392053c61d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7d5614b020a387078f807a58cea0cd90" id="r_a7d5614b020a387078f807a58cea0cd90"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#adab226b6dd6c5fa0959afe67f17a9c75">entity_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7d5614b020a387078f807a58cea0cd90">front</a> () <a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">const</a> <a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">noexcept</a></td></tr>
<tr class="memdesc:a7d5614b020a387078f807a58cea0cd90"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the first entity of the view, if any. <br /></td></tr>
<tr class="separator:a7d5614b020a387078f807a58cea0cd90"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6b0517d50e658cec5c259d0cf1cad8d7" id="r_a6b0517d50e658cec5c259d0cf1cad8d7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#adab226b6dd6c5fa0959afe67f17a9c75">entity_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6b0517d50e658cec5c259d0cf1cad8d7">back</a> () <a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">const</a> <a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">noexcept</a></td></tr>
<tr class="memdesc:a6b0517d50e658cec5c259d0cf1cad8d7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the last entity of the view, if any. <br /></td></tr>
<tr class="separator:a6b0517d50e658cec5c259d0cf1cad8d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abb964d3db8d2476860c91314e6f353b0" id="r_abb964d3db8d2476860c91314e6f353b0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#acca0fa3e8c6ca7fb4e3cebb1964ab146">iterator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#abb964d3db8d2476860c91314e6f353b0">find</a> (<a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">const</a> <a class="el" href="#adab226b6dd6c5fa0959afe67f17a9c75">entity_type</a> entt) <a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">const</a> <a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">noexcept</a></td></tr>
<tr class="memdesc:abb964d3db8d2476860c91314e6f353b0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Finds an entity. <br /></td></tr>
<tr class="separator:abb964d3db8d2476860c91314e6f353b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afd888f9d6b8141c3f1b4c1b1334720ac" id="r_afd888f9d6b8141c3f1b4c1b1334720ac"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#afd888f9d6b8141c3f1b4c1b1334720ac">operator bool</a> () <a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">const</a> <a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">noexcept</a></td></tr>
<tr class="memdesc:afd888f9d6b8141c3f1b4c1b1334720ac"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if a view is fully initialized. <br /></td></tr>
<tr class="separator:afd888f9d6b8141c3f1b4c1b1334720ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5123427d3555f05d61b996fe518b78de" id="r_a5123427d3555f05d61b996fe518b78de"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">bool</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5123427d3555f05d61b996fe518b78de">contains</a> (<a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">const</a> <a class="el" href="#adab226b6dd6c5fa0959afe67f17a9c75">entity_type</a> entt) <a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">const</a> <a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">noexcept</a></td></tr>
<tr class="memdesc:a5123427d3555f05d61b996fe518b78de"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if a view contains an entity. <br /></td></tr>
<tr class="separator:a5123427d3555f05d61b996fe518b78de"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="friends" name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:abff8fcdf8df88a44a818f57034d22e78" id="r_abff8fcdf8df88a44a818f57034d22e78"><td class="memTemplParams" colspan="2"><a id="abff8fcdf8df88a44a818f57034d22e78" name="abff8fcdf8df88a44a818f57034d22e78"></a>
template&lt;<a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">typename</a> <a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">Return</a> , <a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">typename</a> <a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">View</a> , <a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">typename</a> <a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">Other</a> , std::size_t... GLhs, std::size_t... ELhs, std::size_t... GRhs, std::size_t... ERhs&gt; </td></tr>
<tr class="memitem:abff8fcdf8df88a44a818f57034d22e78"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">Return</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><b>internal::view_pack</b> (<a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">const</a> <a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">View</a> &amp;, <a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">const</a> <a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">Other</a> &amp;, std::index_sequence&lt; GLhs... &gt;, std::index_sequence&lt; ELhs... &gt;, std::index_sequence&lt; GRhs... &gt;, std::index_sequence&lt; ERhs... &gt;)</td></tr>
<tr class="separator:abff8fcdf8df88a44a818f57034d22e78"><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;<a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">typename</a> Type, std::size_t Get, std::size_t Exclude&gt;<br />
class entt::basic_common_view&lt; Type, Get, Exclude &gt;</div><p>Basic storage view implementation. </p>
<dl class="section warning"><dt>Warning</dt><dd>For internal use only, backward compatibility not guaranteed. </dd></dl>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Type</td><td>Common type among all storage types. </td></tr>
<tr><td class="paramname">Get</td><td>Number of storage iterated by the view. </td></tr>
<tr><td class="paramname">Exclude</td><td>Number of storage used to filter the view. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="view_8hpp_source.html#l00226">226</a> of file <a class="el" href="view_8hpp_source.html">view.hpp</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="a49d50a6ed08c233e75b59bc3aed62e46" name="a49d50a6ed08c233e75b59bc3aed62e46"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a49d50a6ed08c233e75b59bc3aed62e46">&#9670;&#160;</a></span>common_type</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;<a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">typename</a> Type , std::size_t Get, std::size_t Exclude&gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">using</a> <a class="el" href="classentt_1_1basic__common__view.html">entt::basic_common_view</a>&lt; Type, <a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">Get</a>, <a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">Exclude</a> &gt;::common_type = Type</td>
</tr>
</table>
</div><div class="memdoc">
<p>Common type among all storage types. </p>
<p class="definition">Definition at line <a class="el" href="view_8hpp_source.html#l00302">302</a> of file <a class="el" href="view_8hpp_source.html">view.hpp</a>.</p>
</div>
</div>
<a id="adab226b6dd6c5fa0959afe67f17a9c75" name="adab226b6dd6c5fa0959afe67f17a9c75"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adab226b6dd6c5fa0959afe67f17a9c75">&#9670;&#160;</a></span>entity_type</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;<a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">typename</a> Type , std::size_t Get, std::size_t Exclude&gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">using</a> <a class="el" href="classentt_1_1basic__common__view.html">entt::basic_common_view</a>&lt; Type, <a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">Get</a>, <a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">Exclude</a> &gt;::entity_type = <a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">typename</a> 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="view_8hpp_source.html#l00304">304</a> of file <a class="el" href="view_8hpp_source.html">view.hpp</a>.</p>
</div>
</div>
<a id="acca0fa3e8c6ca7fb4e3cebb1964ab146" name="acca0fa3e8c6ca7fb4e3cebb1964ab146"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acca0fa3e8c6ca7fb4e3cebb1964ab146">&#9670;&#160;</a></span>iterator</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;<a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">typename</a> Type , std::size_t Get, std::size_t Exclude&gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">using</a> <a class="el" href="classentt_1_1basic__common__view.html">entt::basic_common_view</a>&lt; Type, <a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">Get</a>, <a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">Exclude</a> &gt;::iterator = internal::view_iterator&lt;<a class="el" href="#a49d50a6ed08c233e75b59bc3aed62e46">common_type</a>, <a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">Get</a>, <a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">Exclude</a>&gt;</td>
</tr>
</table>
</div><div class="memdoc">
<p>Forward iterator type. </p>
<p class="definition">Definition at line <a class="el" href="view_8hpp_source.html#l00308">308</a> of file <a class="el" href="view_8hpp_source.html">view.hpp</a>.</p>
</div>
</div>
<a id="aa9ae1627c27d445f21b8ddf3db3fe78f" name="aa9ae1627c27d445f21b8ddf3db3fe78f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa9ae1627c27d445f21b8ddf3db3fe78f">&#9670;&#160;</a></span>size_type</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;<a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">typename</a> Type , std::size_t Get, std::size_t Exclude&gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">using</a> <a class="el" href="classentt_1_1basic__common__view.html">entt::basic_common_view</a>&lt; Type, <a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">Get</a>, <a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">Exclude</a> &gt;::size_type = std::size_t</td>
</tr>
</table>
</div><div class="memdoc">
<p>Unsigned integer type. </p>
<p class="definition">Definition at line <a class="el" href="view_8hpp_source.html#l00306">306</a> of file <a class="el" href="view_8hpp_source.html">view.hpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a6b0517d50e658cec5c259d0cf1cad8d7" name="a6b0517d50e658cec5c259d0cf1cad8d7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6b0517d50e658cec5c259d0cf1cad8d7">&#9670;&#160;</a></span>back()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;<a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">typename</a> Type , std::size_t Get, std::size_t Exclude&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="#adab226b6dd6c5fa0959afe67f17a9c75">entity_type</a> <a class="el" href="classentt_1_1basic__common__view.html">entt::basic_common_view</a>&lt; Type, <a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">Get</a>, <a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">Exclude</a> &gt;::back </td>
<td>(</td>
<td class="paramname"><span class="paramname"></span></td><td>)</td>
<td> const</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>Returns the last entity of the view, if any. </p>
<dl class="section return"><dt>Returns</dt><dd>The last entity of the view if one exists, the null entity otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="view_8hpp_source.html#l00370">370</a> of file <a class="el" href="view_8hpp_source.html">view.hpp</a>.</p>
</div>
</div>
<a id="a51cd2d2c3725b7b4122b594dac974da6" name="a51cd2d2c3725b7b4122b594dac974da6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a51cd2d2c3725b7b4122b594dac974da6">&#9670;&#160;</a></span>begin()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;<a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">typename</a> Type , std::size_t Get, std::size_t Exclude&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="#acca0fa3e8c6ca7fb4e3cebb1964ab146">iterator</a> <a class="el" href="classentt_1_1basic__common__view.html">entt::basic_common_view</a>&lt; Type, <a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">Get</a>, <a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">Exclude</a> &gt;::begin </td>
<td>(</td>
<td class="paramname"><span class="paramname"></span></td><td>)</td>
<td> const</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>Returns an iterator to the first entity of the view. </p>
<p>If the view is empty, the returned iterator will be equal to <code><a class="el" href="#aac1aa2564ab77156936955392053c61d" title="Returns an iterator that is past the last entity of the view.">end()</a></code>.</p>
<dl class="section return"><dt>Returns</dt><dd>An iterator to the first entity of the view. </dd></dl>
<p class="definition">Definition at line <a class="el" href="view_8hpp_source.html#l00343">343</a> of file <a class="el" href="view_8hpp_source.html">view.hpp</a>.</p>
</div>
</div>
<a id="a5123427d3555f05d61b996fe518b78de" name="a5123427d3555f05d61b996fe518b78de"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5123427d3555f05d61b996fe518b78de">&#9670;&#160;</a></span>contains()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;<a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">typename</a> Type , std::size_t Get, std::size_t Exclude&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">bool</a> <a class="el" href="classentt_1_1basic__common__view.html">entt::basic_common_view</a>&lt; Type, <a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">Get</a>, <a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">Exclude</a> &gt;::contains </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">const</a> <a class="el" href="#adab226b6dd6c5fa0959afe67f17a9c75">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</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks if a view contains an 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 the view contains the given entity, false otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="view_8hpp_source.html#l00404">404</a> of file <a class="el" href="view_8hpp_source.html">view.hpp</a>.</p>
</div>
</div>
<a id="aac1aa2564ab77156936955392053c61d" name="aac1aa2564ab77156936955392053c61d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aac1aa2564ab77156936955392053c61d">&#9670;&#160;</a></span>end()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;<a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">typename</a> Type , std::size_t Get, std::size_t Exclude&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="#acca0fa3e8c6ca7fb4e3cebb1964ab146">iterator</a> <a class="el" href="classentt_1_1basic__common__view.html">entt::basic_common_view</a>&lt; Type, <a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">Get</a>, <a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">Exclude</a> &gt;::end </td>
<td>(</td>
<td class="paramname"><span class="paramname"></span></td><td>)</td>
<td> const</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>Returns an iterator that is past the last entity of the view. </p>
<dl class="section return"><dt>Returns</dt><dd>An iterator to the entity following the last entity of the view. </dd></dl>
<p class="definition">Definition at line <a class="el" href="view_8hpp_source.html#l00351">351</a> of file <a class="el" href="view_8hpp_source.html">view.hpp</a>.</p>
</div>
</div>
<a id="abb964d3db8d2476860c91314e6f353b0" name="abb964d3db8d2476860c91314e6f353b0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abb964d3db8d2476860c91314e6f353b0">&#9670;&#160;</a></span>find()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;<a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">typename</a> Type , std::size_t Get, std::size_t Exclude&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="#acca0fa3e8c6ca7fb4e3cebb1964ab146">iterator</a> <a class="el" href="classentt_1_1basic__common__view.html">entt::basic_common_view</a>&lt; Type, <a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">Get</a>, <a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">Exclude</a> &gt;::find </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">const</a> <a class="el" href="#adab226b6dd6c5fa0959afe67f17a9c75">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</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Finds an 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>An iterator to the given entity if it's found, past the end iterator otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="view_8hpp_source.html#l00387">387</a> of file <a class="el" href="view_8hpp_source.html">view.hpp</a>.</p>
</div>
</div>
<a id="a7d5614b020a387078f807a58cea0cd90" name="a7d5614b020a387078f807a58cea0cd90"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7d5614b020a387078f807a58cea0cd90">&#9670;&#160;</a></span>front()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;<a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">typename</a> Type , std::size_t Get, std::size_t Exclude&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="#adab226b6dd6c5fa0959afe67f17a9c75">entity_type</a> <a class="el" href="classentt_1_1basic__common__view.html">entt::basic_common_view</a>&lt; Type, <a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">Get</a>, <a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">Exclude</a> &gt;::front </td>
<td>(</td>
<td class="paramname"><span class="paramname"></span></td><td>)</td>
<td> const</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>Returns the first entity of the view, if any. </p>
<dl class="section return"><dt>Returns</dt><dd>The first entity of the view if one exists, the null entity otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="view_8hpp_source.html#l00360">360</a> of file <a class="el" href="view_8hpp_source.html">view.hpp</a>.</p>
</div>
</div>
<a id="a4d4caecc5dfcf100b0132198fdfe43b3" name="a4d4caecc5dfcf100b0132198fdfe43b3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4d4caecc5dfcf100b0132198fdfe43b3">&#9670;&#160;</a></span>handle()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;<a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">typename</a> Type , std::size_t Get, std::size_t Exclude&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">const</a> <a class="el" href="#a49d50a6ed08c233e75b59bc3aed62e46">common_type</a> * <a class="el" href="classentt_1_1basic__common__view.html">entt::basic_common_view</a>&lt; Type, <a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">Get</a>, <a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">Exclude</a> &gt;::handle </td>
<td>(</td>
<td class="paramname"><span class="paramname"></span></td><td>)</td>
<td> const</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>Returns the leading storage of a view, if any. </p>
<dl class="section return"><dt>Returns</dt><dd>The leading storage of the view. </dd></dl>
<p class="definition">Definition at line <a class="el" href="view_8hpp_source.html#l00324">324</a> of file <a class="el" href="view_8hpp_source.html">view.hpp</a>.</p>
</div>
</div>
<a id="afd888f9d6b8141c3f1b4c1b1334720ac" name="afd888f9d6b8141c3f1b4c1b1334720ac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afd888f9d6b8141c3f1b4c1b1334720ac">&#9670;&#160;</a></span>operator bool()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;<a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">typename</a> Type , std::size_t Get, std::size_t Exclude&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classentt_1_1basic__common__view.html">entt::basic_common_view</a>&lt; Type, <a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">Get</a>, <a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">Exclude</a> &gt;<a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">::operator</a> <a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">bool</a> </td>
<td>(</td>
<td class="paramname"><span class="paramname"></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks if a view is fully initialized. </p>
<dl class="section return"><dt>Returns</dt><dd>True if the view is fully initialized, false otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="view_8hpp_source.html#l00395">395</a> of file <a class="el" href="view_8hpp_source.html">view.hpp</a>.</p>
</div>
</div>
<a id="a4572fafa94a210f91cea5a97d5dda3b4" name="a4572fafa94a210f91cea5a97d5dda3b4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4572fafa94a210f91cea5a97d5dda3b4">&#9670;&#160;</a></span>refresh()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;<a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">typename</a> Type , std::size_t Get, std::size_t Exclude&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">void</a> <a class="el" href="classentt_1_1basic__common__view.html">entt::basic_common_view</a>&lt; Type, <a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">Get</a>, <a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">Exclude</a> &gt;::refresh </td>
<td>(</td>
<td class="paramname"><span class="paramname"></span></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>Updates the internal leading view if required. </p>
<p class="definition">Definition at line <a class="el" href="view_8hpp_source.html#l00311">311</a> of file <a class="el" href="view_8hpp_source.html">view.hpp</a>.</p>
</div>
</div>
<a id="a34fdba8fb0d1d16714b473ac31b0f39d" name="a34fdba8fb0d1d16714b473ac31b0f39d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a34fdba8fb0d1d16714b473ac31b0f39d">&#9670;&#160;</a></span>size_hint()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;<a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">typename</a> Type , std::size_t Get, std::size_t Exclude&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="#aa9ae1627c27d445f21b8ddf3db3fe78f">size_type</a> <a class="el" href="classentt_1_1basic__common__view.html">entt::basic_common_view</a>&lt; Type, <a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">Get</a>, <a class="el" href="namespaceentt.html#a12e4d0c58f9c4cc6f5513c39c530b9b7">Exclude</a> &gt;::size_hint </td>
<td>(</td>
<td class="paramname"><span class="paramname"></span></td><td>)</td>
<td> const</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>Estimates the number of entities iterated by the view. </p>
<dl class="section return"><dt>Returns</dt><dd>Estimated number of entities iterated by the view. </dd></dl>
<p class="definition">Definition at line <a class="el" href="view_8hpp_source.html#l00332">332</a> of file <a class="el" href="view_8hpp_source.html">view.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="view_8hpp_source.html">view.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.10.0
</small></address>
</body>
</html>