Scarfski/entt
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
378182736cbd0398bfec188b95d3e75da58dfb22
entt/structentt_1_1meta__data.html
Michele Caini 378182736c API reference v3.10.0
2022-04-18 19:54:29 +02:00

566 lines
29 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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>EnTT: entt::meta_data 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.10.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<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','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih: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_1meta__data.html">meta_data</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_1meta__data-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">entt::meta_data Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Opaque wrapper for data members.
<a href="structentt_1_1meta__data.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-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a0aa23c3d404c35751aa6b85870eafc21"><td class="memItemLeft" align="right" valign="top"><a id="a0aa23c3d404c35751aa6b85870eafc21"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__data.html#a0aa23c3d404c35751aa6b85870eafc21">node_type</a> = internal::meta_data_node</td></tr>
<tr class="memdesc:a0aa23c3d404c35751aa6b85870eafc21"><td class="mdescLeft">&#160;</td><td class="mdescRight">Node type. <br /></td></tr>
<tr class="separator:a0aa23c3d404c35751aa6b85870eafc21"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab322080e34d8e40621a67f2f0e0672b7"><td class="memItemLeft" align="right" valign="top"><a id="ab322080e34d8e40621a67f2f0e0672b7"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__data.html#ab322080e34d8e40621a67f2f0e0672b7">size_type</a> = typename node_type::size_type</td></tr>
<tr class="memdesc:ab322080e34d8e40621a67f2f0e0672b7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unsigned integer type. <br /></td></tr>
<tr class="separator:ab322080e34d8e40621a67f2f0e0672b7"><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:a287652cfd950c698d124d12820ec9d10"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__data.html#a287652cfd950c698d124d12820ec9d10">meta_data</a> (const <a class="el" href="structentt_1_1meta__data.html#a0aa23c3d404c35751aa6b85870eafc21">node_type</a> *curr=nullptr)</td></tr>
<tr class="memdesc:a287652cfd950c698d124d12820ec9d10"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs an instance from a given node. <a href="structentt_1_1meta__data.html#a287652cfd950c698d124d12820ec9d10">More...</a><br /></td></tr>
<tr class="separator:a287652cfd950c698d124d12820ec9d10"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5e1bd9202426e41b5a0d1f25874fa7ec"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceentt.html#a13e040e7b38a8f86d1ab2f096f37b627">id_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__data.html#a5e1bd9202426e41b5a0d1f25874fa7ec">id</a> () const</td></tr>
<tr class="memdesc:a5e1bd9202426e41b5a0d1f25874fa7ec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the identifier assigned to a type. <a href="structentt_1_1meta__data.html#a5e1bd9202426e41b5a0d1f25874fa7ec">More...</a><br /></td></tr>
<tr class="separator:a5e1bd9202426e41b5a0d1f25874fa7ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae49c225400fa1938e53a5f65f6f36152"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structentt_1_1meta__data.html#ab322080e34d8e40621a67f2f0e0672b7">size_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__data.html#ae49c225400fa1938e53a5f65f6f36152">arity</a> () const</td></tr>
<tr class="memdesc:ae49c225400fa1938e53a5f65f6f36152"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the number of setters available. <a href="structentt_1_1meta__data.html#ae49c225400fa1938e53a5f65f6f36152">More...</a><br /></td></tr>
<tr class="separator:ae49c225400fa1938e53a5f65f6f36152"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a821782f679650835b47ac17949bb5f4d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__data.html#a821782f679650835b47ac17949bb5f4d">is_const</a> () const</td></tr>
<tr class="memdesc:a821782f679650835b47ac17949bb5f4d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Indicates whether a data member is constant or not. <a href="structentt_1_1meta__data.html#a821782f679650835b47ac17949bb5f4d">More...</a><br /></td></tr>
<tr class="separator:a821782f679650835b47ac17949bb5f4d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a08417d17ad41c753ec292abdeafd1782"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__data.html#a08417d17ad41c753ec292abdeafd1782">is_static</a> () const</td></tr>
<tr class="memdesc:a08417d17ad41c753ec292abdeafd1782"><td class="mdescLeft">&#160;</td><td class="mdescRight">Indicates whether a data member is static or not. <a href="structentt_1_1meta__data.html#a08417d17ad41c753ec292abdeafd1782">More...</a><br /></td></tr>
<tr class="separator:a08417d17ad41c753ec292abdeafd1782"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad088d09cff4cea8b136d05a0d30049e6"><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__data.html#ad088d09cff4cea8b136d05a0d30049e6">type</a> () const</td></tr>
<tr class="memdesc:ad088d09cff4cea8b136d05a0d30049e6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the object type if any, <code>type_id&lt;void&gt;()</code> otherwise. <a href="structentt_1_1meta__data.html#ad088d09cff4cea8b136d05a0d30049e6">More...</a><br /></td></tr>
<tr class="separator:ad088d09cff4cea8b136d05a0d30049e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9cec301b83378b11ad316663e8ece835"><td class="memTemplParams" colspan="2">template&lt;typename Type &gt; </td></tr>
<tr class="memitem:a9cec301b83378b11ad316663e8ece835"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__data.html#a9cec301b83378b11ad316663e8ece835">set</a> (<a class="el" href="structentt_1_1meta__handle.html">meta_handle</a> instance, Type &amp;&amp;value) const</td></tr>
<tr class="memdesc:a9cec301b83378b11ad316663e8ece835"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the value of a given variable. <a href="structentt_1_1meta__data.html#a9cec301b83378b11ad316663e8ece835">More...</a><br /></td></tr>
<tr class="separator:a9cec301b83378b11ad316663e8ece835"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a754da41b4c8057f7c9a3ff4738935d04"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_1_1meta__any.html">meta_any</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__data.html#a754da41b4c8057f7c9a3ff4738935d04">get</a> (<a class="el" href="structentt_1_1meta__handle.html">meta_handle</a> instance) const</td></tr>
<tr class="memdesc:a754da41b4c8057f7c9a3ff4738935d04"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the value of a given variable. <a href="structentt_1_1meta__data.html#a754da41b4c8057f7c9a3ff4738935d04">More...</a><br /></td></tr>
<tr class="separator:a754da41b4c8057f7c9a3ff4738935d04"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a754ff9b953cd8f9195776e6d6202ce84"><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__data.html#a754ff9b953cd8f9195776e6d6202ce84">arg</a> (const <a class="el" href="structentt_1_1meta__data.html#ab322080e34d8e40621a67f2f0e0672b7">size_type</a> index) const</td></tr>
<tr class="memdesc:a754ff9b953cd8f9195776e6d6202ce84"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the type accepted by the i-th setter. <a href="structentt_1_1meta__data.html#a754ff9b953cd8f9195776e6d6202ce84">More...</a><br /></td></tr>
<tr class="separator:a754ff9b953cd8f9195776e6d6202ce84"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abe3ebb33e7c66a067c5162715c66c880"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structentt_1_1meta__range.html">meta_range</a>&lt; <a class="el" href="structentt_1_1meta__prop.html">meta_prop</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__data.html#abe3ebb33e7c66a067c5162715c66c880">prop</a> () const</td></tr>
<tr class="memdesc:abe3ebb33e7c66a067c5162715c66c880"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a range to visit registered meta properties. <a href="structentt_1_1meta__data.html#abe3ebb33e7c66a067c5162715c66c880">More...</a><br /></td></tr>
<tr class="separator:abe3ebb33e7c66a067c5162715c66c880"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2258b0808fc9c35a27846804b1388fd9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structentt_1_1meta__prop.html">meta_prop</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__data.html#a2258b0808fc9c35a27846804b1388fd9">prop</a> (<a class="el" href="classentt_1_1meta__any.html">meta_any</a> key) const</td></tr>
<tr class="memdesc:a2258b0808fc9c35a27846804b1388fd9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Lookup function for registered meta properties. <a href="structentt_1_1meta__data.html#a2258b0808fc9c35a27846804b1388fd9">More...</a><br /></td></tr>
<tr class="separator:a2258b0808fc9c35a27846804b1388fd9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a597429fb3dfbc05a48d2f8dd31133d97"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__data.html#a597429fb3dfbc05a48d2f8dd31133d97">operator bool</a> () const</td></tr>
<tr class="memdesc:a597429fb3dfbc05a48d2f8dd31133d97"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if an object is valid, false otherwise. <a href="structentt_1_1meta__data.html#a597429fb3dfbc05a48d2f8dd31133d97">More...</a><br /></td></tr>
<tr class="separator:a597429fb3dfbc05a48d2f8dd31133d97"><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 wrapper for data members. </p>
<p class="definition">Definition at line <a class="el" href="meta_8hpp_source.html#l00714">714</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="a287652cfd950c698d124d12820ec9d10"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a287652cfd950c698d124d12820ec9d10">&#9670;&nbsp;</a></span>meta_data()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">entt::meta_data::meta_data </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structentt_1_1meta__data.html#a0aa23c3d404c35751aa6b85870eafc21">node_type</a> *&#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#l00721">721</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="a754ff9b953cd8f9195776e6d6202ce84"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a754ff9b953cd8f9195776e6d6202ce84">&#9670;&nbsp;</a></span>arg()</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_data::arg </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structentt_1_1meta__data.html#ab322080e34d8e40621a67f2f0e0672b7">size_type</a>&#160;</td>
<td class="paramname"><em>index</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>Returns the type accepted by the i-th setter. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">index</td><td>Index of the setter of which to return the accepted type. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The type accepted by the i-th setter. </dd></dl>
<p class="definition">Definition at line <a class="el" href="meta_8hpp_source.html#l01432">1432</a> of file <a class="el" href="meta_8hpp_source.html">meta.hpp</a>.</p>
</div>
</div>
<a id="ae49c225400fa1938e53a5f65f6f36152"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae49c225400fa1938e53a5f65f6f36152">&#9670;&nbsp;</a></span>arity()</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="structentt_1_1meta__data.html#ab322080e34d8e40621a67f2f0e0672b7">size_type</a> entt::meta_data::arity </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 number of setters available. </p>
<dl class="section return"><dt>Returns</dt><dd>The number of setters available. </dd></dl>
<p class="definition">Definition at line <a class="el" href="meta_8hpp_source.html#l00733">733</a> of file <a class="el" href="meta_8hpp_source.html">meta.hpp</a>.</p>
</div>
</div>
<a id="a754da41b4c8057f7c9a3ff4738935d04"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a754da41b4c8057f7c9a3ff4738935d04">&#9670;&nbsp;</a></span>get()</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__any.html">meta_any</a> entt::meta_data::get </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structentt_1_1meta__handle.html">meta_handle</a>&#160;</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>Gets the value of a given variable. </p>
<p>It must be possible to cast the instance to the parent type of the data member.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">instance</td><td>An opaque instance of the underlying type. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A wrapper containing the value of the underlying variable. </dd></dl>
<p class="definition">Definition at line <a class="el" href="meta_8hpp_source.html#l00783">783</a> of file <a class="el" href="meta_8hpp_source.html">meta.hpp</a>.</p>
</div>
</div>
<a id="a5e1bd9202426e41b5a0d1f25874fa7ec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5e1bd9202426e41b5a0d1f25874fa7ec">&#9670;&nbsp;</a></span>id()</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="namespaceentt.html#a13e040e7b38a8f86d1ab2f096f37b627">id_type</a> entt::meta_data::id </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 identifier assigned to a type. </p>
<dl class="section return"><dt>Returns</dt><dd>The identifier assigned to the type. </dd></dl>
<p class="definition">Definition at line <a class="el" href="meta_8hpp_source.html#l00725">725</a> of file <a class="el" href="meta_8hpp_source.html">meta.hpp</a>.</p>
</div>
</div>
<a id="a821782f679650835b47ac17949bb5f4d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a821782f679650835b47ac17949bb5f4d">&#9670;&nbsp;</a></span>is_const()</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_data::is_const </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>Indicates whether a data member is constant or not. </p>
<dl class="section return"><dt>Returns</dt><dd>True if the data member is constant, false otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="meta_8hpp_source.html#l00741">741</a> of file <a class="el" href="meta_8hpp_source.html">meta.hpp</a>.</p>
</div>
</div>
<a id="a08417d17ad41c753ec292abdeafd1782"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a08417d17ad41c753ec292abdeafd1782">&#9670;&nbsp;</a></span>is_static()</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_data::is_static </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>Indicates whether a data member is static or not. </p>
<dl class="section return"><dt>Returns</dt><dd>True if the data member is static, false otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="meta_8hpp_source.html#l00749">749</a> of file <a class="el" href="meta_8hpp_source.html">meta.hpp</a>.</p>
</div>
</div>
<a id="a597429fb3dfbc05a48d2f8dd31133d97"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a597429fb3dfbc05a48d2f8dd31133d97">&#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_data::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 an object is valid, false otherwise. </p>
<dl class="section return"><dt>Returns</dt><dd>True if the object is valid, false otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="meta_8hpp_source.html#l00821">821</a> of file <a class="el" href="meta_8hpp_source.html">meta.hpp</a>.</p>
</div>
</div>
<a id="abe3ebb33e7c66a067c5162715c66c880"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abe3ebb33e7c66a067c5162715c66c880">&#9670;&nbsp;</a></span>prop() <span class="overload">[1/2]</span></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="structentt_1_1meta__range.html">meta_range</a>&lt;<a class="el" href="structentt_1_1meta__prop.html">meta_prop</a>&gt; entt::meta_data::prop </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 range to visit registered meta properties. </p>
<dl class="section return"><dt>Returns</dt><dd>An iterable range to visit registered meta properties. </dd></dl>
<p class="definition">Definition at line <a class="el" href="meta_8hpp_source.html#l00798">798</a> of file <a class="el" href="meta_8hpp_source.html">meta.hpp</a>.</p>
</div>
</div>
<a id="a2258b0808fc9c35a27846804b1388fd9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2258b0808fc9c35a27846804b1388fd9">&#9670;&nbsp;</a></span>prop() <span class="overload">[2/2]</span></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="structentt_1_1meta__prop.html">meta_prop</a> entt::meta_data::prop </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classentt_1_1meta__any.html">meta_any</a>&#160;</td>
<td class="paramname"><em>key</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>Lookup function for registered meta properties. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">key</td><td>The key to use to search for a property. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The registered meta property for the given key, if any. </dd></dl>
<p class="definition">Definition at line <a class="el" href="meta_8hpp_source.html#l00807">807</a> of file <a class="el" href="meta_8hpp_source.html">meta.hpp</a>.</p>
</div>
</div>
<a id="a9cec301b83378b11ad316663e8ece835"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9cec301b83378b11ad316663e8ece835">&#9670;&nbsp;</a></span>set()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Type &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool entt::meta_data::set </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structentt_1_1meta__handle.html">meta_handle</a>&#160;</td>
<td class="paramname"><em>instance</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Type &amp;&amp;&#160;</td>
<td class="paramname"><em>value</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</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>Sets the value of a given variable. </p>
<p>It must be possible to cast the instance to the parent type of the data member.<br />
The type of the value is such that a cast or conversion to the type of the variable is possible. Otherwise, invoking the setter does nothing.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Type</td><td>Type of value to assign. </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">instance</td><td>An opaque instance of the underlying type. </td></tr>
<tr><td class="paramname">value</td><td>Parameter to use to set the underlying variable. </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#l00770">770</a> of file <a class="el" href="meta_8hpp_source.html">meta.hpp</a>.</p>
</div>
</div>
<a id="ad088d09cff4cea8b136d05a0d30049e6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad088d09cff4cea8b136d05a0d30049e6">&#9670;&nbsp;</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_data::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 object type if any, <code>type_id&lt;void&gt;()</code> otherwise. </p>
<dl class="section return"><dt>Returns</dt><dd>The object type if any, <code>type_id&lt;void&gt;()</code> otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="meta_8hpp_source.html#l01424">1424</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="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink