Files
website/docs/stardust-protocol/server/objects/input.html
2021-07-21 19:51:01 -05:00

17 lines
15 KiB
HTML

<!doctype html>
<html lang="en" dir="ltr">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="generator" content="Docusaurus v2.0.0-beta.3">
<title data-react-helmet="true">/input | Stardust XR</title><meta data-react-helmet="true" property="og:url" content="https://stardustxr.org/docs/stardust-protocol/server/objects/input"><meta data-react-helmet="true" name="docusaurus_locale" content="en"><meta data-react-helmet="true" name="docusaurus_version" content="current"><meta data-react-helmet="true" name="docusaurus_tag" content="docs-default-current"><meta data-react-helmet="true" property="og:title" content="/input | Stardust XR"><meta data-react-helmet="true" name="description" content="Object managing input and interaction."><meta data-react-helmet="true" property="og:description" content="Object managing input and interaction."><link data-react-helmet="true" rel="shortcut icon" href="/img/favicon.ico"><link data-react-helmet="true" rel="canonical" href="https://stardustxr.org/docs/stardust-protocol/server/objects/input"><link data-react-helmet="true" rel="alternate" href="https://stardustxr.org/docs/stardust-protocol/server/objects/input" hreflang="en"><link data-react-helmet="true" rel="alternate" href="https://stardustxr.org/docs/stardust-protocol/server/objects/input" hreflang="x-default"><link rel="stylesheet" href="/assets/css/styles.835e2a3a.css">
<link rel="preload" href="/assets/js/runtime~main.32df8f87.js" as="script">
<link rel="preload" href="/assets/js/main.88670e8d.js" as="script">
</head>
<body>
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"dark")}()</script><div id="__docusaurus">
<div><a href="#" class="skipToContent_1oUP">Skip to main content</a></div><nav class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Navigation bar toggle" class="navbar__toggle clean-btn" type="button" tabindex="0"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><img src="/img/icon.webp" alt="Stardust XR logo, a yellow astroid with smaller white astroids around it" class="themedImage_1VuW themedImage--light_3UqQ navbar__logo"><img src="/img/icon.webp" alt="Stardust XR logo, a yellow astroid with smaller white astroids around it" class="themedImage_1VuW themedImage--dark_hz6m navbar__logo"><b class="navbar__title">Stardust XR</b></a><a class="navbar__item navbar__link navbar__link--active" href="/docs/intro">Docs</a></div><div class="navbar__items navbar__items--right"><a href="https://github.com/technobaboo/stardust-xr" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link"><span>GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_3J9K"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></span></a></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div><div class="navbar-sidebar"><div class="navbar-sidebar__brand"><a class="navbar__brand" href="/"><img src="/img/icon.webp" alt="Stardust XR logo, a yellow astroid with smaller white astroids around it" class="themedImage_1VuW themedImage--light_3UqQ navbar__logo"><img src="/img/icon.webp" alt="Stardust XR logo, a yellow astroid with smaller white astroids around it" class="themedImage_1VuW themedImage--dark_hz6m navbar__logo"><b class="navbar__title">Stardust XR</b></a></div><div class="navbar-sidebar__items"><div class="menu"><ul class="menu__list"><li class="menu__list-item"><a class="menu__link navbar__link--active" href="/docs/intro">Docs</a></li><li class="menu__list-item"><a href="https://github.com/technobaboo/stardust-xr" target="_blank" rel="noopener noreferrer" class="menu__link"><span>GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_3J9K"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></span></a></li></ul></div></div></div></nav><div class="main-wrapper docs-wrapper doc-page"><div class="docPage_31aa"><aside class="docSidebarContainer_3Kbt"><div class="sidebar_15mo"><nav class="menu menu--responsive thin-scrollbar menu_Bmed menuWithAnnouncementBar_2WvA" aria-label="Sidebar navigation"><button aria-label="Open menu" aria-haspopup="true" class="button button--secondary button--sm menu__button" type="button"><svg class="sidebarMenuIcon_fgN0" width="24" height="24" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" href="/docs/intro">Intro</a></li><li class="menu__list-item"><a class="menu__link menu__link--sublist menu__link--active" href="#">Protocol</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/stardust-protocol/protocol">Protocol</a></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#" tabindex="0">Client</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/stardust-protocol/client/initial-connection">Initial Client Connection</a></li></ul></li><li class="menu__list-item"><a class="menu__link menu__link--sublist menu__link--active" href="#" tabindex="0">Server</a><ul class="menu__list"><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#" tabindex="0">Node Types</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/stardust-protocol/server/types/Node">Node</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/stardust-protocol/server/types/Spatial">Spatial</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/stardust-protocol/server/types/Model">Model</a></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#" tabindex="-1">Fields</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/stardust-protocol/server/types/field/BoxField">BoxField</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/stardust-protocol/server/types/field/Field">Field</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/stardust-protocol/server/types/field/SphereField">SphereField</a></li></ul></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#" tabindex="-1">Input</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/stardust-protocol/server/types/input/InputHandler">InputHandler</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/stardust-protocol/server/types/input/InputMethod">InputMethod</a></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#" tabindex="-1">inputtypes</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/stardust-protocol/server/types/input/inputtypes/HandInput">HandInput</a></li><li class="menu__list-item"><a class="menu__link" tabindex="-1" href="/docs/stardust-protocol/server/types/input/inputtypes/PointerInput">PointerInput</a></li></ul></li></ul></li></ul></li><li class="menu__list-item"><a class="menu__link menu__link--sublist menu__link--active" href="#" tabindex="0">Server Objects</a><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/stardust-protocol/server/objects/environment">/environment</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/stardust-protocol/server/objects/field">/field</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/stardust-protocol/server/objects/hmd">/hmd</a></li><li class="menu__list-item"><a aria-current="page" class="menu__link menu__link--active active" tabindex="0" href="/docs/stardust-protocol/server/objects/input">/input</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/stardust-protocol/server/objects/lifecycle">/lifecycle</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/stardust-protocol/server/objects/model">/model</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/stardust-protocol/server/objects/spatial">/spatial</a></li></ul></li></ul></li></ul></li></ul></nav></div></aside><main class="docMainContainer_3ufF"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_3FnS"><div class="docItemContainer_33ec"><article><div class="markdown"><header><h1 class="h1Heading_27L5">/input</h1></header><p>Object managing input and interaction.</p><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_2LWZ" id="signals"></a>Signals<a class="hash-link" href="#signals" title="Direct link to heading">#</a></h2><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_2LWZ" id="registerpointerinputstring-name-vector3-origin-vector3-direction-float-tilt"></a><code>registerPointerInput(string name, Vector3 origin, Vector3 direction, float tilt)</code><a class="hash-link" href="#registerpointerinputstring-name-vector3-origin-vector3-direction-float-tilt" title="Direct link to heading">#</a></h3><p>Creates a new [[Pointerinput]] at <code>/input/methods/[name]</code> with the origin, direction, and tilt specified.</p><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_2LWZ" id="registerinputhandlerstring-name-string-field-string-spacepath-vector3-position-quat-rotation-string-callbackpath-string-callbackmethod"></a><code>registerInputHandler(string name, string field, string spacePath, Vector3 position, Quat rotation, string callbackPath, string callbackMethod)</code><a class="hash-link" href="#registerinputhandlerstring-name-string-field-string-spacepath-vector3-position-quat-rotation-string-callbackpath-string-callbackmethod" title="Direct link to heading">#</a></h3><p>Creates a new [[InputHandler]] with the specified <code>name</code> and <code>field</code>, located relative to the space referenced in <code>spacePath</code> and the <code>postion</code> + <code>rotation</code>.</p></div><footer class="row docusaurus-mt-lg"><div class="col"><a href="https://github.com/StardustXR/website/edit/main/docs/stardust-protocol/server/objects/input.md" target="_blank" rel="noreferrer noopener"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_2_ui" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_3DPF"></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages navigation"><div class="pagination-nav__item"><a class="pagination-nav__link" href="/docs/stardust-protocol/server/objects/hmd"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">« /hmd</div></a></div><div class="pagination-nav__item pagination-nav__item--next"><a class="pagination-nav__link" href="/docs/stardust-protocol/server/objects/lifecycle"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">/lifecycle »</div></a></div></nav></div></div><div class="col col--3"><div class="tableOfContents_35-E thin-scrollbar"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#signals" class="table-of-contents__link">Signals</a><ul><li><a href="#registerpointerinputstring-name-vector3-origin-vector3-direction-float-tilt" class="table-of-contents__link"><code>registerPointerInput(string name, Vector3 origin, Vector3 direction, float tilt)</code></a></li><li><a href="#registerinputhandlerstring-name-string-field-string-spacepath-vector3-position-quat-rotation-string-callbackpath-string-callbackmethod" class="table-of-contents__link"><code>registerInputHandler(string name, string field, string spacePath, Vector3 position, Quat rotation, string callbackPath, string callbackMethod)</code></a></li></ul></li></ul></div></div></div></div></main></div></div><footer class="footer footer--dark"><div class="container"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items"><li class="footer__item"><a class="footer__link-item" href="/docs/stardust-protocol/protocol">Protocol</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items"><li class="footer__item"><a href="https://discord.gg/qwxuwRrbP5" target="_blank" rel="noopener noreferrer" class="footer__link-item"><span>Discord<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_3J9K"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></span></a></li><li class="footer__item"><a href="https://twitter.com/stardustxr" target="_blank" rel="noopener noreferrer" class="footer__link-item"><span>Twitter<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_3J9K"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></span></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items"><li class="footer__item"><a href="https://github.com/technobaboo/stardust-xr" target="_blank" rel="noopener noreferrer" class="footer__link-item"><span>GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_3J9K"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></span></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2021 Nova King</div></div></div></footer></div>
<script src="/assets/js/runtime~main.32df8f87.js"></script>
<script src="/assets/js/main.88670e8d.js"></script>
</body>
</html>