318 lines
15 KiB
HTML
318 lines
15 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_base 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
|
|
 <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__base.html">meta_base</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="structentt_1_1meta__base-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">entt::meta_base Struct Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Opaque container for meta base classes.
|
|
<a href="structentt_1_1meta__base.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="meta_8hpp_source.html">meta.hpp</a>></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:a7138b13e8dc1d75ad4e47ef89780eda4"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__base.html#a7138b13e8dc1d75ad4e47ef89780eda4">meta_base</a> (const internal::meta_base_node *curr=nullptr) ENTT_NOEXCEPT</td></tr>
|
|
<tr class="memdesc:a7138b13e8dc1d75ad4e47ef89780eda4"><td class="mdescLeft"> </td><td class="mdescRight">Constructs an instance from a given node. <a href="#a7138b13e8dc1d75ad4e47ef89780eda4">More...</a><br /></td></tr>
|
|
<tr class="separator:a7138b13e8dc1d75ad4e47ef89780eda4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad05e984d2cc36f64c0a64fe951e9cdce"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1meta__type.html">meta_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__base.html#ad05e984d2cc36f64c0a64fe951e9cdce">parent</a> () const ENTT_NOEXCEPT</td></tr>
|
|
<tr class="memdesc:ad05e984d2cc36f64c0a64fe951e9cdce"><td class="mdescLeft"> </td><td class="mdescRight">Returns the meta type to which a meta object belongs. <a href="#ad05e984d2cc36f64c0a64fe951e9cdce">More...</a><br /></td></tr>
|
|
<tr class="separator:ad05e984d2cc36f64c0a64fe951e9cdce"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5e9f69b43cdc90add110654acde5e8b6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1meta__type.html">meta_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__base.html#a5e9f69b43cdc90add110654acde5e8b6">type</a> () const ENTT_NOEXCEPT</td></tr>
|
|
<tr class="memdesc:a5e9f69b43cdc90add110654acde5e8b6"><td class="mdescLeft"> </td><td class="mdescRight">Returns the meta type of the underlying object. <a href="#a5e9f69b43cdc90add110654acde5e8b6">More...</a><br /></td></tr>
|
|
<tr class="separator:a5e9f69b43cdc90add110654acde5e8b6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa83c9d560b8b684d93f8df90830d6c56"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__base.html#aa83c9d560b8b684d93f8df90830d6c56">cast</a> (void *instance) const ENTT_NOEXCEPT</td></tr>
|
|
<tr class="memdesc:aa83c9d560b8b684d93f8df90830d6c56"><td class="mdescLeft"> </td><td class="mdescRight">Casts an instance from a parent type to a base type. <a href="#aa83c9d560b8b684d93f8df90830d6c56">More...</a><br /></td></tr>
|
|
<tr class="separator:aa83c9d560b8b684d93f8df90830d6c56"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad19d5a997c91281da3674a6b17d011bd"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__base.html#ad19d5a997c91281da3674a6b17d011bd">operator bool</a> () const ENTT_NOEXCEPT</td></tr>
|
|
<tr class="memdesc:ad19d5a997c91281da3674a6b17d011bd"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if a meta object is valid, false otherwise. <a href="#ad19d5a997c91281da3674a6b17d011bd">More...</a><br /></td></tr>
|
|
<tr class="separator:ad19d5a997c91281da3674a6b17d011bd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6469955ac7550d5396cf185795c07a15"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__base.html#a6469955ac7550d5396cf185795c07a15">operator==</a> (const <a class="el" href="structentt_1_1meta__base.html">meta_base</a> &other) const ENTT_NOEXCEPT</td></tr>
|
|
<tr class="memdesc:a6469955ac7550d5396cf185795c07a15"><td class="mdescLeft"> </td><td class="mdescRight">Checks if two meta objects refer to the same node. <a href="#a6469955ac7550d5396cf185795c07a15">More...</a><br /></td></tr>
|
|
<tr class="separator:a6469955ac7550d5396cf185795c07a15"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Opaque container for meta base classes. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="meta_8hpp_source.html#l00831">831</a> of file <a class="el" href="meta_8hpp_source.html">meta.hpp</a>.</p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a7138b13e8dc1d75ad4e47ef89780eda4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7138b13e8dc1d75ad4e47ef89780eda4">◆ </a></span>meta_base()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">entt::meta_base::meta_base </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const internal::meta_base_node * </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#l00833">833</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="aa83c9d560b8b684d93f8df90830d6c56"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa83c9d560b8b684d93f8df90830d6c56">◆ </a></span>cast()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void* entt::meta_base::cast </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>instance</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>Casts an instance from a parent type to a base type. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">instance</td><td>The instance to cast. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>An opaque pointer to the base type. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="meta_8hpp_source.html#l00851">851</a> of file <a class="el" href="meta_8hpp_source.html">meta.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad19d5a997c91281da3674a6b17d011bd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad19d5a997c91281da3674a6b17d011bd">◆ </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_base::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#l00859">859</a> of file <a class="el" href="meta_8hpp_source.html">meta.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6469955ac7550d5396cf185795c07a15"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6469955ac7550d5396cf185795c07a15">◆ </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_base::operator== </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="structentt_1_1meta__base.html">meta_base</a> & </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#l00864">864</a> of file <a class="el" href="meta_8hpp_source.html">meta.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad05e984d2cc36f64c0a64fe951e9cdce"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad05e984d2cc36f64c0a64fe951e9cdce">◆ </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_base::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#l01791">1791</a> of file <a class="el" href="meta_8hpp_source.html">meta.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5e9f69b43cdc90add110654acde5e8b6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5e9f69b43cdc90add110654acde5e8b6">◆ </a></span>type()</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_base::type </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 of the underlying object. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The meta type of the underlying object, if any. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="meta_8hpp_source.html#l01796">1796</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  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.13
|
|
</small></address>
|
|
</body>
|
|
</html>
|