<!doctype html public "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <title>OpenVRML: openvrml::node_metatype_registry Class Reference</title> <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <link rel="icon" href="../vrml-16"> <link rel="start" href="http://openvrml.org/index" title="OpenVRML Home"> <link rel="prev" href="http://openvrml.org/discussion" title="Discussion"> <link rel="contents" href="index" title="Documentation Main Page"> <link rel="index" href="functions" title="OpenVRML Compound Members"> <link rel="appendix" href="conformance" title="Conformance Test Results"> <style type="text/css"> @import url("tabs.css"); @import url("http://openvrml.org/openvrml.css"); table { width: 100%; } h2 { border-bottom-style: solid; border-bottom-width: 1px; } /* * Doxygen as of 1.5.4-20071217 uses the class "navpath" instead of "nav". * For now, we'll do both. */ div.nav, div.navpath { background-color: transparent; text-align: left; margin-top: 1em; margin-bottom: 1em; border-color: black; border-left: none; border-right: none; padding-top: 0.5em; padding-bottom: 0.5em; } div.nav :link, div.nav :visited, div.navpath :link, div.navpath :visited { border-width: 1px; border-style: solid; border-color: silver; padding: 2px; } div.nav :link:hover, div.nav :visited:hover, div.navpath :link:hover, div.navpath :visited:hover { border-style: outset; border-color: gray; } div.nav :active, div.navpath :active { border-style: inset; border-color: gray; } .body td { background-color: transparent; } .el { text-decoration: inherit; font-weight: inherit } .elRef { font-weight: inherit } .code:link, .code:visited { text-decoration: inherit; font-weight: inherit; color: inherit; } .codeRef:link { font-weight: normal; color: inherit; } :visited { color: silver; } :link:hover { color: inherit; text-decoration: inherit; background-color: transparent; } h1 { line-height: 1.2em; } td.memItemLeft, td.memItemRight, td.memTemplParams, td.memTemplItemLeft, td.memTemplItemRight, .memtemplate, .memname td { font-family: Consolas, "DejaVu Sans Mono", "Bitstream Vera Sans Mono", "Lucida Console", LucidaTypewriter, monospace; } td.memItemLeft, td.memItemRight, td.mdescLeft, td.mdescRight { background-color: rgb(95%, 95%, 95%); border-color: rgb(65%, 65%, 65%); border-width: 1px; font-size: smaller; } .memItemLeft { margin-top: 0.5em; border-top-style: solid; } .mdescLeft { border-bottom-style: solid; } .memItemRight { border-top-style: solid; margin-top: 0.5em; } .mdescRight { border-bottom-style: solid; } .mdescRight { font-style: italic; } .mdTable { background-color: rgb(95%, 95%, 95%); } .memproto td code { font-family: inherit; font-style: italic; } td.pass { background-color: rgb(50%, 100%, 50%); } td.fail { background-color: rgb(100%, 50%, 50%); } td.invalid { background-color: rgb(75%, 75%, 75%); } .memitem { padding: 0; } .memitem table { width: auto; } .memproto, .memdoc { border-width: 1px; border-color: rgb(65%, 65%, 65%); } .memproto { background-color: rgb(90%, 90%, 90%); font-weight: inherit; font-size: smaller; border-top-style: solid; border-left-style: solid; border-right-style: solid; -webkit-border-top-left-radius: 0.6em; -webkit-border-top-right-radius: 0.6em; -moz-border-radius-topleft: 0.6em; -moz-border-radius-topright: 0.6em; } .memdoc { background-color: rgb(95%, 95%, 95%); padding: 2px 5px; border-style: solid; -webkit-border-bottom-left-radius: 0.6em; -webkit-border-bottom-right-radius: 0.6em; -moz-border-radius-bottomleft: 0.6em; -moz-border-radius-bottomright: 0.6em; } .memname { font-weight: inherit; } div.tabs { background-image: url("tab_b-openvrml.png"); } div.tabs span { background-image: url("tab_l-openvrml.png"); } div.tabs a { background-image: url("tab_r-openvrml.png"); border-bottom: 1px solid #a5a5a5; } div.tabs a:link, div.tabs a:visited, div.tabs a:active, div.tabs a:hover { color: black; } table { border-collapse: collapse; border-spacing: 0; } .note { border: 1px solid rgb(65%, 65%, 65%); background-color: rgb(95%, 95%, 95%); margin-left: 10%; margin-right: 10%; } </style> </head> <body> <table class="sitenav"> <tr> <th><a href="http://openvrml.org/index" title="Home">Home</a></th> <th><a href="http://openvrml.org/download" title="Download">Download</a></th> <th><a href="http://openvrml.org/screenshots/index" title="Screen shots">Screen shots</a></th> <th><a href="http://openvrml.org/discussion" title="Mailing lists and IRC">Discussion</a></th> <th>Documentation</th> </tr> </table> <div class="body"> <!-- Generated by Doxygen 1.5.8 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> <li><a href="examples.html"><span>Examples</span></a></li> </ul> </div> <div class="tabs"> <ul> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <div class="navpath"><a class="el" href="namespaceopenvrml.html">openvrml</a>::<a class="el" href="classopenvrml_1_1node__metatype__registry.html">node_metatype_registry</a> </div> </div> <div class="contents"> <h1>openvrml::node_metatype_registry Class Reference</h1><!-- doxytag: class="openvrml::node_metatype_registry" -->Registry for <code><a class="el" href="classopenvrml_1_1node__metatype.html" title="A class object for node instances.">node_metatype</a>s</code>. <a href="#_details">More...</a> <p> <code>#include <openvrml/browser.h></code> <p> <p> <a href="classopenvrml_1_1node__metatype__registry-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classopenvrml_1_1node__metatype__registry.html#33407894bfe24643af915f4e0a605160">~node_metatype_registry</a> () throw ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy. <a href="#33407894bfe24643af915f4e0a605160"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f0e82320b5469569aa5fe2f17872fd09"></a><!-- doxytag: member="openvrml::node_metatype_registry::browser" ref="f0e82320b5469569aa5fe2f17872fd09" args="() const " --> <a class="el" href="classopenvrml_1_1browser.html">openvrml::browser</a> & </td><td class="memItemRight" valign="bottom"><b>browser</b> () const throw ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classopenvrml_1_1node__metatype__registry.html#d3fded92ed18308ba9b1b767103a1ae9">register_node_metatype</a> (const std::string &id, const boost::shared_ptr< <a class="el" href="classopenvrml_1_1node__metatype.html">node_metatype</a> > &metatype) throw ( std::invalid_argument , std::bad_alloc )</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Register a <code><a class="el" href="classopenvrml_1_1node__metatype.html" title="A class object for node instances.">node_metatype</a></code>. <a href="#d3fded92ed18308ba9b1b767103a1ae9"></a><br></td></tr> <tr><td colspan="2"><br><h2>Private Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classopenvrml_1_1node__metatype__registry.html#6e5c3d6850ead217eadb663f020cd2be">node_metatype_registry</a> (<a class="el" href="classopenvrml_1_1browser.html">openvrml::browser</a> &b)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Construct. <a href="#6e5c3d6850ead217eadb663f020cd2be"></a><br></td></tr> <tr><td colspan="2"><br><h2>Private Attributes</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">boost::scoped_ptr<br class="typebreak"> < local::node_metatype_registry_impl > </td><td class="memItemRight" valign="bottom"><a class="el" href="classopenvrml_1_1node__metatype__registry.html#715fbfbe0f419b3c6b0534392e4bcbd3">impl_</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">A pointer to the implementation object. <a href="#715fbfbe0f419b3c6b0534392e4bcbd3"></a><br></td></tr> <tr><td colspan="2"><br><h2>Friends</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classopenvrml_1_1node__metatype__registry.html#1f1d7cef64cf8365913dc105ef955e8f">browser</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The <code><a class="el" href="classopenvrml_1_1browser.html" title="Encapsulates a VRML browser.">browser</a></code>. <a href="#1f1d7cef64cf8365913dc105ef955e8f"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classopenvrml_1_1node__metatype__registry.html#2a86244651b71394b760e8a0b27f1ab1">operator==</a> (const <a class="el" href="classopenvrml_1_1node__type.html">node_type</a> &, const <a class="el" href="classopenvrml_1_1node__type.html">node_type</a> &) throw ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Compare for equality. <a href="#2a86244651b71394b760e8a0b27f1ab1"></a><br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> Registry for <code><a class="el" href="classopenvrml_1_1node__metatype.html" title="A class object for node instances.">node_metatype</a>s</code>. <hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="6e5c3d6850ead217eadb663f020cd2be"></a><!-- doxytag: member="openvrml::node_metatype_registry::node_metatype_registry" ref="6e5c3d6850ead217eadb663f020cd2be" args="(openvrml::browser &b)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">openvrml::node_metatype_registry::node_metatype_registry </td> <td>(</td> <td class="paramtype"><a class="el" href="classopenvrml_1_1browser.html">openvrml::browser</a> & </td> <td class="paramname"> <em>b</em> </td> <td> ) </td> <td><code> [explicit, private]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Construct. <p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>b</em> </td><td>a <code><a class="el" href="classopenvrml_1_1browser.html" title="Encapsulates a VRML browser.">browser</a></code>. </td></tr> </table> </dl> </div> </div><p> <a class="anchor" name="33407894bfe24643af915f4e0a605160"></a><!-- doxytag: member="openvrml::node_metatype_registry::~node_metatype_registry" ref="33407894bfe24643af915f4e0a605160" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">openvrml::node_metatype_registry::~node_metatype_registry </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td> throw ()</td> </tr> </table> </div> <div class="memdoc"> <p> Destroy. <p> </div> </div><p> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="d3fded92ed18308ba9b1b767103a1ae9"></a><!-- doxytag: member="openvrml::node_metatype_registry::register_node_metatype" ref="d3fded92ed18308ba9b1b767103a1ae9" args="(const std::string &id, const boost::shared_ptr< node_metatype > &metatype)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void openvrml::node_metatype_registry::register_node_metatype </td> <td>(</td> <td class="paramtype">const std::string & </td> <td class="paramname"> <em>id</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const boost::shared_ptr< <a class="el" href="classopenvrml_1_1node__metatype.html">node_metatype</a> > & </td> <td class="paramname"> <em>metatype</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td> throw ( std::invalid_argument , std::bad_alloc )</td> </tr> </table> </div> <div class="memdoc"> <p> Register a <code><a class="el" href="classopenvrml_1_1node__metatype.html" title="A class object for node instances.">node_metatype</a></code>. <p> This operation is destructive; that is, if a <code><a class="el" href="classopenvrml_1_1node__metatype.html" title="A class object for node instances.">node_metatype</a></code> is already registered under <code>id</code>, <code>metatype</code> will replace it in the registry.<p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>id</em> </td><td>the string identifier associated with <code>metatype</code>. </td></tr> <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>metatype</em> </td><td>a <code><a class="el" href="classopenvrml_1_1node__metatype.html" title="A class object for node instances.">node_metatype</a></code>.</td></tr> </table> </dl> <dl compact><dt><b>Exceptions:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>std::invalid_argument</em> </td><td>if <code>metatype</code> is null. </td></tr> <tr><td valign="top"></td><td valign="top"><em>std::bad_alloc</em> </td><td>if memory allocation fails. </td></tr> </table> </dl> </div> </div><p> <hr><h2>Friends And Related Function Documentation</h2> <a class="anchor" name="1f1d7cef64cf8365913dc105ef955e8f"></a><!-- doxytag: member="openvrml::node_metatype_registry::browser" ref="1f1d7cef64cf8365913dc105ef955e8f" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classopenvrml_1_1browser.html">openvrml::browser</a> & openvrml::node_metatype_registry::browser<code> [friend]</code> </td> </tr> </table> </div> <div class="memdoc"> <p> The <code><a class="el" href="classopenvrml_1_1browser.html" title="Encapsulates a VRML browser.">browser</a></code>. <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd>the <code><a class="el" href="classopenvrml_1_1browser.html" title="Encapsulates a VRML browser.">browser</a></code>. </dd></dl> </div> </div><p> <a class="anchor" name="2a86244651b71394b760e8a0b27f1ab1"></a><!-- doxytag: member="openvrml::node_metatype_registry::operator==" ref="2a86244651b71394b760e8a0b27f1ab1" args="(const node_type &, const node_type &)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool operator== </td> <td>(</td> <td class="paramtype">const <a class="el" href="classopenvrml_1_1node__type.html">node_type</a> & </td> <td class="paramname"> <em>lhs</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="classopenvrml_1_1node__type.html">node_type</a> & </td> <td class="paramname"> <em>rhs</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td> throw ()<code> [friend]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Compare for equality. <p> Two <code><a class="el" href="classopenvrml_1_1node__type.html" title="Type information object for nodes.">node_type</a>s</code> <code>t</code> and <code>u</code> are considered equal if all of the following are true:<p> <ul> <li><code>t.id() == u.id()</code></li><li><code>t.interfaces() == u.interfaces()</code></li><li><code>t.metatype().id()</code> is in the set of identifiers associated with <code>u</code> in the <code><a class="el" href="classopenvrml_1_1browser.html" title="Encapsulates a VRML browser.">browser</a></code>'s <code><a class="el" href="classopenvrml_1_1node__metatype.html" title="A class object for node instances.">node_metatype</a></code> map.</li></ul> <p> Note that the latter requirement makes this comparison a rather expensive operation.<p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>lhs</em> </td><td></td></tr> <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>rhs</em> </td><td></td></tr> </table> </dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd><code>true</code> if <code>lhs</code> and <code>rhs</code> are equal; <code>false</code> otherwise. </dd></dl> </div> </div><p> <hr><h2>Member Data Documentation</h2> <a class="anchor" name="715fbfbe0f419b3c6b0534392e4bcbd3"></a><!-- doxytag: member="openvrml::node_metatype_registry::impl_" ref="715fbfbe0f419b3c6b0534392e4bcbd3" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">boost::scoped_ptr< openvrml::local::node_metatype_registry_impl > <a class="el" href="classopenvrml_1_1node__metatype__registry.html#715fbfbe0f419b3c6b0534392e4bcbd3">openvrml::node_metatype_registry::impl_</a><code> [private]</code> </td> </tr> </table> </div> <div class="memdoc"> <p> A pointer to the implementation object. <p> </div> </div><p> </div> </div> <address class="footer"><span class="images"><a href="http://web3d.org/x3d/"><img src="x3d-white-on-black.png" width="43" height="32" border="0" alt="X3D"></a><a href="http://opengl.org"><img src="OGL_sm_wht.png" width="68" height="32" border="0" alt="OpenGL"></a><a href="http://sourceforge.net/projects/openvrml"><img src="http://sourceforge.net/sflogo.php?group_id=7151&type=11" width="120" height="30" border="0" alt="SourceForge.net"></a></span><a href="https://sourceforge.net/apps/trac/openvrml/newticket">Report error</a><br>Generated Thu Aug 13 02:49:17 2009 by Doxygen 1.5.8</address> <script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script> <script type="text/javascript">_uacct = "UA-446379-2"; urchinTracker();</script> <!-- Piwik --> <script type="text/javascript"> var pkBaseURL = (("https:" == document.location.protocol) ? "https://sourceforge.net/apps/piwik/openvrml/" : "http://sourceforge.net/apps/piwik/openvrml/"); document.write(unescape("%3Cscript src='" + pkBaseURL + "piwik.js' type='text/javascript'%3E%3C/script%3E")); </script><script type="text/javascript"> piwik_action_name = ''; piwik_idsite = 1; piwik_url = pkBaseURL + "piwik.php"; piwik_log(piwik_action_name, piwik_idsite, piwik_url); </script> <object><noscript><p><img src="http://sourceforge.net/apps/piwik/openvrml/piwik.php?idsite=1" alt="piwik"/></p></noscript></object> <!-- End Piwik Tag --> </body> </html>