585 lines
33 KiB
HTML
585 lines
33 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.9.7"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>EnTT: entt::basic_common_view< Type, 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>
|
|
<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.13.0</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.7 -->
|
|
<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" 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');
|
|
$(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_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> |
|
|
<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, Get, Exclude > Class Template Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Basic storage view implementation.
|
|
<a href="classentt_1_1basic__common__view.html#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:a49d50a6ed08c233e75b59bc3aed62e46"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__common__view.html#a49d50a6ed08c233e75b59bc3aed62e46">common_type</a> = Type</td></tr>
|
|
<tr class="memdesc:a49d50a6ed08c233e75b59bc3aed62e46"><td class="mdescLeft"> </td><td class="mdescRight">Common type among all storage types. <br /></td></tr>
|
|
<tr class="separator:a49d50a6ed08c233e75b59bc3aed62e46"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adab226b6dd6c5fa0959afe67f17a9c75"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__common__view.html#adab226b6dd6c5fa0959afe67f17a9c75">entity_type</a> = typename Type::entity_type</td></tr>
|
|
<tr class="memdesc:adab226b6dd6c5fa0959afe67f17a9c75"><td class="mdescLeft"> </td><td class="mdescRight">Underlying entity identifier. <br /></td></tr>
|
|
<tr class="separator:adab226b6dd6c5fa0959afe67f17a9c75"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa9ae1627c27d445f21b8ddf3db3fe78f"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__common__view.html#aa9ae1627c27d445f21b8ddf3db3fe78f">size_type</a> = std::size_t</td></tr>
|
|
<tr class="memdesc:aa9ae1627c27d445f21b8ddf3db3fe78f"><td class="mdescLeft"> </td><td class="mdescRight">Unsigned integer type. <br /></td></tr>
|
|
<tr class="separator:aa9ae1627c27d445f21b8ddf3db3fe78f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acca0fa3e8c6ca7fb4e3cebb1964ab146"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__common__view.html#acca0fa3e8c6ca7fb4e3cebb1964ab146">iterator</a> = internal::view_iterator< <a class="el" href="classentt_1_1basic__common__view.html#a49d50a6ed08c233e75b59bc3aed62e46">common_type</a>, Get, Exclude ></td></tr>
|
|
<tr class="memdesc:acca0fa3e8c6ca7fb4e3cebb1964ab146"><td class="mdescLeft"> </td><td class="mdescRight">Bidirectional iterator type. <br /></td></tr>
|
|
<tr class="separator:acca0fa3e8c6ca7fb4e3cebb1964ab146"><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:a4572fafa94a210f91cea5a97d5dda3b4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__common__view.html#a4572fafa94a210f91cea5a97d5dda3b4">refresh</a> () noexcept</td></tr>
|
|
<tr class="memdesc:a4572fafa94a210f91cea5a97d5dda3b4"><td class="mdescLeft"> </td><td class="mdescRight">Updates the internal leading view if required. <br /></td></tr>
|
|
<tr class="separator:a4572fafa94a210f91cea5a97d5dda3b4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4d4caecc5dfcf100b0132198fdfe43b3"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classentt_1_1basic__common__view.html#a49d50a6ed08c233e75b59bc3aed62e46">common_type</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__common__view.html#a4d4caecc5dfcf100b0132198fdfe43b3">handle</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a4d4caecc5dfcf100b0132198fdfe43b3"><td class="mdescLeft"> </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"> </td></tr>
|
|
<tr class="memitem:a34fdba8fb0d1d16714b473ac31b0f39d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1basic__common__view.html#aa9ae1627c27d445f21b8ddf3db3fe78f">size_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__common__view.html#a34fdba8fb0d1d16714b473ac31b0f39d">size_hint</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a34fdba8fb0d1d16714b473ac31b0f39d"><td class="mdescLeft"> </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"> </td></tr>
|
|
<tr class="memitem:a51cd2d2c3725b7b4122b594dac974da6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1basic__common__view.html#acca0fa3e8c6ca7fb4e3cebb1964ab146">iterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__common__view.html#a51cd2d2c3725b7b4122b594dac974da6">begin</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a51cd2d2c3725b7b4122b594dac974da6"><td class="mdescLeft"> </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"> </td></tr>
|
|
<tr class="memitem:aac1aa2564ab77156936955392053c61d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1basic__common__view.html#acca0fa3e8c6ca7fb4e3cebb1964ab146">iterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__common__view.html#aac1aa2564ab77156936955392053c61d">end</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:aac1aa2564ab77156936955392053c61d"><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:aac1aa2564ab77156936955392053c61d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7d5614b020a387078f807a58cea0cd90"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1basic__common__view.html#adab226b6dd6c5fa0959afe67f17a9c75">entity_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__common__view.html#a7d5614b020a387078f807a58cea0cd90">front</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a7d5614b020a387078f807a58cea0cd90"><td class="mdescLeft"> </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"> </td></tr>
|
|
<tr class="memitem:a6b0517d50e658cec5c259d0cf1cad8d7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1basic__common__view.html#adab226b6dd6c5fa0959afe67f17a9c75">entity_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__common__view.html#a6b0517d50e658cec5c259d0cf1cad8d7">back</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a6b0517d50e658cec5c259d0cf1cad8d7"><td class="mdescLeft"> </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"> </td></tr>
|
|
<tr class="memitem:abb964d3db8d2476860c91314e6f353b0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1basic__common__view.html#acca0fa3e8c6ca7fb4e3cebb1964ab146">iterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__common__view.html#abb964d3db8d2476860c91314e6f353b0">find</a> (const <a class="el" href="classentt_1_1basic__common__view.html#adab226b6dd6c5fa0959afe67f17a9c75">entity_type</a> entt) const noexcept</td></tr>
|
|
<tr class="memdesc:abb964d3db8d2476860c91314e6f353b0"><td class="mdescLeft"> </td><td class="mdescRight">Finds an entity. <br /></td></tr>
|
|
<tr class="separator:abb964d3db8d2476860c91314e6f353b0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afd888f9d6b8141c3f1b4c1b1334720ac"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__common__view.html#afd888f9d6b8141c3f1b4c1b1334720ac">operator bool</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:afd888f9d6b8141c3f1b4c1b1334720ac"><td class="mdescLeft"> </td><td class="mdescRight">Checks if a view is fully initialized. <br /></td></tr>
|
|
<tr class="separator:afd888f9d6b8141c3f1b4c1b1334720ac"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5123427d3555f05d61b996fe518b78de"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__common__view.html#a5123427d3555f05d61b996fe518b78de">contains</a> (const <a class="el" href="classentt_1_1basic__common__view.html#adab226b6dd6c5fa0959afe67f17a9c75">entity_type</a> entt) const noexcept</td></tr>
|
|
<tr class="memdesc:a5123427d3555f05d61b996fe518b78de"><td class="mdescLeft"> </td><td class="mdescRight">Checks if a view contains an entity. <br /></td></tr>
|
|
<tr class="separator:a5123427d3555f05d61b996fe518b78de"><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:aecc51cdd84ba9fa9ce12ae9e75d85e46"><td class="memTemplParams" colspan="2"><a id="aecc51cdd84ba9fa9ce12ae9e75d85e46" name="aecc51cdd84ba9fa9ce12ae9e75d85e46"></a>
|
|
template<typename Return , typename View , typename Other , std::size_t... VGet, std::size_t... VExclude, std::size_t... OGet, std::size_t... OExclude> </td></tr>
|
|
<tr class="memitem:aecc51cdd84ba9fa9ce12ae9e75d85e46"><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< VGet... >, std::index_sequence< VExclude... >, std::index_sequence< OGet... >, std::index_sequence< OExclude... >)</td></tr>
|
|
<tr class="separator:aecc51cdd84ba9fa9ce12ae9e75d85e46"><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, std::size_t Get, std::size_t Exclude><br />
|
|
class entt::basic_common_view< Type, 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">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#l00217">217</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">◆ </a></span>common_type</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type , 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, 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#l00255">255</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">◆ </a></span>entity_type</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type , 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, 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#l00257">257</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">◆ </a></span>iterator</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type , 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, Get, Exclude >::iterator = internal::view_iterator<<a class="el" href="classentt_1_1basic__common__view.html#a49d50a6ed08c233e75b59bc3aed62e46">common_type</a>, Get, Exclude></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Bidirectional iterator type. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="view_8hpp_source.html#l00261">261</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">◆ </a></span>size_type</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type , 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, 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#l00259">259</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">◆ </a></span>back()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type , 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#adab226b6dd6c5fa0959afe67f17a9c75">entity_type</a> <a class="el" href="classentt_1_1basic__common__view.html">entt::basic_common_view</a>< Type, Get, Exclude >::back </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 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#l00323">323</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">◆ </a></span>begin()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type , 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#acca0fa3e8c6ca7fb4e3cebb1964ab146">iterator</a> <a class="el" href="classentt_1_1basic__common__view.html">entt::basic_common_view</a>< Type, Get, Exclude >::begin </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 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="classentt_1_1basic__common__view.html#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#l00296">296</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">◆ </a></span>contains()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type , 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, Get, Exclude >::contains </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classentt_1_1basic__common__view.html#adab226b6dd6c5fa0959afe67f17a9c75">entity_type</a> </td>
|
|
<td class="paramname"><em>entt</em></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#l00357">357</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">◆ </a></span>end()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type , 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#acca0fa3e8c6ca7fb4e3cebb1964ab146">iterator</a> <a class="el" href="classentt_1_1basic__common__view.html">entt::basic_common_view</a>< Type, Get, Exclude >::end </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 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#l00304">304</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">◆ </a></span>find()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type , 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#acca0fa3e8c6ca7fb4e3cebb1964ab146">iterator</a> <a class="el" href="classentt_1_1basic__common__view.html">entt::basic_common_view</a>< Type, Get, Exclude >::find </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classentt_1_1basic__common__view.html#adab226b6dd6c5fa0959afe67f17a9c75">entity_type</a> </td>
|
|
<td class="paramname"><em>entt</em></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#l00340">340</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">◆ </a></span>front()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type , 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#adab226b6dd6c5fa0959afe67f17a9c75">entity_type</a> <a class="el" href="classentt_1_1basic__common__view.html">entt::basic_common_view</a>< Type, Get, Exclude >::front </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 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#l00313">313</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">◆ </a></span>handle()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type , 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="classentt_1_1basic__common__view.html#a49d50a6ed08c233e75b59bc3aed62e46">common_type</a> * <a class="el" href="classentt_1_1basic__common__view.html">entt::basic_common_view</a>< Type, Get, Exclude >::handle </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 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#l00277">277</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">◆ </a></span>operator bool()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type , 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, Get, Exclude >::operator bool </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 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#l00348">348</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">◆ </a></span>refresh()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type , 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, Get, Exclude >::refresh </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">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#l00264">264</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">◆ </a></span>size_hint()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type , 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#aa9ae1627c27d445f21b8ddf3db3fe78f">size_type</a> <a class="el" href="classentt_1_1basic__common__view.html">entt::basic_common_view</a>< Type, Get, Exclude >::size_hint </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 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#l00285">285</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.9.7
|
|
</small></address>
|
|
</body>
|
|
</html>
|