<!doctype html public "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <title>OpenVRML: openvrml::browser_event 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_1browser__event.html">browser_event</a> </div> </div> <div class="contents"> <h1>openvrml::browser_event Class Reference</h1><!-- doxytag: class="openvrml::browser_event" -->A <code><a class="el" href="classopenvrml_1_1browser.html" title="Encapsulates a VRML browser.">browser</a></code>-wide event. <a href="#_details">More...</a> <p> <code>#include <openvrml/browser.h></code> <p> <p> <a href="classopenvrml_1_1browser__event-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 Types</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classopenvrml_1_1browser__event.html#0fb72d4d79d031f467622111c192d770">type_id</a> { <br> <a class="el" href="classopenvrml_1_1browser__event.html#0fb72d4d79d031f467622111c192d77000d034c8473f96f3c4210619837241e2">initialized</a> = 1, <br> <a class="el" href="classopenvrml_1_1browser__event.html#0fb72d4d79d031f467622111c192d770be407197b4c78e9dbe05aebba4429d81">shutdown</a> = 2 <br> }</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight"><code><a class="el" href="classopenvrml_1_1browser__event.html" title="A browser-wide event.">browser_event</a></code> type identifier. <a href="classopenvrml_1_1browser__event.html#0fb72d4d79d031f467622111c192d770">More...</a><br></td></tr> <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classopenvrml_1_1browser__event.html#0fb72d4d79d031f467622111c192d770">type_id</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classopenvrml_1_1browser__event.html#db40a92a8340ff551e19363c32f81239">id</a> () const throw ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Event type identifier. <a href="#db40a92a8340ff551e19363c32f81239"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classopenvrml_1_1browser.html">browser</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classopenvrml_1_1browser__event.html#65df75bbe48ace88137542e9d88d7b2c">source</a> () const throw ()</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> that emitted the event. <a href="#65df75bbe48ace88137542e9d88d7b2c"></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_1browser__event.html#07f52ed82d89f7e5eb54e5d9bd082464">browser_event</a> (<a class="el" href="classopenvrml_1_1browser.html">browser</a> &b, <a class="el" href="classopenvrml_1_1browser__event.html#0fb72d4d79d031f467622111c192d770">type_id</a> id) throw ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Construct. <a href="#07f52ed82d89f7e5eb54e5d9bd082464"></a><br></td></tr> <tr><td colspan="2"><br><h2>Private Attributes</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classopenvrml_1_1browser.html">browser</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classopenvrml_1_1browser__event.html#c4c12c7941238703f154fbf9877e2e07">source_</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> from which the event originated. <a href="#c4c12c7941238703f154fbf9877e2e07"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classopenvrml_1_1browser__event.html#0fb72d4d79d031f467622111c192d770">type_id</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classopenvrml_1_1browser__event.html#cd0dec3f18f44d2a181ae8f94c1bd31e">id_</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Event type identifier. <a href="#cd0dec3f18f44d2a181ae8f94c1bd31e"></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_1browser__event.html#112e5b246c1ac82eba078edbc2048617">browser</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Only <code><a class="el" href="classopenvrml_1_1browser.html" title="Encapsulates a VRML browser.">browser</a>s</code> can construct <code><a class="el" href="classopenvrml_1_1browser__event.html" title="A browser-wide event.">browser_event</a>s</code>. <a href="#112e5b246c1ac82eba078edbc2048617"></a><br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> A <code><a class="el" href="classopenvrml_1_1browser.html" title="Encapsulates a VRML browser.">browser</a></code>-wide event. <hr><h2>Member Enumeration Documentation</h2> <a class="anchor" name="0fb72d4d79d031f467622111c192d770"></a><!-- doxytag: member="openvrml::browser_event::type_id" ref="0fb72d4d79d031f467622111c192d770" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">enum <a class="el" href="classopenvrml_1_1browser__event.html#0fb72d4d79d031f467622111c192d770">openvrml::browser_event::type_id</a> </td> </tr> </table> </div> <div class="memdoc"> <p> <code><a class="el" href="classopenvrml_1_1browser__event.html" title="A browser-wide event.">browser_event</a></code> type identifier. <p> <dl compact><dt><b>Enumerator: </b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"><em><a class="anchor" name="0fb72d4d79d031f467622111c192d77000d034c8473f96f3c4210619837241e2"></a><!-- doxytag: member="initialized" ref="0fb72d4d79d031f467622111c192d77000d034c8473f96f3c4210619837241e2" args="" -->initialized</em> </td><td> An <code>initialized</code> event is sent once the world has loaded and all nodes in the initial <a class="el" href="classopenvrml_1_1scene.html" title="A scene in the VRML world.">scene</a> have been initialized. </td></tr> <tr><td valign="top"><em><a class="anchor" name="0fb72d4d79d031f467622111c192d770be407197b4c78e9dbe05aebba4429d81"></a><!-- doxytag: member="shutdown" ref="0fb72d4d79d031f467622111c192d770be407197b4c78e9dbe05aebba4429d81" args="" -->shutdown</em> </td><td> A <code>shutdown</code> event is sent once all of the nodes in the <a class="el" href="classopenvrml_1_1scene.html" title="A scene in the VRML world.">scene</a> have been shut down. </td></tr> </table> </dl> </div> </div><p> <hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="07f52ed82d89f7e5eb54e5d9bd082464"></a><!-- doxytag: member="openvrml::browser_event::browser_event" ref="07f52ed82d89f7e5eb54e5d9bd082464" args="(browser &b, type_id id)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">openvrml::browser_event::browser_event </td> <td>(</td> <td class="paramtype"><a class="el" href="classopenvrml_1_1browser.html">browser</a> & </td> <td class="paramname"> <em>b</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="classopenvrml_1_1browser__event.html#0fb72d4d79d031f467622111c192d770">type_id</a> </td> <td class="paramname"> <em>id</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td> throw ()<code> [private]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Construct. <p> <p><b>For internal use only.</b></p> <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>the <code><a class="el" href="classopenvrml_1_1browser.html" title="Encapsulates a VRML browser.">browser</a></code> from which the event originated. </td></tr> <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>id</em> </td><td>the event type. </td></tr> </table> </dl> </p> </div> </div><p> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="db40a92a8340ff551e19363c32f81239"></a><!-- doxytag: member="openvrml::browser_event::id" ref="db40a92a8340ff551e19363c32f81239" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classopenvrml_1_1browser__event.html#0fb72d4d79d031f467622111c192d770">openvrml::browser_event::type_id</a> openvrml::browser_event::id </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td> const throw ()</td> </tr> </table> </div> <div class="memdoc"> <p> Event type identifier. <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd>the event type identifier. </dd></dl> </div> </div><p> <a class="anchor" name="65df75bbe48ace88137542e9d88d7b2c"></a><!-- doxytag: member="openvrml::browser_event::source" ref="65df75bbe48ace88137542e9d88d7b2c" args="() const " --> <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::browser_event::source </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td> const throw ()</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> that emitted the event. <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> that emitted the event. </dd></dl> </div> </div><p> <hr><h2>Friends And Related Function Documentation</h2> <a class="anchor" name="112e5b246c1ac82eba078edbc2048617"></a><!-- doxytag: member="openvrml::browser_event::browser" ref="112e5b246c1ac82eba078edbc2048617" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">openvrml::browser_event::browser<code> [friend]</code> </td> </tr> </table> </div> <div class="memdoc"> <p> Only <code><a class="el" href="classopenvrml_1_1browser.html" title="Encapsulates a VRML browser.">browser</a>s</code> can construct <code><a class="el" href="classopenvrml_1_1browser__event.html" title="A browser-wide event.">browser_event</a>s</code>. <p> </div> </div><p> <hr><h2>Member Data Documentation</h2> <a class="anchor" name="c4c12c7941238703f154fbf9877e2e07"></a><!-- doxytag: member="openvrml::browser_event::source_" ref="c4c12c7941238703f154fbf9877e2e07" 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> * <a class="el" href="classopenvrml_1_1browser__event.html#c4c12c7941238703f154fbf9877e2e07">openvrml::browser_event::source_</a><code> [private]</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> from which the event originated. <p> <p><b>For internal use only.</b></p> <p> </p> </div> </div><p> <a class="anchor" name="cd0dec3f18f44d2a181ae8f94c1bd31e"></a><!-- doxytag: member="openvrml::browser_event::id_" ref="cd0dec3f18f44d2a181ae8f94c1bd31e" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classopenvrml_1_1browser__event.html#0fb72d4d79d031f467622111c192d770">openvrml::browser_event::type_id</a> <a class="el" href="classopenvrml_1_1browser__event.html#cd0dec3f18f44d2a181ae8f94c1bd31e">openvrml::browser_event::id_</a><code> [private]</code> </td> </tr> </table> </div> <div class="memdoc"> <p> Event type identifier. <p> <p><b>For internal use only.</b></p> <p> </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>