-
Notifications
You must be signed in to change notification settings - Fork 22
Expand file tree
/
Copy pathxrSessionManager.ts
More file actions
632 lines (547 loc) · 22.5 KB
/
Copy pathxrSessionManager.ts
File metadata and controls
632 lines (547 loc) · 22.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
import * as THREE from 'three';
import { VRButton } from 'three/examples/jsm/webxr/VRButton.js';
import { XRControllerModelFactory } from 'three/examples/jsm/webxr/XRControllerModelFactory.js';
import { createLogger, createErrorMetadata } from '@/utils/logger';
import { debugState } from '@/utils/debugState'; // Assuming debugState.ts exists in utils
import { SceneManager } from '@/features/visualisation/managers/sceneManager'; // Correct path
import { GestureRecognitionResult } from '@/features/xr/systems/HandInteractionSystem'; // Correct path
import { Settings } from '@/features/settings/config/settings'; // Correct path, assuming Settings is defined here
const logger = createLogger('XRSessionManager');
export interface XRControllerEvent {
controller: THREE.XRTargetRaySpace;
inputSource: XRInputSource;
data?: any;
}
type XRControllerEventHandler = (event: XRControllerEvent) => void;
// New event handler types for hand interactions
type GestureEventHandler = (gesture: GestureRecognitionResult) => void;
type HandVisibilityHandler = (visible: boolean) => void;
type XRSessionStateHandler = (state: string) => void;
type HandTrackingHandler = (enabled: boolean) => void;
export class XRSessionManager {
private static instance: XRSessionManager;
private sceneManager: SceneManager;
private renderer: THREE.WebGLRenderer | null = null;
private camera: THREE.PerspectiveCamera | null = null;
private scene: THREE.Scene | null = null;
private controllers: THREE.XRTargetRaySpace[] = [];
private controllerGrips: THREE.Object3D[] = [];
private controllerModelFactory: XRControllerModelFactory | null = null;
private vrButton: HTMLElement | null = null;
private sessionActive: boolean = false;
private settings: Settings | null = null;
// Event handlers
private selectStartHandlers: XRControllerEventHandler[] = [];
private selectEndHandlers: XRControllerEventHandler[] = [];
private squeezeStartHandlers: XRControllerEventHandler[] = [];
private squeezeEndHandlers: XRControllerEventHandler[] = [];
// New event handlers for hand interactions
private gestureRecognizedHandlers: GestureEventHandler[] = [];
private handsVisibilityChangedHandlers: HandVisibilityHandler[] = [];
private handTrackingStateHandlers: HandTrackingHandler[] = [];
private constructor(sceneManager: SceneManager, externalRenderer?: THREE.WebGLRenderer) {
this.sceneManager = sceneManager;
// Allow using an external renderer (from React Three Fiber) or try to get one from SceneManager
this.renderer = externalRenderer || sceneManager.getRenderer();
// Get camera and ensure it's a PerspectiveCamera
const camera = sceneManager.getCamera();
if (!camera || !(camera instanceof THREE.PerspectiveCamera)) {
logger.warn('PerspectiveCamera not available from SceneManager, creating default camera');
this.camera = new THREE.PerspectiveCamera(75, window.innerWidth / window.innerHeight, 0.1, 1000);
this.camera.position.z = 5;
} else {
this.camera = camera as THREE.PerspectiveCamera;
}
// Get scene
this.scene = sceneManager.getScene();
if (!this.scene) {
logger.warn('Scene not found in SceneManager, creating default scene');
this.scene = new THREE.Scene();
}
// Log warning instead of throwing error so application can continue
if (!this.renderer) {
logger.warn('XRSessionManager: No renderer provided. XR functionality will be limited.');
}
try {
// Initialize controller model factory
this.controllerModelFactory = new XRControllerModelFactory();
} catch (error) {
logger.error('Failed to create XRControllerModelFactory:', createErrorMetadata(error));
this.controllerModelFactory = null;
}
}
public static getInstance(sceneManager: SceneManager, externalRenderer?: THREE.WebGLRenderer): XRSessionManager {
if (!XRSessionManager.instance) {
XRSessionManager.instance = new XRSessionManager(sceneManager, externalRenderer);
} else if (externalRenderer && !XRSessionManager.instance.renderer) {
// If instance exists but has no renderer, we can update it with the external renderer
XRSessionManager.instance.renderer = externalRenderer;
logger.info('Updated XRSessionManager with external renderer');
}
return XRSessionManager.instance;
}
public initialize(settings: Settings): void {
if (!this.renderer || !this.scene) {
logger.error('Cannot initialize XR: renderer or scene is missing');
return;
}
this.settings = settings;
try {
// Check if WebXR is supported
if ('xr' in navigator && this.renderer) {
// Set up renderer for XR
this.renderer.xr.enabled = true;
// Set reference space type based on settings (assuming teleport implies room scale)
const refSpace = settings.xr?.locomotionMethod === 'teleport' ? 'local-floor' : 'local';
this.renderer.xr.setReferenceSpaceType(refSpace);
if (debugState.isEnabled()) {
logger.info(`Set XR reference space to ${refSpace}`);
}
// Create VR button
this.createVRButton();
// Create controllers
this.setupControllers();
if (debugState.isEnabled()) {
logger.info('XR session manager initialized successfully');
}
} else if (debugState.isEnabled()) {
logger.warn('WebXR not supported in this browser');
}
} catch (error) {
logger.error('Failed to initialize XR:', createErrorMetadata(error));
}
}
private createVRButton(): void {
if (!this.renderer || !navigator.xr) {
logger.warn('WebXR not supported or renderer not available for VR button creation.');
return;
}
const button = document.createElement('button');
button.id = 'xr-button';
button.style.position = 'absolute';
button.style.bottom = '20px';
button.style.right = '20px';
button.style.padding = '12px 24px';
button.style.border = '1px solid #fff';
button.style.borderRadius = '4px';
button.style.background = 'rgba(0,0,0,0.5)';
button.style.color = '#fff';
button.style.font = 'normal 18px sans-serif';
button.style.textAlign = 'center';
button.style.opacity = '0.7';
button.style.outline = 'none';
button.style.zIndex = '100';
button.style.cursor = 'pointer';
const showEnterXR = (supported: boolean, modeText: string) => {
button.textContent = supported ? `ENTER ${modeText}` : `${modeText} NOT SUPPORTED`;
button.disabled = !supported;
};
const showExitXR = () => {
button.textContent = 'EXIT XR';
button.disabled = false;
};
const currentRenderer = this.renderer; // Capture renderer for async operations
const startSession = async (mode: XRSessionMode, sessionInit: XRSessionInit = {}) => {
try {
const session = await navigator.xr!.requestSession(mode, sessionInit);
await currentRenderer.xr.setSession(session);
// showExitXR() will be called by sessionstart listener
} catch (e) {
logger.error(`Failed to start ${mode} session:`, createErrorMetadata(e));
// Attempt to reset button text to a valid enter state
const arSupported = await navigator.xr!.isSessionSupported('immersive-ar').catch(() => false);
const vrSupported = await navigator.xr!.isSessionSupported('immersive-vr').catch(() => false);
if (this.vrButton && !currentRenderer.xr.isPresenting) { // Check if button still exists and not presenting
if (arSupported) showEnterXR(true, 'AR');
else if (vrSupported) showEnterXR(true, 'VR');
else showEnterXR(false, 'XR');
}
}
};
button.onclick = async () => {
if (currentRenderer.xr.isPresenting) {
try {
// sessionend event will trigger button text update via listener
await currentRenderer.xr.getSession()?.end();
} catch (e) {
logger.error('Failed to end XR session:', createErrorMetadata(e));
}
} else {
try {
const arSupported = await navigator.xr!.isSessionSupported('immersive-ar');
if (arSupported) {
logger.info('Attempting to start AR session.');
await startSession('immersive-ar', {
requiredFeatures: ['local-floor'],
optionalFeatures: ['hand-tracking', 'hit-test', 'anchors', 'plane-detection', 'light-estimation'],
});
} else {
logger.info('AR not supported, attempting to start VR session.');
const vrSupported = await navigator.xr!.isSessionSupported('immersive-vr');
if (vrSupported) {
await startSession('immersive-vr', {
requiredFeatures: ['local-floor'],
optionalFeatures: ['hand-tracking'],
});
} else {
showEnterXR(false, 'XR');
logger.warn('Neither AR nor VR is supported.');
}
}
} catch (e) {
logger.error('Error during session support check or start:', createErrorMetadata(e));
showEnterXR(false, 'XR'); // Ensure button reflects error state
}
}
};
// Initial button state determination
const setInitialButtonState = async () => {
try {
const arSupported = await navigator.xr!.isSessionSupported('immersive-ar');
if (arSupported) {
showEnterXR(true, 'AR');
} else {
const vrSupported = await navigator.xr!.isSessionSupported('immersive-vr');
showEnterXR(vrSupported, vrSupported ? 'VR' : 'XR');
}
} catch (e) {
logger.error('Error checking XR support for initial button state:', createErrorMetadata(e));
showEnterXR(false, 'XR');
}
};
setInitialButtonState(); // Call async function to set initial state
this.vrButton = button;
document.body.appendChild(this.vrButton);
// Session event listeners
currentRenderer.xr.addEventListener('sessionstart', () => {
this.sessionActive = true;
showExitXR();
if (debugState.isEnabled()) {
logger.info('XR session started. Environment Blend Mode:', currentRenderer.xr.getSession()?.environmentBlendMode);
}
});
currentRenderer.xr.addEventListener('sessionend', () => {
this.sessionActive = false;
// Reset button to initial state after a short delay
setTimeout(() => {
if (this.vrButton && !currentRenderer.xr.isPresenting) { // Check button exists and not already re-entered XR
setInitialButtonState();
}
}, 100);
if (debugState.isEnabled()) {
logger.info('XR session ended');
}
});
}
private setupControllers(): void {
if (!this.renderer || !this.scene) return;
try {
// Create controllers
for (let i = 0; i < 2; i++) {
// Controller
const controller = this.renderer.xr.getController(i);
controller.addEventListener('selectstart', (event) => this.handleSelectStart(event, i));
controller.addEventListener('selectend', (event) => this.handleSelectEnd(event, i));
controller.addEventListener('squeezestart', (event) => this.handleSqueezeStart(event, i));
controller.addEventListener('squeezeend', (event) => this.handleSqueezeEnd(event, i));
controller.addEventListener('connected', (event) => {
if (debugState.isEnabled()) {
logger.info(`Controller ${i} connected:`, {
handedness: (event as any).data?.handedness,
targetRayMode: (event as any).data?.targetRayMode
});
}
});
controller.addEventListener('disconnected', () => {
if (debugState.isEnabled()) {
logger.info(`Controller ${i} disconnected`);
}
});
this.scene.add(controller);
this.controllers.push(controller as THREE.XRTargetRaySpace);
// Controller grip
const controllerGrip = this.renderer.xr.getControllerGrip(i);
if (this.controllerModelFactory) {
controllerGrip.add(this.controllerModelFactory.createControllerModel(controllerGrip));
}
this.scene.add(controllerGrip);
this.controllerGrips.push(controllerGrip);
// Add visual indicators for the controllers
const geometry = new THREE.BufferGeometry().setFromPoints([
new THREE.Vector3(0, 0, 0),
new THREE.Vector3(0, 0, -1)
]);
const line = new THREE.Line(geometry);
line.name = 'controller-line';
line.scale.z = 5;
controller.add(line);
controller.userData.selectPressed = false;
controller.userData.squeezePressed = false;
}
if (debugState.isEnabled()) {
logger.info('XR controllers set up successfully');
}
} catch (error) {
logger.error('Failed to set up XR controllers:', createErrorMetadata(error));
}
}
// Event handlers
private handleSelectStart(event: any, controllerId: number): void {
if (controllerId >= this.controllers.length) return;
const controller = this.controllers[controllerId];
controller.userData.selectPressed = true;
const inputSource = event.data;
if (debugState.isDataDebugEnabled()) {
logger.debug(`Controller ${controllerId} select start`);
}
this.selectStartHandlers.forEach(handler => {
try {
handler({ controller, inputSource, data: event.data });
} catch (error) {
logger.error('Error in selectStart handler:', createErrorMetadata(error));
}
});
}
private handleSelectEnd(event: any, controllerId: number): void {
if (controllerId >= this.controllers.length) return;
const controller = this.controllers[controllerId];
controller.userData.selectPressed = false;
const inputSource = event.data;
if (debugState.isDataDebugEnabled()) {
logger.debug(`Controller ${controllerId} select end`);
}
this.selectEndHandlers.forEach(handler => {
try {
handler({ controller, inputSource, data: event.data });
} catch (error) {
logger.error('Error in selectEnd handler:', createErrorMetadata(error));
}
});
}
private handleSqueezeStart(event: any, controllerId: number): void {
if (controllerId >= this.controllers.length) return;
const controller = this.controllers[controllerId];
controller.userData.squeezePressed = true;
const inputSource = event.data;
if (debugState.isDataDebugEnabled()) {
logger.debug(`Controller ${controllerId} squeeze start`);
}
this.squeezeStartHandlers.forEach(handler => {
try {
handler({ controller, inputSource, data: event.data });
} catch (error) {
logger.error('Error in squeezeStart handler:', createErrorMetadata(error));
}
});
}
private handleSqueezeEnd(event: any, controllerId: number): void {
if (controllerId >= this.controllers.length) return;
const controller = this.controllers[controllerId];
controller.userData.squeezePressed = false;
const inputSource = event.data;
if (debugState.isDataDebugEnabled()) {
logger.debug(`Controller ${controllerId} squeeze end`);
}
this.squeezeEndHandlers.forEach(handler => {
try {
handler({ controller, inputSource, data: event.data });
} catch (error) {
logger.error('Error in squeezeEnd handler:', createErrorMetadata(error));
}
});
}
// Event subscription methods
public onSelectStart(handler: XRControllerEventHandler): () => void {
this.selectStartHandlers.push(handler);
return () => {
this.selectStartHandlers = this.selectStartHandlers.filter(h => h !== handler);
};
}
public onSelectEnd(handler: XRControllerEventHandler): () => void {
this.selectEndHandlers.push(handler);
return () => {
this.selectEndHandlers = this.selectEndHandlers.filter(h => h !== handler);
};
}
public onSqueezeStart(handler: XRControllerEventHandler): () => void {
this.squeezeStartHandlers.push(handler);
return () => {
this.squeezeStartHandlers = this.squeezeStartHandlers.filter(h => h !== handler);
};
}
public onSqueezeEnd(handler: XRControllerEventHandler): () => void {
this.squeezeEndHandlers.push(handler);
return () => {
this.squeezeEndHandlers = this.squeezeEndHandlers.filter(h => h !== handler);
};
}
// New event subscription methods for hand interactions
public onGestureRecognized(handler: GestureEventHandler): () => void {
this.gestureRecognizedHandlers.push(handler);
return () => {
this.gestureRecognizedHandlers = this.gestureRecognizedHandlers.filter(h => h !== handler);
};
}
public onHandsVisibilityChanged(handler: HandVisibilityHandler): () => void {
this.handsVisibilityChangedHandlers.push(handler);
return () => {
this.handsVisibilityChangedHandlers = this.handsVisibilityChangedHandlers.filter(h => h !== handler);
};
}
// Method to notify gesture events
public notifyGestureRecognized(gesture: GestureRecognitionResult): void {
this.gestureRecognizedHandlers.forEach(handler => {
try {
handler(gesture);
} catch (error) {
logger.error('Error in gesture recognition handler:', createErrorMetadata(error));
}
});
}
// Method to notify hand visibility changes
public notifyHandsVisibilityChanged(visible: boolean): void {
this.handsVisibilityChangedHandlers.forEach(handler => {
try {
handler(visible);
} catch (error) {
logger.error('Error in hand visibility handler:', createErrorMetadata(error));
}
});
}
// XR state methods
public isSessionActive(): boolean {
return this.sessionActive;
}
public getControllers(): THREE.XRTargetRaySpace[] {
return this.controllers;
}
public getControllerGrips(): THREE.Object3D[] {
return this.controllerGrips;
}
public getRenderer(): THREE.WebGLRenderer | null {
return this.renderer;
}
public updateSettings(settings: Settings): void {
this.settings = settings;
// Update reference space if settings changed
if (this.renderer && settings.xr) {
this.renderer.xr.setReferenceSpaceType(
settings.xr.locomotionMethod === 'teleport' ? 'local-floor' : 'local'
);
}
}
public dispose(): void {
try {
// End active session first
if (this.sessionActive && this.renderer?.xr.isPresenting) {
const session = this.renderer.xr.getSession();
if (session) {
session.end().catch(error => {
logger.error('Error ending XR session during disposal:', error);
});
}
}
// Remove controllers from scene and clear event listeners
this.controllers.forEach((controller, index) => {
try {
// Remove from scene
if (controller.parent) {
controller.removeFromParent();
}
// Clear controller-specific data
if (controller.userData) {
controller.userData.selectPressed = false;
controller.userData.squeezePressed = false;
}
// Remove visual indicators (lines, etc.)
const line = controller.getObjectByName('controller-line');
if (line) {
controller.remove(line);
// Properly dispose of geometry and material if it's a Line object
if (line instanceof THREE.Line) {
if (line.geometry) line.geometry.dispose();
if (line.material) {
if (Array.isArray(line.material)) {
line.material.forEach(mat => mat.dispose());
} else {
line.material.dispose();
}
}
}
}
} catch (error) {
logger.error(`Error disposing controller ${index}:`, error);
}
});
// Remove controller grips and their models
this.controllerGrips.forEach((grip, index) => {
try {
if (grip.parent) {
grip.removeFromParent();
}
// Dispose of controller models created by XRControllerModelFactory
grip.traverse((child) => {
if (child instanceof THREE.Mesh) {
if (child.geometry) child.geometry.dispose();
if (child.material) {
if (Array.isArray(child.material)) {
child.material.forEach(mat => mat.dispose());
} else {
child.material.dispose();
}
}
}
});
} catch (error) {
logger.error(`Error disposing controller grip ${index}:`, error);
}
});
// Remove VR button safely
if (this.vrButton) {
try {
if (this.vrButton.parentNode) {
this.vrButton.parentNode.removeChild(this.vrButton);
}
} catch (error) {
logger.error('Error removing VR button:', error);
}
}
// Clear all event listeners and handler arrays
this.selectStartHandlers.length = 0;
this.selectEndHandlers.length = 0;
this.squeezeStartHandlers.length = 0;
this.squeezeEndHandlers.length = 0;
this.gestureRecognizedHandlers.length = 0;
this.handsVisibilityChangedHandlers.length = 0;
this.handTrackingStateHandlers.length = 0;
// Clear arrays
this.controllers.length = 0;
this.controllerGrips.length = 0;
// Clear factory reference
this.controllerModelFactory = null;
// Clear renderer XR session listeners if renderer exists
if (this.renderer?.xr) {
try {
// Note: We can't remove specific listeners without references,
// but setting to null will prevent new events from being processed
this.renderer.xr.enabled = false;
} catch (error) {
logger.error('Error disabling XR on renderer:', error);
}
}
// Clear object references
this.renderer = null;
this.camera = null;
this.scene = null;
this.vrButton = null;
this.settings = null;
// Reset state flags
this.sessionActive = false;
if (debugState.isEnabled()) {
logger.info('XR session manager disposed with complete resource cleanup');
}
} catch (error) {
logger.error('Error during XR session manager disposal:', error);
}
}
}