Files
entt/structentt_1_1meta__dtor.html
2019-10-30 00:07:19 +01:00

286 lines
13 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>EnTT: entt::meta_dtor Struct 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.2.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div 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_1meta__dtor.html">meta_dtor</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="structentt_1_1meta__dtor-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">entt::meta_dtor Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Opaque container for meta destructors.
<a href="structentt_1_1meta__dtor.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="meta_8hpp_source.html">meta.hpp</a>&gt;</code></p>
<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:ab50c68d1bcb838404513bc08381ef3c5"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__dtor.html#ab50c68d1bcb838404513bc08381ef3c5">meta_dtor</a> (const internal::meta_dtor_node *curr=nullptr) ENTT_NOEXCEPT</td></tr>
<tr class="memdesc:ab50c68d1bcb838404513bc08381ef3c5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs an instance from a given node. <a href="#ab50c68d1bcb838404513bc08381ef3c5">More...</a><br /></td></tr>
<tr class="separator:ab50c68d1bcb838404513bc08381ef3c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad5cf3129b534f5cb6f736a713f71e37e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1meta__type.html">meta_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__dtor.html#ad5cf3129b534f5cb6f736a713f71e37e">parent</a> () const ENTT_NOEXCEPT</td></tr>
<tr class="memdesc:ad5cf3129b534f5cb6f736a713f71e37e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the meta type to which a meta object belongs. <a href="#ad5cf3129b534f5cb6f736a713f71e37e">More...</a><br /></td></tr>
<tr class="separator:ad5cf3129b534f5cb6f736a713f71e37e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0b61f83fcfee615d8a27d9ff31c3deed"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__dtor.html#a0b61f83fcfee615d8a27d9ff31c3deed">invoke</a> (<a class="el" href="classentt_1_1meta__handle.html">meta_handle</a> <a class="el" href="classentt_1_1handle.html">handle</a>) const</td></tr>
<tr class="memdesc:a0b61f83fcfee615d8a27d9ff31c3deed"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroys an instance of the underlying type. <a href="#a0b61f83fcfee615d8a27d9ff31c3deed">More...</a><br /></td></tr>
<tr class="separator:a0b61f83fcfee615d8a27d9ff31c3deed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad4b53dd0805dd47276c196b093258deb"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__dtor.html#ad4b53dd0805dd47276c196b093258deb">operator bool</a> () const ENTT_NOEXCEPT</td></tr>
<tr class="memdesc:ad4b53dd0805dd47276c196b093258deb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if a meta object is valid, false otherwise. <a href="#ad4b53dd0805dd47276c196b093258deb">More...</a><br /></td></tr>
<tr class="separator:ad4b53dd0805dd47276c196b093258deb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a55905a8daf9dafcdc33e38e1247b1e9d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__dtor.html#a55905a8daf9dafcdc33e38e1247b1e9d">operator==</a> (const <a class="el" href="structentt_1_1meta__dtor.html">meta_dtor</a> &amp;other) const ENTT_NOEXCEPT</td></tr>
<tr class="memdesc:a55905a8daf9dafcdc33e38e1247b1e9d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if two meta objects refer to the same node. <a href="#a55905a8daf9dafcdc33e38e1247b1e9d">More...</a><br /></td></tr>
<tr class="separator:a55905a8daf9dafcdc33e38e1247b1e9d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Opaque container for meta destructors. </p>
<p class="definition">Definition at line <a class="el" href="meta_8hpp_source.html#l01023">1023</a> of file <a class="el" href="meta_8hpp_source.html">meta.hpp</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ab50c68d1bcb838404513bc08381ef3c5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab50c68d1bcb838404513bc08381ef3c5">&#9670;&nbsp;</a></span>meta_dtor()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">entt::meta_dtor::meta_dtor </td>
<td>(</td>
<td class="paramtype">const internal::meta_dtor_node *&#160;</td>
<td class="paramname"><em>curr</em> = <code>nullptr</code></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs an instance from a given node. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">curr</td><td>The underlying node with which to construct the instance. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="meta_8hpp_source.html#l01025">1025</a> of file <a class="el" href="meta_8hpp_source.html">meta.hpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a0b61f83fcfee615d8a27d9ff31c3deed"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0b61f83fcfee615d8a27d9ff31c3deed">&#9670;&nbsp;</a></span>invoke()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool entt::meta_dtor::invoke </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classentt_1_1meta__handle.html">meta_handle</a>&#160;</td>
<td class="paramname"><em>handle</em></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>Destroys an instance of the underlying type. </p>
<p>It must be possible to cast the instance to the parent type of the meta destructor. Otherwise, invoking the meta destructor results in an undefined behavior.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">handle</td><td>An opaque pointer to an instance of the underlying type. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True in case of success, false otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="meta_8hpp_source.html#l01042">1042</a> of file <a class="el" href="meta_8hpp_source.html">meta.hpp</a>.</p>
</div>
</div>
<a id="ad4b53dd0805dd47276c196b093258deb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad4b53dd0805dd47276c196b093258deb">&#9670;&nbsp;</a></span>operator bool()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">entt::meta_dtor::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>Returns true if a meta object is valid, false otherwise. </p>
<dl class="section return"><dt>Returns</dt><dd>True if the meta object is valid, false otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="meta_8hpp_source.html#l01050">1050</a> of file <a class="el" href="meta_8hpp_source.html">meta.hpp</a>.</p>
</div>
</div>
<a id="a55905a8daf9dafcdc33e38e1247b1e9d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a55905a8daf9dafcdc33e38e1247b1e9d">&#9670;&nbsp;</a></span>operator==()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool entt::meta_dtor::operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structentt_1_1meta__dtor.html">meta_dtor</a> &amp;&#160;</td>
<td class="paramname"><em>other</em></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 two meta objects refer to the same node. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td>The meta object with which to compare. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if the two meta objects refer to the same node, false otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="meta_8hpp_source.html#l01055">1055</a> of file <a class="el" href="meta_8hpp_source.html">meta.hpp</a>.</p>
</div>
</div>
<a id="ad5cf3129b534f5cb6f736a713f71e37e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad5cf3129b534f5cb6f736a713f71e37e">&#9670;&nbsp;</a></span>parent()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classentt_1_1meta__type.html">meta_type</a> entt::meta_dtor::parent </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 meta type to which a meta object belongs. </p>
<dl class="section return"><dt>Returns</dt><dd>The meta type to which the meta object belongs. </dd></dl>
<p class="definition">Definition at line <a class="el" href="meta_8hpp_source.html#l01821">1821</a> of file <a class="el" href="meta_8hpp_source.html">meta.hpp</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>src/entt/meta/<a class="el" href="meta_8hpp_source.html">meta.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.13
</small></address>
</body>
</html>