Scarfski/entt
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
ac9898a17454fee86ed74dc419e51da222ec0c3a
entt/structentt_1_1basic__actor.html
Michele Caini ac9898a174 API reference v3.3.0
2020-02-22 15:45:18 +01:00

764 lines
40 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.16"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>EnTT: entt::basic_actor&lt; Entity &gt; Struct Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">EnTT
&#160;<span id="projectnumber">3.3.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.16 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceentt.html">entt</a></li><li class="navelem"><a class="el" href="structentt_1_1basic__actor.html">basic_actor</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="structentt_1_1basic__actor-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">entt::basic_actor&lt; Entity &gt; Struct Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Dedicated to those who aren't confident with the entity-component-system architecture.
<a href="structentt_1_1basic__actor.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="actor_8hpp_source.html">actor.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a4577b087e2fe3e76dbd4516ae9064c6a"><td class="memItemLeft" align="right" valign="top"><a id="a4577b087e2fe3e76dbd4516ae9064c6a"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__actor.html#a4577b087e2fe3e76dbd4516ae9064c6a">registry_type</a> = <a class="el" href="classentt_1_1basic__registry.html">basic_registry</a>&lt; Entity &gt;</td></tr>
<tr class="memdesc:a4577b087e2fe3e76dbd4516ae9064c6a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type of registry used internally. <br /></td></tr>
<tr class="separator:a4577b087e2fe3e76dbd4516ae9064c6a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2c2e10f12014f5269be0b9ab055acfca"><td class="memItemLeft" align="right" valign="top"><a id="a2c2e10f12014f5269be0b9ab055acfca"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__actor.html#a2c2e10f12014f5269be0b9ab055acfca">entity_type</a> = Entity</td></tr>
<tr class="memdesc:a2c2e10f12014f5269be0b9ab055acfca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Underlying entity identifier. <br /></td></tr>
<tr class="separator:a2c2e10f12014f5269be0b9ab055acfca"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ae7ee04b6533cba81bda114ada62dfd32"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__actor.html#ae7ee04b6533cba81bda114ada62dfd32">basic_actor</a> (<a class="el" href="structentt_1_1basic__actor.html">basic_actor</a> &amp;&amp;other) ENTT_NOEXCEPT</td></tr>
<tr class="memdesc:ae7ee04b6533cba81bda114ada62dfd32"><td class="mdescLeft">&#160;</td><td class="mdescRight">Move constructor. <a href="structentt_1_1basic__actor.html#ae7ee04b6533cba81bda114ada62dfd32">More...</a><br /></td></tr>
<tr class="separator:ae7ee04b6533cba81bda114ada62dfd32"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a32635ae3046ebca665adef6b3ef87ef3"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__actor.html#a32635ae3046ebca665adef6b3ef87ef3">basic_actor</a> (<a class="el" href="structentt_1_1basic__actor.html#a4577b087e2fe3e76dbd4516ae9064c6a">registry_type</a> &amp;ref)</td></tr>
<tr class="memdesc:a32635ae3046ebca665adef6b3ef87ef3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs an actor from a given registry. <a href="structentt_1_1basic__actor.html#a32635ae3046ebca665adef6b3ef87ef3">More...</a><br /></td></tr>
<tr class="separator:a32635ae3046ebca665adef6b3ef87ef3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab4a485086774e27688e467f4c28a3ba7"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__actor.html#ab4a485086774e27688e467f4c28a3ba7">basic_actor</a> (<a class="el" href="structentt_1_1basic__actor.html#a2c2e10f12014f5269be0b9ab055acfca">entity_type</a> <a class="el" href="structentt_1_1basic__actor.html#af92d62c39e122692addbfd6b75ea6922">entity</a>, <a class="el" href="structentt_1_1basic__actor.html#a4577b087e2fe3e76dbd4516ae9064c6a">registry_type</a> &amp;ref) ENTT_NOEXCEPT</td></tr>
<tr class="memdesc:ab4a485086774e27688e467f4c28a3ba7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs an actor from a given entity. <a href="structentt_1_1basic__actor.html#ab4a485086774e27688e467f4c28a3ba7">More...</a><br /></td></tr>
<tr class="separator:ab4a485086774e27688e467f4c28a3ba7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a46dc913885c448e059e9ca7cf3a21221"><td class="memItemLeft" align="right" valign="top"><a id="a46dc913885c448e059e9ca7cf3a21221"></a>
virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__actor.html#a46dc913885c448e059e9ca7cf3a21221">~basic_actor</a> ()</td></tr>
<tr class="memdesc:a46dc913885c448e059e9ca7cf3a21221"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default destructor. <br /></td></tr>
<tr class="separator:a46dc913885c448e059e9ca7cf3a21221"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afffc47714413306f1f3f16d8dafe5673"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structentt_1_1basic__actor.html">basic_actor</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__actor.html#afffc47714413306f1f3f16d8dafe5673">operator=</a> (<a class="el" href="structentt_1_1basic__actor.html">basic_actor</a> &amp;&amp;other) ENTT_NOEXCEPT</td></tr>
<tr class="memdesc:afffc47714413306f1f3f16d8dafe5673"><td class="mdescLeft">&#160;</td><td class="mdescRight">Move assignment operator. <a href="structentt_1_1basic__actor.html#afffc47714413306f1f3f16d8dafe5673">More...</a><br /></td></tr>
<tr class="separator:afffc47714413306f1f3f16d8dafe5673"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abf572e19a5d9625fbf80cc4f00cba032"><td class="memTemplParams" colspan="2">template&lt;typename Component , typename... Args&gt; </td></tr>
<tr class="memitem:abf572e19a5d9625fbf80cc4f00cba032"><td class="memTemplItemLeft" align="right" valign="top">decltype(auto)&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__actor.html#abf572e19a5d9625fbf80cc4f00cba032">assign</a> (Args &amp;&amp;... args)</td></tr>
<tr class="memdesc:abf572e19a5d9625fbf80cc4f00cba032"><td class="mdescLeft">&#160;</td><td class="mdescRight">Assigns the given component to an actor. <a href="structentt_1_1basic__actor.html#abf572e19a5d9625fbf80cc4f00cba032">More...</a><br /></td></tr>
<tr class="separator:abf572e19a5d9625fbf80cc4f00cba032"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab740844d18ada7ad15988f808617a1a1"><td class="memTemplParams" colspan="2">template&lt;typename Component &gt; </td></tr>
<tr class="memitem:ab740844d18ada7ad15988f808617a1a1"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__actor.html#ab740844d18ada7ad15988f808617a1a1">remove</a> ()</td></tr>
<tr class="memdesc:ab740844d18ada7ad15988f808617a1a1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Removes the given component from an actor. <a href="structentt_1_1basic__actor.html#ab740844d18ada7ad15988f808617a1a1">More...</a><br /></td></tr>
<tr class="separator:ab740844d18ada7ad15988f808617a1a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad22a9b6b33a34328a874c96e40f3e6d2"><td class="memTemplParams" colspan="2">template&lt;typename... Component&gt; </td></tr>
<tr class="memitem:ad22a9b6b33a34328a874c96e40f3e6d2"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__actor.html#ad22a9b6b33a34328a874c96e40f3e6d2">has</a> () const</td></tr>
<tr class="memdesc:ad22a9b6b33a34328a874c96e40f3e6d2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if an actor has the given components. <a href="structentt_1_1basic__actor.html#ad22a9b6b33a34328a874c96e40f3e6d2">More...</a><br /></td></tr>
<tr class="separator:ad22a9b6b33a34328a874c96e40f3e6d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1429f1e5b4a80f13219b99addd169f7c"><td class="memTemplParams" colspan="2">template&lt;typename... Component&gt; </td></tr>
<tr class="memitem:a1429f1e5b4a80f13219b99addd169f7c"><td class="memTemplItemLeft" align="right" valign="top">decltype(auto)&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__actor.html#a1429f1e5b4a80f13219b99addd169f7c">get</a> () const</td></tr>
<tr class="memdesc:a1429f1e5b4a80f13219b99addd169f7c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns references to the given components for an actor. <a href="structentt_1_1basic__actor.html#a1429f1e5b4a80f13219b99addd169f7c">More...</a><br /></td></tr>
<tr class="separator:a1429f1e5b4a80f13219b99addd169f7c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afa85d0d013950f57fea284784c6c7bc2"><td class="memTemplParams" colspan="2">template&lt;typename... Component&gt; </td></tr>
<tr class="memitem:afa85d0d013950f57fea284784c6c7bc2"><td class="memTemplItemLeft" align="right" valign="top">decltype(auto)&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__actor.html#afa85d0d013950f57fea284784c6c7bc2">get</a> ()</td></tr>
<tr class="memdesc:afa85d0d013950f57fea284784c6c7bc2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns references to the given components for an actor. <a href="structentt_1_1basic__actor.html#afa85d0d013950f57fea284784c6c7bc2">More...</a><br /></td></tr>
<tr class="separator:afa85d0d013950f57fea284784c6c7bc2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afb2752c70a8429962b4e0c5ca240e95a"><td class="memTemplParams" colspan="2">template&lt;typename... Component&gt; </td></tr>
<tr class="memitem:afb2752c70a8429962b4e0c5ca240e95a"><td class="memTemplItemLeft" align="right" valign="top">auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__actor.html#afb2752c70a8429962b4e0c5ca240e95a">try_get</a> () const</td></tr>
<tr class="memdesc:afb2752c70a8429962b4e0c5ca240e95a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns pointers to the given components for an actor. <a href="structentt_1_1basic__actor.html#afb2752c70a8429962b4e0c5ca240e95a">More...</a><br /></td></tr>
<tr class="separator:afb2752c70a8429962b4e0c5ca240e95a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2c9c5fdcdc7a524a917c419a59bed405"><td class="memTemplParams" colspan="2">template&lt;typename... Component&gt; </td></tr>
<tr class="memitem:a2c9c5fdcdc7a524a917c419a59bed405"><td class="memTemplItemLeft" align="right" valign="top">auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__actor.html#a2c9c5fdcdc7a524a917c419a59bed405">try_get</a> ()</td></tr>
<tr class="memdesc:a2c9c5fdcdc7a524a917c419a59bed405"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns pointers to the given components for an actor. <a href="structentt_1_1basic__actor.html#a2c9c5fdcdc7a524a917c419a59bed405">More...</a><br /></td></tr>
<tr class="separator:a2c9c5fdcdc7a524a917c419a59bed405"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a079bddd72566b14843729a154a8f684e"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structentt_1_1basic__actor.html#a4577b087e2fe3e76dbd4516ae9064c6a">registry_type</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__actor.html#a079bddd72566b14843729a154a8f684e">backend</a> () const ENTT_NOEXCEPT</td></tr>
<tr class="memdesc:a079bddd72566b14843729a154a8f684e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a reference to the underlying registry. <a href="structentt_1_1basic__actor.html#a079bddd72566b14843729a154a8f684e">More...</a><br /></td></tr>
<tr class="separator:a079bddd72566b14843729a154a8f684e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a827ed2e23e39e8b706f7acc511a46024"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structentt_1_1basic__actor.html#a4577b087e2fe3e76dbd4516ae9064c6a">registry_type</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__actor.html#a827ed2e23e39e8b706f7acc511a46024">backend</a> () ENTT_NOEXCEPT</td></tr>
<tr class="memdesc:a827ed2e23e39e8b706f7acc511a46024"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a reference to the underlying registry. <a href="structentt_1_1basic__actor.html#a827ed2e23e39e8b706f7acc511a46024">More...</a><br /></td></tr>
<tr class="separator:a827ed2e23e39e8b706f7acc511a46024"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af92d62c39e122692addbfd6b75ea6922"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structentt_1_1basic__actor.html#a2c2e10f12014f5269be0b9ab055acfca">entity_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__actor.html#af92d62c39e122692addbfd6b75ea6922">entity</a> () const ENTT_NOEXCEPT</td></tr>
<tr class="memdesc:af92d62c39e122692addbfd6b75ea6922"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the entity associated with an actor. <a href="structentt_1_1basic__actor.html#af92d62c39e122692addbfd6b75ea6922">More...</a><br /></td></tr>
<tr class="separator:af92d62c39e122692addbfd6b75ea6922"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae04982e3b8fac20ded6159b75ec98bd0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1basic__actor.html#ae04982e3b8fac20ded6159b75ec98bd0">operator bool</a> () const</td></tr>
<tr class="memdesc:ae04982e3b8fac20ded6159b75ec98bd0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if an actor refers to a valid entity or not. <a href="structentt_1_1basic__actor.html#ae04982e3b8fac20ded6159b75ec98bd0">More...</a><br /></td></tr>
<tr class="separator:ae04982e3b8fac20ded6159b75ec98bd0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename Entity&gt;<br />
struct entt::basic_actor&lt; Entity &gt;</h3>
<p>Dedicated to those who aren't confident with the entity-component-system architecture. </p>
<p>Tiny wrapper around a registry, for all those users that aren't confident with entity-component-system architecture and prefer to iterate objects directly.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Entity</td><td>A valid entity type (see <a class="el" href="structentt_1_1entt__traits.html" title="Entity traits.">entt_traits</a> for more details). </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="actor_8hpp_source.html#l00027">27</a> of file <a class="el" href="actor_8hpp_source.html">actor.hpp</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ae7ee04b6533cba81bda114ada62dfd32"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae7ee04b6533cba81bda114ada62dfd32">&#9670;&nbsp;</a></span>basic_actor() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structentt_1_1basic__actor.html">entt::basic_actor</a>&lt; Entity &gt;::<a class="el" href="structentt_1_1basic__actor.html">basic_actor</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structentt_1_1basic__actor.html">basic_actor</a>&lt; Entity &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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Move constructor. </p>
<p>After actor move construction, instances that have been moved from are placed in a valid but unspecified state. It's highly discouraged to continue using them.</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="actor_8hpp_source.html#l00046">46</a> of file <a class="el" href="actor_8hpp_source.html">actor.hpp</a>.</p>
</div>
</div>
<a id="a32635ae3046ebca665adef6b3ef87ef3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a32635ae3046ebca665adef6b3ef87ef3">&#9670;&nbsp;</a></span>basic_actor() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structentt_1_1basic__actor.html">entt::basic_actor</a>&lt; Entity &gt;::<a class="el" href="structentt_1_1basic__actor.html">basic_actor</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structentt_1_1basic__actor.html#a4577b087e2fe3e76dbd4516ae9064c6a">registry_type</a> &amp;&#160;</td>
<td class="paramname"><em>ref</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 actor from a given registry. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ref</td><td>An instance of the registry class. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="actor_8hpp_source.html#l00056">56</a> of file <a class="el" href="actor_8hpp_source.html">actor.hpp</a>.</p>
</div>
</div>
<a id="ab4a485086774e27688e467f4c28a3ba7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab4a485086774e27688e467f4c28a3ba7">&#9670;&nbsp;</a></span>basic_actor() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structentt_1_1basic__actor.html">entt::basic_actor</a>&lt; Entity &gt;::<a class="el" href="structentt_1_1basic__actor.html">basic_actor</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structentt_1_1basic__actor.html#a2c2e10f12014f5269be0b9ab055acfca">entity_type</a>&#160;</td>
<td class="paramname"><em>entity</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structentt_1_1basic__actor.html#a4577b087e2fe3e76dbd4516ae9064c6a">registry_type</a> &amp;&#160;</td>
<td class="paramname"><em>ref</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">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs an actor from a given entity. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">entity</td><td>A valid entity identifier. </td></tr>
<tr><td class="paramname">ref</td><td>An instance of the registry class. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="actor_8hpp_source.html#l00065">65</a> of file <a class="el" href="actor_8hpp_source.html">actor.hpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="abf572e19a5d9625fbf80cc4f00cba032"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abf572e19a5d9625fbf80cc4f00cba032">&#9670;&nbsp;</a></span>assign()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity &gt; </div>
<div class="memtemplate">
template&lt;typename Component , typename... Args&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">decltype(auto) <a class="el" href="structentt_1_1basic__actor.html">entt::basic_actor</a>&lt; Entity &gt;::assign </td>
<td>(</td>
<td class="paramtype">Args &amp;&amp;...&#160;</td>
<td class="paramname"><em>args</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>Assigns the given component to an actor. </p>
<p>A new instance of the given component is created and initialized with the arguments provided (the component must have a proper constructor or be of aggregate type). Then the component is assigned to the actor.<br />
In case the actor already has a component of the given type, it's replaced with the new one.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Component</td><td>Type of the component to create. </td></tr>
<tr><td class="paramname">Args</td><td>Types of arguments to use to construct the component. </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">args</td><td>Parameters to use to initialize the component. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A reference to the newly created component. </dd></dl>
<p class="definition">Definition at line <a class="el" href="actor_8hpp_source.html#l00113">113</a> of file <a class="el" href="actor_8hpp_source.html">actor.hpp</a>.</p>
</div>
</div>
<a id="a079bddd72566b14843729a154a8f684e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a079bddd72566b14843729a154a8f684e">&#9670;&nbsp;</a></span>backend() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="structentt_1_1basic__actor.html#a4577b087e2fe3e76dbd4516ae9064c6a">registry_type</a>&amp; <a class="el" href="structentt_1_1basic__actor.html">entt::basic_actor</a>&lt; Entity &gt;::backend </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a reference to the underlying registry. </p>
<dl class="section return"><dt>Returns</dt><dd>A reference to the underlying registry. </dd></dl>
<p class="definition">Definition at line <a class="el" href="actor_8hpp_source.html#l00172">172</a> of file <a class="el" href="actor_8hpp_source.html">actor.hpp</a>.</p>
</div>
</div>
<a id="a827ed2e23e39e8b706f7acc511a46024"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a827ed2e23e39e8b706f7acc511a46024">&#9670;&nbsp;</a></span>backend() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structentt_1_1basic__actor.html#a4577b087e2fe3e76dbd4516ae9064c6a">registry_type</a>&amp; <a class="el" href="structentt_1_1basic__actor.html">entt::basic_actor</a>&lt; Entity &gt;::backend </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>Returns a reference to the underlying registry. </p>
<dl class="section return"><dt>Returns</dt><dd>A reference to the underlying registry. </dd></dl>
<p class="definition">Definition at line <a class="el" href="actor_8hpp_source.html#l00177">177</a> of file <a class="el" href="actor_8hpp_source.html">actor.hpp</a>.</p>
</div>
</div>
<a id="af92d62c39e122692addbfd6b75ea6922"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af92d62c39e122692addbfd6b75ea6922">&#9670;&nbsp;</a></span>entity()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structentt_1_1basic__actor.html#a2c2e10f12014f5269be0b9ab055acfca">entity_type</a> <a class="el" href="structentt_1_1basic__actor.html">entt::basic_actor</a>&lt; Entity &gt;::entity </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the entity associated with an actor. </p>
<dl class="section return"><dt>Returns</dt><dd>The entity associated with the actor. </dd></dl>
<p class="definition">Definition at line <a class="el" href="actor_8hpp_source.html#l00185">185</a> of file <a class="el" href="actor_8hpp_source.html">actor.hpp</a>.</p>
</div>
</div>
<a id="afa85d0d013950f57fea284784c6c7bc2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afa85d0d013950f57fea284784c6c7bc2">&#9670;&nbsp;</a></span>get() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity &gt; </div>
<div class="memtemplate">
template&lt;typename... Component&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">decltype(auto) <a class="el" href="structentt_1_1basic__actor.html">entt::basic_actor</a>&lt; Entity &gt;::get </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>Returns references to the given components for an actor. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Component</td><td>Types of components to get. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>References to the components owned by the actor. </dd></dl>
<p class="definition">Definition at line <a class="el" href="actor_8hpp_source.html#l00148">148</a> of file <a class="el" href="actor_8hpp_source.html">actor.hpp</a>.</p>
</div>
</div>
<a id="a1429f1e5b4a80f13219b99addd169f7c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1429f1e5b4a80f13219b99addd169f7c">&#9670;&nbsp;</a></span>get() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity &gt; </div>
<div class="memtemplate">
template&lt;typename... Component&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">decltype(auto) <a class="el" href="structentt_1_1basic__actor.html">entt::basic_actor</a>&lt; Entity &gt;::get </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns references to the given components for an actor. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Component</td><td>Types of components to get. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>References to the components owned by the actor. </dd></dl>
<p class="definition">Definition at line <a class="el" href="actor_8hpp_source.html#l00142">142</a> of file <a class="el" href="actor_8hpp_source.html">actor.hpp</a>.</p>
</div>
</div>
<a id="ad22a9b6b33a34328a874c96e40f3e6d2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad22a9b6b33a34328a874c96e40f3e6d2">&#9670;&nbsp;</a></span>has()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity &gt; </div>
<div class="memtemplate">
template&lt;typename... Component&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="structentt_1_1basic__actor.html">entt::basic_actor</a>&lt; Entity &gt;::has </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 an actor has the given components. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Component</td><td>Components for which to perform the check. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if the actor has all the components, false otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="actor_8hpp_source.html#l00132">132</a> of file <a class="el" href="actor_8hpp_source.html">actor.hpp</a>.</p>
</div>
</div>
<a id="ae04982e3b8fac20ded6159b75ec98bd0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae04982e3b8fac20ded6159b75ec98bd0">&#9670;&nbsp;</a></span>operator bool()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structentt_1_1basic__actor.html">entt::basic_actor</a>&lt; Entity &gt;::operator bool </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">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks if an actor refers to a valid entity or not. </p>
<dl class="section return"><dt>Returns</dt><dd>True if the actor refers to a valid entity, false otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="actor_8hpp_source.html#l00193">193</a> of file <a class="el" href="actor_8hpp_source.html">actor.hpp</a>.</p>
</div>
</div>
<a id="afffc47714413306f1f3f16d8dafe5673"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afffc47714413306f1f3f16d8dafe5673">&#9670;&nbsp;</a></span>operator=()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structentt_1_1basic__actor.html">basic_actor</a>&amp; <a class="el" href="structentt_1_1basic__actor.html">entt::basic_actor</a>&lt; Entity &gt;::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structentt_1_1basic__actor.html">basic_actor</a>&lt; Entity &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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Move assignment operator. </p>
<p>After actor move assignment, instances that have been moved from are placed in a valid but unspecified state. It's highly discouraged to continue using them.</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 actor. </dd></dl>
<p class="definition">Definition at line <a class="el" href="actor_8hpp_source.html#l00088">88</a> of file <a class="el" href="actor_8hpp_source.html">actor.hpp</a>.</p>
</div>
</div>
<a id="ab740844d18ada7ad15988f808617a1a1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab740844d18ada7ad15988f808617a1a1">&#9670;&nbsp;</a></span>remove()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity &gt; </div>
<div class="memtemplate">
template&lt;typename Component &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="structentt_1_1basic__actor.html">entt::basic_actor</a>&lt; Entity &gt;::remove </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>Removes the given component from an actor. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Component</td><td>Type of the component to remove. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="actor_8hpp_source.html#l00122">122</a> of file <a class="el" href="actor_8hpp_source.html">actor.hpp</a>.</p>
</div>
</div>
<a id="a2c9c5fdcdc7a524a917c419a59bed405"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2c9c5fdcdc7a524a917c419a59bed405">&#9670;&nbsp;</a></span>try_get() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity &gt; </div>
<div class="memtemplate">
template&lt;typename... Component&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">auto <a class="el" href="structentt_1_1basic__actor.html">entt::basic_actor</a>&lt; Entity &gt;::try_get </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>Returns pointers to the given components for an actor. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Component</td><td>Types of components to get. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Pointers to the components owned by the actor. </dd></dl>
<p class="definition">Definition at line <a class="el" href="actor_8hpp_source.html#l00164">164</a> of file <a class="el" href="actor_8hpp_source.html">actor.hpp</a>.</p>
</div>
</div>
<a id="afb2752c70a8429962b4e0c5ca240e95a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afb2752c70a8429962b4e0c5ca240e95a">&#9670;&nbsp;</a></span>try_get() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Entity &gt; </div>
<div class="memtemplate">
template&lt;typename... Component&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">auto <a class="el" href="structentt_1_1basic__actor.html">entt::basic_actor</a>&lt; Entity &gt;::try_get </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns pointers to the given components for an actor. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Component</td><td>Types of components to get. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Pointers to the components owned by the actor. </dd></dl>
<p class="definition">Definition at line <a class="el" href="actor_8hpp_source.html#l00158">158</a> of file <a class="el" href="actor_8hpp_source.html">actor.hpp</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>src/entt/entity/<a class="el" href="actor_8hpp_source.html">actor.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.16
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink