929 lines
54 KiB
HTML
929 lines
54 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_runtime_view< Type, Allocator > 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__runtime__view.html">basic_runtime_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="classentt_1_1basic__runtime__view-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">entt::basic_runtime_view< Type, Allocator > Class Template Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Generic runtime view.
|
|
<a href="#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="runtime__view_8hpp_source.html">runtime_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:ab1a56d98d4a7c875fe7a6fa8d12dec1f" id="r_ab1a56d98d4a7c875fe7a6fa8d12dec1f"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="#ab1a56d98d4a7c875fe7a6fa8d12dec1f">allocator_type</a> = Allocator</td></tr>
|
|
<tr class="memdesc:ab1a56d98d4a7c875fe7a6fa8d12dec1f"><td class="mdescLeft"> </td><td class="mdescRight">Allocator type. <br /></td></tr>
|
|
<tr class="separator:ab1a56d98d4a7c875fe7a6fa8d12dec1f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abb7738cda0849f733d0eab14831b7809" id="r_abb7738cda0849f733d0eab14831b7809"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="#abb7738cda0849f733d0eab14831b7809">entity_type</a> = typename Type::entity_type</td></tr>
|
|
<tr class="memdesc:abb7738cda0849f733d0eab14831b7809"><td class="mdescLeft"> </td><td class="mdescRight">Underlying entity identifier. <br /></td></tr>
|
|
<tr class="separator:abb7738cda0849f733d0eab14831b7809"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af1b166605a31e752ec85b4a5ddf29e64" id="r_af1b166605a31e752ec85b4a5ddf29e64"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="#af1b166605a31e752ec85b4a5ddf29e64">size_type</a> = std::size_t</td></tr>
|
|
<tr class="memdesc:af1b166605a31e752ec85b4a5ddf29e64"><td class="mdescLeft"> </td><td class="mdescRight">Unsigned integer type. <br /></td></tr>
|
|
<tr class="separator:af1b166605a31e752ec85b4a5ddf29e64"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acc80c6c7de3e3020edeb51296050eb43" id="r_acc80c6c7de3e3020edeb51296050eb43"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="#acc80c6c7de3e3020edeb51296050eb43">common_type</a> = Type</td></tr>
|
|
<tr class="memdesc:acc80c6c7de3e3020edeb51296050eb43"><td class="mdescLeft"> </td><td class="mdescRight">Common type among all storage types. <br /></td></tr>
|
|
<tr class="separator:acc80c6c7de3e3020edeb51296050eb43"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a46936cbc64be35947bf709b67cef5f3f" id="r_a46936cbc64be35947bf709b67cef5f3f"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="#a46936cbc64be35947bf709b67cef5f3f">iterator</a> = internal::runtime_view_iterator<<a class="el" href="#acc80c6c7de3e3020edeb51296050eb43">common_type</a>></td></tr>
|
|
<tr class="memdesc:a46936cbc64be35947bf709b67cef5f3f"><td class="mdescLeft"> </td><td class="mdescRight">Bidirectional iterator type. <br /></td></tr>
|
|
<tr class="separator:a46936cbc64be35947bf709b67cef5f3f"><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:a14c8cb432c8ddbf865f79d2765f02400" id="r_a14c8cb432c8ddbf865f79d2765f02400"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a14c8cb432c8ddbf865f79d2765f02400">basic_runtime_view</a> () noexcept</td></tr>
|
|
<tr class="memdesc:a14c8cb432c8ddbf865f79d2765f02400"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor to use to create empty, invalid views. <br /></td></tr>
|
|
<tr class="separator:a14c8cb432c8ddbf865f79d2765f02400"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a262d2b09f30d57e67a6e8028c016b637" id="r_a262d2b09f30d57e67a6e8028c016b637"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a262d2b09f30d57e67a6e8028c016b637">basic_runtime_view</a> (const <a class="el" href="#ab1a56d98d4a7c875fe7a6fa8d12dec1f">allocator_type</a> &allocator)</td></tr>
|
|
<tr class="memdesc:a262d2b09f30d57e67a6e8028c016b637"><td class="mdescLeft"> </td><td class="mdescRight">Constructs an empty, invalid view with a given allocator. <br /></td></tr>
|
|
<tr class="separator:a262d2b09f30d57e67a6e8028c016b637"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0f89fdc9d23992e1c86c3306ad012292" id="r_a0f89fdc9d23992e1c86c3306ad012292"><td class="memItemLeft" align="right" valign="top"><a id="a0f89fdc9d23992e1c86c3306ad012292" name="a0f89fdc9d23992e1c86c3306ad012292"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>basic_runtime_view</b> (const <a class="el" href="classentt_1_1basic__runtime__view.html">basic_runtime_view</a> &)=default</td></tr>
|
|
<tr class="memdesc:a0f89fdc9d23992e1c86c3306ad012292"><td class="mdescLeft"> </td><td class="mdescRight">Default copy constructor. <br /></td></tr>
|
|
<tr class="separator:a0f89fdc9d23992e1c86c3306ad012292"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad96d2f1aaa57c82c9330e8f64f0e83fb" id="r_ad96d2f1aaa57c82c9330e8f64f0e83fb"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ad96d2f1aaa57c82c9330e8f64f0e83fb">basic_runtime_view</a> (const <a class="el" href="classentt_1_1basic__runtime__view.html">basic_runtime_view</a> &other, const <a class="el" href="#ab1a56d98d4a7c875fe7a6fa8d12dec1f">allocator_type</a> &allocator)</td></tr>
|
|
<tr class="memdesc:ad96d2f1aaa57c82c9330e8f64f0e83fb"><td class="mdescLeft"> </td><td class="mdescRight">Allocator-extended copy constructor. <br /></td></tr>
|
|
<tr class="separator:ad96d2f1aaa57c82c9330e8f64f0e83fb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afef04d25b27c5226bb2b0bbf073501cf" id="r_afef04d25b27c5226bb2b0bbf073501cf"><td class="memItemLeft" align="right" valign="top"><a id="afef04d25b27c5226bb2b0bbf073501cf" name="afef04d25b27c5226bb2b0bbf073501cf"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>basic_runtime_view</b> (<a class="el" href="classentt_1_1basic__runtime__view.html">basic_runtime_view</a> &&) noexcept=default</td></tr>
|
|
<tr class="memdesc:afef04d25b27c5226bb2b0bbf073501cf"><td class="mdescLeft"> </td><td class="mdescRight">Default move constructor. <br /></td></tr>
|
|
<tr class="separator:afef04d25b27c5226bb2b0bbf073501cf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae977102b64bd4eff2e1c903bddf58492" id="r_ae977102b64bd4eff2e1c903bddf58492"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ae977102b64bd4eff2e1c903bddf58492">basic_runtime_view</a> (<a class="el" href="classentt_1_1basic__runtime__view.html">basic_runtime_view</a> &&other, const <a class="el" href="#ab1a56d98d4a7c875fe7a6fa8d12dec1f">allocator_type</a> &allocator)</td></tr>
|
|
<tr class="memdesc:ae977102b64bd4eff2e1c903bddf58492"><td class="mdescLeft"> </td><td class="mdescRight">Allocator-extended move constructor. <br /></td></tr>
|
|
<tr class="separator:ae977102b64bd4eff2e1c903bddf58492"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8f374ce6d3122f0ddf71db2f8f8083a8" id="r_a8f374ce6d3122f0ddf71db2f8f8083a8"><td class="memItemLeft" align="right" valign="top"><a id="a8f374ce6d3122f0ddf71db2f8f8083a8" name="a8f374ce6d3122f0ddf71db2f8f8083a8"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>~basic_runtime_view</b> ()=default</td></tr>
|
|
<tr class="memdesc:a8f374ce6d3122f0ddf71db2f8f8083a8"><td class="mdescLeft"> </td><td class="mdescRight">Default destructor. <br /></td></tr>
|
|
<tr class="separator:a8f374ce6d3122f0ddf71db2f8f8083a8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a554579a85e4c40fd1506949c01706c27" id="r_a554579a85e4c40fd1506949c01706c27"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1basic__runtime__view.html">basic_runtime_view</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#a554579a85e4c40fd1506949c01706c27">operator=</a> (const <a class="el" href="classentt_1_1basic__runtime__view.html">basic_runtime_view</a> &)=default</td></tr>
|
|
<tr class="memdesc:a554579a85e4c40fd1506949c01706c27"><td class="mdescLeft"> </td><td class="mdescRight">Default copy assignment operator. <br /></td></tr>
|
|
<tr class="separator:a554579a85e4c40fd1506949c01706c27"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abf9d409908a25e0eb7123a52f803c43b" id="r_abf9d409908a25e0eb7123a52f803c43b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1basic__runtime__view.html">basic_runtime_view</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#abf9d409908a25e0eb7123a52f803c43b">operator=</a> (<a class="el" href="classentt_1_1basic__runtime__view.html">basic_runtime_view</a> &&) noexcept=default</td></tr>
|
|
<tr class="memdesc:abf9d409908a25e0eb7123a52f803c43b"><td class="mdescLeft"> </td><td class="mdescRight">Default move assignment operator. <br /></td></tr>
|
|
<tr class="separator:abf9d409908a25e0eb7123a52f803c43b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adfcdaca31934517a51d1993f0a4f6cfd" id="r_adfcdaca31934517a51d1993f0a4f6cfd"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#adfcdaca31934517a51d1993f0a4f6cfd">swap</a> (<a class="el" href="classentt_1_1basic__runtime__view.html">basic_runtime_view</a> &other) noexcept</td></tr>
|
|
<tr class="memdesc:adfcdaca31934517a51d1993f0a4f6cfd"><td class="mdescLeft"> </td><td class="mdescRight">Exchanges the contents with those of a given view. <br /></td></tr>
|
|
<tr class="separator:adfcdaca31934517a51d1993f0a4f6cfd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7461d8fe5d56fa8d1c5ec997f2b086c6" id="r_a7461d8fe5d56fa8d1c5ec997f2b086c6"><td class="memItemLeft" align="right" valign="top">constexpr <a class="el" href="#ab1a56d98d4a7c875fe7a6fa8d12dec1f">allocator_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a7461d8fe5d56fa8d1c5ec997f2b086c6">get_allocator</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a7461d8fe5d56fa8d1c5ec997f2b086c6"><td class="mdescLeft"> </td><td class="mdescRight">Returns the associated allocator. <br /></td></tr>
|
|
<tr class="separator:a7461d8fe5d56fa8d1c5ec997f2b086c6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aba28ae42bd739ad6ffe2951f9213c7cd" id="r_aba28ae42bd739ad6ffe2951f9213c7cd"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#aba28ae42bd739ad6ffe2951f9213c7cd">clear</a> ()</td></tr>
|
|
<tr class="memdesc:aba28ae42bd739ad6ffe2951f9213c7cd"><td class="mdescLeft"> </td><td class="mdescRight">Clears the view. <br /></td></tr>
|
|
<tr class="separator:aba28ae42bd739ad6ffe2951f9213c7cd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae3d9cd9d4afe45ab70b76902ff600e20" id="r_ae3d9cd9d4afe45ab70b76902ff600e20"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1basic__runtime__view.html">basic_runtime_view</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#ae3d9cd9d4afe45ab70b76902ff600e20">iterate</a> (<a class="el" href="#acc80c6c7de3e3020edeb51296050eb43">common_type</a> &base)</td></tr>
|
|
<tr class="memdesc:ae3d9cd9d4afe45ab70b76902ff600e20"><td class="mdescLeft"> </td><td class="mdescRight">Appends an opaque storage object to a runtime view. <br /></td></tr>
|
|
<tr class="separator:ae3d9cd9d4afe45ab70b76902ff600e20"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a96aac4e03af23f9c49900f43a8b6d6b8" id="r_a96aac4e03af23f9c49900f43a8b6d6b8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1basic__runtime__view.html">basic_runtime_view</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#a96aac4e03af23f9c49900f43a8b6d6b8">exclude</a> (<a class="el" href="#acc80c6c7de3e3020edeb51296050eb43">common_type</a> &base)</td></tr>
|
|
<tr class="memdesc:a96aac4e03af23f9c49900f43a8b6d6b8"><td class="mdescLeft"> </td><td class="mdescRight">Adds an opaque storage object as a filter of a runtime view. <br /></td></tr>
|
|
<tr class="separator:a96aac4e03af23f9c49900f43a8b6d6b8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acc18bd1f09d3df3e0373e8024601e2b2" id="r_acc18bd1f09d3df3e0373e8024601e2b2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#af1b166605a31e752ec85b4a5ddf29e64">size_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#acc18bd1f09d3df3e0373e8024601e2b2">size_hint</a> () const</td></tr>
|
|
<tr class="memdesc:acc18bd1f09d3df3e0373e8024601e2b2"><td class="mdescLeft"> </td><td class="mdescRight">Estimates the number of entities iterated by the view. <br /></td></tr>
|
|
<tr class="separator:acc18bd1f09d3df3e0373e8024601e2b2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a140fca2ae84d1dcb861f4b106cd75f29" id="r_a140fca2ae84d1dcb861f4b106cd75f29"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a46936cbc64be35947bf709b67cef5f3f">iterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a140fca2ae84d1dcb861f4b106cd75f29">begin</a> () const</td></tr>
|
|
<tr class="memdesc:a140fca2ae84d1dcb861f4b106cd75f29"><td class="mdescLeft"> </td><td class="mdescRight">Returns an iterator to the first entity that has the given elements. <br /></td></tr>
|
|
<tr class="separator:a140fca2ae84d1dcb861f4b106cd75f29"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abd8f3fcaf66b7ee4cb033aa9ba13b807" id="r_abd8f3fcaf66b7ee4cb033aa9ba13b807"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a46936cbc64be35947bf709b67cef5f3f">iterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#abd8f3fcaf66b7ee4cb033aa9ba13b807">end</a> () const</td></tr>
|
|
<tr class="memdesc:abd8f3fcaf66b7ee4cb033aa9ba13b807"><td class="mdescLeft"> </td><td class="mdescRight">Returns an iterator that is past the last entity that has the given elements. <br /></td></tr>
|
|
<tr class="separator:abd8f3fcaf66b7ee4cb033aa9ba13b807"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae60420edc7a111866fd4164d060cc513" id="r_ae60420edc7a111866fd4164d060cc513"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ae60420edc7a111866fd4164d060cc513">operator bool</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:ae60420edc7a111866fd4164d060cc513"><td class="mdescLeft"> </td><td class="mdescRight">Checks whether a view is initialized or not. <br /></td></tr>
|
|
<tr class="separator:ae60420edc7a111866fd4164d060cc513"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8ff8f51d9d329fd39633960e1f79994f" id="r_a8ff8f51d9d329fd39633960e1f79994f"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#a8ff8f51d9d329fd39633960e1f79994f">contains</a> (const <a class="el" href="#abb7738cda0849f733d0eab14831b7809">entity_type</a> entt) const</td></tr>
|
|
<tr class="memdesc:a8ff8f51d9d329fd39633960e1f79994f"><td class="mdescLeft"> </td><td class="mdescRight">Checks if a view contains an entity. <br /></td></tr>
|
|
<tr class="separator:a8ff8f51d9d329fd39633960e1f79994f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9477a9767c87dee34b144b687dfa66ae" id="r_a9477a9767c87dee34b144b687dfa66ae"><td class="memTemplParams" colspan="2">template<typename Func> </td></tr>
|
|
<tr class="memitem:a9477a9767c87dee34b144b687dfa66ae"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a9477a9767c87dee34b144b687dfa66ae">each</a> (Func func) const</td></tr>
|
|
<tr class="memdesc:a9477a9767c87dee34b144b687dfa66ae"><td class="mdescLeft"> </td><td class="mdescRight">Iterates entities and applies the given function object to them. <br /></td></tr>
|
|
<tr class="separator:a9477a9767c87dee34b144b687dfa66ae"><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, typename Allocator><br />
|
|
class entt::basic_runtime_view< Type, Allocator ></div><p>Generic runtime view. </p>
|
|
<p>Runtime views iterate over those entities that are at least in the given storage. During initialization, a runtime view looks at the number of entities available for each element and uses the smallest set in order to get a performance boost when iterating.</p>
|
|
<p><b>Important</b> </p>
|
|
<p>Iterators aren't invalidated if:</p>
|
|
<ul>
|
|
<li>New elements are added to the storage.</li>
|
|
<li>The entity currently pointed is modified (for example, elements are added or removed from it).</li>
|
|
<li>The entity currently pointed is destroyed.</li>
|
|
</ul>
|
|
<p>In all other cases, modifying the storage iterated by the view in any way invalidates all the iterators.</p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">Type</td><td>Common base type. </td></tr>
|
|
<tr><td class="paramname">Allocator</td><td>Type of allocator used to manage memory and elements. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="runtime__view_8hpp_source.html#l00124">124</a> of file <a class="el" href="runtime__view_8hpp_source.html">runtime_view.hpp</a>.</p>
|
|
</div><h2 class="groupheader">Member Typedef Documentation</h2>
|
|
<a id="ab1a56d98d4a7c875fe7a6fa8d12dec1f" name="ab1a56d98d4a7c875fe7a6fa8d12dec1f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab1a56d98d4a7c875fe7a6fa8d12dec1f">◆ </a></span>allocator_type</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type, typename Allocator> </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">using <a class="el" href="classentt_1_1basic__runtime__view.html">entt::basic_runtime_view</a>< Type, Allocator >::allocator_type = Allocator</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Allocator type. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="runtime__view_8hpp_source.html#l00131">131</a> of file <a class="el" href="runtime__view_8hpp_source.html">runtime_view.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="acc80c6c7de3e3020edeb51296050eb43" name="acc80c6c7de3e3020edeb51296050eb43"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acc80c6c7de3e3020edeb51296050eb43">◆ </a></span>common_type</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type, typename Allocator> </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">using <a class="el" href="classentt_1_1basic__runtime__view.html">entt::basic_runtime_view</a>< Type, Allocator >::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="runtime__view_8hpp_source.html#l00137">137</a> of file <a class="el" href="runtime__view_8hpp_source.html">runtime_view.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abb7738cda0849f733d0eab14831b7809" name="abb7738cda0849f733d0eab14831b7809"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abb7738cda0849f733d0eab14831b7809">◆ </a></span>entity_type</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type, typename Allocator> </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">using <a class="el" href="classentt_1_1basic__runtime__view.html">entt::basic_runtime_view</a>< Type, Allocator >::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="runtime__view_8hpp_source.html#l00133">133</a> of file <a class="el" href="runtime__view_8hpp_source.html">runtime_view.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a46936cbc64be35947bf709b67cef5f3f" name="a46936cbc64be35947bf709b67cef5f3f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a46936cbc64be35947bf709b67cef5f3f">◆ </a></span>iterator</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type, typename Allocator> </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">using <a class="el" href="classentt_1_1basic__runtime__view.html">entt::basic_runtime_view</a>< Type, Allocator >::iterator = internal::runtime_view_iterator<<a class="el" href="#acc80c6c7de3e3020edeb51296050eb43">common_type</a>></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Bidirectional iterator type. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="runtime__view_8hpp_source.html#l00139">139</a> of file <a class="el" href="runtime__view_8hpp_source.html">runtime_view.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af1b166605a31e752ec85b4a5ddf29e64" name="af1b166605a31e752ec85b4a5ddf29e64"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af1b166605a31e752ec85b4a5ddf29e64">◆ </a></span>size_type</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type, typename Allocator> </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">using <a class="el" href="classentt_1_1basic__runtime__view.html">entt::basic_runtime_view</a>< Type, Allocator >::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="runtime__view_8hpp_source.html#l00135">135</a> of file <a class="el" href="runtime__view_8hpp_source.html">runtime_view.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a14c8cb432c8ddbf865f79d2765f02400" name="a14c8cb432c8ddbf865f79d2765f02400"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a14c8cb432c8ddbf865f79d2765f02400">◆ </a></span>basic_runtime_view() <span class="overload">[1/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type, typename Allocator> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1basic__runtime__view.html">entt::basic_runtime_view</a>< Type, Allocator >::basic_runtime_view </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>Default constructor to use to create empty, invalid views. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="runtime__view_8hpp_source.html#l00142">142</a> of file <a class="el" href="runtime__view_8hpp_source.html">runtime_view.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a262d2b09f30d57e67a6e8028c016b637" name="a262d2b09f30d57e67a6e8028c016b637"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a262d2b09f30d57e67a6e8028c016b637">◆ </a></span>basic_runtime_view() <span class="overload">[2/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type, typename Allocator> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1basic__runtime__view.html">entt::basic_runtime_view</a>< Type, Allocator >::basic_runtime_view </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="#ab1a56d98d4a7c875fe7a6fa8d12dec1f">allocator_type</a> &</td> <td class="paramname"><span class="paramname"><em>allocator</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 explicit">explicit</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Constructs an empty, invalid view with a given allocator. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">allocator</td><td>The allocator to use. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="runtime__view_8hpp_source.html#l00149">149</a> of file <a class="el" href="runtime__view_8hpp_source.html">runtime_view.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad96d2f1aaa57c82c9330e8f64f0e83fb" name="ad96d2f1aaa57c82c9330e8f64f0e83fb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad96d2f1aaa57c82c9330e8f64f0e83fb">◆ </a></span>basic_runtime_view() <span class="overload">[3/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type, typename Allocator> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1basic__runtime__view.html">entt::basic_runtime_view</a>< Type, Allocator >::basic_runtime_view </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classentt_1_1basic__runtime__view.html">basic_runtime_view</a>< Type, Allocator > &</td> <td class="paramname"><span class="paramname"><em>other</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="#ab1a56d98d4a7c875fe7a6fa8d12dec1f">allocator_type</a> &</td> <td class="paramname"><span class="paramname"><em>allocator</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Allocator-extended copy constructor. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">other</td><td>The instance to copy from. </td></tr>
|
|
<tr><td class="paramname">allocator</td><td>The allocator to use. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="runtime__view_8hpp_source.html#l00161">161</a> of file <a class="el" href="runtime__view_8hpp_source.html">runtime_view.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae977102b64bd4eff2e1c903bddf58492" name="ae977102b64bd4eff2e1c903bddf58492"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae977102b64bd4eff2e1c903bddf58492">◆ </a></span>basic_runtime_view() <span class="overload">[4/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type, typename Allocator> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1basic__runtime__view.html">entt::basic_runtime_view</a>< Type, Allocator >::basic_runtime_view </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classentt_1_1basic__runtime__view.html">basic_runtime_view</a>< Type, Allocator > &&</td> <td class="paramname"><span class="paramname"><em>other</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="#ab1a56d98d4a7c875fe7a6fa8d12dec1f">allocator_type</a> &</td> <td class="paramname"><span class="paramname"><em>allocator</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Allocator-extended move constructor. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">other</td><td>The instance to move from. </td></tr>
|
|
<tr><td class="paramname">allocator</td><td>The allocator to use. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="runtime__view_8hpp_source.html#l00173">173</a> of file <a class="el" href="runtime__view_8hpp_source.html">runtime_view.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a140fca2ae84d1dcb861f4b106cd75f29" name="a140fca2ae84d1dcb861f4b106cd75f29"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a140fca2ae84d1dcb861f4b106cd75f29">◆ </a></span>begin()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type, typename Allocator> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="#a46936cbc64be35947bf709b67cef5f3f">iterator</a> <a class="el" href="classentt_1_1basic__runtime__view.html">entt::basic_runtime_view</a>< Type, Allocator >::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> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns an iterator to the first entity that has the given elements. </p>
|
|
<p>If the view is empty, the returned iterator will be equal to <code><a class="el" href="#abd8f3fcaf66b7ee4cb033aa9ba13b807" title="Returns an iterator that is past the last entity that has the given elements.">end()</a></code>.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>An iterator to the first entity that has the given elements. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="runtime__view_8hpp_source.html#l00257">257</a> of file <a class="el" href="runtime__view_8hpp_source.html">runtime_view.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aba28ae42bd739ad6ffe2951f9213c7cd" name="aba28ae42bd739ad6ffe2951f9213c7cd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aba28ae42bd739ad6ffe2951f9213c7cd">◆ </a></span>clear()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type, typename Allocator> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classentt_1_1basic__runtime__view.html">entt::basic_runtime_view</a>< Type, Allocator >::clear </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> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Clears the view. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="runtime__view_8hpp_source.html#l00211">211</a> of file <a class="el" href="runtime__view_8hpp_source.html">runtime_view.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8ff8f51d9d329fd39633960e1f79994f" name="a8ff8f51d9d329fd39633960e1f79994f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8ff8f51d9d329fd39633960e1f79994f">◆ </a></span>contains()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type, typename Allocator> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool <a class="el" href="classentt_1_1basic__runtime__view.html">entt::basic_runtime_view</a>< Type, Allocator >::contains </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="#abb7738cda0849f733d0eab14831b7809">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> </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="runtime__view_8hpp_source.html#l00284">284</a> of file <a class="el" href="runtime__view_8hpp_source.html">runtime_view.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9477a9767c87dee34b144b687dfa66ae" name="a9477a9767c87dee34b144b687dfa66ae"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9477a9767c87dee34b144b687dfa66ae">◆ </a></span>each()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type, typename Allocator> </div>
|
|
<div class="memtemplate">
|
|
template<typename Func> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classentt_1_1basic__runtime__view.html">entt::basic_runtime_view</a>< Type, Allocator >::each </td>
|
|
<td>(</td>
|
|
<td class="paramtype">Func</td> <td class="paramname"><span class="paramname"><em>func</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> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Iterates entities and applies the given function object to them. </p>
|
|
<p>The function object is invoked for each entity. It is provided only with the entity itself.<br />
|
|
The signature of the function should be equivalent to the following:</p>
|
|
<div class="fragment"><div class="line">void(<span class="keyword">const</span> <a class="code hl_typedef" href="#abb7738cda0849f733d0eab14831b7809">entity_type</a>);</div>
|
|
<div class="ttc" id="aclassentt_1_1basic__runtime__view_html_abb7738cda0849f733d0eab14831b7809"><div class="ttname"><a href="#abb7738cda0849f733d0eab14831b7809">entt::basic_runtime_view::entity_type</a></div><div class="ttdeci">typename Type::entity_type entity_type</div><div class="ttdoc">Underlying entity identifier.</div><div class="ttdef"><b>Definition</b> <a href="runtime__view_8hpp_source.html#l00133">runtime_view.hpp:133</a></div></div>
|
|
</div><!-- fragment --><dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">Func</td><td>Type of the function object to invoke. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">func</td><td>A valid function object. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="runtime__view_8hpp_source.html#l00305">305</a> of file <a class="el" href="runtime__view_8hpp_source.html">runtime_view.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abd8f3fcaf66b7ee4cb033aa9ba13b807" name="abd8f3fcaf66b7ee4cb033aa9ba13b807"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abd8f3fcaf66b7ee4cb033aa9ba13b807">◆ </a></span>end()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type, typename Allocator> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="#a46936cbc64be35947bf709b67cef5f3f">iterator</a> <a class="el" href="classentt_1_1basic__runtime__view.html">entt::basic_runtime_view</a>< Type, Allocator >::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> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns an iterator that is past the last entity that has the given elements. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>An iterator to the entity following the last entity that has the given elements. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="runtime__view_8hpp_source.html#l00267">267</a> of file <a class="el" href="runtime__view_8hpp_source.html">runtime_view.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a96aac4e03af23f9c49900f43a8b6d6b8" name="a96aac4e03af23f9c49900f43a8b6d6b8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a96aac4e03af23f9c49900f43a8b6d6b8">◆ </a></span>exclude()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type, typename Allocator> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1basic__runtime__view.html">basic_runtime_view</a> & <a class="el" href="classentt_1_1basic__runtime__view.html">entt::basic_runtime_view</a>< Type, Allocator >::exclude </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="#acc80c6c7de3e3020edeb51296050eb43">common_type</a> &</td> <td class="paramname"><span class="paramname"><em>base</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Adds an opaque storage object as a filter of a runtime view. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>An opaque reference to a storage object. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>This runtime view. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="runtime__view_8hpp_source.html#l00236">236</a> of file <a class="el" href="runtime__view_8hpp_source.html">runtime_view.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7461d8fe5d56fa8d1c5ec997f2b086c6" name="a7461d8fe5d56fa8d1c5ec997f2b086c6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7461d8fe5d56fa8d1c5ec997f2b086c6">◆ </a></span>get_allocator()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type, typename Allocator> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="#ab1a56d98d4a7c875fe7a6fa8d12dec1f">allocator_type</a> <a class="el" href="classentt_1_1basic__runtime__view.html">entt::basic_runtime_view</a>< Type, Allocator >::get_allocator </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 constexpr">constexpr</span><span class="mlabel noexcept">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the associated allocator. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The associated allocator. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="runtime__view_8hpp_source.html#l00206">206</a> of file <a class="el" href="runtime__view_8hpp_source.html">runtime_view.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae3d9cd9d4afe45ab70b76902ff600e20" name="ae3d9cd9d4afe45ab70b76902ff600e20"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae3d9cd9d4afe45ab70b76902ff600e20">◆ </a></span>iterate()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type, typename Allocator> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1basic__runtime__view.html">basic_runtime_view</a> & <a class="el" href="classentt_1_1basic__runtime__view.html">entt::basic_runtime_view</a>< Type, Allocator >::iterate </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="#acc80c6c7de3e3020edeb51296050eb43">common_type</a> &</td> <td class="paramname"><span class="paramname"><em>base</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Appends an opaque storage object to a runtime view. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">base</td><td>An opaque reference to a storage object. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>This runtime view. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="runtime__view_8hpp_source.html#l00221">221</a> of file <a class="el" href="runtime__view_8hpp_source.html">runtime_view.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae60420edc7a111866fd4164d060cc513" name="ae60420edc7a111866fd4164d060cc513"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae60420edc7a111866fd4164d060cc513">◆ </a></span>operator bool()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type, typename Allocator> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1basic__runtime__view.html">entt::basic_runtime_view</a>< Type, Allocator >::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 whether a view is initialized or not. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if the view is initialized, false otherwise. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="runtime__view_8hpp_source.html#l00275">275</a> of file <a class="el" href="runtime__view_8hpp_source.html">runtime_view.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abf9d409908a25e0eb7123a52f803c43b" name="abf9d409908a25e0eb7123a52f803c43b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abf9d409908a25e0eb7123a52f803c43b">◆ </a></span>operator=() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type, typename Allocator> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1basic__runtime__view.html">basic_runtime_view</a> & <a class="el" href="classentt_1_1basic__runtime__view.html">entt::basic_runtime_view</a>< Type, Allocator >::operator= </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classentt_1_1basic__runtime__view.html">basic_runtime_view</a>< Type, Allocator > &&</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 default">default</span><span class="mlabel noexcept">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Default move assignment operator. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>This runtime view. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a554579a85e4c40fd1506949c01706c27" name="a554579a85e4c40fd1506949c01706c27"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a554579a85e4c40fd1506949c01706c27">◆ </a></span>operator=() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type, typename Allocator> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1basic__runtime__view.html">basic_runtime_view</a> & <a class="el" href="classentt_1_1basic__runtime__view.html">entt::basic_runtime_view</a>< Type, Allocator >::operator= </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classentt_1_1basic__runtime__view.html">basic_runtime_view</a>< Type, Allocator > &</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 default">default</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Default copy assignment operator. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>This runtime view. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="acc18bd1f09d3df3e0373e8024601e2b2" name="acc18bd1f09d3df3e0373e8024601e2b2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acc18bd1f09d3df3e0373e8024601e2b2">◆ </a></span>size_hint()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type, typename Allocator> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="#af1b166605a31e752ec85b4a5ddf29e64">size_type</a> <a class="el" href="classentt_1_1basic__runtime__view.html">entt::basic_runtime_view</a>< Type, Allocator >::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> </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="runtime__view_8hpp_source.html#l00245">245</a> of file <a class="el" href="runtime__view_8hpp_source.html">runtime_view.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="adfcdaca31934517a51d1993f0a4f6cfd" name="adfcdaca31934517a51d1993f0a4f6cfd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adfcdaca31934517a51d1993f0a4f6cfd">◆ </a></span>swap()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type, typename Allocator> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classentt_1_1basic__runtime__view.html">entt::basic_runtime_view</a>< Type, Allocator >::swap </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classentt_1_1basic__runtime__view.html">basic_runtime_view</a>< Type, Allocator > &</td> <td class="paramname"><span class="paramname"><em>other</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>Exchanges the contents with those of a given view. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">other</td><td>View to exchange the content with. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="runtime__view_8hpp_source.html#l00196">196</a> of file <a class="el" href="runtime__view_8hpp_source.html">runtime_view.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>src/entt/entity/<a class="el" href="entity_2fwd_8hpp_source.html">fwd.hpp</a></li>
|
|
<li>src/entt/entity/<a class="el" href="runtime__view_8hpp_source.html">runtime_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>
|