diff --git a/404.html b/404.html index 58bdbd83..22e90ed9 100644 --- a/404.html +++ b/404.html @@ -5,13 +5,13 @@ Page Not Found | Stardust XR - +
Skip to main content

Page Not Found

We could not find what you were looking for.

Please contact the owner of the site that linked you to the original URL and let them know their link is broken.

- + \ No newline at end of file diff --git a/assets/js/b4e94af8.314c217b.js b/assets/js/b4e94af8.314c217b.js new file mode 100644 index 00000000..68724cf5 --- /dev/null +++ b/assets/js/b4e94af8.314c217b.js @@ -0,0 +1 @@ +(self.webpackChunkstardust_website=self.webpackChunkstardust_website||[]).push([[300],{3905:function(e,t,a){"use strict";a.d(t,{Zo:function(){return p},kt:function(){return u}});var i=a(7294);function l(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function s(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);t&&(i=i.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,i)}return a}function n(e){for(var t=1;t=0||(l[a]=e[a]);return l}(e,t);if(Object.getOwnPropertySymbols){var s=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(l[a]=e[a])}return l}var r=i.createContext({}),k=function(e){var t=i.useContext(r),a=t;return e&&(a="function"==typeof e?e(t):n(n({},t),e)),a},p=function(e){var t=k(e.components);return i.createElement(r.Provider,{value:t},e.children)},m={inlineCode:"code",wrapper:function(e){var t=e.children;return i.createElement(i.Fragment,{},t)}},o=i.forwardRef((function(e,t){var a=e.components,l=e.mdxType,s=e.originalType,r=e.parentName,p=c(e,["components","mdxType","originalType","parentName"]),o=k(a),u=l,d=o["".concat(r,".").concat(u)]||o[u]||m[u]||s;return a?i.createElement(d,n(n({ref:t},p),{},{components:a})):i.createElement(d,n({ref:t},p))}));function u(e,t){var a=arguments,l=t&&t.mdxType;if("string"==typeof e||l){var s=a.length,n=new Array(s);n[0]=o;var c={};for(var r in t)hasOwnProperty.call(t,r)&&(c[r]=t[r]);c.originalType=e,c.mdxType="string"==typeof e?e:l,n[1]=c;for(var k=2;k=0||(l[a]=e[a]);return l}(e,t);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(l[a]=e[a])}return l}var r=i.createContext({}),p=function(e){var t=i.useContext(r),a=t;return e&&(a="function"==typeof e?e(t):c(c({},t),e)),a},m=function(e){var t=p(e.components);return i.createElement(r.Provider,{value:t},e.children)},k={inlineCode:"code",wrapper:function(e){var t=e.children;return i.createElement(i.Fragment,{},t)}},o=i.forwardRef((function(e,t){var a=e.components,l=e.mdxType,n=e.originalType,r=e.parentName,m=s(e,["components","mdxType","originalType","parentName"]),o=p(a),u=l,d=o["".concat(r,".").concat(u)]||o[u]||k[u]||n;return a?i.createElement(d,c(c({ref:t},m),{},{components:a})):i.createElement(d,c({ref:t},m))}));function u(e,t){var a=arguments,l=t&&t.mdxType;if("string"==typeof e||l){var n=a.length,c=new Array(n);c[0]=o;var s={};for(var r in t)hasOwnProperty.call(t,r)&&(s[r]=t[r]);s.originalType=e,s.mdxType="string"==typeof e?e:l,c[1]=s;for(var p=2;p=c)&&Object.keys(a.O).every((function(e){return a.O[e](r[u])}))?r.splice(u--,1):(f=!1,c0&&e[d-1][2]>c;d--)e[d]=e[d-1];e[d]=[r,n,c]},a.n=function(e){var t=e&&e.__esModule?function(){return e.default}:function(){return e};return a.d(t,{a:t}),t},r=Object.getPrototypeOf?function(e){return Object.getPrototypeOf(e)}:function(e){return e.__proto__},a.t=function(e,n){if(1&n&&(e=this(e)),8&n)return e;if("object"==typeof e&&e){if(4&n&&e.__esModule)return e;if(16&n&&"function"==typeof e.then)return e}var c=Object.create(null);a.r(c);var o={};t=t||[null,r({}),r([]),r(r)];for(var f=2&n&&e;"object"==typeof f&&!~t.indexOf(f);f=r(f))Object.getOwnPropertyNames(f).forEach((function(t){o[t]=function(){return e[t]}}));return o.default=function(){return e},a.d(c,o),c},a.d=function(e,t){for(var r in t)a.o(t,r)&&!a.o(e,r)&&Object.defineProperty(e,r,{enumerable:!0,get:t[r]})},a.f={},a.e=function(e){return Promise.all(Object.keys(a.f).reduce((function(t,r){return a.f[r](e,t),t}),[]))},a.u=function(e){return"assets/js/"+({16:"1fbe18c3",53:"935f2afb",74:"86790a84",85:"1f391b9e",121:"4cc9031b",195:"c4f5d8e4",272:"3e4d3f97",300:"b4e94af8",342:"003df647",347:"1134c138",351:"1dea05a0",487:"c9dc9d85",500:"614808c6",514:"1be78505",523:"c5e91741",587:"42ef8d41",659:"255c4b9f",671:"0e384e19",672:"5f7b5dec",734:"78a5a427",770:"493a26d0",852:"e3f705b4",855:"40d7c56e",918:"17896441",925:"57a1f8cb",993:"2bb13bfd"}[e]||e)+"."+{16:"9b345413",53:"3b880ae3",74:"a8bd6126",85:"2f7cafbf",111:"75041932",121:"6d2b959b",195:"4cc7e67e",272:"7a047a87",300:"dbbcf369",342:"e507ecc8",347:"49f5d17d",351:"f3f3c957",486:"58eb0f8c",487:"76ff415f",500:"3f64a30e",514:"41ee86ca",523:"08a518f1",587:"10b8a8da",608:"7f4ce0f0",659:"c65b0156",668:"6e212175",671:"54e5cc8e",672:"69ac141d",734:"d28e8492",770:"eea6df75",852:"cd110c86",855:"7622e13d",918:"0ff9f9f9",925:"f2b913d5",993:"2622b5e4"}[e]+".js"},a.miniCssF=function(e){return"assets/css/styles.835e2a3a.css"},a.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),a.o=function(e,t){return Object.prototype.hasOwnProperty.call(e,t)},n={},c="stardust-website:",a.l=function(e,t,r,o){if(n[e])n[e].push(t);else{var f,u;if(void 0!==r)for(var i=document.getElementsByTagName("script"),d=0;d=c)&&Object.keys(a.O).every((function(e){return a.O[e](r[u])}))?r.splice(u--,1):(f=!1,c0&&e[d-1][2]>c;d--)e[d]=e[d-1];e[d]=[r,n,c]},a.n=function(e){var t=e&&e.__esModule?function(){return e.default}:function(){return e};return a.d(t,{a:t}),t},r=Object.getPrototypeOf?function(e){return Object.getPrototypeOf(e)}:function(e){return e.__proto__},a.t=function(e,n){if(1&n&&(e=this(e)),8&n)return e;if("object"==typeof e&&e){if(4&n&&e.__esModule)return e;if(16&n&&"function"==typeof e.then)return e}var c=Object.create(null);a.r(c);var o={};t=t||[null,r({}),r([]),r(r)];for(var f=2&n&&e;"object"==typeof f&&!~t.indexOf(f);f=r(f))Object.getOwnPropertyNames(f).forEach((function(t){o[t]=function(){return e[t]}}));return o.default=function(){return e},a.d(c,o),c},a.d=function(e,t){for(var r in t)a.o(t,r)&&!a.o(e,r)&&Object.defineProperty(e,r,{enumerable:!0,get:t[r]})},a.f={},a.e=function(e){return Promise.all(Object.keys(a.f).reduce((function(t,r){return a.f[r](e,t),t}),[]))},a.u=function(e){return"assets/js/"+({16:"1fbe18c3",53:"935f2afb",74:"86790a84",85:"1f391b9e",121:"4cc9031b",195:"c4f5d8e4",272:"3e4d3f97",300:"b4e94af8",342:"003df647",347:"1134c138",351:"1dea05a0",487:"c9dc9d85",500:"614808c6",514:"1be78505",523:"c5e91741",587:"42ef8d41",659:"255c4b9f",671:"0e384e19",672:"5f7b5dec",734:"78a5a427",770:"493a26d0",852:"e3f705b4",855:"40d7c56e",918:"17896441",925:"57a1f8cb",993:"2bb13bfd"}[e]||e)+"."+{16:"9b345413",53:"3b880ae3",74:"a8bd6126",85:"2f7cafbf",111:"75041932",121:"6d2b959b",195:"4cc7e67e",272:"7a047a87",300:"314c217b",342:"e507ecc8",347:"49f5d17d",351:"f3f3c957",486:"58eb0f8c",487:"76ff415f",500:"3f64a30e",514:"41ee86ca",523:"08a518f1",587:"10b8a8da",608:"7f4ce0f0",659:"c65b0156",668:"6e212175",671:"54e5cc8e",672:"69ac141d",734:"d28e8492",770:"eea6df75",852:"cd110c86",855:"7622e13d",918:"0ff9f9f9",925:"f2b913d5",993:"2622b5e4"}[e]+".js"},a.miniCssF=function(e){return"assets/css/styles.835e2a3a.css"},a.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),a.o=function(e,t){return Object.prototype.hasOwnProperty.call(e,t)},n={},c="stardust-website:",a.l=function(e,t,r,o){if(n[e])n[e].push(t);else{var f,u;if(void 0!==r)for(var i=document.getElementsByTagName("script"),d=0;d Intro | Stardust XR - +
- + \ No newline at end of file diff --git a/docs/stardust-protocol/client/initial-connection.html b/docs/stardust-protocol/client/initial-connection.html index 33919d7d..a3cea55d 100644 --- a/docs/stardust-protocol/client/initial-connection.html +++ b/docs/stardust-protocol/client/initial-connection.html @@ -5,13 +5,13 @@ Initial Client Connection | Stardust XR - +
- + \ No newline at end of file diff --git a/docs/stardust-protocol/protocol.html b/docs/stardust-protocol/protocol.html index a726adda..1e74ac32 100644 --- a/docs/stardust-protocol/protocol.html +++ b/docs/stardust-protocol/protocol.html @@ -5,7 +5,7 @@ Protocol | Stardust XR - + @@ -31,7 +31,7 @@ | type | 3 | | id | The same as the message call's ID | | data | Flexbuffer containing return value |

Data Types#

Stardust does not support the Map or FixedTypedVector flexbuffers datatypes.

Color#

A Vector of 4 float is treated as a Color in the form RGBA.

Vector2#

A Vector of 2 double is treated as a Vector2.

Vector3#

A Vector of 3 double is treated as a Vector3.

Quaternion#

A Vector of 4 double is treated as a Quaternion.

- + \ No newline at end of file diff --git a/docs/stardust-protocol/server/objects/environment.html b/docs/stardust-protocol/server/objects/environment.html index d827c7e0..f7227a11 100644 --- a/docs/stardust-protocol/server/objects/environment.html +++ b/docs/stardust-protocol/server/objects/environment.html @@ -5,13 +5,13 @@ /environment | Stardust XR - +

/environment

Signals#

visible(bool enable)#

Enable or disables the skybox visibility (lighting remains active). This is not meant to be used for an additive AR mode as StereoKit will perform that when the OpenXR runtime indicates the layer's blend mode is additive.

setSkytex(string path)#

Sets the sky texture to be the image (HDR) at the absolute path.

setLighting(string path)#

Sets the ambient lighting (using spherical harmonics) to the HDR at the absolute path.

- + \ No newline at end of file diff --git a/docs/stardust-protocol/server/objects/field.html b/docs/stardust-protocol/server/objects/field.html index 12690bb5..0f51541f 100644 --- a/docs/stardust-protocol/server/objects/field.html +++ b/docs/stardust-protocol/server/objects/field.html @@ -5,13 +5,13 @@ /field | Stardust XR - +

/field

Object managing fields for interaction.

Signals#

createBoxField(string name, Vector3 origin, Quaternion orientation, Vector3 size)#

Creates a new [[BoxField]] at /field/[name].

createSphereField(string name, Vector3 origin, float radius)#

Creates a new [[SphereField]] at /field/[name].

- + \ No newline at end of file diff --git a/docs/stardust-protocol/server/objects/hmd.html b/docs/stardust-protocol/server/objects/hmd.html index 9ca36d19..156d812b 100644 --- a/docs/stardust-protocol/server/objects/hmd.html +++ b/docs/stardust-protocol/server/objects/hmd.html @@ -5,13 +5,13 @@ /hmd | Stardust XR - +

/hmd

Reference object to the HMD being used to render content and track head position.

Signals#

setPosition(Vector3 position)#

setRotation(Quaternion rotation)#

setPose(Vector3 position, Quaternion rotation)#

setIPD(double meters)#

- + \ No newline at end of file diff --git a/docs/stardust-protocol/server/objects/input.html b/docs/stardust-protocol/server/objects/input.html index 411659d5..df5e573a 100644 --- a/docs/stardust-protocol/server/objects/input.html +++ b/docs/stardust-protocol/server/objects/input.html @@ -5,13 +5,13 @@ /input | Stardust XR - +

/input

Object managing input and interaction.

Signals#

registerPointerInput(string name, Vector3 origin, Vector3 direction, float tilt)#

Creates a new [[Pointerinput]] at /input/methods/[name] with the origin, direction, and tilt specified.

registerInputHandler(string name, string field, string spacePath, Vector3 position, Quat rotation, string callbackPath, string callbackMethod)#

Creates a new [[InputHandler]] with the specified name and field, located relative to the space referenced in spacePath and the postion + rotation.

- + \ No newline at end of file diff --git a/docs/stardust-protocol/server/objects/lifecycle.html b/docs/stardust-protocol/server/objects/lifecycle.html index 044609b0..9705c4f8 100644 --- a/docs/stardust-protocol/server/objects/lifecycle.html +++ b/docs/stardust-protocol/server/objects/lifecycle.html @@ -5,13 +5,13 @@ /lifecycle | Stardust XR - +

/lifecycle

Object representing the life cycle of the Stardust server, from start to each frame to end.

Signals#

subscribeLogicStep(string path, string method)#

Executes method on object at path on the client when the main logic loop of the server starts each frame.

method must have arguments of (double delta, double timeToRender).

delta gives the time in seconds between the current time and the last time the logic loop executed while timeToRender gives the time in ms since epoch when the current frame is expected to reach the user's eyes.

- + \ No newline at end of file diff --git a/docs/stardust-protocol/server/objects/model.html b/docs/stardust-protocol/server/objects/model.html index 5c89afa1..3c5bdd4a 100644 --- a/docs/stardust-protocol/server/objects/model.html +++ b/docs/stardust-protocol/server/objects/model.html @@ -5,13 +5,13 @@ /model | Stardust XR - +

/model

Object managing graphical models.

Signals#

createFromFile(string name, string path)#

Creates a new [[Model]] at /model/[name].

- + \ No newline at end of file diff --git a/docs/stardust-protocol/server/objects/spatial.html b/docs/stardust-protocol/server/objects/spatial.html index 84cd61f5..99658910 100644 --- a/docs/stardust-protocol/server/objects/spatial.html +++ b/docs/stardust-protocol/server/objects/spatial.html @@ -5,13 +5,13 @@ /spatial | Stardust XR - +

/spatial

Object managing spatial nodes for parenting.

Signals#

create(string name, Vector3 origin, Quat orientation, Vector3 scale, bool translatable, bool rotatable, bool scalable)#

Creates a new [[Spatial]] at /spatial/[name].

- + \ No newline at end of file diff --git a/docs/stardust-protocol/server/types/Model.html b/docs/stardust-protocol/server/types/Model.html index ef7d3555..243ede44 100644 --- a/docs/stardust-protocol/server/types/Model.html +++ b/docs/stardust-protocol/server/types/Model.html @@ -5,13 +5,13 @@ Model | Stardust XR - +

Model

Derived from [[Spatial]]#

A graphical model.

Properties#

setOrigin(Vector3 origin)#

Sets the origin to origin.

setOrientation(Quat orientation)#

Sets the orientation to orientation.

setPose(Vector3 origin, Quat orientation)#

Sets the pose using origin and orientation absolutely.

destroy()#

Destroys the model instance. Resources like the mesh and material and textures may be in memory still, but the resource manager will clean it up if needed.

setMaterialProperty(uint32 submeshIndex, string propertyName, float value)#

setMaterialProperty(uint32 submeshIndex, string propertyName, Color value)#

setMaterialProperty(uint32 submeshIndex, string propertyName, string value)#

Sets the material property propertyName on this model's submesh at submeshIndex to value. Valid material names are:

NameTypeDescription
colorColorTint/multiply the shader's output color by this amount. (default is opaque white)
roughnessfloatScale the metal texture's roughness by this amount
metallicfloatScale the metal texture's metalness by this amount
tex_scalefloatScale the UV coordinates of all textures by this amount
diffusestringPath to the diffuse texture of the material (if it has one).
emissionstringPath to the emission texture of the material (if it has one).
metalstringPath to the metalness texture of the material (if it has one).
normalstringPath to the normal map texture of the material (if it has one).
occlusionstringPath to the occlusion map texture of the material (if it has one).
- + \ No newline at end of file diff --git a/docs/stardust-protocol/server/types/Node.html b/docs/stardust-protocol/server/types/Node.html index bcf1b91e..305e0733 100644 --- a/docs/stardust-protocol/server/types/Node.html +++ b/docs/stardust-protocol/server/types/Node.html @@ -5,13 +5,13 @@ Node | Stardust XR - +

Node

A base type for all othertypes that exist in 3D space.

Methods#

destroy(null)#

Destroy this node immediately, as well as all its children if it has any.

- + \ No newline at end of file diff --git a/docs/stardust-protocol/server/types/Spatial.html b/docs/stardust-protocol/server/types/Spatial.html index 20804c65..fba49cef 100644 --- a/docs/stardust-protocol/server/types/Spatial.html +++ b/docs/stardust-protocol/server/types/Spatial.html @@ -5,13 +5,13 @@ Spatial | Stardust XR - +

Spatial

Derived from [[Node]]#

A base type for types that exist in 3D space, always relative to another space or the engine's world space. Spatials are always relative because in AR or XXR reference spaces change constantly in response to new environments.

Internal Properties#

Sometimes it makes sense for a Spatial to not be scalable (like in [[Field]]s where scaling dramatically increases the number of steps to raymarch for pointers) or not be rotatable (point lights) or such, so these are disabled for certain Spatial-derived objects, mentioned right after "Derived from [[Spatial]]".

translatable: bool#

If false, object's origin cannot be modified from a client.

rotatable: bool#

If false, object's rotation cannot be modified from a client (e.g. point lights, point sound sources).

scalable: bool#

If false, object's scale cannot be modified from a client (e.g. [[Field]]s, [[PointerInput]]s).

Methods#

move(Vector3 position)#

Moves the Spatial relative to itself if translatable is not false.

rotate(Quat rotation)#

Rotates the Spatial relative to itself if rotatable is not false.

rotateAround(Vector3 point, Quat rotation)#

Rotates the Spatial around point (relative to itself) if rotatable is not false.

scale(float scale)#

Multiplies the Spatial's scale vector by scale if scalable is not false.

setOrigin(Vector3 origin)#

Sets the origin to origin if translatable is not false.

setOrientation(Quat orientation)#

Sets the orientation to orientation if rotatable is not false.

setScale(Vector3 scale)#

Sets the scale to scale if scalable is not false.

setPose(Vector3 origin, Quat orientation)#

Sets the pose relative to the Spatial's space if translatable and rotatable are true. This method saves on IPC calls compared to setOrigin and setOrientation in sequence.

setTransform(Vector3 origin, Quat orientation)#

Sets the transform relative to the Spatial's space if translatable, rotatable and scalable are true. This method saves on IPC calls compared to setOrigin, setOrientation, and setScale in sequence.

setSpatialParent(string parentPath)#

Sets the spatial parent of this Spatial while keeping the "absolute" position in space intact.

- + \ No newline at end of file diff --git a/docs/stardust-protocol/server/types/field/BoxField.html b/docs/stardust-protocol/server/types/field/BoxField.html index 4af68e4d..aed46a3a 100644 --- a/docs/stardust-protocol/server/types/field/BoxField.html +++ b/docs/stardust-protocol/server/types/field/BoxField.html @@ -5,13 +5,13 @@ BoxField | Stardust XR - +

BoxField

Derived from [[Field]], this Field is in a rectangular prism shape.

Properties#

setSize(Vector3 size)#

Sets the size of the box.

- + \ No newline at end of file diff --git a/docs/stardust-protocol/server/types/field/Field.html b/docs/stardust-protocol/server/types/field/Field.html index 03082fc9..e7af29f3 100644 --- a/docs/stardust-protocol/server/types/field/Field.html +++ b/docs/stardust-protocol/server/types/field/Field.html @@ -5,13 +5,13 @@ Field | Stardust XR - +

Field

Derived from [[Spatial]]#

Type that contains methods all Fields share. All fields created are under /field.

Methods#

double distance(string spacePath, Vector3 point)#

Returns the distance from point to the surface of the object, positive if the point is outside and negative if inside. When point is far enough away the object will give an approximate distance to the origin instead of the surface.

Vector3 normal(string spacePath, Vector3 point)#

Returns the normal of point compared to the surface of the object. Normal always points toward object.

Vector3 closestPoint(string spacePath, Vector3 point)#

Returns the closest point from point to the surface of the object. Use this instead of distance and normal when best to limit IPC calls.

- + \ No newline at end of file diff --git a/docs/stardust-protocol/server/types/field/SphereField.html b/docs/stardust-protocol/server/types/field/SphereField.html index ec051891..bb8b8fcb 100644 --- a/docs/stardust-protocol/server/types/field/SphereField.html +++ b/docs/stardust-protocol/server/types/field/SphereField.html @@ -5,13 +5,13 @@ SphereField | Stardust XR - +

SphereField

Derived from [[Field]], this Field is in a sphere shape.

Properties#

setRadius(double size)#

Sets the radius of the sphere.

- + \ No newline at end of file diff --git a/docs/stardust-protocol/server/types/input/InputHandler.html b/docs/stardust-protocol/server/types/input/InputHandler.html index 929eed85..854dc7d1 100644 --- a/docs/stardust-protocol/server/types/input/InputHandler.html +++ b/docs/stardust-protocol/server/types/input/InputHandler.html @@ -5,13 +5,13 @@ InputHandler | Stardust XR - +

InputHandler

Derived from [[Spatial]] (scalable: false)#

A handler to allow clients to recieve input.

Methods#

setOrigin(Vector3 origin)#

Sets the origin to origin.

setOrientation(Quat orientation)#

Sets the orientation to orientation.

setPose(Vector3 origin, Quat orientation)#

Sets the pose using origin and orientation relative to the pose's space.

setField(string field)#

Sets the field this input handler will use.

setCallback(string callbackPath, string callbackMethod)#

Sets the callback this input handler will use.

- + \ No newline at end of file diff --git a/docs/stardust-protocol/server/types/input/InputMethod.html b/docs/stardust-protocol/server/types/input/InputMethod.html index b895008f..64868079 100644 --- a/docs/stardust-protocol/server/types/input/InputMethod.html +++ b/docs/stardust-protocol/server/types/input/InputMethod.html @@ -5,13 +5,13 @@ InputMethod | Stardust XR - +

InputMethod

Represents an input device generically, with specifics being fleshed out in subclasses.

Internal Properties#

type: uint8#

NameDescription
0GlobalA non-spatial input, used for power buttons and system volume and such
1ControllerContains a pose and datamap for buttons, trackpad, joystick, grip, trigger, etc.
2[[PointerInput]]Defined by origin, direction, and tilt with datamap for buttons, trackpad, etc.
3[[HandInput]]Contains a full 27-bone hand skeleton (including forearm) and datamap for abstractions like grip, pinch distance/point, etc.

datamap: Dictionary#

See #Datamap:

Internal Methods#

distanceToField(string field)#

Returns the distance from this input to a field in meters. field is the name of the field, not the full path.

serialize()#

Returns a serialized version of the InputMethod, each serialized schema is shown under #Serialization in the respective Input subclasses.

Serialization#

KeyValue Type
typeint
distancefloat

Datamap#

The datamap is a dictionary containing abstracted and raw data related to the input that clients can use to analyze input in the most optimal way. It has keys of type Key(Flexbuffers-specific, in any other language use a String) and values:

TypeExample UsesUsage Notes
boolDigital buttonsIf values are analog, use a float instead with 1.0 being considered true.
floatAnalog trigger, gripFor values such as grip/trigger, make the range 0.0-1.0, for something like a scroll wheel -0.5-0.5.
Vector2Touchpad, joystickFor values such as trackpad and joystick, make each component in the range of -0.5-0.5 and calculate+apply deadzone before setting these values.
Vector3Pinch position, grip axis vectorFor points and directions, make this a value inside the InputMethod's local space. Raw hand pose data should not be put in the datamap.

Standard supported datamap keys will be put in the individual type's documentation, however you can put more data in and some input handlers may be able to use that data for better interactions.

Methods#

setPosition(Vector3 point)#

Sets the position of this [[InputMethod]]. This pose also defines the main interaction point.

modifyDatamap(Dictionary data)#

Modifies the datamap of this [[InputMethod]]. Each key here will add to the datamap if not present and set the existing value if present. Any key not present in data will be unaffected.

- + \ No newline at end of file diff --git a/docs/stardust-protocol/server/types/input/inputtypes/HandInput.html b/docs/stardust-protocol/server/types/input/inputtypes/HandInput.html index 72f98d76..fecef196 100644 --- a/docs/stardust-protocol/server/types/input/inputtypes/HandInput.html +++ b/docs/stardust-protocol/server/types/input/inputtypes/HandInput.html @@ -5,13 +5,13 @@ HandInput | Stardust XR - +

HandInput

Derived from [[InputMethod]] and [[Spatial]] (scalable: false)#

A full 27-bone hand+forearm input with useful abstractions provided through the datamap.

The local space of a hand is where +Z is away from the palm, +Y is from the palm to the fingers, and +X is orthogonal and to the right.

Serialization#

KeyValue Type
originVector3
directionVector3
tiltfloat
datamapDictionary
[    thumb metacarpal,    thumb proximal,    thumb distal,    thumb tip,    index metacarpal,    index proximal,    index intermediate,    index distal,    index tip,    middle metacarpal,    middle proximal,    middle intermediate,    middle distal,    middle tip,    ring metacarpal,    ring proximal,    ring intermediate,    ring distal,    ring tip,    little metacarpal,    little proximal,    little intermediate,    little distal,    little tip]

(This section is WIP)

Datamap#

Required#

KeyValue TypeDescription
confidencefloat (range 0.0-1.0)How confident the hand tracker is of the pose of the hand
isLeftbooltrue if this hand is the left hand, false if not
pinchStrengthfloat (range 0.0-1.0)How much the hand is pinching
pinchDistancefloat (>0.0)The distance in meters between the thumb and index finger
grabStrengthfloat (range 0.0-1.0)How much the hand is making a fist

Methods#

TODO: Properly secured field distance calculation accessible to clients

- + \ No newline at end of file diff --git a/docs/stardust-protocol/server/types/input/inputtypes/PointerInput.html b/docs/stardust-protocol/server/types/input/inputtypes/PointerInput.html index 9e1c6bfd..b36c9f29 100644 --- a/docs/stardust-protocol/server/types/input/inputtypes/PointerInput.html +++ b/docs/stardust-protocol/server/types/input/inputtypes/PointerInput.html @@ -5,13 +5,13 @@ PointerInput | Stardust XR - +

PointerInput

Derived from [[InputMethod]]#

An input method for pointers, such as the Huawei VR Glass's remote, a pointer put on an Index controller, Oculus style laser mouse, etc.

The local space for a pointer is where +Z is along the pointer's direction, +X is to the right of the pointer when laying face up, and +Y is upward when laying face up.

Serialization#

KeyValue Type
originVector3
directionVector3
tiltfloat
datamapDictionary

Datamap#

Required#

KeyValue TypeDescription
selectfloat (range 0.0-1.0)Whether the pointer is attempting to select an object, usually through trigger. 1.0 is selected, 0.0 is not selected, and inbetween is to add smoothness to the interaction.
grabfloat (range 0.0-1.0)How much the pointer is attempting to grab an object. 0.0 is not grabbing at all, 1.0 is grabbing the strongest, and inbetween is to add smoothness.
scrollVector2 (component range -0.5-0.5)The amount to scroll on this input tick (sensitivity determined on the receiving client). Can be used for 2D scrolling as well as adjusting depth/size when grabbing an object.

Built in#

KeyValue TypeDescription
deepestPointDistancefloat (>=0.0)The distance along the ray where the deepest surface point resides.

Methods#

setDirection(Vector3 direction)#

Sets the direction the pointer is pointing in stage space.

setTilt(float angle)#

Sets the tilt of the pointer (rotation about the pointer direction) clockwise in radians.

setOrientation(Vector3 direction, float angle)#

Sets the direction and tilt of the pointer to save on IPC calls.

setPose(Vector3 origin, Vector3 direction, float angle)#

Sets the origin, direction, and tilt of the pointer to save on IPC calls.

- + \ No newline at end of file diff --git a/index.html b/index.html index 5f999006..83324b14 100644 --- a/index.html +++ b/index.html @@ -5,13 +5,13 @@ Stardust XR - +

Stardust XR

We Fight for the Users!

Protocol API Reference
Flexible

Flexible

Stardust allows you to make XR widgets or interfaces and run them among others. You don't have to make a whole system UI, just a few pieces.

Streamlined

Streamlined

Stardust is made using StereoKit, which allows for a fast and lightweight display server.

- + \ No newline at end of file diff --git a/roadmap.html b/roadmap.html index 3a1eb63b..e3995deb 100644 --- a/roadmap.html +++ b/roadmap.html @@ -5,13 +5,13 @@ Roadmap | Stardust XR - +
-

Roadmap

  • Core functionality
    • IPC+RPC
    • Protocol documentation
  • Server
    • Per-client scenegraph
    • Statically link StereoKit
    • Basic features
      • Spatial parenting/spatial transformation
      • Model loading
      • Set model material parameters
      • Fields (SDFs for interaction)
        • Box field
        • Rounded box field
        • Sphere field
      • Input
        • Input methods
          • Hand input
            • Creation from client
            • Creation from OpenXR
            • Creation from StereoKit (flatscreen)
            • Interaction with clients
          • Pointer input
            • Creation from client
            • Creation from OpenXR
            • Creation from StereoKit (flatscreen, mouse cursor ray)
            • Interaction with clients
          • Controller input
            • Creation from client
            • Creation from OpenXR
            • Interaction with clients
          • Global input (e.g. volume buttons)
            • Creation from client
            • Creation from OpenXR
            • Interaction with clients
        • Input handler
      • Environment
        • Set skytex
        • Set skylight
- +

Roadmap

MVP#

  • Core functionality
    • IPC+RPC
    • Protocol documentation
  • Client
    • Fusion
      • Initial connection
      • Node type creation/destruction
      • Interface interaction
      • Callbacks
  • Server
    • Per-client scenegraph
    • Statically link StereoKit
    • Basic features
      • Logic step
      • Spatial transforms
        • Absolute movement
        • Relative movement
        • Spatial parenting
      • Models
        • Loading
        • Setting material parameters
      • Fields (SDFs for interaction)
        • Box field
        • Rounded box field
        • Sphere field
      • Input
        • Input methods
          • Hand input
            • Creation from OpenXR
            • Creation from StereoKit (flatscreen)
            • Interaction with clients
          • Pointer input
            • Creation from StereoKit (flatscreen, mouse cursor ray)
            • Interaction with clients
        • Input handler
          • Async input propagation through distance
      • Environment
        • Set skytex
        • Set skylight
      • Items
        • Base item class
        • Base item accepter class
        • Environment equirectangular item
        • Environment equirectangular accepter
      • 2D integration
        • Panels
          • Panel item
          • sk-wlroots (for Wayland)
            • Statically link wlroots
            • Rendering
            • Input seats
        • Panel shells
          • Accept panel items
          • Put surface on model material's texture
          • Feed input through to panel
          • Release panel items
+ \ No newline at end of file