Scarfski/entt
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
c49227d82878de2cd4ae3decf93cfe4d097e994e
entt/structentt_1_1meta__prop.html
Michele Caini c49227d828 API reference v3.5.2
2020-09-22 08:42:41 +02:00

247 lines
12 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_prop 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.5.2</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__prop.html">meta_prop</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__prop-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">entt::meta_prop Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Opaque wrapper for meta properties of any type.
<a href="structentt_1_1meta__prop.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:a9da5b4916bdadd45ff0e0d90b245226c"><td class="memItemLeft" align="right" valign="top"><a id="a9da5b4916bdadd45ff0e0d90b245226c"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__prop.html#a9da5b4916bdadd45ff0e0d90b245226c">node_type</a> = internal::meta_prop_node</td></tr>
<tr class="memdesc:a9da5b4916bdadd45ff0e0d90b245226c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Node type. <br /></td></tr>
<tr class="separator:a9da5b4916bdadd45ff0e0d90b245226c"><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:aa8e984b8c789f155bc7c3a4f87f429c0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__prop.html#aa8e984b8c789f155bc7c3a4f87f429c0">meta_prop</a> (const <a class="el" href="structentt_1_1meta__prop.html#a9da5b4916bdadd45ff0e0d90b245226c">node_type</a> *curr=nullptr) noexcept</td></tr>
<tr class="memdesc:aa8e984b8c789f155bc7c3a4f87f429c0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs an instance from a given node. <a href="structentt_1_1meta__prop.html#aa8e984b8c789f155bc7c3a4f87f429c0">More...</a><br /></td></tr>
<tr class="separator:aa8e984b8c789f155bc7c3a4f87f429c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae8bd5282326b1e77f8f927a02f631a56"><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__prop.html#ae8bd5282326b1e77f8f927a02f631a56">key</a> () const</td></tr>
<tr class="memdesc:ae8bd5282326b1e77f8f927a02f631a56"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the stored key. <a href="structentt_1_1meta__prop.html#ae8bd5282326b1e77f8f927a02f631a56">More...</a><br /></td></tr>
<tr class="separator:ae8bd5282326b1e77f8f927a02f631a56"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a82a1d1796e873be7ba0c9fb539ec22ef"><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__prop.html#a82a1d1796e873be7ba0c9fb539ec22ef">value</a> () const</td></tr>
<tr class="memdesc:a82a1d1796e873be7ba0c9fb539ec22ef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the stored value. <a href="structentt_1_1meta__prop.html#a82a1d1796e873be7ba0c9fb539ec22ef">More...</a><br /></td></tr>
<tr class="separator:a82a1d1796e873be7ba0c9fb539ec22ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a97affd0004b41d0fedc5287157f701c6"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__prop.html#a97affd0004b41d0fedc5287157f701c6">operator bool</a> () const noexcept</td></tr>
<tr class="memdesc:a97affd0004b41d0fedc5287157f701c6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if a meta object is valid, false otherwise. <a href="structentt_1_1meta__prop.html#a97affd0004b41d0fedc5287157f701c6">More...</a><br /></td></tr>
<tr class="separator:a97affd0004b41d0fedc5287157f701c6"><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 properties of any type. </p>
<p class="definition">Definition at line <a class="el" href="meta_8hpp_source.html#l00577">577</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="aa8e984b8c789f155bc7c3a4f87f429c0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa8e984b8c789f155bc7c3a4f87f429c0">&#9670;&nbsp;</a></span>meta_prop()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">entt::meta_prop::meta_prop </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structentt_1_1meta__prop.html#a9da5b4916bdadd45ff0e0d90b245226c">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#l00585">585</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="ae8bd5282326b1e77f8f927a02f631a56"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae8bd5282326b1e77f8f927a02f631a56">&#9670;&nbsp;</a></span>key()</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_prop::key </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 stored key. </p>
<dl class="section return"><dt>Returns</dt><dd>A meta any containing the key stored with the property. </dd></dl>
<p class="definition">Definition at line <a class="el" href="meta_8hpp_source.html#l00593">593</a> of file <a class="el" href="meta_8hpp_source.html">meta.hpp</a>.</p>
</div>
</div>
<a id="a97affd0004b41d0fedc5287157f701c6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a97affd0004b41d0fedc5287157f701c6">&#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_prop::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#l00609">609</a> of file <a class="el" href="meta_8hpp_source.html">meta.hpp</a>.</p>
</div>
</div>
<a id="a82a1d1796e873be7ba0c9fb539ec22ef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a82a1d1796e873be7ba0c9fb539ec22ef">&#9670;&nbsp;</a></span>value()</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_prop::value </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 stored value. </p>
<dl class="section return"><dt>Returns</dt><dd>A meta any containing the value stored with the property. </dd></dl>
<p class="definition">Definition at line <a class="el" href="meta_8hpp_source.html#l00601">601</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