Scarfski/entt
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
8b79c832820fc66ddfe1b584b5065e64b62529aa
entt/classentt_1_1basic__organizer.html
Michele Caini 8b79c83282 API reference v3.8.1
2021-07-28 10:12:19 +02:00

356 lines
19 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; Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.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.1</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> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classentt_1_1basic__organizer-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">entt::basic_organizer&lt; Entity &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Utility class for creating a static task graph.
<a href="classentt_1_1basic__organizer.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="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__organizer_1_1vertex.html">vertex</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Vertex type of a task graph defined as an adjacency list. <a href="structentt_1_1basic__organizer_1_1vertex.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:a36b865f5d3802e48a0fa027c43e3a39c"><td class="memItemLeft" align="right" valign="top"><a id="a36b865f5d3802e48a0fa027c43e3a39c"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__organizer.html#a36b865f5d3802e48a0fa027c43e3a39c">entity_type</a> = Entity</td></tr>
<tr class="memdesc:a36b865f5d3802e48a0fa027c43e3a39c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Underlying entity identifier. <br /></td></tr>
<tr class="separator:a36b865f5d3802e48a0fa027c43e3a39c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afcf528b532b3c41ab06c11d5c82a7260"><td class="memItemLeft" align="right" valign="top"><a id="afcf528b532b3c41ab06c11d5c82a7260"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__organizer.html#afcf528b532b3c41ab06c11d5c82a7260">size_type</a> = std::size_t</td></tr>
<tr class="memdesc:afcf528b532b3c41ab06c11d5c82a7260"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unsigned integer type. <br /></td></tr>
<tr class="separator:afcf528b532b3c41ab06c11d5c82a7260"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8eb83a2af62a10e9515776b8f26b1edc"><td class="memItemLeft" align="right" valign="top"><a id="a8eb83a2af62a10e9515776b8f26b1edc"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__organizer.html#a8eb83a2af62a10e9515776b8f26b1edc">function_type</a> = callback_type</td></tr>
<tr class="memdesc:a8eb83a2af62a10e9515776b8f26b1edc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Raw task function type. <br /></td></tr>
<tr class="separator:a8eb83a2af62a10e9515776b8f26b1edc"><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:a9c26a53ceaa41f54d88678b636e96ad5"><td class="memTemplParams" colspan="2">template&lt;auto Candidate, typename... Req&gt; </td></tr>
<tr class="memitem:a9c26a53ceaa41f54d88678b636e96ad5"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__organizer.html#a9c26a53ceaa41f54d88678b636e96ad5">emplace</a> (const char *name=nullptr)</td></tr>
<tr class="memdesc:a9c26a53ceaa41f54d88678b636e96ad5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds a free function to the task list. <a href="classentt_1_1basic__organizer.html#a9c26a53ceaa41f54d88678b636e96ad5">More...</a><br /></td></tr>
<tr class="separator:a9c26a53ceaa41f54d88678b636e96ad5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae28283f55e13443712ddfd29bf01f9f7"><td class="memTemplParams" colspan="2">template&lt;auto Candidate, typename... Req, typename Type &gt; </td></tr>
<tr class="memitem:ae28283f55e13443712ddfd29bf01f9f7"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__organizer.html#ae28283f55e13443712ddfd29bf01f9f7">emplace</a> (Type &amp;value_or_instance, const char *name=nullptr)</td></tr>
<tr class="memdesc:ae28283f55e13443712ddfd29bf01f9f7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds a free function with payload or a member function with an instance to the task list. <a href="classentt_1_1basic__organizer.html#ae28283f55e13443712ddfd29bf01f9f7">More...</a><br /></td></tr>
<tr class="separator:ae28283f55e13443712ddfd29bf01f9f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abed2a897fe81bd69f85ed9305c1fcdc3"><td class="memTemplParams" colspan="2">template&lt;typename... Req&gt; </td></tr>
<tr class="memitem:abed2a897fe81bd69f85ed9305c1fcdc3"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__organizer.html#abed2a897fe81bd69f85ed9305c1fcdc3">emplace</a> (<a class="el" href="classentt_1_1basic__organizer.html#a8eb83a2af62a10e9515776b8f26b1edc">function_type</a> *func, const void *payload=nullptr, const char *name=nullptr)</td></tr>
<tr class="memdesc:abed2a897fe81bd69f85ed9305c1fcdc3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds an user defined function with optional payload to the task list. <a href="classentt_1_1basic__organizer.html#abed2a897fe81bd69f85ed9305c1fcdc3">More...</a><br /></td></tr>
<tr class="separator:abed2a897fe81bd69f85ed9305c1fcdc3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abb49a4c59833592036dce927cae6143d"><td class="memItemLeft" align="right" valign="top">std::vector&lt; <a class="el" href="structentt_1_1basic__organizer_1_1vertex.html">vertex</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__organizer.html#abb49a4c59833592036dce927cae6143d">graph</a> ()</td></tr>
<tr class="memdesc:abb49a4c59833592036dce927cae6143d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generates a task graph for the current content. <a href="classentt_1_1basic__organizer.html#abb49a4c59833592036dce927cae6143d">More...</a><br /></td></tr>
<tr class="separator:abb49a4c59833592036dce927cae6143d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abd9bb70defec160e5da0d5807c11b18f"><td class="memItemLeft" align="right" valign="top"><a id="abd9bb70defec160e5da0d5807c11b18f"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1basic__organizer.html#abd9bb70defec160e5da0d5807c11b18f">clear</a> ()</td></tr>
<tr class="memdesc:abd9bb70defec160e5da0d5807c11b18f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Erases all elements from a container. <br /></td></tr>
<tr class="separator:abd9bb70defec160e5da0d5807c11b18f"><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 />
class entt::basic_organizer&lt; Entity &gt;</h3>
<p>Utility class for creating a static task graph. </p>
<p>This class offers minimal support (but sufficient in many cases) for creating an execution graph from functions and their requirements on resources.<br />
Note that the resulting tasks aren't executed in any case. This isn't the goal of the tool. Instead, they are returned to the user in the form of a graph that allows for safe execution.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Entity</td><td>A valid entity type (see <a class="el" href="classentt_1_1entt__traits.html" title="Entity traits.">entt_traits</a> for more details). </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="organizer_8hpp_source.html#l00125">125</a> of file <a class="el" href="organizer_8hpp_source.html">organizer.hpp</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a9c26a53ceaa41f54d88678b636e96ad5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9c26a53ceaa41f54d88678b636e96ad5">&#9670;&nbsp;</a></span>emplace() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity &gt; </div>
<div class="memtemplate">
template&lt;auto Candidate, typename... Req&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;::emplace </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>name</em> = <code>nullptr</code></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>Adds a free function to the task list. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Candidate</td><td>Function to add to the task list. </td></tr>
<tr><td class="paramname">Req</td><td>Additional requirements and/or override resource access mode. </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>Optional name to associate with the task. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="organizer_8hpp_source.html#l00376">376</a> of file <a class="el" href="organizer_8hpp_source.html">organizer.hpp</a>.</p>
</div>
</div>
<a id="abed2a897fe81bd69f85ed9305c1fcdc3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abed2a897fe81bd69f85ed9305c1fcdc3">&#9670;&nbsp;</a></span>emplace() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity &gt; </div>
<div class="memtemplate">
template&lt;typename... Req&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;::emplace </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classentt_1_1basic__organizer.html#a8eb83a2af62a10e9515776b8f26b1edc">function_type</a> *&#160;</td>
<td class="paramname"><em>func</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void *&#160;</td>
<td class="paramname"><em>payload</em> = <code>nullptr</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>name</em> = <code>nullptr</code>&#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>Adds an user defined function with optional payload to the task list. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Req</td><td>Additional requirements and/or override resource access mode. </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">func</td><td>Function to add to the task list. </td></tr>
<tr><td class="paramname">payload</td><td>User defined arbitrary data. </td></tr>
<tr><td class="paramname">name</td><td>Optional name to associate with the task. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="organizer_8hpp_source.html#l00444">444</a> of file <a class="el" href="organizer_8hpp_source.html">organizer.hpp</a>.</p>
</div>
</div>
<a id="ae28283f55e13443712ddfd29bf01f9f7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae28283f55e13443712ddfd29bf01f9f7">&#9670;&nbsp;</a></span>emplace() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity &gt; </div>
<div class="memtemplate">
template&lt;auto Candidate, typename... Req, typename Type &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;::emplace </td>
<td>(</td>
<td class="paramtype">Type &amp;&#160;</td>
<td class="paramname"><em>value_or_instance</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>name</em> = <code>nullptr</code>&#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>Adds a free function with payload or a member function with an instance to the task list. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Candidate</td><td>Function or member to add to the task list. </td></tr>
<tr><td class="paramname">Req</td><td>Additional requirements and/or override resource access mode. </td></tr>
<tr><td class="paramname">Type</td><td>Type of class or type of payload. </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">value_or_instance</td><td>A valid object that fits the purpose. </td></tr>
<tr><td class="paramname">name</td><td>Optional name to associate with the task. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="organizer_8hpp_source.html#l00408">408</a> of file <a class="el" href="organizer_8hpp_source.html">organizer.hpp</a>.</p>
</div>
</div>
<a id="abb49a4c59833592036dce927cae6143d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abb49a4c59833592036dce927cae6143d">&#9670;&nbsp;</a></span>graph()</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">std::vector&lt;<a class="el" href="structentt_1_1basic__organizer_1_1vertex.html">vertex</a>&gt; <a class="el" href="classentt_1_1basic__organizer.html">entt::basic_organizer</a>&lt; Entity &gt;::graph </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Generates a task graph for the current content. </p>
<dl class="section return"><dt>Returns</dt><dd>The adjacency list of the task graph. </dd></dl>
<p class="definition">Definition at line <a class="el" href="organizer_8hpp_source.html#l00466">466</a> of file <a class="el" href="organizer_8hpp_source.html">organizer.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="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