Scarfski/entt
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
1546c8982e6172a6f01334caaeb89a32bb494004
entt/structentt_1_1basic__organizer_1_1vertex.html
Michele Caini 1546c8982e API reference v3.8.0
2021-07-21 14:02:37 +02:00

590 lines
31 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::basic_organizer&lt; Entity &gt;::vertex Struct 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.8.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="classentt_1_1basic__organizer.html">basic_organizer</a></li><li class="navelem"><a class="el" href="structentt_1_1basic__organizer_1_1vertex.html">vertex</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="structentt_1_1basic__organizer_1_1vertex-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">entt::basic_organizer&lt; Entity &gt;::vertex Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Vertex type of a task graph defined as an adjacency list.
<a href="structentt_1_1basic__organizer_1_1vertex.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="organizer_8hpp_source.html">organizer.hpp</a>&gt;</code></p>
<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:aa0c8053ba7636d0dd6d6f211b922eba9"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__organizer_1_1vertex.html#aa0c8053ba7636d0dd6d6f211b922eba9">vertex</a> (const bool vtype, vertex_data <a class="el" href="structentt_1_1basic__organizer_1_1vertex.html#a8e60b82f8db48e9bb2a8d0bf9cc5ac17">data</a>, std::vector&lt; std::size_t &gt; edges)</td></tr>
<tr class="memdesc:aa0c8053ba7636d0dd6d6f211b922eba9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a vertex of the task graph. <a href="structentt_1_1basic__organizer_1_1vertex.html#aa0c8053ba7636d0dd6d6f211b922eba9">More...</a><br /></td></tr>
<tr class="separator:aa0c8053ba7636d0dd6d6f211b922eba9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a178e6d3f6243441c9c5fd24112e5ed7b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1basic__organizer.html#afcf528b532b3c41ab06c11d5c82a7260">size_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__organizer_1_1vertex.html#a178e6d3f6243441c9c5fd24112e5ed7b">ro_dependency</a> (<a class="el" href="classentt_1_1type__info.html">type_info</a> *buffer, const std::size_t length) const</td></tr>
<tr class="memdesc:a178e6d3f6243441c9c5fd24112e5ed7b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fills a buffer with the type info objects for the writable resources of a vertex. <a href="structentt_1_1basic__organizer_1_1vertex.html#a178e6d3f6243441c9c5fd24112e5ed7b">More...</a><br /></td></tr>
<tr class="separator:a178e6d3f6243441c9c5fd24112e5ed7b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae6899283d1aecfd1fd4f0f712cb3ed4f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1basic__organizer.html#afcf528b532b3c41ab06c11d5c82a7260">size_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__organizer_1_1vertex.html#ae6899283d1aecfd1fd4f0f712cb3ed4f">rw_dependency</a> (<a class="el" href="classentt_1_1type__info.html">type_info</a> *buffer, const std::size_t length) const</td></tr>
<tr class="memdesc:ae6899283d1aecfd1fd4f0f712cb3ed4f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fills a buffer with the type info objects for the read-only resources of a vertex. <a href="structentt_1_1basic__organizer_1_1vertex.html#ae6899283d1aecfd1fd4f0f712cb3ed4f">More...</a><br /></td></tr>
<tr class="separator:ae6899283d1aecfd1fd4f0f712cb3ed4f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7ac52b2bcd9d4a5fa78b92822fc88418"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1basic__organizer.html#afcf528b532b3c41ab06c11d5c82a7260">size_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__organizer_1_1vertex.html#a7ac52b2bcd9d4a5fa78b92822fc88418">ro_count</a> () const</td></tr>
<tr class="memdesc:a7ac52b2bcd9d4a5fa78b92822fc88418"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the number of read-only resources of a vertex. <a href="structentt_1_1basic__organizer_1_1vertex.html#a7ac52b2bcd9d4a5fa78b92822fc88418">More...</a><br /></td></tr>
<tr class="separator:a7ac52b2bcd9d4a5fa78b92822fc88418"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0d1f98d28191735e9d22cce081f98b02"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1basic__organizer.html#afcf528b532b3c41ab06c11d5c82a7260">size_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__organizer_1_1vertex.html#a0d1f98d28191735e9d22cce081f98b02">rw_count</a> () const</td></tr>
<tr class="memdesc:a0d1f98d28191735e9d22cce081f98b02"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the number of writable resources of a vertex. <a href="structentt_1_1basic__organizer_1_1vertex.html#a0d1f98d28191735e9d22cce081f98b02">More...</a><br /></td></tr>
<tr class="separator:a0d1f98d28191735e9d22cce081f98b02"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a33b714b2096db39c751734aea33ae949"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__organizer_1_1vertex.html#a33b714b2096db39c751734aea33ae949">top_level</a> () const</td></tr>
<tr class="memdesc:a33b714b2096db39c751734aea33ae949"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if a vertex is also a top-level one. <a href="structentt_1_1basic__organizer_1_1vertex.html#a33b714b2096db39c751734aea33ae949">More...</a><br /></td></tr>
<tr class="separator:a33b714b2096db39c751734aea33ae949"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0ade3ec95fdca81a42808ef585453651"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1type__info.html">type_info</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__organizer_1_1vertex.html#a0ade3ec95fdca81a42808ef585453651">info</a> () const</td></tr>
<tr class="memdesc:a0ade3ec95fdca81a42808ef585453651"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a type info object associated with a vertex. <a href="structentt_1_1basic__organizer_1_1vertex.html#a0ade3ec95fdca81a42808ef585453651">More...</a><br /></td></tr>
<tr class="separator:a0ade3ec95fdca81a42808ef585453651"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aacc9f65a7bd16763647677d8b84bb74b"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__organizer_1_1vertex.html#aacc9f65a7bd16763647677d8b84bb74b">name</a> () const</td></tr>
<tr class="memdesc:aacc9f65a7bd16763647677d8b84bb74b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a user defined name associated with a vertex, if any. <a href="structentt_1_1basic__organizer_1_1vertex.html#aacc9f65a7bd16763647677d8b84bb74b">More...</a><br /></td></tr>
<tr class="separator:aacc9f65a7bd16763647677d8b84bb74b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adbda67e21133ac80f05e7131ee00aec2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1basic__organizer.html#a8eb83a2af62a10e9515776b8f26b1edc">function_type</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__organizer_1_1vertex.html#adbda67e21133ac80f05e7131ee00aec2">callback</a> () const</td></tr>
<tr class="memdesc:adbda67e21133ac80f05e7131ee00aec2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the function associated with a vertex. <a href="structentt_1_1basic__organizer_1_1vertex.html#adbda67e21133ac80f05e7131ee00aec2">More...</a><br /></td></tr>
<tr class="separator:adbda67e21133ac80f05e7131ee00aec2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8e60b82f8db48e9bb2a8d0bf9cc5ac17"><td class="memItemLeft" align="right" valign="top">const void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__organizer_1_1vertex.html#a8e60b82f8db48e9bb2a8d0bf9cc5ac17">data</a> () const</td></tr>
<tr class="memdesc:a8e60b82f8db48e9bb2a8d0bf9cc5ac17"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the payload associated with a vertex, if any. <a href="structentt_1_1basic__organizer_1_1vertex.html#a8e60b82f8db48e9bb2a8d0bf9cc5ac17">More...</a><br /></td></tr>
<tr class="separator:a8e60b82f8db48e9bb2a8d0bf9cc5ac17"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9001bb3bbdfa60b8331d45d741a89de5"><td class="memItemLeft" align="right" valign="top">const std::vector&lt; std::size_t &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__organizer_1_1vertex.html#a9001bb3bbdfa60b8331d45d741a89de5">children</a> () const</td></tr>
<tr class="memdesc:a9001bb3bbdfa60b8331d45d741a89de5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the list of nodes reachable from a given vertex. <a href="structentt_1_1basic__organizer_1_1vertex.html#a9001bb3bbdfa60b8331d45d741a89de5">More...</a><br /></td></tr>
<tr class="separator:a9001bb3bbdfa60b8331d45d741a89de5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9208ce46f18ba46229bacbc070fd8eec"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__organizer_1_1vertex.html#a9208ce46f18ba46229bacbc070fd8eec">prepare</a> (<a class="el" href="classentt_1_1basic__registry.html">basic_registry</a>&lt; <a class="el" href="classentt_1_1basic__organizer.html#a36b865f5d3802e48a0fa027c43e3a39c">entity_type</a> &gt; &amp;reg) const</td></tr>
<tr class="memdesc:a9208ce46f18ba46229bacbc070fd8eec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prepares a registry and assures that all required resources are properly instantiated before using them. <a href="structentt_1_1basic__organizer_1_1vertex.html#a9208ce46f18ba46229bacbc070fd8eec">More...</a><br /></td></tr>
<tr class="separator:a9208ce46f18ba46229bacbc070fd8eec"><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 Entity&gt;<br />
struct entt::basic_organizer&lt; Entity &gt;::vertex</h3>
<p>Vertex type of a task graph defined as an adjacency list. </p>
<p class="definition">Definition at line <a class="el" href="organizer_8hpp_source.html#l00255">255</a> of file <a class="el" href="organizer_8hpp_source.html">organizer.hpp</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="aa0c8053ba7636d0dd6d6f211b922eba9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa0c8053ba7636d0dd6d6f211b922eba9">&#9670;&nbsp;</a></span>vertex()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classentt_1_1basic__organizer.html">entt::basic_organizer</a>&lt; Entity &gt;::vertex::vertex </td>
<td>(</td>
<td class="paramtype">const bool&#160;</td>
<td class="paramname"><em>vtype</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">vertex_data&#160;</td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::vector&lt; std::size_t &gt;&#160;</td>
<td class="paramname"><em>edges</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</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 vertex of the task graph. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">vtype</td><td>True if the vertex is a top-level one, false otherwise. </td></tr>
<tr><td class="paramname">data</td><td>The data associated with the vertex. </td></tr>
<tr><td class="paramname">edges</td><td>The indices of the children in the adjacency list. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="organizer_8hpp_source.html#l00262">262</a> of file <a class="el" href="organizer_8hpp_source.html">organizer.hpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="adbda67e21133ac80f05e7131ee00aec2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adbda67e21133ac80f05e7131ee00aec2">&#9670;&nbsp;</a></span>callback()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classentt_1_1basic__organizer.html#a8eb83a2af62a10e9515776b8f26b1edc">function_type</a>* <a class="el" href="classentt_1_1basic__organizer.html">entt::basic_organizer</a>&lt; Entity &gt;::vertex::callback </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 the function associated with a vertex. </p>
<dl class="section return"><dt>Returns</dt><dd>The function associated with the vertex. </dd></dl>
<p class="definition">Definition at line <a class="el" href="organizer_8hpp_source.html#l00334">334</a> of file <a class="el" href="organizer_8hpp_source.html">organizer.hpp</a>.</p>
</div>
</div>
<a id="a9001bb3bbdfa60b8331d45d741a89de5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9001bb3bbdfa60b8331d45d741a89de5">&#9670;&nbsp;</a></span>children()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const std::vector&lt;std::size_t&gt;&amp; <a class="el" href="classentt_1_1basic__organizer.html">entt::basic_organizer</a>&lt; Entity &gt;::vertex::children </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 the list of nodes reachable from a given vertex. </p>
<dl class="section return"><dt>Returns</dt><dd>The list of nodes reachable from the vertex. </dd></dl>
<p class="definition">Definition at line <a class="el" href="organizer_8hpp_source.html#l00350">350</a> of file <a class="el" href="organizer_8hpp_source.html">organizer.hpp</a>.</p>
</div>
</div>
<a id="a8e60b82f8db48e9bb2a8d0bf9cc5ac17"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8e60b82f8db48e9bb2a8d0bf9cc5ac17">&#9670;&nbsp;</a></span>data()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const void* <a class="el" href="classentt_1_1basic__organizer.html">entt::basic_organizer</a>&lt; Entity &gt;::vertex::data </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 the payload associated with a vertex, if any. </p>
<dl class="section return"><dt>Returns</dt><dd>The payload associated with the vertex, if any. </dd></dl>
<p class="definition">Definition at line <a class="el" href="organizer_8hpp_source.html#l00342">342</a> of file <a class="el" href="organizer_8hpp_source.html">organizer.hpp</a>.</p>
</div>
</div>
<a id="a0ade3ec95fdca81a42808ef585453651"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0ade3ec95fdca81a42808ef585453651">&#9670;&nbsp;</a></span>info()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classentt_1_1type__info.html">type_info</a> <a class="el" href="classentt_1_1basic__organizer.html">entt::basic_organizer</a>&lt; Entity &gt;::vertex::info </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 a type info object associated with a vertex. </p>
<dl class="section return"><dt>Returns</dt><dd>A properly initialized type info object. </dd></dl>
<p class="definition">Definition at line <a class="el" href="organizer_8hpp_source.html#l00318">318</a> of file <a class="el" href="organizer_8hpp_source.html">organizer.hpp</a>.</p>
</div>
</div>
<a id="aacc9f65a7bd16763647677d8b84bb74b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aacc9f65a7bd16763647677d8b84bb74b">&#9670;&nbsp;</a></span>name()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const char* <a class="el" href="classentt_1_1basic__organizer.html">entt::basic_organizer</a>&lt; Entity &gt;::vertex::name </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 a user defined name associated with a vertex, if any. </p>
<dl class="section return"><dt>Returns</dt><dd>The user defined name associated with the vertex, if any. </dd></dl>
<p class="definition">Definition at line <a class="el" href="organizer_8hpp_source.html#l00326">326</a> of file <a class="el" href="organizer_8hpp_source.html">organizer.hpp</a>.</p>
</div>
</div>
<a id="a9208ce46f18ba46229bacbc070fd8eec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9208ce46f18ba46229bacbc070fd8eec">&#9670;&nbsp;</a></span>prepare()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classentt_1_1basic__organizer.html">entt::basic_organizer</a>&lt; Entity &gt;::vertex::prepare </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classentt_1_1basic__registry.html">basic_registry</a>&lt; <a class="el" href="classentt_1_1basic__organizer.html#a36b865f5d3802e48a0fa027c43e3a39c">entity_type</a> &gt; &amp;&#160;</td>
<td class="paramname"><em>reg</em></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>Prepares a registry and assures that all required resources are properly instantiated before using them. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">reg</td><td>A valid registry. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="organizer_8hpp_source.html#l00359">359</a> of file <a class="el" href="organizer_8hpp_source.html">organizer.hpp</a>.</p>
</div>
</div>
<a id="a7ac52b2bcd9d4a5fa78b92822fc88418"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7ac52b2bcd9d4a5fa78b92822fc88418">&#9670;&nbsp;</a></span>ro_count()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classentt_1_1basic__organizer.html#afcf528b532b3c41ab06c11d5c82a7260">size_type</a> <a class="el" href="classentt_1_1basic__organizer.html">entt::basic_organizer</a>&lt; Entity &gt;::vertex::ro_count </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 the number of read-only resources of a vertex. </p>
<dl class="section return"><dt>Returns</dt><dd>The number of read-only resources of the vertex. </dd></dl>
<p class="definition">Definition at line <a class="el" href="organizer_8hpp_source.html#l00294">294</a> of file <a class="el" href="organizer_8hpp_source.html">organizer.hpp</a>.</p>
</div>
</div>
<a id="a178e6d3f6243441c9c5fd24112e5ed7b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a178e6d3f6243441c9c5fd24112e5ed7b">&#9670;&nbsp;</a></span>ro_dependency()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classentt_1_1basic__organizer.html#afcf528b532b3c41ab06c11d5c82a7260">size_type</a> <a class="el" href="classentt_1_1basic__organizer.html">entt::basic_organizer</a>&lt; Entity &gt;::vertex::ro_dependency </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classentt_1_1type__info.html">type_info</a> *&#160;</td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::size_t&#160;</td>
<td class="paramname"><em>length</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</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>Fills a buffer with the type info objects for the writable resources of a vertex. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buffer</td><td>A buffer pre-allocated by the user. </td></tr>
<tr><td class="paramname">length</td><td>The length of the user-supplied buffer. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The number of type info objects written to the buffer. </dd></dl>
<p class="definition">Definition at line <a class="el" href="organizer_8hpp_source.html#l00275">275</a> of file <a class="el" href="organizer_8hpp_source.html">organizer.hpp</a>.</p>
</div>
</div>
<a id="a0d1f98d28191735e9d22cce081f98b02"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0d1f98d28191735e9d22cce081f98b02">&#9670;&nbsp;</a></span>rw_count()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classentt_1_1basic__organizer.html#afcf528b532b3c41ab06c11d5c82a7260">size_type</a> <a class="el" href="classentt_1_1basic__organizer.html">entt::basic_organizer</a>&lt; Entity &gt;::vertex::rw_count </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 the number of writable resources of a vertex. </p>
<dl class="section return"><dt>Returns</dt><dd>The number of writable resources of the vertex. </dd></dl>
<p class="definition">Definition at line <a class="el" href="organizer_8hpp_source.html#l00302">302</a> of file <a class="el" href="organizer_8hpp_source.html">organizer.hpp</a>.</p>
</div>
</div>
<a id="ae6899283d1aecfd1fd4f0f712cb3ed4f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae6899283d1aecfd1fd4f0f712cb3ed4f">&#9670;&nbsp;</a></span>rw_dependency()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classentt_1_1basic__organizer.html#afcf528b532b3c41ab06c11d5c82a7260">size_type</a> <a class="el" href="classentt_1_1basic__organizer.html">entt::basic_organizer</a>&lt; Entity &gt;::vertex::rw_dependency </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classentt_1_1type__info.html">type_info</a> *&#160;</td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::size_t&#160;</td>
<td class="paramname"><em>length</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</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>Fills a buffer with the type info objects for the read-only resources of a vertex. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buffer</td><td>A buffer pre-allocated by the user. </td></tr>
<tr><td class="paramname">length</td><td>The length of the user-supplied buffer. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The number of type info objects written to the buffer. </dd></dl>
<p class="definition">Definition at line <a class="el" href="organizer_8hpp_source.html#l00286">286</a> of file <a class="el" href="organizer_8hpp_source.html">organizer.hpp</a>.</p>
</div>
</div>
<a id="a33b714b2096db39c751734aea33ae949"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a33b714b2096db39c751734aea33ae949">&#9670;&nbsp;</a></span>top_level()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classentt_1_1basic__organizer.html">entt::basic_organizer</a>&lt; Entity &gt;::vertex::top_level </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>Checks if a vertex is also a top-level one. </p>
<dl class="section return"><dt>Returns</dt><dd>True if the vertex is a top-level one, false otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="organizer_8hpp_source.html#l00310">310</a> of file <a class="el" href="organizer_8hpp_source.html">organizer.hpp</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>src/entt/entity/<a class="el" href="organizer_8hpp_source.html">organizer.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