Scarfski/entt
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
6fdc43199ce25a0cc26cf8f7f43274d84bb33014
entt/structentt_1_1meta__range.html
Michele Caini 6fdc43199c API reference v3.9.0
2021-12-21 13:20:51 +01:00

312 lines
17 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>EnTT: entt::meta_range&lt; Type, Node &gt; Struct Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">EnTT
&#160;<span id="projectnumber">3.9.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceentt.html">entt</a></li><li class="navelem"><a class="el" href="structentt_1_1meta__range.html">meta_range</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="structentt_1_1meta__range-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">entt::meta_range&lt; Type, Node &gt; Struct Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Iterable range to use to iterate all types of meta objects.
<a href="structentt_1_1meta__range.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="range_8hpp_source.html">range.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a432a47eca3a3f2615a989f74d45b08d8"><td class="memItemLeft" align="right" valign="top"><a id="a432a47eca3a3f2615a989f74d45b08d8"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__range.html#a432a47eca3a3f2615a989f74d45b08d8">node_type</a> = Node</td></tr>
<tr class="memdesc:a432a47eca3a3f2615a989f74d45b08d8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Node type. <br /></td></tr>
<tr class="separator:a432a47eca3a3f2615a989f74d45b08d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae7ab3712220f7a5ab04b14ecdccf8abd"><td class="memItemLeft" align="right" valign="top"><a id="ae7ab3712220f7a5ab04b14ecdccf8abd"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__range.html#ae7ab3712220f7a5ab04b14ecdccf8abd">iterator</a> = internal::meta_range_iterator&lt; Type, Node &gt;</td></tr>
<tr class="memdesc:ae7ab3712220f7a5ab04b14ecdccf8abd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Input iterator type. <br /></td></tr>
<tr class="separator:ae7ab3712220f7a5ab04b14ecdccf8abd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a28dd40f858f770c7e4bb03bfcf6ade2b"><td class="memItemLeft" align="right" valign="top"><a id="a28dd40f858f770c7e4bb03bfcf6ade2b"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__range.html#a28dd40f858f770c7e4bb03bfcf6ade2b">const_iterator</a> = <a class="el" href="structentt_1_1meta__range.html#ae7ab3712220f7a5ab04b14ecdccf8abd">iterator</a></td></tr>
<tr class="memdesc:a28dd40f858f770c7e4bb03bfcf6ade2b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constant input iterator type. <br /></td></tr>
<tr class="separator:a28dd40f858f770c7e4bb03bfcf6ade2b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ab8064a6fa2209baf3af9501230165615"><td class="memItemLeft" align="right" valign="top"><a id="ab8064a6fa2209baf3af9501230165615"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__range.html#ab8064a6fa2209baf3af9501230165615">meta_range</a> ()=default</td></tr>
<tr class="memdesc:ab8064a6fa2209baf3af9501230165615"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor. <br /></td></tr>
<tr class="separator:ab8064a6fa2209baf3af9501230165615"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa9eb66c65013ff00985f88e956360511"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__range.html#aa9eb66c65013ff00985f88e956360511">meta_range</a> (<a class="el" href="structentt_1_1meta__range.html#a432a47eca3a3f2615a989f74d45b08d8">node_type</a> *head)</td></tr>
<tr class="memdesc:aa9eb66c65013ff00985f88e956360511"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a meta range from a given node. <a href="structentt_1_1meta__range.html#aa9eb66c65013ff00985f88e956360511">More...</a><br /></td></tr>
<tr class="separator:aa9eb66c65013ff00985f88e956360511"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1e6679691bb8b102dc742dc7d8794c15"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structentt_1_1meta__range.html#a28dd40f858f770c7e4bb03bfcf6ade2b">const_iterator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__range.html#a1e6679691bb8b102dc742dc7d8794c15">cbegin</a> () const</td></tr>
<tr class="memdesc:a1e6679691bb8b102dc742dc7d8794c15"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns an iterator to the beginning. <a href="structentt_1_1meta__range.html#a1e6679691bb8b102dc742dc7d8794c15">More...</a><br /></td></tr>
<tr class="separator:a1e6679691bb8b102dc742dc7d8794c15"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ada1265752a1413ea58af92dc80e6ac77"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structentt_1_1meta__range.html#ae7ab3712220f7a5ab04b14ecdccf8abd">iterator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__range.html#ada1265752a1413ea58af92dc80e6ac77">begin</a> () const</td></tr>
<tr class="memdesc:ada1265752a1413ea58af92dc80e6ac77"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns an iterator to the beginning. <a href="structentt_1_1meta__range.html#ada1265752a1413ea58af92dc80e6ac77">More...</a><br /></td></tr>
<tr class="separator:ada1265752a1413ea58af92dc80e6ac77"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a56dc6086d89e868639de03ebe41d4a65"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structentt_1_1meta__range.html#a28dd40f858f770c7e4bb03bfcf6ade2b">const_iterator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__range.html#a56dc6086d89e868639de03ebe41d4a65">cend</a> () const</td></tr>
<tr class="memdesc:a56dc6086d89e868639de03ebe41d4a65"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns an iterator to the end. <a href="structentt_1_1meta__range.html#a56dc6086d89e868639de03ebe41d4a65">More...</a><br /></td></tr>
<tr class="separator:a56dc6086d89e868639de03ebe41d4a65"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a57c7d271b68054016e4430c9859a6d43"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structentt_1_1meta__range.html#ae7ab3712220f7a5ab04b14ecdccf8abd">iterator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__range.html#a57c7d271b68054016e4430c9859a6d43">end</a> () const</td></tr>
<tr class="memdesc:a57c7d271b68054016e4430c9859a6d43"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns an iterator to the end. <a href="structentt_1_1meta__range.html#a57c7d271b68054016e4430c9859a6d43">More...</a><br /></td></tr>
<tr class="separator:a57c7d271b68054016e4430c9859a6d43"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename Type, typename Node = typename Type::node_type&gt;<br />
struct entt::meta_range&lt; Type, Node &gt;</h3>
<p>Iterable range to use to iterate all types of meta objects. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Type</td><td>Type of meta objects returned. </td></tr>
<tr><td class="paramname">Node</td><td>Type of meta nodes iterated. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="range_8hpp_source.html#l00073">73</a> of file <a class="el" href="range_8hpp_source.html">range.hpp</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="aa9eb66c65013ff00985f88e956360511"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa9eb66c65013ff00985f88e956360511">&#9670;&nbsp;</a></span>meta_range()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Type , typename Node = typename Type::node_type&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structentt_1_1meta__range.html">entt::meta_range</a>&lt; Type, Node &gt;::<a class="el" href="structentt_1_1meta__range.html">meta_range</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structentt_1_1meta__range.html#a432a47eca3a3f2615a989f74d45b08d8">node_type</a> *&#160;</td>
<td class="paramname"><em>head</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs a meta range from a given node. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">head</td><td>The underlying node with which to construct the range. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="range_8hpp_source.html#l00088">88</a> of file <a class="el" href="range_8hpp_source.html">range.hpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ada1265752a1413ea58af92dc80e6ac77"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ada1265752a1413ea58af92dc80e6ac77">&#9670;&nbsp;</a></span>begin()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Type , typename Node = typename Type::node_type&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structentt_1_1meta__range.html#ae7ab3712220f7a5ab04b14ecdccf8abd">iterator</a> <a class="el" href="structentt_1_1meta__range.html">entt::meta_range</a>&lt; Type, Node &gt;::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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns an iterator to the beginning. </p>
<dl class="section return"><dt>Returns</dt><dd>An iterator to the first meta object of the range. </dd></dl>
<p class="definition">Definition at line <a class="el" href="range_8hpp_source.html#l00100">100</a> of file <a class="el" href="range_8hpp_source.html">range.hpp</a>.</p>
</div>
</div>
<a id="a1e6679691bb8b102dc742dc7d8794c15"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1e6679691bb8b102dc742dc7d8794c15">&#9670;&nbsp;</a></span>cbegin()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Type , typename Node = typename Type::node_type&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structentt_1_1meta__range.html#a28dd40f858f770c7e4bb03bfcf6ade2b">const_iterator</a> <a class="el" href="structentt_1_1meta__range.html">entt::meta_range</a>&lt; Type, Node &gt;::cbegin </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns an iterator to the beginning. </p>
<dl class="section return"><dt>Returns</dt><dd>An iterator to the first meta object of the range. </dd></dl>
<p class="definition">Definition at line <a class="el" href="range_8hpp_source.html#l00095">95</a> of file <a class="el" href="range_8hpp_source.html">range.hpp</a>.</p>
</div>
</div>
<a id="a56dc6086d89e868639de03ebe41d4a65"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a56dc6086d89e868639de03ebe41d4a65">&#9670;&nbsp;</a></span>cend()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Type , typename Node = typename Type::node_type&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structentt_1_1meta__range.html#a28dd40f858f770c7e4bb03bfcf6ade2b">const_iterator</a> <a class="el" href="structentt_1_1meta__range.html">entt::meta_range</a>&lt; Type, Node &gt;::cend </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns an iterator to the end. </p>
<dl class="section return"><dt>Returns</dt><dd>An iterator to the element following the last meta object of the range. </dd></dl>
<p class="definition">Definition at line <a class="el" href="range_8hpp_source.html#l00109">109</a> of file <a class="el" href="range_8hpp_source.html">range.hpp</a>.</p>
</div>
</div>
<a id="a57c7d271b68054016e4430c9859a6d43"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a57c7d271b68054016e4430c9859a6d43">&#9670;&nbsp;</a></span>end()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Type , typename Node = typename Type::node_type&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structentt_1_1meta__range.html#ae7ab3712220f7a5ab04b14ecdccf8abd">iterator</a> <a class="el" href="structentt_1_1meta__range.html">entt::meta_range</a>&lt; Type, Node &gt;::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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns an iterator to the end. </p>
<dl class="section return"><dt>Returns</dt><dd>An iterator to the element following the last meta object of the range. </dd></dl>
<p class="definition">Definition at line <a class="el" href="range_8hpp_source.html#l00114">114</a> of file <a class="el" href="range_8hpp_source.html">range.hpp</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>src/entt/meta/<a class="el" href="range_8hpp_source.html">range.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink