1032 lines
58 KiB
HTML
1032 lines
58 KiB
HTML
<!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.13.2"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>EnTT: entt::basic_sigh_mixin< Type, Registry > 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>
|
|
<script type="text/javascript" src="clipboard.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="cookie.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"> 3.15.0</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.13.2 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() { codefold.init(0); });
|
|
/* @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&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search',false);
|
|
$(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function(){ initResizable(false); });
|
|
/* @license-end */
|
|
</script>
|
|
<!-- 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_1basic__sigh__mixin.html">basic_sigh_mixin</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div id="doc-content">
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-types">Public Types</a> |
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="classentt_1_1basic__sigh__mixin-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">entt::basic_sigh_mixin< Type, Registry > Class Template Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Mixin type used to add signal support to storage types.
|
|
<a href="#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="mixin_8hpp_source.html">mixin.hpp</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for entt::basic_sigh_mixin< Type, Registry >:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classentt_1_1basic__sigh__mixin__inherit__graph.png" border="0" usemap="#aentt_1_1basic__sigh__mixin_3_01Type_00_01Registry_01_4_inherit__map" alt="Inheritance graph"/></div>
|
|
<map name="aentt_1_1basic__sigh__mixin_3_01Type_00_01Registry_01_4_inherit__map" id="aentt_1_1basic__sigh__mixin_3_01Type_00_01Registry_01_4_inherit__map">
|
|
<area shape="rect" title="Mixin type used to add signal support to storage types." alt="" coords="5,79,157,119"/>
|
|
<area shape="rect" title=" " alt="" coords="56,5,107,31"/>
|
|
<area shape="poly" title=" " alt="" coords="84,44,84,79,79,79,79,44"/>
|
|
</map>
|
|
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
|
|
<div class="dynheader">
|
|
Collaboration diagram for entt::basic_sigh_mixin< Type, Registry >:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classentt_1_1basic__sigh__mixin__coll__graph.png" border="0" usemap="#aentt_1_1basic__sigh__mixin_3_01Type_00_01Registry_01_4_coll__map" alt="Collaboration graph"/></div>
|
|
<map name="aentt_1_1basic__sigh__mixin_3_01Type_00_01Registry_01_4_coll__map" id="aentt_1_1basic__sigh__mixin_3_01Type_00_01Registry_01_4_coll__map">
|
|
<area shape="rect" title="Mixin type used to add signal support to storage types." alt="" coords="5,79,157,119"/>
|
|
<area shape="rect" title=" " alt="" coords="56,5,107,31"/>
|
|
<area shape="poly" title=" " alt="" coords="84,44,84,79,79,79,79,44"/>
|
|
</map>
|
|
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
|
|
<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:a3bfbe6206629d98c0e15d15798865c84" id="r_a3bfbe6206629d98c0e15d15798865c84"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="#a3bfbe6206629d98c0e15d15798865c84">allocator_type</a> = typename underlying_type::allocator_type</td></tr>
|
|
<tr class="memdesc:a3bfbe6206629d98c0e15d15798865c84"><td class="mdescLeft"> </td><td class="mdescRight">Allocator type. <br /></td></tr>
|
|
<tr class="separator:a3bfbe6206629d98c0e15d15798865c84"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0af7926221dcae3edc768c1b710de79f" id="r_a0af7926221dcae3edc768c1b710de79f"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="#a0af7926221dcae3edc768c1b710de79f">entity_type</a> = typename underlying_type::entity_type</td></tr>
|
|
<tr class="memdesc:a0af7926221dcae3edc768c1b710de79f"><td class="mdescLeft"> </td><td class="mdescRight">Underlying entity identifier. <br /></td></tr>
|
|
<tr class="separator:a0af7926221dcae3edc768c1b710de79f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5eddc32c85c4c0e0d20d5288add24bc3" id="r_a5eddc32c85c4c0e0d20d5288add24bc3"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="#a5eddc32c85c4c0e0d20d5288add24bc3">registry_type</a> = owner_type</td></tr>
|
|
<tr class="memdesc:a5eddc32c85c4c0e0d20d5288add24bc3"><td class="mdescLeft"> </td><td class="mdescRight">Expected registry type. <br /></td></tr>
|
|
<tr class="separator:a5eddc32c85c4c0e0d20d5288add24bc3"><td class="memSeparator" colspan="2"> </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:a6374b697a080abbbc826161799dad699" id="r_a6374b697a080abbbc826161799dad699"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a6374b697a080abbbc826161799dad699">basic_sigh_mixin</a> ()</td></tr>
|
|
<tr class="memdesc:a6374b697a080abbbc826161799dad699"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br /></td></tr>
|
|
<tr class="separator:a6374b697a080abbbc826161799dad699"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5e37835efeb7a49d40155e392722418a" id="r_a5e37835efeb7a49d40155e392722418a"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a5e37835efeb7a49d40155e392722418a">basic_sigh_mixin</a> (const <a class="el" href="#a3bfbe6206629d98c0e15d15798865c84">allocator_type</a> &allocator)</td></tr>
|
|
<tr class="memdesc:a5e37835efeb7a49d40155e392722418a"><td class="mdescLeft"> </td><td class="mdescRight">Constructs an empty storage with a given allocator. <br /></td></tr>
|
|
<tr class="separator:a5e37835efeb7a49d40155e392722418a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8d78fa2f9dd8a7489a7306b75366e6bf" id="r_a8d78fa2f9dd8a7489a7306b75366e6bf"><td class="memItemLeft" align="right" valign="top"><a id="a8d78fa2f9dd8a7489a7306b75366e6bf" name="a8d78fa2f9dd8a7489a7306b75366e6bf"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>basic_sigh_mixin</b> (const <a class="el" href="classentt_1_1basic__sigh__mixin.html">basic_sigh_mixin</a> &)=delete</td></tr>
|
|
<tr class="memdesc:a8d78fa2f9dd8a7489a7306b75366e6bf"><td class="mdescLeft"> </td><td class="mdescRight">Default copy constructor, deleted on purpose. <br /></td></tr>
|
|
<tr class="separator:a8d78fa2f9dd8a7489a7306b75366e6bf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8924ad4c2e88eb1fd15ab585ca7505a8" id="r_a8924ad4c2e88eb1fd15ab585ca7505a8"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a8924ad4c2e88eb1fd15ab585ca7505a8">basic_sigh_mixin</a> (<a class="el" href="classentt_1_1basic__sigh__mixin.html">basic_sigh_mixin</a> &&other) noexcept</td></tr>
|
|
<tr class="memdesc:a8924ad4c2e88eb1fd15ab585ca7505a8"><td class="mdescLeft"> </td><td class="mdescRight">Move constructor. <br /></td></tr>
|
|
<tr class="separator:a8924ad4c2e88eb1fd15ab585ca7505a8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab367b15994cddc48d7cd1e34c419beb4" id="r_ab367b15994cddc48d7cd1e34c419beb4"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ab367b15994cddc48d7cd1e34c419beb4">basic_sigh_mixin</a> (<a class="el" href="classentt_1_1basic__sigh__mixin.html">basic_sigh_mixin</a> &&other, const <a class="el" href="#a3bfbe6206629d98c0e15d15798865c84">allocator_type</a> &allocator)</td></tr>
|
|
<tr class="memdesc:ab367b15994cddc48d7cd1e34c419beb4"><td class="mdescLeft"> </td><td class="mdescRight">Allocator-extended move constructor. <br /></td></tr>
|
|
<tr class="separator:ab367b15994cddc48d7cd1e34c419beb4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8d4ca0355d2eb28044c0ba055f75d85b" id="r_a8d4ca0355d2eb28044c0ba055f75d85b"><td class="memItemLeft" align="right" valign="top"><a id="a8d4ca0355d2eb28044c0ba055f75d85b" name="a8d4ca0355d2eb28044c0ba055f75d85b"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>~basic_sigh_mixin</b> () override=default</td></tr>
|
|
<tr class="memdesc:a8d4ca0355d2eb28044c0ba055f75d85b"><td class="mdescLeft"> </td><td class="mdescRight">Default destructor. <br /></td></tr>
|
|
<tr class="separator:a8d4ca0355d2eb28044c0ba055f75d85b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af44458bdfcc2084eed576af724383fdd" id="r_af44458bdfcc2084eed576af724383fdd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1basic__sigh__mixin.html">basic_sigh_mixin</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#af44458bdfcc2084eed576af724383fdd">operator=</a> (const <a class="el" href="classentt_1_1basic__sigh__mixin.html">basic_sigh_mixin</a> &)=delete</td></tr>
|
|
<tr class="memdesc:af44458bdfcc2084eed576af724383fdd"><td class="mdescLeft"> </td><td class="mdescRight">Default copy assignment operator, deleted on purpose. <br /></td></tr>
|
|
<tr class="separator:af44458bdfcc2084eed576af724383fdd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4c00f12e254af5e6b3ccd6ab89d79737" id="r_a4c00f12e254af5e6b3ccd6ab89d79737"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1basic__sigh__mixin.html">basic_sigh_mixin</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#a4c00f12e254af5e6b3ccd6ab89d79737">operator=</a> (<a class="el" href="classentt_1_1basic__sigh__mixin.html">basic_sigh_mixin</a> &&other) noexcept</td></tr>
|
|
<tr class="memdesc:a4c00f12e254af5e6b3ccd6ab89d79737"><td class="mdescLeft"> </td><td class="mdescRight">Move assignment operator. <br /></td></tr>
|
|
<tr class="separator:a4c00f12e254af5e6b3ccd6ab89d79737"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a41f34b4216ba01ab99fd4c85f57d363a" id="r_a41f34b4216ba01ab99fd4c85f57d363a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a41f34b4216ba01ab99fd4c85f57d363a">swap</a> (<a class="el" href="classentt_1_1basic__sigh__mixin.html">basic_sigh_mixin</a> &other) noexcept</td></tr>
|
|
<tr class="memdesc:a41f34b4216ba01ab99fd4c85f57d363a"><td class="mdescLeft"> </td><td class="mdescRight">Exchanges the contents with those of a given storage. <br /></td></tr>
|
|
<tr class="separator:a41f34b4216ba01ab99fd4c85f57d363a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0c57f7ab639278e2445da4cd1ac32187" id="r_a0c57f7ab639278e2445da4cd1ac32187"><td class="memItemLeft" align="right" valign="top">auto </td><td class="memItemRight" valign="bottom"><a class="el" href="#a0c57f7ab639278e2445da4cd1ac32187">on_construct</a> () noexcept</td></tr>
|
|
<tr class="memdesc:a0c57f7ab639278e2445da4cd1ac32187"><td class="mdescLeft"> </td><td class="mdescRight">Returns a sink object. <br /></td></tr>
|
|
<tr class="separator:a0c57f7ab639278e2445da4cd1ac32187"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0ac778697e4f09d34062415753b13f27" id="r_a0ac778697e4f09d34062415753b13f27"><td class="memItemLeft" align="right" valign="top">auto </td><td class="memItemRight" valign="bottom"><a class="el" href="#a0ac778697e4f09d34062415753b13f27">on_update</a> () noexcept</td></tr>
|
|
<tr class="memdesc:a0ac778697e4f09d34062415753b13f27"><td class="mdescLeft"> </td><td class="mdescRight">Returns a sink object. <br /></td></tr>
|
|
<tr class="separator:a0ac778697e4f09d34062415753b13f27"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab95e47b07373502e551033b45fd79c74" id="r_ab95e47b07373502e551033b45fd79c74"><td class="memItemLeft" align="right" valign="top">auto </td><td class="memItemRight" valign="bottom"><a class="el" href="#ab95e47b07373502e551033b45fd79c74">on_destroy</a> () noexcept</td></tr>
|
|
<tr class="memdesc:ab95e47b07373502e551033b45fd79c74"><td class="mdescLeft"> </td><td class="mdescRight">Returns a sink object. <br /></td></tr>
|
|
<tr class="separator:ab95e47b07373502e551033b45fd79c74"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1dc138f96dbb5d5ccb6668b812f80231" id="r_a1dc138f96dbb5d5ccb6668b812f80231"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a1dc138f96dbb5d5ccb6668b812f80231">operator bool</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a1dc138f96dbb5d5ccb6668b812f80231"><td class="mdescLeft"> </td><td class="mdescRight">Checks if a mixin refers to a valid registry. <br /></td></tr>
|
|
<tr class="separator:a1dc138f96dbb5d5ccb6668b812f80231"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a15bac16d552602c9d3b8069dc2c5421a" id="r_a15bac16d552602c9d3b8069dc2c5421a"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="#a5eddc32c85c4c0e0d20d5288add24bc3">registry_type</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#a15bac16d552602c9d3b8069dc2c5421a">registry</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a15bac16d552602c9d3b8069dc2c5421a"><td class="mdescLeft"> </td><td class="mdescRight">Returns a pointer to the underlying registry, if any. <br /></td></tr>
|
|
<tr class="separator:a15bac16d552602c9d3b8069dc2c5421a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a77dc805c82973744114f33417337bb97" id="r_a77dc805c82973744114f33417337bb97"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a5eddc32c85c4c0e0d20d5288add24bc3">registry_type</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#a77dc805c82973744114f33417337bb97">registry</a> () noexcept</td></tr>
|
|
<tr class="memdesc:a77dc805c82973744114f33417337bb97"><td class="mdescLeft"> </td><td class="mdescRight">Returns a pointer to the underlying registry, if any. <br /></td></tr>
|
|
<tr class="separator:a77dc805c82973744114f33417337bb97"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aecb243e7869599f48e8acf9b21a380ca" id="r_aecb243e7869599f48e8acf9b21a380ca"><td class="memItemLeft" align="right" valign="top">auto </td><td class="memItemRight" valign="bottom"><a class="el" href="#aecb243e7869599f48e8acf9b21a380ca">generate</a> ()</td></tr>
|
|
<tr class="memdesc:aecb243e7869599f48e8acf9b21a380ca"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new identifier or recycles a destroyed one. <br /></td></tr>
|
|
<tr class="separator:aecb243e7869599f48e8acf9b21a380ca"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3c5c054e7644149a58e88025aa607cce" id="r_a3c5c054e7644149a58e88025aa607cce"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a0af7926221dcae3edc768c1b710de79f">entity_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a3c5c054e7644149a58e88025aa607cce">generate</a> (const <a class="el" href="#a0af7926221dcae3edc768c1b710de79f">entity_type</a> hint)</td></tr>
|
|
<tr class="memdesc:a3c5c054e7644149a58e88025aa607cce"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new identifier or recycles a destroyed one. <br /></td></tr>
|
|
<tr class="separator:a3c5c054e7644149a58e88025aa607cce"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a18f129c8b510408c7e697e5210dbcb6f" id="r_a18f129c8b510408c7e697e5210dbcb6f"><td class="memTemplParams" colspan="2">template<typename It> </td></tr>
|
|
<tr class="memitem:a18f129c8b510408c7e697e5210dbcb6f"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a18f129c8b510408c7e697e5210dbcb6f">generate</a> (It first, It last)</td></tr>
|
|
<tr class="memdesc:a18f129c8b510408c7e697e5210dbcb6f"><td class="mdescLeft"> </td><td class="mdescRight">Assigns each element in a range an identifier. <br /></td></tr>
|
|
<tr class="separator:a18f129c8b510408c7e697e5210dbcb6f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a78517b70c5f6dbf8cb1cdd94ea1b5890" id="r_a78517b70c5f6dbf8cb1cdd94ea1b5890"><td class="memTemplParams" colspan="2">template<typename... Args> </td></tr>
|
|
<tr class="memitem:a78517b70c5f6dbf8cb1cdd94ea1b5890"><td class="memTemplItemLeft" align="right" valign="top">decltype(auto) </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a78517b70c5f6dbf8cb1cdd94ea1b5890">emplace</a> (const <a class="el" href="#a0af7926221dcae3edc768c1b710de79f">entity_type</a> entt, Args &&...args)</td></tr>
|
|
<tr class="memdesc:a78517b70c5f6dbf8cb1cdd94ea1b5890"><td class="mdescLeft"> </td><td class="mdescRight">Assigns an entity to a storage and constructs its object. <br /></td></tr>
|
|
<tr class="separator:a78517b70c5f6dbf8cb1cdd94ea1b5890"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1825979313096feb7d59d09f2e821d77" id="r_a1825979313096feb7d59d09f2e821d77"><td class="memTemplParams" colspan="2">template<typename... Func> </td></tr>
|
|
<tr class="memitem:a1825979313096feb7d59d09f2e821d77"><td class="memTemplItemLeft" align="right" valign="top">decltype(auto) </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a1825979313096feb7d59d09f2e821d77">patch</a> (const <a class="el" href="#a0af7926221dcae3edc768c1b710de79f">entity_type</a> entt, Func &&...func)</td></tr>
|
|
<tr class="memdesc:a1825979313096feb7d59d09f2e821d77"><td class="mdescLeft"> </td><td class="mdescRight">Updates the instance assigned to a given entity in-place. <br /></td></tr>
|
|
<tr class="separator:a1825979313096feb7d59d09f2e821d77"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa53fc080eb084535f639efd1e67f3e3c" id="r_aa53fc080eb084535f639efd1e67f3e3c"><td class="memTemplParams" colspan="2">template<typename It, typename... Args> </td></tr>
|
|
<tr class="memitem:aa53fc080eb084535f639efd1e67f3e3c"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#aa53fc080eb084535f639efd1e67f3e3c">insert</a> (It first, It last, Args &&...args)</td></tr>
|
|
<tr class="memdesc:aa53fc080eb084535f639efd1e67f3e3c"><td class="mdescLeft"> </td><td class="mdescRight">Assigns one or more entities to a storage and constructs their objects from a given instance. <br /></td></tr>
|
|
<tr class="separator:aa53fc080eb084535f639efd1e67f3e3c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><div class="compoundTemplParams">template<typename Type, typename Registry><br />
|
|
class entt::basic_sigh_mixin< Type, Registry ></div><p>Mixin type used to add signal support to storage types. </p>
|
|
<p>The function type of a listener is equivalent to:</p>
|
|
<div class="fragment"><div class="line">void(<a class="code hl_class" href="classentt_1_1basic__registry.html">basic_registry<entity_type></a> &, <a class="code hl_typedef" href="#a0af7926221dcae3edc768c1b710de79f">entity_type</a>);</div>
|
|
<div class="ttc" id="aclassentt_1_1basic__registry_html"><div class="ttname"><a href="classentt_1_1basic__registry.html">entt::basic_registry</a></div><div class="ttdoc">Fast and reliable entity-component system.</div><div class="ttdef"><b>Definition</b> <a href="registry_8hpp_source.html#l00234">registry.hpp:234</a></div></div>
|
|
<div class="ttc" id="aclassentt_1_1basic__sigh__mixin_html_a0af7926221dcae3edc768c1b710de79f"><div class="ttname"><a href="#a0af7926221dcae3edc768c1b710de79f">entt::basic_sigh_mixin::entity_type</a></div><div class="ttdeci">typename underlying_type::entity_type entity_type</div><div class="ttdoc">Underlying entity identifier.</div><div class="ttdef"><b>Definition</b> <a href="mixin_8hpp_source.html#l00134">mixin.hpp:134</a></div></div>
|
|
</div><!-- fragment --><p>This applies to all signals made available.</p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">Type</td><td>Underlying storage type. </td></tr>
|
|
<tr><td class="paramname">Registry</td><td>Basic registry type. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mixin_8hpp_source.html#l00057">57</a> of file <a class="el" href="mixin_8hpp_source.html">mixin.hpp</a>.</p>
|
|
</div><h2 class="groupheader">Member Typedef Documentation</h2>
|
|
<a id="a3bfbe6206629d98c0e15d15798865c84" name="a3bfbe6206629d98c0e15d15798865c84"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3bfbe6206629d98c0e15d15798865c84">◆ </a></span>allocator_type</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type, typename Registry> </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">using <a class="el" href="classentt_1_1basic__sigh__mixin.html">entt::basic_sigh_mixin</a>< Type, Registry >::allocator_type = typename underlying_type::allocator_type</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Allocator type. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mixin_8hpp_source.html#l00132">132</a> of file <a class="el" href="mixin_8hpp_source.html">mixin.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0af7926221dcae3edc768c1b710de79f" name="a0af7926221dcae3edc768c1b710de79f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0af7926221dcae3edc768c1b710de79f">◆ </a></span>entity_type</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type, typename Registry> </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">using <a class="el" href="classentt_1_1basic__sigh__mixin.html">entt::basic_sigh_mixin</a>< Type, Registry >::entity_type = typename underlying_type::entity_type</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Underlying entity identifier. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mixin_8hpp_source.html#l00134">134</a> of file <a class="el" href="mixin_8hpp_source.html">mixin.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5eddc32c85c4c0e0d20d5288add24bc3" name="a5eddc32c85c4c0e0d20d5288add24bc3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5eddc32c85c4c0e0d20d5288add24bc3">◆ </a></span>registry_type</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type, typename Registry> </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">using <a class="el" href="classentt_1_1basic__sigh__mixin.html">entt::basic_sigh_mixin</a>< Type, Registry >::registry_type = owner_type</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Expected registry type. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mixin_8hpp_source.html#l00136">136</a> of file <a class="el" href="mixin_8hpp_source.html">mixin.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a6374b697a080abbbc826161799dad699" name="a6374b697a080abbbc826161799dad699"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6374b697a080abbbc826161799dad699">◆ </a></span>basic_sigh_mixin() <span class="overload">[1/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type, typename Registry> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1basic__sigh__mixin.html">entt::basic_sigh_mixin</a>< Type, Registry >::basic_sigh_mixin </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Default constructor. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mixin_8hpp_source.html#l00139">139</a> of file <a class="el" href="mixin_8hpp_source.html">mixin.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5e37835efeb7a49d40155e392722418a" name="a5e37835efeb7a49d40155e392722418a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5e37835efeb7a49d40155e392722418a">◆ </a></span>basic_sigh_mixin() <span class="overload">[2/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type, typename Registry> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1basic__sigh__mixin.html">entt::basic_sigh_mixin</a>< Type, Registry >::basic_sigh_mixin </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="#a3bfbe6206629d98c0e15d15798865c84">allocator_type</a> &</td> <td class="paramname"><span class="paramname"><em>allocator</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel explicit">explicit</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Constructs an empty storage 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="mixin_8hpp_source.html#l00146">146</a> of file <a class="el" href="mixin_8hpp_source.html">mixin.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8924ad4c2e88eb1fd15ab585ca7505a8" name="a8924ad4c2e88eb1fd15ab585ca7505a8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8924ad4c2e88eb1fd15ab585ca7505a8">◆ </a></span>basic_sigh_mixin() <span class="overload">[3/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type, typename Registry> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1basic__sigh__mixin.html">entt::basic_sigh_mixin</a>< Type, Registry >::basic_sigh_mixin </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classentt_1_1basic__sigh__mixin.html">basic_sigh_mixin</a>< Type, Registry > &&</td> <td class="paramname"><span class="paramname"><em>other</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel noexcept">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="mixin_8hpp_source.html#l00173">173</a> of file <a class="el" href="mixin_8hpp_source.html">mixin.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab367b15994cddc48d7cd1e34c419beb4" name="ab367b15994cddc48d7cd1e34c419beb4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab367b15994cddc48d7cd1e34c419beb4">◆ </a></span>basic_sigh_mixin() <span class="overload">[4/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type, typename Registry> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1basic__sigh__mixin.html">entt::basic_sigh_mixin</a>< Type, Registry >::basic_sigh_mixin </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classentt_1_1basic__sigh__mixin.html">basic_sigh_mixin</a>< Type, Registry > &&</td> <td class="paramname"><span class="paramname"><em>other</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="#a3bfbe6206629d98c0e15d15798865c84">allocator_type</a> &</td> <td class="paramname"><span class="paramname"><em>allocator</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</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="mixin_8hpp_source.html#l00187">187</a> of file <a class="el" href="mixin_8hpp_source.html">mixin.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a78517b70c5f6dbf8cb1cdd94ea1b5890" name="a78517b70c5f6dbf8cb1cdd94ea1b5890"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a78517b70c5f6dbf8cb1cdd94ea1b5890">◆ </a></span>emplace()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type, typename Registry> </div>
|
|
<div class="memtemplate">
|
|
template<typename... Args> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">decltype(auto) <a class="el" href="classentt_1_1basic__sigh__mixin.html">entt::basic_sigh_mixin</a>< Type, Registry >::emplace </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="#a0af7926221dcae3edc768c1b710de79f">entity_type</a></td> <td class="paramname"><span class="paramname"><em>entt</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">Args &&...</td> <td class="paramname"><span class="paramname"><em>args</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Assigns an entity to a storage and constructs its object. </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">Args</td><td>Types of arguments to forward to the underlying storage. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">entt</td><td>A valid identifier. </td></tr>
|
|
<tr><td class="paramname">args</td><td>Parameters to forward to the underlying storage. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A reference to the newly created object. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mixin_8hpp_source.html#l00339">339</a> of file <a class="el" href="mixin_8hpp_source.html">mixin.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aecb243e7869599f48e8acf9b21a380ca" name="aecb243e7869599f48e8acf9b21a380ca"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aecb243e7869599f48e8acf9b21a380ca">◆ </a></span>generate() <span class="overload">[1/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type, typename Registry> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">auto <a class="el" href="classentt_1_1basic__sigh__mixin.html">entt::basic_sigh_mixin</a>< Type, Registry >::generate </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Creates a new identifier or recycles a destroyed one. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>A valid identifier. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mixin_8hpp_source.html#l00297">297</a> of file <a class="el" href="mixin_8hpp_source.html">mixin.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3c5c054e7644149a58e88025aa607cce" name="a3c5c054e7644149a58e88025aa607cce"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3c5c054e7644149a58e88025aa607cce">◆ </a></span>generate() <span class="overload">[2/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type, typename Registry> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="#a0af7926221dcae3edc768c1b710de79f">entity_type</a> <a class="el" href="classentt_1_1basic__sigh__mixin.html">entt::basic_sigh_mixin</a>< Type, Registry >::generate </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="#a0af7926221dcae3edc768c1b710de79f">entity_type</a></td> <td class="paramname"><span class="paramname"><em>hint</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Creates a new identifier or recycles a destroyed one. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">hint</td><td>Required identifier. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A valid identifier. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mixin_8hpp_source.html#l00308">308</a> of file <a class="el" href="mixin_8hpp_source.html">mixin.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a18f129c8b510408c7e697e5210dbcb6f" name="a18f129c8b510408c7e697e5210dbcb6f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a18f129c8b510408c7e697e5210dbcb6f">◆ </a></span>generate() <span class="overload">[3/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type, typename Registry> </div>
|
|
<div class="memtemplate">
|
|
template<typename It> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classentt_1_1basic__sigh__mixin.html">entt::basic_sigh_mixin</a>< Type, Registry >::generate </td>
|
|
<td>(</td>
|
|
<td class="paramtype">It</td> <td class="paramname"><span class="paramname"><em>first</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">It</td> <td class="paramname"><span class="paramname"><em>last</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Assigns each element in a range an identifier. </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">It</td><td>Type of mutable forward iterator. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">first</td><td>An iterator to the first element of the range to generate. </td></tr>
|
|
<tr><td class="paramname">last</td><td>An iterator past the last element of the range to generate. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mixin_8hpp_source.html#l00321">321</a> of file <a class="el" href="mixin_8hpp_source.html">mixin.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa53fc080eb084535f639efd1e67f3e3c" name="aa53fc080eb084535f639efd1e67f3e3c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa53fc080eb084535f639efd1e67f3e3c">◆ </a></span>insert()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type, typename Registry> </div>
|
|
<div class="memtemplate">
|
|
template<typename It, typename... Args> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classentt_1_1basic__sigh__mixin.html">entt::basic_sigh_mixin</a>< Type, Registry >::insert </td>
|
|
<td>(</td>
|
|
<td class="paramtype">It</td> <td class="paramname"><span class="paramname"><em>first</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">It</td> <td class="paramname"><span class="paramname"><em>last</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">Args &&...</td> <td class="paramname"><span class="paramname"><em>args</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Assigns one or more entities to a storage and constructs their objects from a given instance. </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">It</td><td>Type of input iterator. </td></tr>
|
|
<tr><td class="paramname">Args</td><td>Types of arguments to forward to the underlying storage. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">first</td><td>An iterator to the first element of the range of entities. </td></tr>
|
|
<tr><td class="paramname">last</td><td>An iterator past the last element of the range of entities. </td></tr>
|
|
<tr><td class="paramname">args</td><td>Parameters to use to forward to the underlying storage. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mixin_8hpp_source.html#l00369">369</a> of file <a class="el" href="mixin_8hpp_source.html">mixin.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0c57f7ab639278e2445da4cd1ac32187" name="a0c57f7ab639278e2445da4cd1ac32187"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0c57f7ab639278e2445da4cd1ac32187">◆ </a></span>on_construct()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type, typename Registry> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">auto <a class="el" href="classentt_1_1basic__sigh__mixin.html">entt::basic_sigh_mixin</a>< Type, Registry >::on_construct </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel nodiscard">nodiscard</span><span class="mlabel noexcept">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns a sink object. </p>
|
|
<p>The sink returned by this function can be used to receive notifications whenever a new instance is created and assigned to an entity.<br />
|
|
Listeners are invoked after the object has been assigned to the entity.</p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classentt_1_1sink.html" title="Sink class.">sink</a></dd></dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A temporary sink object. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mixin_8hpp_source.html#l00238">238</a> of file <a class="el" href="mixin_8hpp_source.html">mixin.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab95e47b07373502e551033b45fd79c74" name="ab95e47b07373502e551033b45fd79c74"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab95e47b07373502e551033b45fd79c74">◆ </a></span>on_destroy()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type, typename Registry> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">auto <a class="el" href="classentt_1_1basic__sigh__mixin.html">entt::basic_sigh_mixin</a>< Type, Registry >::on_destroy </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel nodiscard">nodiscard</span><span class="mlabel noexcept">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns a sink object. </p>
|
|
<p>The sink returned by this function can be used to receive notifications whenever an instance is removed from an entity and thus destroyed.<br />
|
|
Listeners are invoked before the object has been removed from the entity.</p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classentt_1_1sink.html" title="Sink class.">sink</a></dd></dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A temporary sink object. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mixin_8hpp_source.html#l00268">268</a> of file <a class="el" href="mixin_8hpp_source.html">mixin.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0ac778697e4f09d34062415753b13f27" name="a0ac778697e4f09d34062415753b13f27"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0ac778697e4f09d34062415753b13f27">◆ </a></span>on_update()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type, typename Registry> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">auto <a class="el" href="classentt_1_1basic__sigh__mixin.html">entt::basic_sigh_mixin</a>< Type, Registry >::on_update </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel nodiscard">nodiscard</span><span class="mlabel noexcept">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns a sink object. </p>
|
|
<p>The sink returned by this function can be used to receive notifications whenever an instance is explicitly updated.<br />
|
|
Listeners are invoked after the object has been updated.</p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classentt_1_1sink.html" title="Sink class.">sink</a></dd></dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A temporary sink object. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mixin_8hpp_source.html#l00253">253</a> of file <a class="el" href="mixin_8hpp_source.html">mixin.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1dc138f96dbb5d5ccb6668b812f80231" name="a1dc138f96dbb5d5ccb6668b812f80231"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1dc138f96dbb5d5ccb6668b812f80231">◆ </a></span>operator bool()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type, typename Registry> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1basic__sigh__mixin.html">entt::basic_sigh_mixin</a>< Type, Registry >::operator bool </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel explicit">explicit</span><span class="mlabel nodiscard">nodiscard</span><span class="mlabel noexcept">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Checks if a mixin refers to a valid registry. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if the mixin refers to a valid registry, false otherwise. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mixin_8hpp_source.html#l00276">276</a> of file <a class="el" href="mixin_8hpp_source.html">mixin.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4c00f12e254af5e6b3ccd6ab89d79737" name="a4c00f12e254af5e6b3ccd6ab89d79737"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4c00f12e254af5e6b3ccd6ab89d79737">◆ </a></span>operator=() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type, typename Registry> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1basic__sigh__mixin.html">basic_sigh_mixin</a> & <a class="el" href="classentt_1_1basic__sigh__mixin.html">entt::basic_sigh_mixin</a>< Type, Registry >::operator= </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classentt_1_1basic__sigh__mixin.html">basic_sigh_mixin</a>< Type, Registry > &&</td> <td class="paramname"><span class="paramname"><em>other</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel noexcept">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 mixin. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mixin_8hpp_source.html#l00209">209</a> of file <a class="el" href="mixin_8hpp_source.html">mixin.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af44458bdfcc2084eed576af724383fdd" name="af44458bdfcc2084eed576af724383fdd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af44458bdfcc2084eed576af724383fdd">◆ </a></span>operator=() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type, typename Registry> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classentt_1_1basic__sigh__mixin.html">basic_sigh_mixin</a> & <a class="el" href="classentt_1_1basic__sigh__mixin.html">entt::basic_sigh_mixin</a>< Type, Registry >::operator= </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classentt_1_1basic__sigh__mixin.html">basic_sigh_mixin</a>< Type, Registry > &</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel delete">delete</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Default copy assignment operator, deleted on purpose. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>This mixin. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1825979313096feb7d59d09f2e821d77" name="a1825979313096feb7d59d09f2e821d77"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1825979313096feb7d59d09f2e821d77">◆ </a></span>patch()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type, typename Registry> </div>
|
|
<div class="memtemplate">
|
|
template<typename... Func> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">decltype(auto) <a class="el" href="classentt_1_1basic__sigh__mixin.html">entt::basic_sigh_mixin</a>< Type, Registry >::patch </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="#a0af7926221dcae3edc768c1b710de79f">entity_type</a></td> <td class="paramname"><span class="paramname"><em>entt</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">Func &&...</td> <td class="paramname"><span class="paramname"><em>func</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Updates the instance assigned to a given entity in-place. </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">Func</td><td>Types of the function objects to invoke. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">entt</td><td>A valid identifier. </td></tr>
|
|
<tr><td class="paramname">func</td><td>Valid function objects. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A reference to the patched instance. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mixin_8hpp_source.html#l00353">353</a> of file <a class="el" href="mixin_8hpp_source.html">mixin.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a15bac16d552602c9d3b8069dc2c5421a" name="a15bac16d552602c9d3b8069dc2c5421a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a15bac16d552602c9d3b8069dc2c5421a">◆ </a></span>registry() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type, typename Registry> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const <a class="el" href="#a5eddc32c85c4c0e0d20d5288add24bc3">registry_type</a> & <a class="el" href="classentt_1_1basic__sigh__mixin.html">entt::basic_sigh_mixin</a>< Type, Registry >::registry </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel nodiscard">nodiscard</span><span class="mlabel noexcept">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns a pointer to the underlying registry, if any. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>A pointer to the underlying registry, if any. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mixin_8hpp_source.html#l00284">284</a> of file <a class="el" href="mixin_8hpp_source.html">mixin.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a77dc805c82973744114f33417337bb97" name="a77dc805c82973744114f33417337bb97"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a77dc805c82973744114f33417337bb97">◆ </a></span>registry() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type, typename Registry> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="#a5eddc32c85c4c0e0d20d5288add24bc3">registry_type</a> & <a class="el" href="classentt_1_1basic__sigh__mixin.html">entt::basic_sigh_mixin</a>< Type, Registry >::registry </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel nodiscard">nodiscard</span><span class="mlabel noexcept">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns a pointer to the underlying registry, if any. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>A pointer to the underlying registry, if any. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mixin_8hpp_source.html#l00289">289</a> of file <a class="el" href="mixin_8hpp_source.html">mixin.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a41f34b4216ba01ab99fd4c85f57d363a" name="a41f34b4216ba01ab99fd4c85f57d363a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a41f34b4216ba01ab99fd4c85f57d363a">◆ </a></span>swap()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Type, typename Registry> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classentt_1_1basic__sigh__mixin.html">entt::basic_sigh_mixin</a>< Type, Registry >::swap </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classentt_1_1basic__sigh__mixin.html">basic_sigh_mixin</a>< Type, Registry > &</td> <td class="paramname"><span class="paramname"><em>other</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel noexcept">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Exchanges the contents with those of a given storage. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">other</td><td>Storage to exchange the content with. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="mixin_8hpp_source.html#l00218">218</a> of file <a class="el" href="mixin_8hpp_source.html">mixin.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="mixin_8hpp_source.html">mixin.hpp</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.2
|
|
</small></address>
|
|
</div><!-- doc-content -->
|
|
</body>
|
|
</html>
|