Files
entt/structentt_1_1meta__prop.html
2023-06-15 11:47:04 +02:00

328 lines
15 KiB
HTML

<!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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.6"/>
<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-awesome.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 id="projectrow">
<td id="projectalign">
<div id="projectname">EnTT<span id="projectnumber">&#160;3.12.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.6 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</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-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 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 id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a08a108215ee382b52f60c3b3307df46f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__prop.html#a08a108215ee382b52f60c3b3307df46f">meta_prop</a> () noexcept</td></tr>
<tr class="memdesc:a08a108215ee382b52f60c3b3307df46f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor. <br /></td></tr>
<tr class="separator:a08a108215ee382b52f60c3b3307df46f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4c9bc740c450e55f072be9e7969b2b61"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__prop.html#a4c9bc740c450e55f072be9e7969b2b61">meta_prop</a> (const <a class="el" href="classentt_1_1meta__ctx.html">meta_ctx</a> &amp;area, const internal::meta_prop_node &amp;curr) noexcept</td></tr>
<tr class="memdesc:a4c9bc740c450e55f072be9e7969b2b61"><td class="mdescLeft">&#160;</td><td class="mdescRight">Context aware constructor for meta objects. <br /></td></tr>
<tr class="separator:a4c9bc740c450e55f072be9e7969b2b61"><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 by const reference. <br /></td></tr>
<tr class="separator:a82a1d1796e873be7ba0c9fb539ec22ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a459bfd17717f66a925062e992fcd9013"><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#a459bfd17717f66a925062e992fcd9013">value</a> ()</td></tr>
<tr class="memdesc:a459bfd17717f66a925062e992fcd9013"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the stored value by reference. <br /></td></tr>
<tr class="separator:a459bfd17717f66a925062e992fcd9013"><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 an object is valid, false otherwise. <br /></td></tr>
<tr class="separator:a97affd0004b41d0fedc5287157f701c6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac7c7cc8175382311c5d63a5f636a442a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__prop.html#ac7c7cc8175382311c5d63a5f636a442a">operator==</a> (const <a class="el" href="structentt_1_1meta__prop.html">meta_prop</a> &amp;other) const noexcept</td></tr>
<tr class="memdesc:ac7c7cc8175382311c5d63a5f636a442a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if two objects refer to the same type. <br /></td></tr>
<tr class="separator:ac7c7cc8175382311c5d63a5f636a442a"><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 properties of any type. </p>
<p class="definition">Definition at line <a class="el" href="meta_8hpp_source.html#l00753">753</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="a08a108215ee382b52f60c3b3307df46f" name="a08a108215ee382b52f60c3b3307df46f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a08a108215ee382b52f60c3b3307df46f">&#9670;&#160;</a></span>meta_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">entt::meta_prop::meta_prop </td>
<td>(</td>
<td class="paramname"></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>Default constructor. </p>
<p class="definition">Definition at line <a class="el" href="meta_8hpp_source.html#l00755">755</a> of file <a class="el" href="meta_8hpp_source.html">meta.hpp</a>.</p>
</div>
</div>
<a id="a4c9bc740c450e55f072be9e7969b2b61" name="a4c9bc740c450e55f072be9e7969b2b61"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4c9bc740c450e55f072be9e7969b2b61">&#9670;&#160;</a></span>meta_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">entt::meta_prop::meta_prop </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classentt_1_1meta__ctx.html">meta_ctx</a> &amp;&#160;</td>
<td class="paramname"><em>area</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const internal::meta_prop_node &amp;&#160;</td>
<td class="paramname"><em>curr</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</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>Context aware constructor for meta objects. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">area</td><td>The context from which to search for meta types. </td></tr>
<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#l00764">764</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="a97affd0004b41d0fedc5287157f701c6" name="a97affd0004b41d0fedc5287157f701c6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a97affd0004b41d0fedc5287157f701c6">&#9670;&#160;</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 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#l00788">788</a> of file <a class="el" href="meta_8hpp_source.html">meta.hpp</a>.</p>
</div>
</div>
<a id="ac7c7cc8175382311c5d63a5f636a442a" name="ac7c7cc8175382311c5d63a5f636a442a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac7c7cc8175382311c5d63a5f636a442a">&#9670;&#160;</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_prop::operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structentt_1_1meta__prop.html">meta_prop</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 class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks if two objects refer to the same type. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td>The object with which to compare. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if the objects refer to the same type, false otherwise. </dd></dl>
<p class="definition">Definition at line <a class="el" href="meta_8hpp_source.html#l00797">797</a> of file <a class="el" href="meta_8hpp_source.html">meta.hpp</a>.</p>
</div>
</div>
<a id="a459bfd17717f66a925062e992fcd9013" name="a459bfd17717f66a925062e992fcd9013"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a459bfd17717f66a925062e992fcd9013">&#9670;&#160;</a></span>value() <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__any.html">meta_any</a> entt::meta_prop::value </td>
<td>(</td>
<td class="paramname"></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>Returns the stored value by reference. </p>
<dl class="section return"><dt>Returns</dt><dd>A wrapper containing the value stored with the property. </dd></dl>
<p class="definition">Definition at line <a class="el" href="meta_8hpp_source.html#l00780">780</a> of file <a class="el" href="meta_8hpp_source.html">meta.hpp</a>.</p>
</div>
</div>
<a id="a82a1d1796e873be7ba0c9fb539ec22ef" name="a82a1d1796e873be7ba0c9fb539ec22ef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a82a1d1796e873be7ba0c9fb539ec22ef">&#9670;&#160;</a></span>value() <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="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 by const reference. </p>
<dl class="section return"><dt>Returns</dt><dd>A wrapper containing the value stored with the property. </dd></dl>
<p class="definition">Definition at line <a class="el" href="meta_8hpp_source.html#l00772">772</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.6
</small></address>
</body>
</html>