@threlte/xr 0.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (57) hide show
  1. package/LICENSE +9 -0
  2. package/README.md +13 -0
  3. package/dist/components/ARButton.svelte +25 -0
  4. package/dist/components/ARButton.svelte.d.ts +250 -0
  5. package/dist/components/Controller.svelte +124 -0
  6. package/dist/components/Controller.svelte.d.ts +30 -0
  7. package/dist/components/Hand.svelte +119 -0
  8. package/dist/components/Hand.svelte.d.ts +24 -0
  9. package/dist/components/Hands.svelte +35 -0
  10. package/dist/components/Hands.svelte.d.ts +24 -0
  11. package/dist/components/Ray.svelte +23 -0
  12. package/dist/components/Ray.svelte.d.ts +18 -0
  13. package/dist/components/ShortRay.svelte +28 -0
  14. package/dist/components/ShortRay.svelte.d.ts +16 -0
  15. package/dist/components/TeleportControls.svelte +136 -0
  16. package/dist/components/TeleportControls.svelte.d.ts +54 -0
  17. package/dist/components/VRButton.svelte +24 -0
  18. package/dist/components/VRButton.svelte.d.ts +250 -0
  19. package/dist/components/XR.svelte +114 -0
  20. package/dist/components/XR.svelte.d.ts +59 -0
  21. package/dist/components/XRButton.svelte +79 -0
  22. package/dist/components/XRButton.svelte.d.ts +265 -0
  23. package/dist/hooks/index.d.ts +7 -0
  24. package/dist/hooks/index.js +7 -0
  25. package/dist/hooks/useController.d.ts +14 -0
  26. package/dist/hooks/useController.js +32 -0
  27. package/dist/hooks/useEvent.d.ts +14 -0
  28. package/dist/hooks/useEvent.js +34 -0
  29. package/dist/hooks/useHand.d.ts +8 -0
  30. package/dist/hooks/useHand.js +14 -0
  31. package/dist/hooks/useHandJoint.d.ts +6 -0
  32. package/dist/hooks/useHandJoint.js +19 -0
  33. package/dist/hooks/useHitTest.d.ts +5 -0
  34. package/dist/hooks/useHitTest.js +44 -0
  35. package/dist/hooks/useTeleport.d.ts +13 -0
  36. package/dist/hooks/useTeleport.js +54 -0
  37. package/dist/hooks/useXR.d.ts +14 -0
  38. package/dist/hooks/useXR.js +15 -0
  39. package/dist/index.d.ts +12 -0
  40. package/dist/index.js +11 -0
  41. package/dist/internal/events.d.ts +5 -0
  42. package/dist/internal/events.js +26 -0
  43. package/dist/internal/stores.d.ts +10 -0
  44. package/dist/internal/stores.js +10 -0
  45. package/dist/lib/getXRSessionOptions.d.ts +2 -0
  46. package/dist/lib/getXRSessionOptions.js +15 -0
  47. package/dist/lib/getXRSupportState.d.ts +7 -0
  48. package/dist/lib/getXRSupportState.js +20 -0
  49. package/dist/lib/handJoints.d.ts +2 -0
  50. package/dist/lib/handJoints.js +27 -0
  51. package/dist/lib/toggleXRSession.d.ts +14 -0
  52. package/dist/lib/toggleXRSession.js +33 -0
  53. package/dist/plugins/teleportPlugin.d.ts +1 -0
  54. package/dist/plugins/teleportPlugin.js +41 -0
  55. package/dist/types.d.ts +31 -0
  56. package/dist/types.js +1 -0
  57. package/package.json +50 -0
