Scarfski/entt
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
4b578e1085ee3e41591613048becabb34a13cd9c
entt/structentt_1_1meta__data.html
Michele Caini 4b578e1085 API reference v3.6.0
2021-01-09 18:58:42 +01:00

522 lines
27 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.20"/>
<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.6.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.20 -->
<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_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 meta data.
<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>
</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:a122d0099ecace0a5f9c6def781ad8e37"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__data.html#a122d0099ecace0a5f9c6def781ad8e37">meta_data</a> (const <a class="el" href="structentt_1_1meta__data.html#a0aa23c3d404c35751aa6b85870eafc21">node_type</a> *curr=nullptr) noexcept</td></tr>
<tr class="memdesc:a122d0099ecace0a5f9c6def781ad8e37"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs an instance from a given node. <a href="structentt_1_1meta__data.html#a122d0099ecace0a5f9c6def781ad8e37">More...</a><br /></td></tr>
<tr class="separator:a122d0099ecace0a5f9c6def781ad8e37"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9cd69d82eb33a431ffbb211c4072afaf"><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#a9cd69d82eb33a431ffbb211c4072afaf">id</a> () const noexcept</td></tr>
<tr class="memdesc:a9cd69d82eb33a431ffbb211c4072afaf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the identifier assigned to a meta object. <a href="structentt_1_1meta__data.html#a9cd69d82eb33a431ffbb211c4072afaf">More...</a><br /></td></tr>
<tr class="separator:a9cd69d82eb33a431ffbb211c4072afaf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a457ccf1db2b581944af0ac5d8ebcd454"><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#a457ccf1db2b581944af0ac5d8ebcd454">parent</a> () const noexcept</td></tr>
<tr class="memdesc:a457ccf1db2b581944af0ac5d8ebcd454"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the meta type to which a meta object belongs. <a href="structentt_1_1meta__data.html#a457ccf1db2b581944af0ac5d8ebcd454">More...</a><br /></td></tr>
<tr class="separator:a457ccf1db2b581944af0ac5d8ebcd454"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a148f106584bfdd2bb33591d790c4a1c1"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__data.html#a148f106584bfdd2bb33591d790c4a1c1">is_const</a> () const noexcept</td></tr>
<tr class="memdesc:a148f106584bfdd2bb33591d790c4a1c1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Indicates whether a meta data is constant or not. <a href="structentt_1_1meta__data.html#a148f106584bfdd2bb33591d790c4a1c1">More...</a><br /></td></tr>
<tr class="separator:a148f106584bfdd2bb33591d790c4a1c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adeddff29e0b47f621f1bc77cb9d2be80"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__data.html#adeddff29e0b47f621f1bc77cb9d2be80">is_static</a> () const noexcept</td></tr>
<tr class="memdesc:adeddff29e0b47f621f1bc77cb9d2be80"><td class="mdescLeft">&#160;</td><td class="mdescRight">Indicates whether a meta data is static or not. <a href="structentt_1_1meta__data.html#adeddff29e0b47f621f1bc77cb9d2be80">More...</a><br /></td></tr>
<tr class="separator:adeddff29e0b47f621f1bc77cb9d2be80"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa81980c2d202f511ec8afcb8b324afb4"><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#aa81980c2d202f511ec8afcb8b324afb4">type</a> () const noexcept</td></tr>
<tr class="memdesc:aa81980c2d202f511ec8afcb8b324afb4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the meta type of the underlying object. <a href="structentt_1_1meta__data.html#aa81980c2d202f511ec8afcb8b324afb4">More...</a><br /></td></tr>
<tr class="separator:aa81980c2d202f511ec8afcb8b324afb4"><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:a2cb34e63269b41df322b9e45f58b191c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classentt_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#a2cb34e63269b41df322b9e45f58b191c">prop</a> () const noexcept</td></tr>
<tr class="memdesc:a2cb34e63269b41df322b9e45f58b191c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a range to use to visit all meta properties. <a href="structentt_1_1meta__data.html#a2cb34e63269b41df322b9e45f58b191c">More...</a><br /></td></tr>
<tr class="separator:a2cb34e63269b41df322b9e45f58b191c"><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">Returns the property associated with a given key. <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:a1127923d5d2f1c59af5e739c95f4798a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__data.html#a1127923d5d2f1c59af5e739c95f4798a">operator bool</a> () const noexcept</td></tr>
<tr class="memdesc:a1127923d5d2f1c59af5e739c95f4798a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if a meta object is valid, false otherwise. <a href="structentt_1_1meta__data.html#a1127923d5d2f1c59af5e739c95f4798a">More...</a><br /></td></tr>
<tr class="separator:a1127923d5d2f1c59af5e739c95f4798a"><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 meta data. </p>
<p class="definition">Definition at line <a class="el" href="meta_8hpp_source.html#l00836">836</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="a122d0099ecace0a5f9c6def781ad8e37"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a122d0099ecace0a5f9c6def781ad8e37">&#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 class="mlabel">noexcept</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#l00841">841</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="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 meta data. Otherwise, invoking the getter results in an undefined behavior.</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 meta any containing the value of the underlying variable. </dd></dl>
<p class="definition">Definition at line <a class="el" href="meta_8hpp_source.html#l00900">900</a> of file <a class="el" href="meta_8hpp_source.html">meta.hpp</a>.</p>
</div>
</div>
<a id="a9cd69d82eb33a431ffbb211c4072afaf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9cd69d82eb33a431ffbb211c4072afaf">&#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 class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the identifier assigned to a meta object. </p>
<dl class="section return"><dt>Returns</dt><dd>The identifier assigned to the meta object. </dd></dl>
<p class="definition">Definition at line <a class="el" href="meta_8hpp_source.html#l00846">846</a> of file <a class="el" href="meta_8hpp_source.html">meta.hpp</a>.</p>
</div>
</div>
<a id="a148f106584bfdd2bb33591d790c4a1c1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a148f106584bfdd2bb33591d790c4a1c1">&#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 class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Indicates whether a meta data is constant or not. </p>
<dl class="section return"><dt>Returns</dt><dd>True if the meta data is constant, false otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="meta_8hpp_source.html#l00857">857</a> of file <a class="el" href="meta_8hpp_source.html">meta.hpp</a>.</p>
</div>
</div>
<a id="adeddff29e0b47f621f1bc77cb9d2be80"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adeddff29e0b47f621f1bc77cb9d2be80">&#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 class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Indicates whether a meta data is static or not. </p>
<dl class="section return"><dt>Returns</dt><dd>True if the meta data is static, false otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="meta_8hpp_source.html#l00865">865</a> of file <a class="el" href="meta_8hpp_source.html">meta.hpp</a>.</p>
</div>
</div>
<a id="a1127923d5d2f1c59af5e739c95f4798a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1127923d5d2f1c59af5e739c95f4798a">&#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 class="mlabel">noexcept</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#l00923">923</a> of file <a class="el" href="meta_8hpp_source.html">meta.hpp</a>.</p>
</div>
</div>
<a id="a457ccf1db2b581944af0ac5d8ebcd454"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a457ccf1db2b581944af0ac5d8ebcd454">&#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_data::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 class="mlabel">noexcept</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#l01677">1677</a> of file <a class="el" href="meta_8hpp_source.html">meta.hpp</a>.</p>
</div>
</div>
<a id="a2cb34e63269b41df322b9e45f58b191c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2cb34e63269b41df322b9e45f58b191c">&#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="classentt_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 class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a range to use to visit all meta properties. </p>
<dl class="section return"><dt>Returns</dt><dd>An iterable range to use to visit all meta properties. </dd></dl>
<p class="definition">Definition at line <a class="el" href="meta_8hpp_source.html#l00905">905</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>Returns the property associated with a given key. </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 property associated with the given key, if any. </dd></dl>
<p class="definition">Definition at line <a class="el" href="meta_8hpp_source.html#l00914">914</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 meta data. Otherwise, invoking the setter results in an undefined behavior.<br />
The type of the value must be 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#l00887">887</a> of file <a class="el" href="meta_8hpp_source.html">meta.hpp</a>.</p>
</div>
</div>
<a id="aa81980c2d202f511ec8afcb8b324afb4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa81980c2d202f511ec8afcb8b324afb4">&#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 class="mlabel">noexcept</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#l01682">1682</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.svg" width="104" height="31" alt="doxygen"/></a> 1.8.20
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink