623 lines
36 KiB
HTML
623 lines
36 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.13.2"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>EnTT: entt::basic_common_view< Type, Checked, Get, Exclude > 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>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.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"> 3.15.0</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.13.2 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() { codefold.init(0); });
|
|
/* @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&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search',false);
|
|
$(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function(){ initResizable(false); });
|
|
/* @license-end */
|
|
</script>
|
|
<!-- 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 id="doc-content">
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-types">Public Types</a> |
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#friends">Friends</a> |
|
|
<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< Type, Checked, Get, Exclude > Class Template Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Basic storage view implementation.
|
|
<a href="#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="view_8hpp_source.html">view.hpp</a>></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:ad2a9d4a491583d833ffc421a3913f982" id="r_ad2a9d4a491583d833ffc421a3913f982"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="#ad2a9d4a491583d833ffc421a3913f982">common_type</a> = Type</td></tr>
|
|
<tr class="memdesc:ad2a9d4a491583d833ffc421a3913f982"><td class="mdescLeft"> </td><td class="mdescRight">Common type among all storage types. <br /></td></tr>
|
|
<tr class="separator:ad2a9d4a491583d833ffc421a3913f982"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2a004edc23118d54d2074fe8a1a1cdd7" id="r_a2a004edc23118d54d2074fe8a1a1cdd7"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="#a2a004edc23118d54d2074fe8a1a1cdd7">entity_type</a> = typename Type::entity_type</td></tr>
|
|
<tr class="memdesc:a2a004edc23118d54d2074fe8a1a1cdd7"><td class="mdescLeft"> </td><td class="mdescRight">Underlying entity identifier. <br /></td></tr>
|
|
<tr class="separator:a2a004edc23118d54d2074fe8a1a1cdd7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af8a47cbe23041f655e46986cd82f7e39" id="r_af8a47cbe23041f655e46986cd82f7e39"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="#af8a47cbe23041f655e46986cd82f7e39">size_type</a> = std::size_t</td></tr>
|
|
<tr class="memdesc:af8a47cbe23041f655e46986cd82f7e39"><td class="mdescLeft"> </td><td class="mdescRight">Unsigned integer type. <br /></td></tr>
|
|
<tr class="separator:af8a47cbe23041f655e46986cd82f7e39"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a665b5a34eee656129ba04d718a98c05a" id="r_a665b5a34eee656129ba04d718a98c05a"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="#a665b5a34eee656129ba04d718a98c05a">difference_type</a> = std::ptrdiff_t</td></tr>
|
|
<tr class="memdesc:a665b5a34eee656129ba04d718a98c05a"><td class="mdescLeft"> </td><td class="mdescRight">Signed integer type. <br /></td></tr>
|
|
<tr class="separator:a665b5a34eee656129ba04d718a98c05a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac1779f77c4f07bd1db2479b9557be325" id="r_ac1779f77c4f07bd1db2479b9557be325"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="#ac1779f77c4f07bd1db2479b9557be325">iterator</a> = internal::view_iterator<<a class="el" href="#ad2a9d4a491583d833ffc421a3913f982">common_type</a>, Checked, Get, Exclude></td></tr>
|
|
<tr class="memdesc:ac1779f77c4f07bd1db2479b9557be325"><td class="mdescLeft"> </td><td class="mdescRight">Forward iterator type. <br /></td></tr>
|
|
<tr class="separator:ac1779f77c4f07bd1db2479b9557be325"><td class="memSeparator" colspan="2"> </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:a6455db81193b2e9ce830e2ed95ae0795" id="r_a6455db81193b2e9ce830e2ed95ae0795"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a6455db81193b2e9ce830e2ed95ae0795">refresh</a> () noexcept</td></tr>
|
|
<tr class="memdesc:a6455db81193b2e9ce830e2ed95ae0795"><td class="mdescLeft"> </td><td class="mdescRight">Updates the internal leading view if required. <br /></td></tr>
|
|
<tr class="separator:a6455db81193b2e9ce830e2ed95ae0795"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2aff92b331b0ca09fc2dc6006261fa2f" id="r_a2aff92b331b0ca09fc2dc6006261fa2f"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="#ad2a9d4a491583d833ffc421a3913f982">common_type</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="#a2aff92b331b0ca09fc2dc6006261fa2f">handle</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a2aff92b331b0ca09fc2dc6006261fa2f"><td class="mdescLeft"> </td><td class="mdescRight">Returns the leading storage of a view, if any. <br /></td></tr>
|
|
<tr class="separator:a2aff92b331b0ca09fc2dc6006261fa2f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4f4d649b5d2a9d823f93125450d38fc8" id="r_a4f4d649b5d2a9d823f93125450d38fc8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#af8a47cbe23041f655e46986cd82f7e39">size_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a4f4d649b5d2a9d823f93125450d38fc8">size_hint</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a4f4d649b5d2a9d823f93125450d38fc8"><td class="mdescLeft"> </td><td class="mdescRight">Estimates the number of entities iterated by the view. <br /></td></tr>
|
|
<tr class="separator:a4f4d649b5d2a9d823f93125450d38fc8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2007dc390b50ccc73a6d1ef6557d762b" id="r_a2007dc390b50ccc73a6d1ef6557d762b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#ac1779f77c4f07bd1db2479b9557be325">iterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a2007dc390b50ccc73a6d1ef6557d762b">begin</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a2007dc390b50ccc73a6d1ef6557d762b"><td class="mdescLeft"> </td><td class="mdescRight">Returns an iterator to the first entity of the view. <br /></td></tr>
|
|
<tr class="separator:a2007dc390b50ccc73a6d1ef6557d762b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acf2805f088e1f44931e00a4548782dce" id="r_acf2805f088e1f44931e00a4548782dce"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#ac1779f77c4f07bd1db2479b9557be325">iterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#acf2805f088e1f44931e00a4548782dce">end</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:acf2805f088e1f44931e00a4548782dce"><td class="mdescLeft"> </td><td class="mdescRight">Returns an iterator that is past the last entity of the view. <br /></td></tr>
|
|
<tr class="separator:acf2805f088e1f44931e00a4548782dce"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a94855cfbd9b0c88fdfb2161b0c5753bc" id="r_a94855cfbd9b0c88fdfb2161b0c5753bc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a2a004edc23118d54d2074fe8a1a1cdd7">entity_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a94855cfbd9b0c88fdfb2161b0c5753bc">front</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a94855cfbd9b0c88fdfb2161b0c5753bc"><td class="mdescLeft"> </td><td class="mdescRight">Returns the first entity of the view, if any. <br /></td></tr>
|
|
<tr class="separator:a94855cfbd9b0c88fdfb2161b0c5753bc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a63c2d833d41810b5a5b28ecf653dc056" id="r_a63c2d833d41810b5a5b28ecf653dc056"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a2a004edc23118d54d2074fe8a1a1cdd7">entity_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a63c2d833d41810b5a5b28ecf653dc056">back</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a63c2d833d41810b5a5b28ecf653dc056"><td class="mdescLeft"> </td><td class="mdescRight">Returns the last entity of the view, if any. <br /></td></tr>
|
|
<tr class="separator:a63c2d833d41810b5a5b28ecf653dc056"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a206be195c1f69d1a06894af690b3f768" id="r_a206be195c1f69d1a06894af690b3f768"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#ac1779f77c4f07bd1db2479b9557be325">iterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a206be195c1f69d1a06894af690b3f768">find</a> (const <a class="el" href="#a2a004edc23118d54d2074fe8a1a1cdd7">entity_type</a> entt) const noexcept</td></tr>
|
|
<tr class="memdesc:a206be195c1f69d1a06894af690b3f768"><td class="mdescLeft"> </td><td class="mdescRight">Finds an entity. <br /></td></tr>
|
|
<tr class="separator:a206be195c1f69d1a06894af690b3f768"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae300d448aaf4ef7330fb7b635e5877a4" id="r_ae300d448aaf4ef7330fb7b635e5877a4"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ae300d448aaf4ef7330fb7b635e5877a4">operator bool</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:ae300d448aaf4ef7330fb7b635e5877a4"><td class="mdescLeft"> </td><td class="mdescRight">Checks if a view is fully initialized. <br /></td></tr>
|
|
<tr class="separator:ae300d448aaf4ef7330fb7b635e5877a4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5639cffd5495c9dd1a94cc2a4839fe9f" id="r_a5639cffd5495c9dd1a94cc2a4839fe9f"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#a5639cffd5495c9dd1a94cc2a4839fe9f">contains</a> (const <a class="el" href="#a2a004edc23118d54d2074fe8a1a1cdd7">entity_type</a> entt) const noexcept</td></tr>
|
|
<tr class="memdesc:a5639cffd5495c9dd1a94cc2a4839fe9f"><td class="mdescLeft"> </td><td class="mdescRight">Checks if a view contains an entity. <br /></td></tr>
|
|
<tr class="separator:a5639cffd5495c9dd1a94cc2a4839fe9f"><td class="memSeparator" colspan="2"> </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<typename Return, typename View, typename Other, std::size_t... GLhs, std::size_t... ELhs, std::size_t... GRhs, std::size_t... ERhs> </td></tr>
|
|
<tr class="memitem:abff8fcdf8df88a44a818f57034d22e78"><td class="memTemplItemLeft" align="right" valign="top">Return </td><td class="memTemplItemRight" valign="bottom"><b>internal::view_pack</b> (const View &, const Other &, std::index_sequence< GLhs... >, std::index_sequence< ELhs... >, std::index_sequence< GRhs... >, std::index_sequence< ERhs... >)</td></tr>
|
|
<tr class="separator:abff8fcdf8df88a44a818f57034d22e78"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><div class="compoundTemplParams">template<typename Type, bool Checked, std::size_t Get, std::size_t Exclude><br />
|
|
class entt::basic_common_view< Type, Checked, Get, Exclude ></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">Checked</td><td>True to enable the tombstone check, false otherwise. </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#l00233">233</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="ad2a9d4a491583d833ffc421a3913f982" name="ad2a9d4a491583d833ffc421a3913f982"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad2a9d4a491583d833ffc421a3913f982">◆ </a></span>common_type</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type, bool Checked, std::size_t Get, std::size_t Exclude> </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">using <a class="el" href="classentt_1_1basic__common__view.html">entt::basic_common_view</a>< Type, Checked, Get, Exclude >::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#l00301">301</a> of file <a class="el" href="view_8hpp_source.html">view.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a665b5a34eee656129ba04d718a98c05a" name="a665b5a34eee656129ba04d718a98c05a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a665b5a34eee656129ba04d718a98c05a">◆ </a></span>difference_type</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type, bool Checked, std::size_t Get, std::size_t Exclude> </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">using <a class="el" href="classentt_1_1basic__common__view.html">entt::basic_common_view</a>< Type, Checked, Get, Exclude >::difference_type = std::ptrdiff_t</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Signed integer type. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="view_8hpp_source.html#l00307">307</a> of file <a class="el" href="view_8hpp_source.html">view.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2a004edc23118d54d2074fe8a1a1cdd7" name="a2a004edc23118d54d2074fe8a1a1cdd7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2a004edc23118d54d2074fe8a1a1cdd7">◆ </a></span>entity_type</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type, bool Checked, std::size_t Get, std::size_t Exclude> </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">using <a class="el" href="classentt_1_1basic__common__view.html">entt::basic_common_view</a>< Type, Checked, Get, Exclude >::entity_type = typename 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#l00303">303</a> of file <a class="el" href="view_8hpp_source.html">view.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac1779f77c4f07bd1db2479b9557be325" name="ac1779f77c4f07bd1db2479b9557be325"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac1779f77c4f07bd1db2479b9557be325">◆ </a></span>iterator</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type, bool Checked, std::size_t Get, std::size_t Exclude> </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">using <a class="el" href="classentt_1_1basic__common__view.html">entt::basic_common_view</a>< Type, Checked, Get, Exclude >::iterator = internal::view_iterator<<a class="el" href="#ad2a9d4a491583d833ffc421a3913f982">common_type</a>, Checked, Get, Exclude></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#l00309">309</a> of file <a class="el" href="view_8hpp_source.html">view.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af8a47cbe23041f655e46986cd82f7e39" name="af8a47cbe23041f655e46986cd82f7e39"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af8a47cbe23041f655e46986cd82f7e39">◆ </a></span>size_type</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type, bool Checked, std::size_t Get, std::size_t Exclude> </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">using <a class="el" href="classentt_1_1basic__common__view.html">entt::basic_common_view</a>< Type, Checked, Get, Exclude >::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#l00305">305</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="a63c2d833d41810b5a5b28ecf653dc056" name="a63c2d833d41810b5a5b28ecf653dc056"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a63c2d833d41810b5a5b28ecf653dc056">◆ </a></span>back()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type, bool Checked, std::size_t Get, std::size_t Exclude> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="#a2a004edc23118d54d2074fe8a1a1cdd7">entity_type</a> <a class="el" href="classentt_1_1basic__common__view.html">entt::basic_common_view</a>< Type, Checked, Get, Exclude >::back </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel nodiscard">nodiscard</span><span class="mlabel noexcept">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#l00371">371</a> of file <a class="el" href="view_8hpp_source.html">view.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2007dc390b50ccc73a6d1ef6557d762b" name="a2007dc390b50ccc73a6d1ef6557d762b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2007dc390b50ccc73a6d1ef6557d762b">◆ </a></span>begin()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type, bool Checked, std::size_t Get, std::size_t Exclude> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="#ac1779f77c4f07bd1db2479b9557be325">iterator</a> <a class="el" href="classentt_1_1basic__common__view.html">entt::basic_common_view</a>< Type, Checked, Get, Exclude >::begin </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel nodiscard">nodiscard</span><span class="mlabel noexcept">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="#acf2805f088e1f44931e00a4548782dce" 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#l00344">344</a> of file <a class="el" href="view_8hpp_source.html">view.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5639cffd5495c9dd1a94cc2a4839fe9f" name="a5639cffd5495c9dd1a94cc2a4839fe9f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5639cffd5495c9dd1a94cc2a4839fe9f">◆ </a></span>contains()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type, bool Checked, std::size_t Get, std::size_t Exclude> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="classentt_1_1basic__common__view.html">entt::basic_common_view</a>< Type, Checked, Get, Exclude >::contains </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="#a2a004edc23118d54d2074fe8a1a1cdd7">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">inline</span><span class="mlabel nodiscard">nodiscard</span><span class="mlabel noexcept">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#l00405">405</a> of file <a class="el" href="view_8hpp_source.html">view.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="acf2805f088e1f44931e00a4548782dce" name="acf2805f088e1f44931e00a4548782dce"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acf2805f088e1f44931e00a4548782dce">◆ </a></span>end()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type, bool Checked, std::size_t Get, std::size_t Exclude> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="#ac1779f77c4f07bd1db2479b9557be325">iterator</a> <a class="el" href="classentt_1_1basic__common__view.html">entt::basic_common_view</a>< Type, Checked, Get, Exclude >::end </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel nodiscard">nodiscard</span><span class="mlabel noexcept">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#l00352">352</a> of file <a class="el" href="view_8hpp_source.html">view.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a206be195c1f69d1a06894af690b3f768" name="a206be195c1f69d1a06894af690b3f768"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a206be195c1f69d1a06894af690b3f768">◆ </a></span>find()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type, bool Checked, std::size_t Get, std::size_t Exclude> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="#ac1779f77c4f07bd1db2479b9557be325">iterator</a> <a class="el" href="classentt_1_1basic__common__view.html">entt::basic_common_view</a>< Type, Checked, Get, Exclude >::find </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="#a2a004edc23118d54d2074fe8a1a1cdd7">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">inline</span><span class="mlabel nodiscard">nodiscard</span><span class="mlabel noexcept">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#l00388">388</a> of file <a class="el" href="view_8hpp_source.html">view.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a94855cfbd9b0c88fdfb2161b0c5753bc" name="a94855cfbd9b0c88fdfb2161b0c5753bc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a94855cfbd9b0c88fdfb2161b0c5753bc">◆ </a></span>front()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type, bool Checked, std::size_t Get, std::size_t Exclude> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="#a2a004edc23118d54d2074fe8a1a1cdd7">entity_type</a> <a class="el" href="classentt_1_1basic__common__view.html">entt::basic_common_view</a>< Type, Checked, Get, Exclude >::front </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel nodiscard">nodiscard</span><span class="mlabel noexcept">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#l00361">361</a> of file <a class="el" href="view_8hpp_source.html">view.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2aff92b331b0ca09fc2dc6006261fa2f" name="a2aff92b331b0ca09fc2dc6006261fa2f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2aff92b331b0ca09fc2dc6006261fa2f">◆ </a></span>handle()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type, bool Checked, std::size_t Get, std::size_t Exclude> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const <a class="el" href="#ad2a9d4a491583d833ffc421a3913f982">common_type</a> * <a class="el" href="classentt_1_1basic__common__view.html">entt::basic_common_view</a>< Type, Checked, Get, Exclude >::handle </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel nodiscard">nodiscard</span><span class="mlabel noexcept">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#l00325">325</a> of file <a class="el" href="view_8hpp_source.html">view.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae300d448aaf4ef7330fb7b635e5877a4" name="ae300d448aaf4ef7330fb7b635e5877a4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae300d448aaf4ef7330fb7b635e5877a4">◆ </a></span>operator bool()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type, bool Checked, std::size_t Get, std::size_t Exclude> </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>< Type, Checked, Get, Exclude >::operator bool </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel explicit">explicit</span><span class="mlabel nodiscard">nodiscard</span><span class="mlabel noexcept">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#l00396">396</a> of file <a class="el" href="view_8hpp_source.html">view.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6455db81193b2e9ce830e2ed95ae0795" name="a6455db81193b2e9ce830e2ed95ae0795"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6455db81193b2e9ce830e2ed95ae0795">◆ </a></span>refresh()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type, bool Checked, std::size_t Get, std::size_t Exclude> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classentt_1_1basic__common__view.html">entt::basic_common_view</a>< Type, Checked, Get, Exclude >::refresh </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel noexcept">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#l00312">312</a> of file <a class="el" href="view_8hpp_source.html">view.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4f4d649b5d2a9d823f93125450d38fc8" name="a4f4d649b5d2a9d823f93125450d38fc8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4f4d649b5d2a9d823f93125450d38fc8">◆ </a></span>size_hint()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type, bool Checked, std::size_t Get, std::size_t Exclude> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="#af8a47cbe23041f655e46986cd82f7e39">size_type</a> <a class="el" href="classentt_1_1basic__common__view.html">entt::basic_common_view</a>< Type, Checked, Get, Exclude >::size_hint </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel nodiscard">nodiscard</span><span class="mlabel noexcept">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#l00333">333</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 <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.2
|
|
</small></address>
|
|
</div><!-- doc-content -->
|
|
</body>
|
|
</html>
|