Files
entt/namespaceentt.html
2017-10-19 16:24:25 +02:00

285 lines
20 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>entt: entt Namespace 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">2.0.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</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><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">entt Namespace Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>EnTT</code> default namespace.
<a href="#details">More...</a></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_1entt__traits.html">entt_traits</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Entity traits. <a href="structentt_1_1entt__traits.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</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_1entt__traits_3_01std_1_1uint16__t_01_4.html">entt_traits&lt; std::uint16_t &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Entity traits for a 16 bits entity identifier. <a href="structentt_1_1entt__traits_3_01std_1_1uint16__t_01_4.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</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_1entt__traits_3_01std_1_1uint32__t_01_4.html">entt_traits&lt; std::uint32_t &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Entity traits for a 32 bits entity identifier. <a href="structentt_1_1entt__traits_3_01std_1_1uint32__t_01_4.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</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_1entt__traits_3_01std_1_1uint64__t_01_4.html">entt_traits&lt; std::uint64_t &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Entity traits for a 64 bits entity identifier. <a href="structentt_1_1entt__traits_3_01std_1_1uint64__t_01_4.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1Family.html">Family</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Dynamic identifier generator. <a href="classentt_1_1Family.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1PersistentView.html">PersistentView</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Persistent view. <a href="classentt_1_1PersistentView.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1Registry.html">Registry</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A repository class for entities and components. <a href="classentt_1_1Registry.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1SigH.html">SigH</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Signal handler. <a href="classentt_1_1SigH.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1SigH_3_01Ret_07Args_8_8_8_08_00_01Collector_01_4.html">SigH&lt; Ret(Args...), Collector &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Signal handler. <a href="classentt_1_1SigH_3_01Ret_07Args_8_8_8_08_00_01Collector_01_4.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1SparseSet.html">SparseSet</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sparse set. <a href="classentt_1_1SparseSet.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1SparseSet_3_01Entity_01_4.html">SparseSet&lt; Entity &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Basic sparse set implementation. <a href="classentt_1_1SparseSet_3_01Entity_01_4.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1SparseSet_3_01Entity_00_01Type_01_4.html">SparseSet&lt; Entity, Type &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Extended sparse set implementation. <a href="classentt_1_1SparseSet_3_01Entity_00_01Type_01_4.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1View.html">View</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Multi component view. <a href="classentt_1_1View.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1View_3_01Entity_00_01Component_01_4.html">View&lt; Entity, Component &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Single component view specialization. <a href="classentt_1_1View_3_01Entity_00_01Component_01_4.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="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:aa56ef01a9c62f21d68dd60f005296b23"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceentt.html#aa56ef01a9c62f21d68dd60f005296b23">DefaultRegistry</a> = <a class="el" href="classentt_1_1Registry.html">Registry</a>&lt; std::uint32_t &gt;</td></tr>
<tr class="memdesc:aa56ef01a9c62f21d68dd60f005296b23"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default registry class. <a href="#aa56ef01a9c62f21d68dd60f005296b23">More...</a><br /></td></tr>
<tr class="separator:aa56ef01a9c62f21d68dd60f005296b23"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeba406e321af94eebdf1da0540a3ee03"><td class="memTemplParams" colspan="2">template&lt;typename Event &gt; </td></tr>
<tr class="memitem:aeba406e321af94eebdf1da0540a3ee03"><td class="memTemplItemLeft" align="right" valign="top">using&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceentt.html#aeba406e321af94eebdf1da0540a3ee03">EventH</a> = <a class="el" href="classentt_1_1SigH.html">SigH</a>&lt; void(const Event &amp;)&gt;</td></tr>
<tr class="memdesc:aeba406e321af94eebdf1da0540a3ee03"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event handler. <a href="#aeba406e321af94eebdf1da0540a3ee03">More...</a><br /></td></tr>
<tr class="separator:aeba406e321af94eebdf1da0540a3ee03"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a2da4a1967225dc9ab0bc7b177cc78f9f"><td class="memTemplParams" colspan="2">template&lt;typename Ret , typename... Args&gt; </td></tr>
<tr class="memitem:a2da4a1967225dc9ab0bc7b177cc78f9f"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceentt.html#a2da4a1967225dc9ab0bc7b177cc78f9f">operator!=</a> (const <a class="el" href="classentt_1_1SigH.html">SigH</a>&lt; Ret(Args...)&gt; &amp;lhs, const <a class="el" href="classentt_1_1SigH.html">SigH</a>&lt; Ret(Args...)&gt; &amp;rhs) noexcept</td></tr>
<tr class="memdesc:a2da4a1967225dc9ab0bc7b177cc78f9f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if the contents of the two signals are different. <a href="#a2da4a1967225dc9ab0bc7b177cc78f9f">More...</a><br /></td></tr>
<tr class="separator:a2da4a1967225dc9ab0bc7b177cc78f9f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a02c0c4d37a2cdf573029814c1903de3c"><td class="memTemplParams" colspan="2">template&lt;typename... Types&gt; </td></tr>
<tr class="memitem:a02c0c4d37a2cdf573029814c1903de3c"><td class="memTemplItemLeft" align="right" valign="top">constexpr auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceentt.html#a02c0c4d37a2cdf573029814c1903de3c">ident</a> = Identifier&lt;std::decay_t&lt;Types&gt;...&gt;{std::make_index_sequence&lt;sizeof...(Types)&gt;{}}</td></tr>
<tr class="memdesc:a02c0c4d37a2cdf573029814c1903de3c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Types identifers. <a href="#a02c0c4d37a2cdf573029814c1903de3c">More...</a><br /></td></tr>
<tr class="separator:a02c0c4d37a2cdf573029814c1903de3c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><code>EnTT</code> default namespace. </p>
</div><h2 class="groupheader">Typedef Documentation</h2>
<a id="aa56ef01a9c62f21d68dd60f005296b23"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa56ef01a9c62f21d68dd60f005296b23">&#9670;&nbsp;</a></span>DefaultRegistry</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="namespaceentt.html#aa56ef01a9c62f21d68dd60f005296b23">entt::DefaultRegistry</a> = typedef <a class="el" href="classentt_1_1Registry.html">Registry</a>&lt;std::uint32_t&gt;</td>
</tr>
</table>
</div><div class="memdoc">
<p>Default registry class. </p>
<p>The default registry is the best choice for almost all the applications.<br />
Users should have a really good reason to choose something different. </p>
<p class="definition">Definition at line <a class="el" href="registry_8hpp_source.html#l00741">741</a> of file <a class="el" href="registry_8hpp_source.html">registry.hpp</a>.</p>
</div>
</div>
<a id="aeba406e321af94eebdf1da0540a3ee03"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeba406e321af94eebdf1da0540a3ee03">&#9670;&nbsp;</a></span>EventH</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Event &gt; </div>
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="namespaceentt.html#aeba406e321af94eebdf1da0540a3ee03">entt::EventH</a> = typedef <a class="el" href="classentt_1_1SigH.html">SigH</a>&lt;void(const Event &amp;)&gt;</td>
</tr>
</table>
</div><div class="memdoc">
<p>Event handler. </p>
<p>Unmanaged event handler. Collecting data for this kind of signals doesn't make sense at all. Its sole purpose is to provide the listeners with the given event. </p>
<p class="definition">Definition at line <a class="el" href="sigh_8hpp_source.html#l00342">342</a> of file <a class="el" href="sigh_8hpp_source.html">sigh.hpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a2da4a1967225dc9ab0bc7b177cc78f9f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2da4a1967225dc9ab0bc7b177cc78f9f">&#9670;&nbsp;</a></span>operator!=()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Ret , typename... Args&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool entt::operator!= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classentt_1_1SigH.html">SigH</a>&lt; Ret(Args...)&gt; &amp;&#160;</td>
<td class="paramname"><em>lhs</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classentt_1_1SigH.html">SigH</a>&lt; Ret(Args...)&gt; &amp;&#160;</td>
<td class="paramname"><em>rhs</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">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks if the contents of the two signals are different. </p>
<p>Two signals are identical if they have the same size and the same listeners registered exactly in the same order.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Ret</td><td>Return type of a function type. </td></tr>
<tr><td class="paramname">Args</td><td>Types of the arguments of a function type. </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">lhs</td><td>A valid signal object. </td></tr>
<tr><td class="paramname">rhs</td><td>A valid signal object. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if the two signals are different, false otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="sigh_8hpp_source.html#l00329">329</a> of file <a class="el" href="sigh_8hpp_source.html">sigh.hpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="a02c0c4d37a2cdf573029814c1903de3c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a02c0c4d37a2cdf573029814c1903de3c">&#9670;&nbsp;</a></span>ident</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename... Types&gt; </div>
<table class="memname">
<tr>
<td class="memname">constexpr auto entt::ident = Identifier&lt;std::decay_t&lt;Types&gt;...&gt;{std::make_index_sequence&lt;sizeof...(Types)&gt;{}}</td>
</tr>
</table>
</div><div class="memdoc">
<p>Types identifers. </p>
<p>Variable template used to generate identifiers at compile-time for the given types. Use the <code>constexpr</code> <code>get</code> member function to know what's the identifier associated to the specific type.</p>
<dl class="section note"><dt>Note</dt><dd>Identifiers are constant expression and can be used in any context where such an expression is required. As an example: <div class="fragment"><div class="line">constexpr <span class="keyword">auto</span> identifiers = entt::ident&lt;AType, AnotherType&gt;;</div><div class="line"></div><div class="line"><span class="keywordflow">switch</span>(aTypeIdentifier) {</div><div class="line"><span class="keywordflow">case</span> identifers.get&lt;AType&gt;():</div><div class="line"> <span class="comment">// ...</span></div><div class="line"> <span class="keywordflow">break</span>;</div><div class="line"><span class="keywordflow">case</span> identifers.get&lt;AnotherType&gt;():</div><div class="line"> <span class="comment">// ...</span></div><div class="line"> <span class="keywordflow">break</span>;</div><div class="line"><span class="keywordflow">default</span>:</div><div class="line"> <span class="comment">// ...</span></div><div class="line">}</div></div><!-- fragment --></dd></dl>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Types</td><td>The list of types for which to generate identifiers. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="ident_8hpp_source.html#l00065">65</a> of file <a class="el" href="ident_8hpp_source.html">ident.hpp</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>