Scarfski/entt
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
7cf7699bab13f2e0414dd4dda6a29591dd8b5686
entt/classentt_1_1emitter.html
Michele Caini 7cf7699bab API reference v3.12.0
2023-06-15 11:47:04 +02:00

749 lines
37 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" 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.9.6"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>EnTT: entt::emitter&lt; Derived, Allocator &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-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">&#160;3.12.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.6 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(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">
<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_1emitter.html">emitter</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="classentt_1_1emitter-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">entt::emitter&lt; Derived, Allocator &gt; Class Template Reference</div></div>
</div><!--header-->
<div class="contents">
<p>General purpose event emitter.
<a href="classentt_1_1emitter.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="emitter_8hpp_source.html">emitter.hpp</a>&gt;</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:a0d22ffe04a17ac2cdd0a216dd17e3b5d"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1emitter.html#a0d22ffe04a17ac2cdd0a216dd17e3b5d">allocator_type</a> = Allocator</td></tr>
<tr class="memdesc:a0d22ffe04a17ac2cdd0a216dd17e3b5d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allocator type. <br /></td></tr>
<tr class="separator:a0d22ffe04a17ac2cdd0a216dd17e3b5d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa72c6b30d4d14c1b954f7ebed3a4f123"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1emitter.html#aa72c6b30d4d14c1b954f7ebed3a4f123">size_type</a> = std::size_t</td></tr>
<tr class="memdesc:aa72c6b30d4d14c1b954f7ebed3a4f123"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unsigned integer type. <br /></td></tr>
<tr class="separator:aa72c6b30d4d14c1b954f7ebed3a4f123"><td class="memSeparator" colspan="2">&#160;</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:a685882e0f6b442759dd109f88e5b18a9"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1emitter.html#a685882e0f6b442759dd109f88e5b18a9">emitter</a> ()</td></tr>
<tr class="memdesc:a685882e0f6b442759dd109f88e5b18a9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor. <br /></td></tr>
<tr class="separator:a685882e0f6b442759dd109f88e5b18a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3e03b43a4239091637f18f63645c23a3"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1emitter.html#a3e03b43a4239091637f18f63645c23a3">emitter</a> (const <a class="el" href="classentt_1_1emitter.html#a0d22ffe04a17ac2cdd0a216dd17e3b5d">allocator_type</a> &amp;allocator)</td></tr>
<tr class="memdesc:a3e03b43a4239091637f18f63645c23a3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs an emitter with a given allocator. <br /></td></tr>
<tr class="separator:a3e03b43a4239091637f18f63645c23a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abffc10f084ae3158a400ca4a26768bfa"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1emitter.html#abffc10f084ae3158a400ca4a26768bfa">~emitter</a> () noexcept</td></tr>
<tr class="memdesc:abffc10f084ae3158a400ca4a26768bfa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default destructor. <br /></td></tr>
<tr class="separator:abffc10f084ae3158a400ca4a26768bfa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a351058758b1fc6840c467a10fd2912c4"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1emitter.html#a351058758b1fc6840c467a10fd2912c4">emitter</a> (<a class="el" href="classentt_1_1emitter.html">emitter</a> &amp;&amp;other) noexcept</td></tr>
<tr class="memdesc:a351058758b1fc6840c467a10fd2912c4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Move constructor. <br /></td></tr>
<tr class="separator:a351058758b1fc6840c467a10fd2912c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af78e1139f2a728260850d4fd667a0fbf"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1emitter.html#af78e1139f2a728260850d4fd667a0fbf">emitter</a> (<a class="el" href="classentt_1_1emitter.html">emitter</a> &amp;&amp;other, const <a class="el" href="classentt_1_1emitter.html#a0d22ffe04a17ac2cdd0a216dd17e3b5d">allocator_type</a> &amp;allocator) noexcept</td></tr>
<tr class="memdesc:af78e1139f2a728260850d4fd667a0fbf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allocator-extended move constructor. <br /></td></tr>
<tr class="separator:af78e1139f2a728260850d4fd667a0fbf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3cf6cad201e76ebbc43d426518928501"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1emitter.html">emitter</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1emitter.html#a3cf6cad201e76ebbc43d426518928501">operator=</a> (<a class="el" href="classentt_1_1emitter.html">emitter</a> &amp;&amp;other) noexcept</td></tr>
<tr class="memdesc:a3cf6cad201e76ebbc43d426518928501"><td class="mdescLeft">&#160;</td><td class="mdescRight">Move assignment operator. <br /></td></tr>
<tr class="separator:a3cf6cad201e76ebbc43d426518928501"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a98b35cbec0716390be9c8be8582946c4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1emitter.html#a98b35cbec0716390be9c8be8582946c4">swap</a> (<a class="el" href="classentt_1_1emitter.html">emitter</a> &amp;other)</td></tr>
<tr class="memdesc:a98b35cbec0716390be9c8be8582946c4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Exchanges the contents with those of a given emitter. <br /></td></tr>
<tr class="separator:a98b35cbec0716390be9c8be8582946c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae7a4a02a33a8b4c0fb6014f32a793dd9"><td class="memItemLeft" align="right" valign="top">constexpr <a class="el" href="classentt_1_1emitter.html#a0d22ffe04a17ac2cdd0a216dd17e3b5d">allocator_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1emitter.html#ae7a4a02a33a8b4c0fb6014f32a793dd9">get_allocator</a> () const noexcept</td></tr>
<tr class="memdesc:ae7a4a02a33a8b4c0fb6014f32a793dd9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the associated allocator. <br /></td></tr>
<tr class="separator:ae7a4a02a33a8b4c0fb6014f32a793dd9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7d8d8141c67248b448f47f5a123fd8e9"><td class="memTemplParams" colspan="2">template&lt;typename Type &gt; </td></tr>
<tr class="memitem:a7d8d8141c67248b448f47f5a123fd8e9"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classentt_1_1emitter.html#a7d8d8141c67248b448f47f5a123fd8e9">publish</a> (Type &amp;&amp;value)</td></tr>
<tr class="memdesc:a7d8d8141c67248b448f47f5a123fd8e9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Publishes a given event. <br /></td></tr>
<tr class="separator:a7d8d8141c67248b448f47f5a123fd8e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad620441c088f7e4d1cc4f852f4ec4bad"><td class="memTemplParams" colspan="2">template&lt;typename Type &gt; </td></tr>
<tr class="memitem:ad620441c088f7e4d1cc4f852f4ec4bad"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classentt_1_1emitter.html#ad620441c088f7e4d1cc4f852f4ec4bad">on</a> (std::function&lt; void(Type &amp;, Derived &amp;)&gt; func)</td></tr>
<tr class="memdesc:ad620441c088f7e4d1cc4f852f4ec4bad"><td class="mdescLeft">&#160;</td><td class="mdescRight">Registers a listener with the event emitter. <br /></td></tr>
<tr class="separator:ad620441c088f7e4d1cc4f852f4ec4bad"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa1c5ac5f75740ebb9fa3eb9f533ba23c"><td class="memTemplParams" colspan="2">template&lt;typename Type &gt; </td></tr>
<tr class="memitem:aa1c5ac5f75740ebb9fa3eb9f533ba23c"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classentt_1_1emitter.html#aa1c5ac5f75740ebb9fa3eb9f533ba23c">erase</a> ()</td></tr>
<tr class="memdesc:aa1c5ac5f75740ebb9fa3eb9f533ba23c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disconnects a listener from the event emitter. <br /></td></tr>
<tr class="separator:aa1c5ac5f75740ebb9fa3eb9f533ba23c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5222e50d997a70afcdfc678a26d59ca4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1emitter.html#a5222e50d997a70afcdfc678a26d59ca4">clear</a> () noexcept</td></tr>
<tr class="memdesc:a5222e50d997a70afcdfc678a26d59ca4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disconnects all the listeners. <br /></td></tr>
<tr class="separator:a5222e50d997a70afcdfc678a26d59ca4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6bced239a3a07f86dc759ebc1a71813a"><td class="memTemplParams" colspan="2">template&lt;typename Type &gt; </td></tr>
<tr class="memitem:a6bced239a3a07f86dc759ebc1a71813a"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classentt_1_1emitter.html#a6bced239a3a07f86dc759ebc1a71813a">contains</a> () const</td></tr>
<tr class="memdesc:a6bced239a3a07f86dc759ebc1a71813a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if there are listeners registered for the specific event. <br /></td></tr>
<tr class="separator:a6bced239a3a07f86dc759ebc1a71813a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac9fe97c008e4923e4e784faddc9f4eca"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1emitter.html#ac9fe97c008e4923e4e784faddc9f4eca">empty</a> () const noexcept</td></tr>
<tr class="memdesc:ac9fe97c008e4923e4e784faddc9f4eca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if there are listeners registered with the event emitter. <br /></td></tr>
<tr class="separator:ac9fe97c008e4923e4e784faddc9f4eca"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><div class="compoundTemplParams">template&lt;typename Derived, typename Allocator&gt;<br />
class entt::emitter&lt; Derived, Allocator &gt;</div><p>General purpose event emitter. </p>
<p>To create an emitter type, derived classes must inherit from the base as:</p>
<div class="fragment"><div class="line"><span class="keyword">struct </span>my_emitter: <a class="code hl_class" href="classentt_1_1emitter.html">emitter</a>&lt;my_emitter&gt; {</div>
<div class="line"> <span class="comment">// ...</span></div>
<div class="line">}</div>
<div class="ttc" id="aclassentt_1_1emitter_html"><div class="ttname"><a href="classentt_1_1emitter.html">entt::emitter</a></div><div class="ttdoc">General purpose event emitter.</div><div class="ttdef"><b>Definition:</b> <a href="emitter_8hpp_source.html#l00036">emitter.hpp:36</a></div></div>
</div><!-- fragment --><p>Handlers for the different events are created internally on the fly. It's not required to specify in advance the full list of accepted events.<br />
Moreover, whenever an event is published, an emitter also passes a reference to itself to its listeners.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Derived</td><td>Emitter 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="emitter_8hpp_source.html#l00036">36</a> of file <a class="el" href="emitter_8hpp_source.html">emitter.hpp</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="a0d22ffe04a17ac2cdd0a216dd17e3b5d" name="a0d22ffe04a17ac2cdd0a216dd17e3b5d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0d22ffe04a17ac2cdd0a216dd17e3b5d">&#9670;&#160;</a></span>allocator_type</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Derived , typename Allocator &gt; </div>
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classentt_1_1emitter.html">entt::emitter</a>&lt; Derived, Allocator &gt;::allocator_type = Allocator</td>
</tr>
</table>
</div><div class="memdoc">
<p>Allocator type. </p>
<p class="definition">Definition at line <a class="el" href="emitter_8hpp_source.html#l00046">46</a> of file <a class="el" href="emitter_8hpp_source.html">emitter.hpp</a>.</p>
</div>
</div>
<a id="aa72c6b30d4d14c1b954f7ebed3a4f123" name="aa72c6b30d4d14c1b954f7ebed3a4f123"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa72c6b30d4d14c1b954f7ebed3a4f123">&#9670;&#160;</a></span>size_type</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Derived , typename Allocator &gt; </div>
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classentt_1_1emitter.html">entt::emitter</a>&lt; Derived, Allocator &gt;::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="emitter_8hpp_source.html#l00048">48</a> of file <a class="el" href="emitter_8hpp_source.html">emitter.hpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a685882e0f6b442759dd109f88e5b18a9" name="a685882e0f6b442759dd109f88e5b18a9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a685882e0f6b442759dd109f88e5b18a9">&#9670;&#160;</a></span>emitter() <span class="overload">[1/4]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Derived , typename Allocator &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classentt_1_1emitter.html">entt::emitter</a>&lt; Derived, Allocator &gt;::emitter </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>Default constructor. </p>
<p class="definition">Definition at line <a class="el" href="emitter_8hpp_source.html#l00051">51</a> of file <a class="el" href="emitter_8hpp_source.html">emitter.hpp</a>.</p>
</div>
</div>
<a id="a3e03b43a4239091637f18f63645c23a3" name="a3e03b43a4239091637f18f63645c23a3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3e03b43a4239091637f18f63645c23a3">&#9670;&#160;</a></span>emitter() <span class="overload">[2/4]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Derived , typename Allocator &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classentt_1_1emitter.html">entt::emitter</a>&lt; Derived, Allocator &gt;::emitter </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classentt_1_1emitter.html#a0d22ffe04a17ac2cdd0a216dd17e3b5d">allocator_type</a> &amp;&#160;</td>
<td class="paramname"><em>allocator</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs an emitter 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="emitter_8hpp_source.html#l00058">58</a> of file <a class="el" href="emitter_8hpp_source.html">emitter.hpp</a>.</p>
</div>
</div>
<a id="abffc10f084ae3158a400ca4a26768bfa" name="abffc10f084ae3158a400ca4a26768bfa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abffc10f084ae3158a400ca4a26768bfa">&#9670;&#160;</a></span>~emitter()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Derived , typename Allocator &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classentt_1_1emitter.html">entt::emitter</a>&lt; Derived, Allocator &gt;::~<a class="el" href="classentt_1_1emitter.html">emitter</a> </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 class="mlabel">virtual</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Default destructor. </p>
<p class="definition">Definition at line <a class="el" href="emitter_8hpp_source.html#l00062">62</a> of file <a class="el" href="emitter_8hpp_source.html">emitter.hpp</a>.</p>
</div>
</div>
<a id="a351058758b1fc6840c467a10fd2912c4" name="a351058758b1fc6840c467a10fd2912c4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a351058758b1fc6840c467a10fd2912c4">&#9670;&#160;</a></span>emitter() <span class="overload">[3/4]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Derived , typename Allocator &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classentt_1_1emitter.html">entt::emitter</a>&lt; Derived, Allocator &gt;::emitter </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classentt_1_1emitter.html">emitter</a>&lt; Derived, Allocator &gt; &amp;&amp;&#160;</td>
<td class="paramname"><em>other</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>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>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="emitter_8hpp_source.html#l00070">70</a> of file <a class="el" href="emitter_8hpp_source.html">emitter.hpp</a>.</p>
</div>
</div>
<a id="af78e1139f2a728260850d4fd667a0fbf" name="af78e1139f2a728260850d4fd667a0fbf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af78e1139f2a728260850d4fd667a0fbf">&#9670;&#160;</a></span>emitter() <span class="overload">[4/4]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Derived , typename Allocator &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classentt_1_1emitter.html">entt::emitter</a>&lt; Derived, Allocator &gt;::emitter </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classentt_1_1emitter.html">emitter</a>&lt; Derived, Allocator &gt; &amp;&amp;&#160;</td>
<td class="paramname"><em>other</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classentt_1_1emitter.html#a0d22ffe04a17ac2cdd0a216dd17e3b5d">allocator_type</a> &amp;&#160;</td>
<td class="paramname"><em>allocator</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 class="mlabel">noexcept</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="emitter_8hpp_source.html#l00078">78</a> of file <a class="el" href="emitter_8hpp_source.html">emitter.hpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a5222e50d997a70afcdfc678a26d59ca4" name="a5222e50d997a70afcdfc678a26d59ca4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5222e50d997a70afcdfc678a26d59ca4">&#9670;&#160;</a></span>clear()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Derived , typename Allocator &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classentt_1_1emitter.html">entt::emitter</a>&lt; Derived, Allocator &gt;::clear </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 class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Disconnects all the listeners. </p>
<p class="definition">Definition at line <a class="el" href="emitter_8hpp_source.html#l00146">146</a> of file <a class="el" href="emitter_8hpp_source.html">emitter.hpp</a>.</p>
</div>
</div>
<a id="a6bced239a3a07f86dc759ebc1a71813a" name="a6bced239a3a07f86dc759ebc1a71813a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6bced239a3a07f86dc759ebc1a71813a">&#9670;&#160;</a></span>contains()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Derived , typename Allocator &gt; </div>
<div class="memtemplate">
template&lt;typename Type &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classentt_1_1emitter.html">entt::emitter</a>&lt; Derived, Allocator &gt;::contains </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 there are listeners registered for the specific event. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Type</td><td>Type of event to test. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if there are no listeners registered, false otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="emitter_8hpp_source.html#l00156">156</a> of file <a class="el" href="emitter_8hpp_source.html">emitter.hpp</a>.</p>
</div>
</div>
<a id="ac9fe97c008e4923e4e784faddc9f4eca" name="ac9fe97c008e4923e4e784faddc9f4eca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac9fe97c008e4923e4e784faddc9f4eca">&#9670;&#160;</a></span>empty()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Derived , typename Allocator &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classentt_1_1emitter.html">entt::emitter</a>&lt; Derived, Allocator &gt;::empty </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 class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks if there are listeners registered with the event emitter. </p>
<dl class="section return"><dt>Returns</dt><dd>True if there are no listeners registered, false otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="emitter_8hpp_source.html#l00164">164</a> of file <a class="el" href="emitter_8hpp_source.html">emitter.hpp</a>.</p>
</div>
</div>
<a id="aa1c5ac5f75740ebb9fa3eb9f533ba23c" name="aa1c5ac5f75740ebb9fa3eb9f533ba23c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa1c5ac5f75740ebb9fa3eb9f533ba23c">&#9670;&#160;</a></span>erase()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Derived , typename Allocator &gt; </div>
<div class="memtemplate">
template&lt;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_1emitter.html">entt::emitter</a>&lt; Derived, Allocator &gt;::erase </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>Disconnects a listener from the event emitter. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Type</td><td>Type of event of the listener. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="emitter_8hpp_source.html#l00141">141</a> of file <a class="el" href="emitter_8hpp_source.html">emitter.hpp</a>.</p>
</div>
</div>
<a id="ae7a4a02a33a8b4c0fb6014f32a793dd9" name="ae7a4a02a33a8b4c0fb6014f32a793dd9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae7a4a02a33a8b4c0fb6014f32a793dd9">&#9670;&#160;</a></span>get_allocator()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Derived , typename Allocator &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr <a class="el" href="classentt_1_1emitter.html#a0d22ffe04a17ac2cdd0a216dd17e3b5d">allocator_type</a> <a class="el" href="classentt_1_1emitter.html">entt::emitter</a>&lt; Derived, Allocator &gt;::get_allocator </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 class="mlabel">constexpr</span><span class="mlabel">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="emitter_8hpp_source.html#l00108">108</a> of file <a class="el" href="emitter_8hpp_source.html">emitter.hpp</a>.</p>
</div>
</div>
<a id="ad620441c088f7e4d1cc4f852f4ec4bad" name="ad620441c088f7e4d1cc4f852f4ec4bad"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad620441c088f7e4d1cc4f852f4ec4bad">&#9670;&#160;</a></span>on()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Derived , typename Allocator &gt; </div>
<div class="memtemplate">
template&lt;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_1emitter.html">entt::emitter</a>&lt; Derived, Allocator &gt;::on </td>
<td>(</td>
<td class="paramtype">std::function&lt; void(Type &amp;, Derived &amp;)&gt;&#160;</td>
<td class="paramname"><em>func</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>Registers a listener with the event emitter. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Type</td><td>Type of event to which to connect the listener. </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">func</td><td>The listener to register. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="emitter_8hpp_source.html#l00130">130</a> of file <a class="el" href="emitter_8hpp_source.html">emitter.hpp</a>.</p>
</div>
</div>
<a id="a3cf6cad201e76ebbc43d426518928501" name="a3cf6cad201e76ebbc43d426518928501"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3cf6cad201e76ebbc43d426518928501">&#9670;&#160;</a></span>operator=()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Derived , typename Allocator &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classentt_1_1emitter.html">emitter</a> &amp; <a class="el" href="classentt_1_1emitter.html">entt::emitter</a>&lt; Derived, Allocator &gt;::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classentt_1_1emitter.html">emitter</a>&lt; Derived, Allocator &gt; &amp;&amp;&#160;</td>
<td class="paramname"><em>other</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Move assignment operator. </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>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>This dispatcher. </dd></dl>
<p class="definition">Definition at line <a class="el" href="emitter_8hpp_source.html#l00088">88</a> of file <a class="el" href="emitter_8hpp_source.html">emitter.hpp</a>.</p>
</div>
</div>
<a id="a7d8d8141c67248b448f47f5a123fd8e9" name="a7d8d8141c67248b448f47f5a123fd8e9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7d8d8141c67248b448f47f5a123fd8e9">&#9670;&#160;</a></span>publish()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Derived , typename Allocator &gt; </div>
<div class="memtemplate">
template&lt;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_1emitter.html">entt::emitter</a>&lt; Derived, Allocator &gt;::publish </td>
<td>(</td>
<td class="paramtype">Type &amp;&amp;&#160;</td>
<td class="paramname"><em>value</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>Publishes a given event. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Type</td><td>Type of event to trigger. </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>An instance of the given type of event. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="emitter_8hpp_source.html#l00118">118</a> of file <a class="el" href="emitter_8hpp_source.html">emitter.hpp</a>.</p>
</div>
</div>
<a id="a98b35cbec0716390be9c8be8582946c4" name="a98b35cbec0716390be9c8be8582946c4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a98b35cbec0716390be9c8be8582946c4">&#9670;&#160;</a></span>swap()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Derived , typename Allocator &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classentt_1_1emitter.html">entt::emitter</a>&lt; Derived, Allocator &gt;::swap </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classentt_1_1emitter.html">emitter</a>&lt; Derived, Allocator &gt; &amp;&#160;</td>
<td class="paramname"><em>other</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>Exchanges the contents with those of a given emitter. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td>Emitter to exchange the content with. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="emitter_8hpp_source.html#l00099">99</a> of file <a class="el" href="emitter_8hpp_source.html">emitter.hpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/entt/signal/<a class="el" href="emitter_8hpp_source.html">emitter.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.6
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink