<!doctype html public "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <title>OpenVRML: openvrml::pointing_device_sensor_node 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_1pointing__device__sensor__node.html">pointing_device_sensor_node</a> </div> </div> <div class="contents"> <h1>openvrml::pointing_device_sensor_node Class Reference</h1><!-- doxytag: class="openvrml::pointing_device_sensor_node" --><!-- doxytag: inherits="openvrml::child_node" -->A <a class="el" href="classopenvrml_1_1node.html" title="A node in the scene graph.">node</a> that can be affected by a pointing device. <a href="#_details">More...</a> <p> <code>#include <openvrml/node.h></code> <p> <div class="dynheader"> Inheritance diagram for openvrml::pointing_device_sensor_node:</div> <div class="dynsection"> <p><center><img src="classopenvrml_1_1pointing__device__sensor__node__inherit__graph.png" border="0" usemap="#openvrml_1_1pointing__device__sensor__node__inherit__map" alt="Inheritance graph"></center> <map name="openvrml_1_1pointing__device__sensor__node__inherit__map"> <area shape="rect" href="classopenvrml_1_1child__node.html" title="Abstract base class for child nodes." alt="" coords="63,160,212,189"><area shape="rect" href="classopenvrml_1_1bounded__volume__node.html" title="Abstract base class for nodes that represent a bounded volume in the scene graph..." alt="" coords="24,83,251,112"><area shape="rect" href="classopenvrml_1_1node.html" title="A node in the scene graph." alt="" coords="80,5,195,35"></map> <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div> <p> <a href="classopenvrml_1_1pointing__device__sensor__node-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">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classopenvrml_1_1pointing__device__sensor__node.html#333984b11336a098bfdceb5586b22d7e">~pointing_device_sensor_node</a> ()=0 throw ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy. <a href="#333984b11336a098bfdceb5586b22d7e"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classopenvrml_1_1pointing__device__sensor__node.html#bd9faa08e26de2aba676b6462ab263f8">activate</a> (double timestamp, bool over, bool active, const double(&point)[3])</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Convey a pointing device state change. <a href="#bd9faa08e26de2aba676b6462ab263f8"></a><br></td></tr> <tr><td colspan="2"><br><h2>Protected 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_1pointing__device__sensor__node.html#2af855dd995c97f91bd504216b3ce4f1">pointing_device_sensor_node</a> (const <a class="el" href="classopenvrml_1_1node__type.html">node_type</a> &type, const boost::shared_ptr< <a class="el" href="classopenvrml_1_1scope.html">openvrml::scope</a> > &<a class="el" href="classopenvrml_1_1scope.html">scope</a>)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Construct. <a href="#2af855dd995c97f91bd504216b3ce4f1"></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">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classopenvrml_1_1pointing__device__sensor__node.html#ce3de1116ee1ceaed1b282d62dda7a28">do_activate</a> (double timestamp, bool over, bool active, const double(&point)[3])=0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Called to convey a pointing device state change. <a href="#ce3de1116ee1ceaed1b282d62dda7a28"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <br class="typebreak"> <a class="el" href="classopenvrml_1_1pointing__device__sensor__node.html">pointing_device_sensor_node</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classopenvrml_1_1pointing__device__sensor__node.html#622fb660343031e812f9ca1202acf71d">to_pointing_device_sensor</a> () throw ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Cast to a <code><a class="el" href="classopenvrml_1_1pointing__device__sensor__node.html" title="A node that can be affected by a pointing device.">pointing_device_sensor_node</a></code>. <a href="#622fb660343031e812f9ca1202acf71d"></a><br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> A <a class="el" href="classopenvrml_1_1node.html" title="A node in the scene graph.">node</a> that can be affected by a pointing device. <hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="333984b11336a098bfdceb5586b22d7e"></a><!-- doxytag: member="openvrml::pointing_device_sensor_node::~pointing_device_sensor_node" ref="333984b11336a098bfdceb5586b22d7e" args="()=0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">openvrml::pointing_device_sensor_node::~pointing_device_sensor_node </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td> throw ()<code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Destroy. <p> </div> </div><p> <a class="anchor" name="2af855dd995c97f91bd504216b3ce4f1"></a><!-- doxytag: member="openvrml::pointing_device_sensor_node::pointing_device_sensor_node" ref="2af855dd995c97f91bd504216b3ce4f1" args="(const node_type &type, const boost::shared_ptr< openvrml::scope > &scope)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">openvrml::pointing_device_sensor_node::pointing_device_sensor_node </td> <td>(</td> <td class="paramtype">const <a class="el" href="classopenvrml_1_1node__type.html">node_type</a> & </td> <td class="paramname"> <em>type</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const boost::shared_ptr< <a class="el" href="classopenvrml_1_1scope.html">openvrml::scope</a> > & </td> <td class="paramname"> <em>scope</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [protected]</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>type</em> </td><td>the <code><a class="el" href="classopenvrml_1_1node__type.html" title="Type information object for nodes.">node_type</a></code>. </td></tr> <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em><a class="el" href="classopenvrml_1_1scope.html" title="The scope class keeps track of defined nodes and prototypes.">scope</a></em> </td><td>the <code><a class="el" href="classopenvrml_1_1scope.html" title="The scope class keeps track of defined nodes and prototypes.">scope</a></code> to which the <a class="el" href="classopenvrml_1_1node.html" title="A node in the scene graph.">node</a> belongs. </td></tr> </table> </dl> </div> </div><p> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="bd9faa08e26de2aba676b6462ab263f8"></a><!-- doxytag: member="openvrml::pointing_device_sensor_node::activate" ref="bd9faa08e26de2aba676b6462ab263f8" args="(double timestamp, bool over, bool active, const double(&point)[3])" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void openvrml::pointing_device_sensor_node::activate </td> <td>(</td> <td class="paramtype">double </td> <td class="paramname"> <em>timestamp</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"> <em>over</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"> <em>active</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const double(&) </td> <td class="paramname"> <em>point</em>[3]</td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p> Convey a pointing device state change. <p> This function delegates to <code><a class="el" href="classopenvrml_1_1pointing__device__sensor__node.html#ce3de1116ee1ceaed1b282d62dda7a28" title="Called to convey a pointing device state change.">do_activate</a></code>.<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>timestamp</em> </td><td>the current time. </td></tr> <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>over</em> </td><td>whether the pointing device is over the geometry affected by the pointing device sensor. </td></tr> <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>active</em> </td><td>whether the pointing device is “active”; e.g., whether a mouse button is currently depressed. </td></tr> <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>point</em> </td><td>the position of the pointer on the affected geometry. </td></tr> </table> </dl> </div> </div><p> <a class="anchor" name="ce3de1116ee1ceaed1b282d62dda7a28"></a><!-- doxytag: member="openvrml::pointing_device_sensor_node::do_activate" ref="ce3de1116ee1ceaed1b282d62dda7a28" args="(double timestamp, bool over, bool active, const double(&point)[3])=0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void openvrml::pointing_device_sensor_node::do_activate </td> <td>(</td> <td class="paramtype">double </td> <td class="paramname"> <em>timestamp</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"> <em>over</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"> <em>active</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const double(&) </td> <td class="paramname"> <em>point</em>[3]</td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [private, pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Called to convey a pointing device state change. <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>timestamp</em> </td><td>the current time. </td></tr> <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>over</em> </td><td>whether the pointing device is over the geometry affected by the pointing device sensor. </td></tr> <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>active</em> </td><td>whether the pointing device is “active”; e.g., whether a mouse button is currently depressed. </td></tr> <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>point</em> </td><td>the position of the pointer on the affected geometry. </td></tr> </table> </dl> </div> </div><p> <a class="anchor" name="622fb660343031e812f9ca1202acf71d"></a><!-- doxytag: member="openvrml::pointing_device_sensor_node::to_pointing_device_sensor" ref="622fb660343031e812f9ca1202acf71d" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classopenvrml_1_1pointing__device__sensor__node.html">openvrml::pointing_device_sensor_node</a> * openvrml::pointing_device_sensor_node::to_pointing_device_sensor </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td> throw ()<code> [private, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Cast to a <code><a class="el" href="classopenvrml_1_1pointing__device__sensor__node.html" title="A node that can be affected by a pointing device.">pointing_device_sensor_node</a></code>. <p> <p><b>For internal use only.</b></p> <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd>a pointer to the object. </dd></dl> </p> <p>Reimplemented from <a class="el" href="classopenvrml_1_1node.html#e51027945a617ced6e4e5caaba074a70">openvrml::node</a>.</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:21 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>