package/LICENSE ADDED
@@ -0,0 +1,9 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2023 Micheal Parks
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
6
+
7
+ The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
8
+
9
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,13 @@
1
+ <h1>threlte-xr</h1>
2
+
3
+ [![Version](https://img.shields.io/npm/v/threlte-xr?style=flat&colorA=000000&colorB=000000)](https://www.npmjs.com/package/threlte-xr)
4
+ [![Downloads](https://img.shields.io/npm/dt/threlte-xr.svg?style=flat&colorA=000000&colorB=000000)](https://www.npmjs.com/package/threlte-xr)
5
+
6
+ Svelte components and hooks for creating VR/AR applications with [threlte (v6)](https://next.threlte.xyz/), inspired by the design of [react-xr](https://github.com/pmndrs/react-xr).
7
+
8
+ > **Warning**
9
+ > `threlte-xr` is early in development. There will likely be frequent breaking changes until it reaches 0.1.0. It will only work with Threlte v6 onward.
10
+
11
+ ```bash
12
+ npm install threlte-xr
13
+ ```
@@ -0,0 +1,25 @@
1
+ <!--
2
+ @component
3
+ `<ARButton />` is an HTML `<button />` that can be used to init and display info about your immersive AR session.
4
+
5
+ ```svelte
6
+ <ARButton
7
+ on:error={(event) => {}}
8
+ on:click={(event) => {}}
9
+ />
10
+ ```
11
+ -->
12
+
13
+ <script>import XRButton from "./XRButton.svelte";
14
+ </script>
15
+
16
+ <XRButton
17
+ {...$$restProps}
18
+ mode='immersive-ar'
19
+ sessionInit={{
20
+ domOverlay: typeof document !== 'undefined' ? { root: document.body } : undefined,
21
+ optionalFeatures: ['hit-test', 'dom-overlay', 'dom-overlay-for-handheld-ar']
22
+ }}
23
+ on:click
24
+ on:error
25
+ />
@@ -0,0 +1,250 @@
1
+ import { SvelteComponent } from "svelte";
2
+ declare const __propDef: {
3
+ props: {
4
+ force?: "enter" | "exit";
5
+ styled?: boolean;
6
+ form?: string | null | undefined;
7
+ radiogroup?: string | null | undefined;
8
+ name?: string | null | undefined;
9
+ style?: string | null | undefined;
10
+ disabled?: boolean | null | undefined;
11
+ formaction?: string | null | undefined;
12
+ formenctype?: string | null | undefined;
13
+ formmethod?: string | null | undefined;
14
+ formnovalidate?: boolean | null | undefined;
15
+ formtarget?: string | null | undefined;
16
+ type?: "submit" | "reset" | "button" | null | undefined;
17
+ value?: string | number | string[] | null | undefined;
18
+ accesskey?: string | null | undefined;
19
+ autofocus?: boolean | null | undefined;
20
+ class?: string | null | undefined;
21
+ contenteditable?: import("svelte/elements").Booleanish | "inherit" | null | undefined;
22
+ contextmenu?: string | null | undefined;
23
+ dir?: string | null | undefined;
24
+ draggable?: import("svelte/elements").Booleanish | null | undefined;
25
+ enterkeyhint?: "enter" | "done" | "go" | "next" | "previous" | "search" | "send" | null | undefined;
26
+ hidden?: boolean | null | undefined;
27
+ id?: string | null | undefined;
28
+ lang?: string | null | undefined;
29
+ part?: string | null | undefined;
30
+ placeholder?: string | null | undefined;
31
+ slot?: string | null | undefined;
32
+ spellcheck?: import("svelte/elements").Booleanish | null | undefined;
33
+ tabindex?: number | null | undefined;
34
+ title?: string | null | undefined;
35
+ translate?: "" | "yes" | "no" | null | undefined;
36
+ inert?: boolean | null | undefined;
37
+ role?: import("svelte/elements").AriaRole | null | undefined;
38
+ about?: string | null | undefined;
39
+ datatype?: string | null | undefined;
40
+ inlist?: any;
41
+ prefix?: string | null | undefined;
42
+ property?: string | null | undefined;
43
+ resource?: string | null | undefined;
44
+ typeof?: string | null | undefined;
45
+ vocab?: string | null | undefined;
46
+ autocapitalize?: string | null | undefined;
47
+ autocorrect?: string | null | undefined;
48
+ autosave?: string | null | undefined;
49
+ color?: string | null | undefined;
50
+ itemprop?: string | null | undefined;
51
+ itemscope?: boolean | null | undefined;
52
+ itemtype?: string | null | undefined;
53
+ itemid?: string | null | undefined;
54
+ itemref?: string | null | undefined;
55
+ results?: number | null | undefined;
56
+ security?: string | null | undefined;
57
+ unselectable?: "on" | "off" | null | undefined;
58
+ inputmode?: "search" | "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | null | undefined;
59
+ is?: string | null | undefined;
60
+ 'bind:innerHTML'?: string | null | undefined;
61
+ 'bind:textContent'?: string | null | undefined;
62
+ 'bind:innerText'?: string | null | undefined;
63
+ 'bind:contentRect'?: DOMRectReadOnly | null | undefined;
64
+ 'bind:contentBoxSize'?: ResizeObserverSize[] | null | undefined;
65
+ 'bind:borderBoxSize'?: ResizeObserverSize[] | null | undefined;
66
+ 'bind:devicePixelContentBoxSize'?: ResizeObserverSize[] | null | undefined;
67
+ 'data-sveltekit-keepfocus'?: true | "" | "off" | null | undefined;
68
+ 'data-sveltekit-noscroll'?: true | "" | "off" | null | undefined;
69
+ 'data-sveltekit-preload-code'?: true | "" | "off" | "eager" | "viewport" | "hover" | "tap" | null | undefined;
70
+ 'data-sveltekit-preload-data'?: true | "" | "off" | "hover" | "tap" | null | undefined;
71
+ 'data-sveltekit-reload'?: true | "" | "off" | null | undefined;
72
+ 'data-sveltekit-replacestate'?: true | "" | "off" | null | undefined;
73
+ 'aria-activedescendant'?: string | null | undefined;
74
+ 'aria-atomic'?: import("svelte/elements").Booleanish | null | undefined;
75
+ 'aria-autocomplete'?: "inline" | "list" | "none" | "both" | null | undefined;
76
+ 'aria-busy'?: import("svelte/elements").Booleanish | null | undefined;
77
+ 'aria-checked'?: boolean | "true" | "false" | "mixed" | null | undefined;
78
+ 'aria-colcount'?: number | null | undefined;
79
+ 'aria-colindex'?: number | null | undefined;
80
+ 'aria-colspan'?: number | null | undefined;
81
+ 'aria-controls'?: string | null | undefined;
82
+ 'aria-current'?: import("svelte/elements").Booleanish | "page" | "step" | "location" | "date" | "time" | null | undefined;
83
+ 'aria-describedby'?: string | null | undefined;
84
+ 'aria-details'?: string | null | undefined;
85
+ 'aria-disabled'?: import("svelte/elements").Booleanish | null | undefined;
86
+ 'aria-dropeffect'?: "link" | "none" | "copy" | "execute" | "move" | "popup" | null | undefined;
87
+ 'aria-errormessage'?: string | null | undefined;
88
+ 'aria-expanded'?: import("svelte/elements").Booleanish | null | undefined;
89
+ 'aria-flowto'?: string | null | undefined;
90
+ 'aria-grabbed'?: import("svelte/elements").Booleanish | null | undefined;
91
+ 'aria-haspopup'?: import("svelte/elements").Booleanish | "dialog" | "grid" | "listbox" | "menu" | "tree" | null | undefined;
92
+ 'aria-hidden'?: import("svelte/elements").Booleanish | null | undefined;
93
+ 'aria-invalid'?: import("svelte/elements").Booleanish | "grammar" | "spelling" | null | undefined;
94
+ 'aria-keyshortcuts'?: string | null | undefined;
95
+ 'aria-label'?: string | null | undefined;
96
+ 'aria-labelledby'?: string | null | undefined;
97
+ 'aria-level'?: number | null | undefined;
98
+ 'aria-live'?: "off" | "assertive" | "polite" | null | undefined;
99
+ 'aria-modal'?: import("svelte/elements").Booleanish | null | undefined;
100
+ 'aria-multiline'?: import("svelte/elements").Booleanish | null | undefined;
101
+ 'aria-multiselectable'?: import("svelte/elements").Booleanish | null | undefined;
102
+ 'aria-orientation'?: "horizontal" | "vertical" | null | undefined;
103
+ 'aria-owns'?: string | null | undefined;
104
+ 'aria-placeholder'?: string | null | undefined;
105
+ 'aria-posinset'?: number | null | undefined;
106
+ 'aria-pressed'?: boolean | "true" | "false" | "mixed" | null | undefined;
107
+ 'aria-readonly'?: import("svelte/elements").Booleanish | null | undefined;
108
+ 'aria-relevant'?: "text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals" | null | undefined;
109
+ 'aria-required'?: import("svelte/elements").Booleanish | null | undefined;
110
+ 'aria-roledescription'?: string | null | undefined;
111
+ 'aria-rowcount'?: number | null | undefined;
112
+ 'aria-rowindex'?: number | null | undefined;
113
+ 'aria-rowspan'?: number | null | undefined;
114
+ 'aria-selected'?: import("svelte/elements").Booleanish | null | undefined;
115
+ 'aria-setsize'?: number | null | undefined;
116
+ 'aria-sort'?: "none" | "ascending" | "descending" | "other" | null | undefined;
117
+ 'aria-valuemax'?: number | null | undefined;
118
+ 'aria-valuemin'?: number | null | undefined;
119
+ 'aria-valuenow'?: number | null | undefined;
120
+ 'aria-valuetext'?: string | null | undefined;
121
+ 'on:copy'?: import("svelte/elements").ClipboardEventHandler<HTMLButtonElement> | null | undefined;
122
+ 'on:cut'?: import("svelte/elements").ClipboardEventHandler<HTMLButtonElement> | null | undefined;
123
+ 'on:paste'?: import("svelte/elements").ClipboardEventHandler<HTMLButtonElement> | null | undefined;
124
+ 'on:compositionend'?: import("svelte/elements").CompositionEventHandler<HTMLButtonElement> | null | undefined;
125
+ 'on:compositionstart'?: import("svelte/elements").CompositionEventHandler<HTMLButtonElement> | null | undefined;
126
+ 'on:compositionupdate'?: import("svelte/elements").CompositionEventHandler<HTMLButtonElement> | null | undefined;
127
+ 'on:focus'?: import("svelte/elements").FocusEventHandler<HTMLButtonElement> | null | undefined;
128
+ 'on:focusin'?: import("svelte/elements").FocusEventHandler<HTMLButtonElement> | null | undefined;
129
+ 'on:focusout'?: import("svelte/elements").FocusEventHandler<HTMLButtonElement> | null | undefined;
130
+ 'on:blur'?: import("svelte/elements").FocusEventHandler<HTMLButtonElement> | null | undefined;
131
+ 'on:change'?: import("svelte/elements").FormEventHandler<HTMLButtonElement> | null | undefined;
132
+ 'on:beforeinput'?: import("svelte/elements").EventHandler<InputEvent, HTMLButtonElement> | null | undefined;
133
+ 'on:input'?: import("svelte/elements").FormEventHandler<HTMLButtonElement> | null | undefined;
134
+ 'on:reset'?: import("svelte/elements").FormEventHandler<HTMLButtonElement> | null | undefined;
135
+ 'on:submit'?: import("svelte/elements").EventHandler<SubmitEvent, HTMLButtonElement> | null | undefined;
136
+ 'on:invalid'?: import("svelte/elements").EventHandler<Event, HTMLButtonElement> | null | undefined;
137
+ 'on:formdata'?: import("svelte/elements").EventHandler<FormDataEvent, HTMLButtonElement> | null | undefined;
138
+ 'on:load'?: import("svelte/elements").EventHandler<Event, Element> | null | undefined;
139
+ 'on:error'?: import("svelte/elements").EventHandler<Event, Element> | null | undefined;
140
+ 'on:toggle'?: import("svelte/elements").EventHandler<Event, HTMLButtonElement> | null | undefined;
141
+ 'on:keydown'?: import("svelte/elements").KeyboardEventHandler<HTMLButtonElement> | null | undefined;
142
+ 'on:keypress'?: import("svelte/elements").KeyboardEventHandler<HTMLButtonElement> | null | undefined;
143
+ 'on:keyup'?: import("svelte/elements").KeyboardEventHandler<HTMLButtonElement> | null | undefined;
144
+ 'on:abort'?: import("svelte/elements").EventHandler<Event, HTMLButtonElement> | null | undefined;
145
+ 'on:canplay'?: import("svelte/elements").EventHandler<Event, HTMLButtonElement> | null | undefined;
146
+ 'on:canplaythrough'?: import("svelte/elements").EventHandler<Event, HTMLButtonElement> | null | undefined;
147
+ 'on:cuechange'?: import("svelte/elements").EventHandler<Event, HTMLButtonElement> | null | undefined;
148
+ 'on:durationchange'?: import("svelte/elements").EventHandler<Event, HTMLButtonElement> | null | undefined;
149
+ 'on:emptied'?: import("svelte/elements").EventHandler<Event, HTMLButtonElement> | null | undefined;
150
+ 'on:encrypted'?: import("svelte/elements").EventHandler<Event, HTMLButtonElement> | null | undefined;
151
+ 'on:ended'?: import("svelte/elements").EventHandler<Event, HTMLButtonElement> | null | undefined;
152
+ 'on:loadeddata'?: import("svelte/elements").EventHandler<Event, HTMLButtonElement> | null | undefined;
153
+ 'on:loadedmetadata'?: import("svelte/elements").EventHandler<Event, HTMLButtonElement> | null | undefined;
154
+ 'on:loadstart'?: import("svelte/elements").EventHandler<Event, HTMLButtonElement> | null | undefined;
155
+ 'on:pause'?: import("svelte/elements").EventHandler<Event, HTMLButtonElement> | null | undefined;
156
+ 'on:play'?: import("svelte/elements").EventHandler<Event, HTMLButtonElement> | null | undefined;
157
+ 'on:playing'?: import("svelte/elements").EventHandler<Event, HTMLButtonElement> | null | undefined;
158
+ 'on:progress'?: import("svelte/elements").EventHandler<Event, HTMLButtonElement> | null | undefined;
159
+ 'on:ratechange'?: import("svelte/elements").EventHandler<Event, HTMLButtonElement> | null | undefined;
160
+ 'on:seeked'?: import("svelte/elements").EventHandler<Event, HTMLButtonElement> | null | undefined;
161
+ 'on:seeking'?: import("svelte/elements").EventHandler<Event, HTMLButtonElement> | null | undefined;
162
+ 'on:stalled'?: import("svelte/elements").EventHandler<Event, HTMLButtonElement> | null | undefined;
163
+ 'on:suspend'?: import("svelte/elements").EventHandler<Event, HTMLButtonElement> | null | undefined;
164
+ 'on:timeupdate'?: import("svelte/elements").EventHandler<Event, HTMLButtonElement> | null | undefined;
165
+ 'on:volumechange'?: import("svelte/elements").EventHandler<Event, HTMLButtonElement> | null | undefined;
166
+ 'on:waiting'?: import("svelte/elements").EventHandler<Event, HTMLButtonElement> | null | undefined;
167
+ 'on:auxclick'?: import("svelte/elements").MouseEventHandler<HTMLButtonElement> | null | undefined;
168
+ 'on:click'?: import("svelte/elements").MouseEventHandler<HTMLButtonElement> | null | undefined;
169
+ 'on:contextmenu'?: import("svelte/elements").MouseEventHandler<HTMLButtonElement> | null | undefined;
170
+ 'on:dblclick'?: import("svelte/elements").MouseEventHandler<HTMLButtonElement> | null | undefined;
171
+ 'on:drag'?: import("svelte/elements").DragEventHandler<HTMLButtonElement> | null | undefined;
172
+ 'on:dragend'?: import("svelte/elements").DragEventHandler<HTMLButtonElement> | null | undefined;
173
+ 'on:dragenter'?: import("svelte/elements").DragEventHandler<HTMLButtonElement> | null | undefined;
174
+ 'on:dragexit'?: import("svelte/elements").DragEventHandler<HTMLButtonElement> | null | undefined;
175
+ 'on:dragleave'?: import("svelte/elements").DragEventHandler<HTMLButtonElement> | null | undefined;
176
+ 'on:dragover'?: import("svelte/elements").DragEventHandler<HTMLButtonElement> | null | undefined;
177
+ 'on:dragstart'?: import("svelte/elements").DragEventHandler<HTMLButtonElement> | null | undefined;
178
+ 'on:drop'?: import("svelte/elements").DragEventHandler<HTMLButtonElement> | null | undefined;
179
+ 'on:mousedown'?: import("svelte/elements").MouseEventHandler<HTMLButtonElement> | null | undefined;
180
+ 'on:mouseenter'?: import("svelte/elements").MouseEventHandler<HTMLButtonElement> | null | undefined;
181
+ 'on:mouseleave'?: import("svelte/elements").MouseEventHandler<HTMLButtonElement> | null | undefined;
182
+ 'on:mousemove'?: import("svelte/elements").MouseEventHandler<HTMLButtonElement> | null | undefined;
183
+ 'on:mouseout'?: import("svelte/elements").MouseEventHandler<HTMLButtonElement> | null | undefined;
184
+ 'on:mouseover'?: import("svelte/elements").MouseEventHandler<HTMLButtonElement> | null | undefined;
185
+ 'on:mouseup'?: import("svelte/elements").MouseEventHandler<HTMLButtonElement> | null | undefined;
186
+ 'on:select'?: import("svelte/elements").EventHandler<Event, HTMLButtonElement> | null | undefined;
187
+ 'on:selectionchange'?: import("svelte/elements").EventHandler<Event, HTMLButtonElement> | null | undefined;
188
+ 'on:selectstart'?: import("svelte/elements").EventHandler<Event, HTMLButtonElement> | null | undefined;
189
+ 'on:touchcancel'?: import("svelte/elements").TouchEventHandler<HTMLButtonElement> | null | undefined;
190
+ 'on:touchend'?: import("svelte/elements").TouchEventHandler<HTMLButtonElement> | null | undefined;
191
+ 'on:touchmove'?: import("svelte/elements").TouchEventHandler<HTMLButtonElement> | null | undefined;
192
+ 'on:touchstart'?: import("svelte/elements").TouchEventHandler<HTMLButtonElement> | null | undefined;
193
+ 'on:gotpointercapture'?: import("svelte/elements").PointerEventHandler<HTMLButtonElement> | null | undefined;
194
+ 'on:pointercancel'?: import("svelte/elements").PointerEventHandler<HTMLButtonElement> | null | undefined;
195
+ 'on:pointerdown'?: import("svelte/elements").PointerEventHandler<HTMLButtonElement> | null | undefined;
196
+ 'on:pointerenter'?: import("svelte/elements").PointerEventHandler<HTMLButtonElement> | null | undefined;
197
+ 'on:pointerleave'?: import("svelte/elements").PointerEventHandler<HTMLButtonElement> | null | undefined;
198
+ 'on:pointermove'?: import("svelte/elements").PointerEventHandler<HTMLButtonElement> | null | undefined;
199
+ 'on:pointerout'?: import("svelte/elements").PointerEventHandler<HTMLButtonElement> | null | undefined;
200
+ 'on:pointerover'?: import("svelte/elements").PointerEventHandler<HTMLButtonElement> | null | undefined;
201
+ 'on:pointerup'?: import("svelte/elements").PointerEventHandler<HTMLButtonElement> | null | undefined;
202
+ 'on:lostpointercapture'?: import("svelte/elements").PointerEventHandler<HTMLButtonElement> | null | undefined;
203
+ 'on:scroll'?: import("svelte/elements").UIEventHandler<HTMLButtonElement> | null | undefined;
204
+ 'on:resize'?: import("svelte/elements").UIEventHandler<HTMLButtonElement> | null | undefined;
205
+ 'on:wheel'?: import("svelte/elements").WheelEventHandler<HTMLButtonElement> | null | undefined;
206
+ 'on:animationstart'?: import("svelte/elements").AnimationEventHandler<HTMLButtonElement> | null | undefined;
207
+ 'on:animationend'?: import("svelte/elements").AnimationEventHandler<HTMLButtonElement> | null | undefined;
208
+ 'on:animationiteration'?: import("svelte/elements").AnimationEventHandler<HTMLButtonElement> | null | undefined;
209
+ 'on:transitionstart'?: import("svelte/elements").TransitionEventHandler<HTMLButtonElement> | null | undefined;
210
+ 'on:transitionrun'?: import("svelte/elements").TransitionEventHandler<HTMLButtonElement> | null | undefined;
211
+ 'on:transitionend'?: import("svelte/elements").TransitionEventHandler<HTMLButtonElement> | null | undefined;
212
+ 'on:transitioncancel'?: import("svelte/elements").TransitionEventHandler<HTMLButtonElement> | null | undefined;
213
+ 'on:outrostart'?: import("svelte/elements").EventHandler<CustomEvent<null>, HTMLButtonElement> | null | undefined;
214
+ 'on:outroend'?: import("svelte/elements").EventHandler<CustomEvent<null>, HTMLButtonElement> | null | undefined;
215
+ 'on:introstart'?: import("svelte/elements").EventHandler<CustomEvent<null>, HTMLButtonElement> | null | undefined;
216
+ 'on:introend'?: import("svelte/elements").EventHandler<CustomEvent<null>, HTMLButtonElement> | null | undefined;
217
+ 'on:message'?: import("svelte/elements").MessageEventHandler<HTMLButtonElement> | null | undefined;
218
+ 'on:messageerror'?: import("svelte/elements").MessageEventHandler<HTMLButtonElement> | null | undefined;
219
+ 'on:visibilitychange'?: import("svelte/elements").EventHandler<Event, HTMLButtonElement> | null | undefined;
220
+ 'on:cancel'?: import("svelte/elements").EventHandler<Event, HTMLButtonElement> | null | undefined;
221
+ 'on:close'?: import("svelte/elements").EventHandler<Event, HTMLButtonElement> | null | undefined;
222
+ 'on:fullscreenchange'?: import("svelte/elements").EventHandler<Event, HTMLButtonElement> | null | undefined;
223
+ 'on:fullscreenerror'?: import("svelte/elements").EventHandler<Event, HTMLButtonElement> | null | undefined;
224
+ };
225
+ events: {
226
+ click: CustomEvent<{
227
+ state: "unsupported" | "insecure" | "blocked" | "supported";
228
+ }>;
229
+ error: CustomEvent<Error>;
230
+ } & {
231
+ [evt: string]: CustomEvent<any>;
232
+ };
233
+ slots: {};
234
+ };
235
+ export type ArButtonProps = typeof __propDef.props;
236
+ export type ArButtonEvents = typeof __propDef.events;
237
+ export type ArButtonSlots = typeof __propDef.slots;
238
+ /**
239
+ * `<ARButton />` is an HTML `<button />` that can be used to init and display info about your immersive AR session.
240
+ *
241
+ * ```svelte
242
+ * <ARButton
243
+ * on:error={(event) => {}}
244
+ * on:click={(event) => {}}
245
+ * />
246
+ * ```
247
+ */
248
+ export default class ArButton extends SvelteComponent<ArButtonProps, ArButtonEvents, ArButtonSlots> {
249
+ }
250
+ export {};
@@ -0,0 +1,124 @@
1
+ <!--
2
+ @component
3
+ `<Controller />` represents a THREE.XRTargetRaySpace, a THREE.XRGripSpace, and a controller model.
4
+ -->
5
+ <script
6
+
7
+ context="module"
8
+ >import { T, createRawEventDispatcher, useThrelte } from "@threlte/core";
9
+ import { onDestroy } from "svelte";
10
+ import { XRControllerModelFactory } from "three/examples/jsm/webxr/XRControllerModelFactory";
11
+ import ShortRay from "../components/ShortRay.svelte";
12
+ import { gaze, left as leftStore, right as rightStore } from "../hooks/useController";
13
+ import { useControllerEvent } from "../hooks/useEvent";
14
+ import { fire } from "../internal/events";
15
+ import {
16
+ activeTeleportController,
17
+ isHandTracking,
18
+ pendingTeleportDestination
19
+ } from "../internal/stores";
20
+ const factory = new XRControllerModelFactory();
21
+ const stores = {
22
+ left: leftStore,
23
+ right: rightStore,
24
+ none: gaze
25
+ };
26
+ const events = [
27
+ "select",
28
+ "selectstart",
29
+ "selectend",
30
+ "squeeze",
31
+ "squeezeend",
32
+ "squeezestart"
33
+ ];
34
+ const eventMap = /* @__PURE__ */ new WeakMap();
35
+ </script>
36
+
37
+ <script>export let left = false;
38
+ export let right = false;
39
+ $:
40
+ if (left && right) {
41
+ throw new Error("A <Controller> component can only specify one hand.");
42
+ }
43
+ $:
44
+ if (!left && !right) {
45
+ throw new Error("A <Controller> component must specify a hand.");
46
+ }
47
+ $:
48
+ handedness = left ? "left" : "right";
49
+ const dispatch = createRawEventDispatcher();
50
+ const { xr } = useThrelte().renderer;
51
+ const handleConnected = (event) => {
52
+ const data = event.data;
53
+ if (data.handedness !== handedness)
54
+ return;
55
+ stores[data.handedness].set({ ...eventMap.get(event.target), inputSource: data });
56
+ fire("connected", event, { input: "controller" });
57
+ };
58
+ const handleDisconnected = (event) => {
59
+ if (event.data.handedness !== handedness)
60
+ return;
61
+ stores[event.data.handedness].set(void 0);
62
+ fire("disconnected", event, { input: "controller" });
63
+ };
64
+ const handleEvent = (event) => fire(event.type, event);
65
+ for (const index of [0, 1]) {
66
+ const controller2 = xr.getController(index);
67
+ const grip2 = xr.getControllerGrip(index);
68
+ const model2 = factory.createControllerModel(grip2);
69
+ eventMap.set(controller2, { controller: controller2, model: model2, grip: grip2 });
70
+ controller2.addEventListener("connected", handleConnected);
71
+ controller2.addEventListener("disconnected", handleDisconnected);
72
+ events.forEach((name) => controller2.addEventListener(name, handleEvent));
73
+ }
74
+ $:
75
+ store = left ? stores.left : stores.right;
76
+ $:
77
+ grip = $store?.grip;
78
+ $:
79
+ controller = $store?.controller;
80
+ $:
81
+ model = $store?.model;
82
+ for (const type of ["connected", "disconnected", ...events]) {
83
+ useControllerEvent(type, (event) => dispatch(type, event), {
84
+ handedness: left ? "left" : "right"
85
+ });
86
+ }
87
+ onDestroy(() => {
88
+ for (const index of [0, 1]) {
89
+ const controller2 = xr.getController(index);
90
+ controller2.removeEventListener("connected", handleConnected);
91
+ controller2.removeEventListener("disconnected", handleDisconnected);
92
+ events.forEach((name) => controller2.removeEventListener(name, handleEvent));
93
+ }
94
+ });
95
+ </script>
96
+
97
+ {#if !$isHandTracking}
98
+ {#if grip}
99
+ <T
100
+ is={grip}
101
+ name="XR controller grip {handedness}"
102
+ >
103
+ <slot>
104
+ <T is={model} />
105
+ </slot>
106
+
107
+ <slot name="grip" />
108
+ </T>
109
+ {/if}
110
+
111
+ {#if controller}
112
+ <T
113
+ is={controller}
114
+ name="XR controller {handedness}"
115
+ visible={!$isHandTracking}
116
+ >
117
+ <slot name="target-ray" />
118
+ <ShortRay
119
+ visible={$activeTeleportController === controller &&
120
+ $pendingTeleportDestination === undefined}
121
+ />
122
+ </T>
123
+ {/if}
124
+ {/if}
@@ -0,0 +1,30 @@
1
+ import { SvelteComponent } from "svelte";
2
+ import type { XRControllerEvent } from '../types';
3
+ declare const __propDef: {
4
+ props: {
5
+ /** Whether the controller should be matched with the left hand. */ left?: boolean;
6
+ /** Whether the controller should be matched with the right hand. */ right?: boolean;
7
+ };
8
+ slots: {
9
+ default: {};
10
+ grip: {};
11
+ 'target-ray': {};
12
+ };
13
+ events: {
14
+ connected: XRControllerEvent<'connected'>;
15
+ disconnected: XRControllerEvent<'disconnected'>;
16
+ select: XRControllerEvent<'select'>;
17
+ selectstart: XRControllerEvent<'selectstart'>;
18
+ selectend: XRControllerEvent<'selectend'>;
19
+ squeeze: XRControllerEvent<'squeeze'>;
20
+ squeezeend: XRControllerEvent<'squeezeend'>;
21
+ squeezestart: XRControllerEvent<'squeezestart'>;
22
+ };
23
+ };
24
+ export type ControllerProps = typeof __propDef.props;
25
+ export type ControllerEvents = typeof __propDef.events;
26
+ export type ControllerSlots = typeof __propDef.slots;
27
+ /** `<Controller />` represents a THREE.XRTargetRaySpace, a THREE.XRGripSpace, and a controller model. */
28
+ export default class Controller extends SvelteComponent<ControllerProps, ControllerEvents, ControllerSlots> {
29
+ }
30
+ export {};
@@ -0,0 +1,119 @@
1
+ <script context='module'>import { T, useThrelte, createRawEventDispatcher, useFrame } from "@threlte/core";
2
+ import { XRHandModelFactory } from "three/examples/jsm/webxr/XRHandModelFactory";
3
+ import { fire } from "../internal/events";
4
+ import { left as leftStore, right as rightStore } from "../hooks/useHand";
5
+ import { useHandEvent } from "../hooks/useEvent";
6
+ import { onDestroy } from "svelte";
7
+ const factory = new XRHandModelFactory();
8
+ const stores = {
9
+ left: leftStore,
10
+ right: rightStore
11
+ };
12
+ const eventMap = /* @__PURE__ */ new WeakMap();
13
+ </script>
14
+
15
+ <script>export let left = false;
16
+ export let right = false;
17
+ const dispatch = createRawEventDispatcher();
18
+ const { xr } = useThrelte().renderer;
19
+ const space = xr.getReferenceSpace();
20
+ $:
21
+ if (left && right) {
22
+ throw new Error("A <Hand> component can only specify one hand.");
23
+ }
24
+ $:
25
+ if (!left && !right) {
26
+ throw new Error("A <Hand> component must specify a hand.");
27
+ }
28
+ $:
29
+ handedness = left ? "left" : "right";
30
+ const handleConnected = (event) => {
31
+ const inputSource2 = event.data.hand;
32
+ const eventHandedness = event.data.handedness;
33
+ if (eventHandedness !== handedness)
34
+ return;
35
+ stores[handedness].set({ ...eventMap.get(event.target), inputSource: inputSource2 });
36
+ fire("connected", event, { input: "hand" });
37
+ };
38
+ const handleDisconnected = (event) => {
39
+ const eventHandedness = event.data.handedness;
40
+ if (eventHandedness !== handedness)
41
+ return;
42
+ stores[handedness].set(void 0);
43
+ fire("disconnected", event, { input: "hand" });
44
+ };
45
+ const handlePinchEvent = (event) => {
46
+ fire(event.type, event);
47
+ };
48
+ for (const index of [0, 1]) {
49
+ const hand2 = xr.getHand(index);
50
+ const model2 = factory.createHandModel(hand2, "mesh");
51
+ eventMap.set(hand2, { hand: hand2, model: model2 });
52
+ hand2.addEventListener("connected", handleConnected);
53
+ hand2.addEventListener("disconnected", handleDisconnected);
54
+ hand2.addEventListener("pinchstart", handlePinchEvent);
55
+ hand2.addEventListener("pinchend", handlePinchEvent);
56
+ }
57
+ let children;
58
+ const { start, stop } = useFrame(() => {
59
+ const frame = xr.getFrame();
60
+ const joint = inputSource.get("wrist");
61
+ if (joint === void 0 || space === null)
62
+ return;
63
+ const pose = frame.getJointPose?.(joint, space);
64
+ if (pose === void 0 || pose === null)
65
+ return;
66
+ const { position, orientation } = pose.transform;
67
+ children.position.set(position.x, position.y, position.z);
68
+ children.quaternion.set(orientation.x, orientation.y, orientation.z, orientation.w);
69
+ }, { autostart: false });
70
+ $:
71
+ if (($$slots.wrist || $$slots.default) && inputSource) {
72
+ start();
73
+ } else {
74
+ stop();
75
+ }
76
+ $:
77
+ store = left ? stores.left : stores.right;
78
+ $:
79
+ hand = $store?.hand;
80
+ $:
81
+ inputSource = $store?.inputSource;
82
+ $:
83
+ model = $store?.model;
84
+ const handEvents = [
85
+ "connected",
86
+ "disconnected",
87
+ "pinchstart",
88
+ "pinchend"
89
+ ];
90
+ for (const name of handEvents) {
91
+ useHandEvent(name, (event) => dispatch(name, event), {
92
+ handedness: left ? "left" : "right"
93
+ });
94
+ }
95
+ onDestroy(() => {
96
+ for (const index of [0, 1]) {
97
+ const hand2 = xr.getHand(index);
98
+ hand2.removeEventListener("connected", handleConnected);
99
+ hand2.removeEventListener("disconnected", handleDisconnected);
100
+ hand2.removeEventListener("pinchstart", handlePinchEvent);
101
+ hand2.removeEventListener("pinchend", handlePinchEvent);
102
+ }
103
+ });
104
+ </script>
105
+
106
+ {#if hand}
107
+ <T
108
+ is={hand}
109
+ name='XR hand {handedness}'
110
+ >
111
+ {#if $$slots.default === undefined}
112
+ <T is={model} />
113
+ {/if}
114
+ <T.Group bind:ref={children}>
115
+ <slot name='wrist' />
116
+ <slot />
117
+ </T.Group>
118
+ </T>
119
+ {/if}
@@ -0,0 +1,24 @@
1
+ import { SvelteComponent } from "svelte";
2
+ import type { XRHandEvent } from '../types';
3
+ declare const __propDef: {
4
+ props: {
5
+ /** Whether the XRHand should be matched with the left hand. */ left?: boolean;
6
+ /** Whether the XRHand should be matched with the right hand. */ right?: boolean;
7
+ };
8
+ slots: {
9
+ wrist: {};
10
+ default: {};
11
+ };
12
+ events: {
13
+ connected: XRHandEvent<'connected', null>;
14
+ disconnected: XRHandEvent<'disconnected', null>;
15
+ pinchstart: XRHandEvent<'pinchstart', THREE.XRHandSpace>;
16
+ pinchend: XRHandEvent<'pinchend', THREE.XRHandSpace>;
17
+ };
18
+ };
19
+ export type HandProps = typeof __propDef.props;
20
+ export type HandEvents = typeof __propDef.events;
21
+ export type HandSlots = typeof __propDef.slots;
22
+ export default class Hand extends SvelteComponent<HandProps, HandEvents, HandSlots> {
23
+ }
24
+ export {};
@@ -0,0 +1,35 @@
1
+ <!--
2
+ @component
3
+ Creates XRHand inputs for devices that allow hand tracking.
4
+ -->
5
+ <script>import { createRawEventDispatcher } from "@threlte/core";
6
+ import Hand from "./Hand.svelte";
7
+ export let profile = "mesh";
8
+ const dispatch = createRawEventDispatcher();
9
+ const handedness = [void 0, void 0];
10
+ const setHandedness = (index, event) => {
11
+ if (event.data) {
12
+ handedness[index] = event.data.handedness;
13
+ }
14
+ };
15
+ </script>
16
+
17
+ {#each [0, 1] as index (index)}
18
+ <Hand
19
+ {index}
20
+ {profile}
21
+ on:connected={(event) => {
22
+ setHandedness(index, event)
23
+ dispatch(event.type, event)
24
+ }}
25
+ on:disconnected
26
+ on:pinchstart
27
+ on:pinchend
28
+ >
29
+ {#if handedness[index] === 'left'}
30
+ <slot name='left' />
31
+ {:else if handedness[index] === 'right'}
32
+ <slot name='right' />
33
+ {/if}
34
+ </Hand>
35
+ {/each}