entt/structentt_1_1meta__conv.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">
<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.18"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>EnTT: entt::meta_conv 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.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.18 -->
<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__conv.html">meta_conv</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__conv-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">entt::meta_conv Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Opaque wrapper for meta conversion functions.  
 <a href="structentt_1_1meta__conv.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:a2a184d32afd64728156252dc0343f81d"><td class="memItemLeft" align="right" valign="top"><a id="a2a184d32afd64728156252dc0343f81d"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__conv.html#a2a184d32afd64728156252dc0343f81d">node_type</a> = internal::meta_conv_node</td></tr>
<tr class="memdesc:a2a184d32afd64728156252dc0343f81d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Node type. <br /></td></tr>
<tr class="separator:a2a184d32afd64728156252dc0343f81d"><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:a5c0e6e992f5bac0af9d0a91282a0eff1"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__conv.html#a5c0e6e992f5bac0af9d0a91282a0eff1">meta_conv</a> (const <a class="el" href="structentt_1_1meta__conv.html#a2a184d32afd64728156252dc0343f81d">node_type</a> *curr=nullptr) noexcept</td></tr>
<tr class="memdesc:a5c0e6e992f5bac0af9d0a91282a0eff1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs an instance from a given node.  <a href="structentt_1_1meta__conv.html#a5c0e6e992f5bac0af9d0a91282a0eff1">More...</a><br /></td></tr>
<tr class="separator:a5c0e6e992f5bac0af9d0a91282a0eff1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a855c16d5b88514505f87e99afa9b227f"><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__conv.html#a855c16d5b88514505f87e99afa9b227f">parent</a> () const noexcept</td></tr>
<tr class="memdesc:a855c16d5b88514505f87e99afa9b227f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the meta type to which a meta object belongs.  <a href="structentt_1_1meta__conv.html#a855c16d5b88514505f87e99afa9b227f">More...</a><br /></td></tr>
<tr class="separator:a855c16d5b88514505f87e99afa9b227f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6e1e6363e5080fe2fe0a8d4553d19230"><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__conv.html#a6e1e6363e5080fe2fe0a8d4553d19230">type</a> () const noexcept</td></tr>
<tr class="memdesc:a6e1e6363e5080fe2fe0a8d4553d19230"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the meta type of the underlying object.  <a href="structentt_1_1meta__conv.html#a6e1e6363e5080fe2fe0a8d4553d19230">More...</a><br /></td></tr>
<tr class="separator:a6e1e6363e5080fe2fe0a8d4553d19230"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3a4ce95f59cb387a0a654d41c9ff57bf"><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__conv.html#a3a4ce95f59cb387a0a654d41c9ff57bf">convert</a> (const void *instance) const</td></tr>
<tr class="memdesc:a3a4ce95f59cb387a0a654d41c9ff57bf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts an instance to the underlying type.  <a href="structentt_1_1meta__conv.html#a3a4ce95f59cb387a0a654d41c9ff57bf">More...</a><br /></td></tr>
<tr class="separator:a3a4ce95f59cb387a0a654d41c9ff57bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4ce973e101877839536b747c41b8f2b5"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structentt_1_1meta__conv.html#a4ce973e101877839536b747c41b8f2b5">operator bool</a> () const noexcept</td></tr>
<tr class="memdesc:a4ce973e101877839536b747c41b8f2b5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if a meta object is valid, false otherwise.  <a href="structentt_1_1meta__conv.html#a4ce973e101877839536b747c41b8f2b5">More...</a><br /></td></tr>
<tr class="separator:a4ce973e101877839536b747c41b8f2b5"><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 conversion functions. </p>

<p class="definition">Definition at line <a class="el" href="meta_8hpp_source.html#l00622">622</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="a5c0e6e992f5bac0af9d0a91282a0eff1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5c0e6e992f5bac0af9d0a91282a0eff1">&#9670;&nbsp;</a></span>meta_conv()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">entt::meta_conv::meta_conv </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structentt_1_1meta__conv.html#a2a184d32afd64728156252dc0343f81d">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#l00627">627</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="a3a4ce95f59cb387a0a654d41c9ff57bf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3a4ce95f59cb387a0a654d41c9ff57bf">&#9670;&nbsp;</a></span>convert()</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_conv::convert </td>
          <td>(</td>
          <td class="paramtype">const void *&#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>Converts an instance to the underlying type. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">instance</td><td>The instance to convert. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>An opaque pointer to the instance to convert. </dd></dl>

<p class="definition">Definition at line <a class="el" href="meta_8hpp_source.html#l00642">642</a> of file <a class="el" href="meta_8hpp_source.html">meta.hpp</a>.</p>

</div>
</div>
<a id="a4ce973e101877839536b747c41b8f2b5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4ce973e101877839536b747c41b8f2b5">&#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_conv::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#l00650">650</a> of file <a class="el" href="meta_8hpp_source.html">meta.hpp</a>.</p>

</div>
</div>
<a id="a855c16d5b88514505f87e99afa9b227f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a855c16d5b88514505f87e99afa9b227f">&#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_conv::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#l01422">1422</a> of file <a class="el" href="meta_8hpp_source.html">meta.hpp</a>.</p>

</div>
</div>
<a id="a6e1e6363e5080fe2fe0a8d4553d19230"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6e1e6363e5080fe2fe0a8d4553d19230">&#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_conv::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#l01427">1427</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.png" alt="doxygen"/>
</a> 1.8.18
</small></address>
</body>
</html>