1 line
5.8 KiB
JavaScript
1 line
5.8 KiB
JavaScript
"use strict";(self.webpackChunkstardust_website=self.webpackChunkstardust_website||[]).push([[824],{3905:function(e,t,r){r.d(t,{Zo:function(){return c},kt:function(){return f}});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function o(e){for(var t=1;t<arguments.length;t++){var r=null!=arguments[t]?arguments[t]:{};t%2?i(Object(r),!0).forEach((function(t){n(e,t,r[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(r)):i(Object(r)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(r,t))}))}return e}function s(e,t){if(null==e)return{};var r,a,n=function(e,t){if(null==e)return{};var r,a,n={},i=Object.keys(e);for(a=0;a<i.length;a++)r=i[a],t.indexOf(r)>=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a<i.length;a++)r=i[a],t.indexOf(r)>=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var p=a.createContext({}),l=function(e){var t=a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},c=function(e){var t=l(e.components);return a.createElement(p.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},d=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,c=s(e,["components","mdxType","originalType","parentName"]),d=l(r),f=n,m=d["".concat(p,".").concat(f)]||d[f]||u[f]||i;return r?a.createElement(m,o(o({ref:t},c),{},{components:r})):a.createElement(m,o({ref:t},c))}));function f(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,o=new Array(i);o[0]=d;var s={};for(var p in t)hasOwnProperty.call(t,p)&&(s[p]=t[p]);s.originalType=e,s.mdxType="string"==typeof e?e:n,o[1]=s;for(var l=2;l<i;l++)o[l]=r[l];return a.createElement.apply(null,o)}return a.createElement.apply(null,r)}d.displayName="MDXCreateElement"},3258:function(e,t,r){r.r(t),r.d(t,{frontMatter:function(){return s},contentTitle:function(){return p},metadata:function(){return l},toc:function(){return c},default:function(){return d}});var a=r(7462),n=r(3366),i=(r(7294),r(3905)),o=["components"],s={sidebar_position:9},p="Zone",l={unversionedId:"stardust-protocol/server/types/Zone",id:"stardust-protocol/server/types/Zone",isDocsHomePage:!1,title:"Zone",description:"Derived from Spatial",source:"@site/docs/stardust-protocol/server/types/Zone.md",sourceDirName:"stardust-protocol/server/types",slug:"/stardust-protocol/server/types/Zone",permalink:"/docs/stardust-protocol/server/types/Zone",editUrl:"https://github.com/StardustXR/website/edit/main/docs/stardust-protocol/server/types/Zone.md",version:"current",sidebarPosition:9,frontMatter:{sidebar_position:9},sidebar:"tutorialSidebar",previous:{title:"PointerInput",permalink:"/docs/stardust-protocol/server/types/input/inputtypes/PointerInput"},next:{title:"/drawable",permalink:"/docs/stardust-protocol/server/objects/drawable"}},c=[{value:"Derived from Spatial",id:"derived-from-spatial",children:[]},{value:"Signals",id:"signals",children:[{value:"<code>bool isCaptured(string spatialUUID)</code>",id:"bool-iscapturedstring-spatialuuid",children:[]},{value:"<code>capture(string spatialUUID)</code>",id:"capturestring-spatialuuid",children:[]},{value:"<code>release(string spatialUUID)</code>",id:"releasestring-spatialuuid",children:[]}]}],u={toc:c};function d(e){var t=e.components,r=(0,n.Z)(e,o);return(0,i.kt)("wrapper",(0,a.Z)({},u,r,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("h1",{id:"zone"},"Zone"),(0,i.kt)("h3",{id:"derived-from-spatial"},"Derived from ",(0,i.kt)("a",{parentName:"h3",href:"Spatial"},"Spatial")),(0,i.kt)("p",null,"An object to manipulate compatible ",(0,i.kt)("a",{parentName:"p",href:"Spatial"},"Spatials")," inside its field, such as organizing/aligning widgets or creating workspaces, acting as an inertial reference frame or part of a multi-selection wand."),(0,i.kt)("h2",{id:"signals"},"Signals"),(0,i.kt)("h3",{id:"bool-iscapturedstring-spatialuuid"},(0,i.kt)("inlineCode",{parentName:"h3"},"bool isCaptured(string spatialUUID)")),(0,i.kt)("p",null,"Returns ",(0,i.kt)("inlineCode",{parentName:"p"},"true"),"/",(0,i.kt)("inlineCode",{parentName:"p"},"false")," if the ",(0,i.kt)("a",{parentName:"p",href:"Spatial"},"Spatial")," is captured by this zone or another, ",(0,i.kt)("inlineCode",{parentName:"p"},"null")," if the ",(0,i.kt)("a",{parentName:"p",href:"Spatial"},"Spatial")," at ",(0,i.kt)("inlineCode",{parentName:"p"},"spatialUUID")," is not accessible by this zone or does not exist."),(0,i.kt)("h3",{id:"capturestring-spatialuuid"},(0,i.kt)("inlineCode",{parentName:"h3"},"capture(string spatialUUID)")),(0,i.kt)("p",null,"Captures the ",(0,i.kt)("a",{parentName:"p",href:"Spatial"},"Spatial")," at ",(0,i.kt)("inlineCode",{parentName:"p"},"spatialUUID")," if that ",(0,i.kt)("a",{parentName:"p",href:"Spatial"},"Spatial")," exists and is accessible by this zone. This means that the ",(0,i.kt)("a",{parentName:"p",href:"Spatial"},"Spatial")," cannot be seen or affected by other zones unless a zone is closer to the ",(0,i.kt)("a",{parentName:"p",href:"Spatial"},"Spatial")," than this zone."),(0,i.kt)("h3",{id:"releasestring-spatialuuid"},(0,i.kt)("inlineCode",{parentName:"h3"},"release(string spatialUUID)")),(0,i.kt)("p",null,"Uncaptures the ",(0,i.kt)("a",{parentName:"p",href:"Spatial"},"Spatial")," at ",(0,i.kt)("inlineCode",{parentName:"p"},"spatialUUID")," so any zone the ",(0,i.kt)("a",{parentName:"p",href:"Spatial"},"Spatial")," is inside can access it."))}d.isMDXComponent=!0}}]); |