WebXRControllerPointerSelection.ts 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665
  1. import { WebXRFeaturesManager, WebXRFeatureName } from "../webXRFeaturesManager";
  2. import { WebXRSessionManager } from "../webXRSessionManager";
  3. import { AbstractMesh } from "../../Meshes/abstractMesh";
  4. import { Observer } from "../../Misc/observable";
  5. import { WebXRInput } from "../webXRInput";
  6. import { WebXRInputSource } from "../webXRInputSource";
  7. import { Scene } from "../../scene";
  8. import { WebXRControllerComponent } from "../motionController/webXRControllerComponent";
  9. import { Nullable } from "../../types";
  10. import { Matrix, Vector3 } from "../../Maths/math.vector";
  11. import { Color3 } from "../../Maths/math.color";
  12. import { Axis } from "../../Maths/math.axis";
  13. import { StandardMaterial } from "../../Materials/standardMaterial";
  14. import { CylinderBuilder } from "../../Meshes/Builders/cylinderBuilder";
  15. import { TorusBuilder } from "../../Meshes/Builders/torusBuilder";
  16. import { Ray } from "../../Culling/ray";
  17. import { PickingInfo } from "../../Collisions/pickingInfo";
  18. import { WebXRAbstractFeature } from "./WebXRAbstractFeature";
  19. import { UtilityLayerRenderer } from "../../Rendering/utilityLayerRenderer";
  20. import { WebXRAbstractMotionController } from "../motionController/webXRAbstractMotionController";
  21. import { WebXRCamera } from "../webXRCamera";
  22. import { Node } from "../../node";
  23. import { Viewport } from "../../Maths/math.viewport";
  24. /**
  25. * Options interface for the pointer selection module
  26. */
  27. export interface IWebXRControllerPointerSelectionOptions {
  28. /**
  29. * if provided, this scene will be used to render meshes.
  30. */
  31. customUtilityLayerScene?: Scene;
  32. /**
  33. * Disable the pointer up event when the xr controller in screen and gaze mode is disposed (meaning - when the user removed the finger from the screen)
  34. * If not disabled, the last picked point will be used to execute a pointer up event
  35. * If disabled, pointer up event will be triggered right after the pointer down event.
  36. * Used in screen and gaze target ray mode only
  37. */
  38. disablePointerUpOnTouchOut: boolean;
  39. /**
  40. * For gaze mode for tracked-pointer / controllers (time to select instead of button press)
  41. */
  42. forceGazeMode: boolean;
  43. /**
  44. * Factor to be applied to the pointer-moved function in the gaze mode. How sensitive should the gaze mode be when checking if the pointer moved
  45. * to start a new countdown to the pointer down event.
  46. * Defaults to 1.
  47. */
  48. gazeModePointerMovedFactor?: number;
  49. /**
  50. * Different button type to use instead of the main component
  51. */
  52. overrideButtonId?: string;
  53. /**
  54. * use this rendering group id for the meshes (optional)
  55. */
  56. renderingGroupId?: number;
  57. /**
  58. * The amount of time in milliseconds it takes between pick found something to a pointer down event.
  59. * Used in gaze modes. Tracked pointer uses the trigger, screen uses touch events
  60. * 3000 means 3 seconds between pointing at something and selecting it
  61. */
  62. timeToSelect?: number;
  63. /**
  64. * Should meshes created here be added to a utility layer or the main scene
  65. */
  66. useUtilityLayer?: boolean;
  67. /**
  68. * Optional WebXR camera to be used for gaze selection
  69. */
  70. gazeCamera?: WebXRCamera;
  71. /**
  72. * the xr input to use with this pointer selection
  73. */
  74. xrInput: WebXRInput;
  75. /**
  76. * Should the scene pointerX and pointerY update be disabled
  77. * This is required for fullscreen AR GUI, but might slow down other experiences.
  78. * Disable in VR, if not needed.
  79. * The first rig camera (left eye) will be used to calculate the projection
  80. */
  81. disableScenePointerVectorUpdate: boolean;
  82. }
  83. /**
  84. * A module that will enable pointer selection for motion controllers of XR Input Sources
  85. */
  86. export class WebXRControllerPointerSelection extends WebXRAbstractFeature {
  87. private static _idCounter = 200;
  88. private _attachController = (xrController: WebXRInputSource) => {
  89. if (this._controllers[xrController.uniqueId]) {
  90. // already attached
  91. return;
  92. }
  93. // For now no support for hand-tracked input sources!
  94. if (xrController.inputSource.hand && !xrController.inputSource.gamepad) {
  95. return;
  96. }
  97. // only support tracker pointer
  98. const { laserPointer, selectionMesh } = this._generateNewMeshPair(xrController.pointer);
  99. // get two new meshes
  100. this._controllers[xrController.uniqueId] = {
  101. xrController,
  102. laserPointer,
  103. selectionMesh,
  104. meshUnderPointer: null,
  105. pick: null,
  106. tmpRay: new Ray(new Vector3(), new Vector3()),
  107. id: WebXRControllerPointerSelection._idCounter++,
  108. };
  109. switch (xrController.inputSource.targetRayMode) {
  110. case "tracked-pointer":
  111. return this._attachTrackedPointerRayMode(xrController);
  112. case "gaze":
  113. return this._attachGazeMode(xrController);
  114. case "screen":
  115. return this._attachScreenRayMode(xrController);
  116. }
  117. };
  118. private _controllers: {
  119. [controllerUniqueId: string]: {
  120. xrController?: WebXRInputSource;
  121. webXRCamera?: WebXRCamera;
  122. selectionComponent?: WebXRControllerComponent;
  123. onButtonChangedObserver?: Nullable<Observer<WebXRControllerComponent>>;
  124. onFrameObserver?: Nullable<Observer<XRFrame>>;
  125. laserPointer: AbstractMesh;
  126. selectionMesh: AbstractMesh;
  127. meshUnderPointer: Nullable<AbstractMesh>;
  128. pick: Nullable<PickingInfo>;
  129. id: number;
  130. tmpRay: Ray;
  131. // event support
  132. eventListeners?: { [event in XREventType]?: (event: XRInputSourceEvent) => void };
  133. };
  134. } = {};
  135. private _scene: Scene;
  136. private _tmpVectorForPickCompare = new Vector3();
  137. /**
  138. * The module's name
  139. */
  140. public static readonly Name = WebXRFeatureName.POINTER_SELECTION;
  141. /**
  142. * The (Babylon) version of this module.
  143. * This is an integer representing the implementation version.
  144. * This number does not correspond to the WebXR specs version
  145. */
  146. public static readonly Version = 1;
  147. /**
  148. * Disable lighting on the laser pointer (so it will always be visible)
  149. */
  150. public disablePointerLighting: boolean = true;
  151. /**
  152. * Disable lighting on the selection mesh (so it will always be visible)
  153. */
  154. public disableSelectionMeshLighting: boolean = true;
  155. /**
  156. * Should the laser pointer be displayed
  157. */
  158. public displayLaserPointer: boolean = true;
  159. /**
  160. * Should the selection mesh be displayed (The ring at the end of the laser pointer)
  161. */
  162. public displaySelectionMesh: boolean = true;
  163. /**
  164. * This color will be set to the laser pointer when selection is triggered
  165. */
  166. public laserPointerPickedColor: Color3 = new Color3(0.9, 0.9, 0.9);
  167. /**
  168. * Default color of the laser pointer
  169. */
  170. public laserPointerDefaultColor: Color3 = new Color3(0.7, 0.7, 0.7);
  171. /**
  172. * default color of the selection ring
  173. */
  174. public selectionMeshDefaultColor: Color3 = new Color3(0.8, 0.8, 0.8);
  175. /**
  176. * This color will be applied to the selection ring when selection is triggered
  177. */
  178. public selectionMeshPickedColor: Color3 = new Color3(0.3, 0.3, 1.0);
  179. /**
  180. * Optional filter to be used for ray selection. This predicate shares behavior with
  181. * scene.pointerMovePredicate which takes priority if it is also assigned.
  182. */
  183. public raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  184. /**
  185. * constructs a new background remover module
  186. * @param _xrSessionManager the session manager for this module
  187. * @param _options read-only options to be used in this module
  188. */
  189. constructor(_xrSessionManager: WebXRSessionManager, private readonly _options: IWebXRControllerPointerSelectionOptions) {
  190. super(_xrSessionManager);
  191. this._scene = this._xrSessionManager.scene;
  192. }
  193. /**
  194. * attach this feature
  195. * Will usually be called by the features manager
  196. *
  197. * @returns true if successful.
  198. */
  199. public attach(): boolean {
  200. if (!super.attach()) {
  201. return false;
  202. }
  203. this._options.xrInput.controllers.forEach(this._attachController);
  204. this._addNewAttachObserver(this._options.xrInput.onControllerAddedObservable, this._attachController);
  205. this._addNewAttachObserver(this._options.xrInput.onControllerRemovedObservable, (controller) => {
  206. // REMOVE the controller
  207. this._detachController(controller.uniqueId);
  208. });
  209. this._scene.constantlyUpdateMeshUnderPointer = true;
  210. if (this._options.gazeCamera) {
  211. const webXRCamera = this._options.gazeCamera;
  212. const { laserPointer, selectionMesh } = this._generateNewMeshPair(webXRCamera);
  213. this._controllers["camera"] = {
  214. webXRCamera,
  215. laserPointer,
  216. selectionMesh,
  217. meshUnderPointer: null,
  218. pick: null,
  219. tmpRay: new Ray(new Vector3(), new Vector3()),
  220. id: WebXRControllerPointerSelection._idCounter++,
  221. };
  222. this._attachGazeMode();
  223. }
  224. return true;
  225. }
  226. /**
  227. * detach this feature.
  228. * Will usually be called by the features manager
  229. *
  230. * @returns true if successful.
  231. */
  232. public detach(): boolean {
  233. if (!super.detach()) {
  234. return false;
  235. }
  236. Object.keys(this._controllers).forEach((controllerId) => {
  237. this._detachController(controllerId);
  238. });
  239. return true;
  240. }
  241. /**
  242. * Will get the mesh under a specific pointer.
  243. * `scene.meshUnderPointer` will only return one mesh - either left or right.
  244. * @param controllerId the controllerId to check
  245. * @returns The mesh under pointer or null if no mesh is under the pointer
  246. */
  247. public getMeshUnderPointer(controllerId: string): Nullable<AbstractMesh> {
  248. if (this._controllers[controllerId]) {
  249. return this._controllers[controllerId].meshUnderPointer;
  250. } else {
  251. return null;
  252. }
  253. }
  254. /**
  255. * Get the xr controller that correlates to the pointer id in the pointer event
  256. *
  257. * @param id the pointer id to search for
  258. * @returns the controller that correlates to this id or null if not found
  259. */
  260. public getXRControllerByPointerId(id: number): Nullable<WebXRInputSource> {
  261. const keys = Object.keys(this._controllers);
  262. for (let i = 0; i < keys.length; ++i) {
  263. if (this._controllers[keys[i]].id === id) {
  264. return this._controllers[keys[i]].xrController || null;
  265. }
  266. }
  267. return null;
  268. }
  269. private _identityMatrix = Matrix.Identity();
  270. private _screenCoordinatesRef = Vector3.Zero();
  271. private _viewportRef = new Viewport(0, 0, 0, 0);
  272. protected _onXRFrame(_xrFrame: XRFrame) {
  273. Object.keys(this._controllers).forEach((id) => {
  274. const controllerData = this._controllers[id];
  275. let controllerGlobalPosition: Vector3;
  276. // Every frame check collisions/input
  277. if (controllerData.xrController) {
  278. controllerGlobalPosition = controllerData.xrController.pointer.position;
  279. controllerData.xrController.getWorldPointerRayToRef(controllerData.tmpRay);
  280. } else if (controllerData.webXRCamera) {
  281. controllerGlobalPosition = controllerData.webXRCamera.position;
  282. controllerData.webXRCamera.getForwardRayToRef(controllerData.tmpRay);
  283. } else {
  284. return;
  285. }
  286. // update pointerX and pointerY of the scene. Only if the flag is set to true!
  287. if (!this._options.disableScenePointerVectorUpdate && controllerGlobalPosition) {
  288. const scene = this._xrSessionManager.scene;
  289. const camera = this._options.xrInput.xrCamera;
  290. if (camera) {
  291. camera.viewport.toGlobalToRef(scene.getEngine().getRenderWidth(), scene.getEngine().getRenderHeight(), this._viewportRef);
  292. Vector3.ProjectToRef(controllerGlobalPosition, this._identityMatrix, scene.getTransformMatrix(), this._viewportRef, this._screenCoordinatesRef);
  293. scene.pointerX = this._screenCoordinatesRef.x;
  294. scene.pointerY = this._screenCoordinatesRef.y;
  295. }
  296. }
  297. controllerData.pick = this._scene.pickWithRay(controllerData.tmpRay, this._scene.pointerMovePredicate || this.raySelectionPredicate);
  298. const pick = controllerData.pick;
  299. if (pick && pick.pickedPoint && pick.hit) {
  300. // Update laser state
  301. this._updatePointerDistance(controllerData.laserPointer, pick.distance);
  302. // Update cursor state
  303. controllerData.selectionMesh.position.copyFrom(pick.pickedPoint);
  304. controllerData.selectionMesh.scaling.x = Math.sqrt(pick.distance);
  305. controllerData.selectionMesh.scaling.y = Math.sqrt(pick.distance);
  306. controllerData.selectionMesh.scaling.z = Math.sqrt(pick.distance);
  307. // To avoid z-fighting
  308. let pickNormal = this._convertNormalToDirectionOfRay(pick.getNormal(true), controllerData.tmpRay);
  309. let deltaFighting = 0.001;
  310. controllerData.selectionMesh.position.copyFrom(pick.pickedPoint);
  311. if (pickNormal) {
  312. let axis1 = Vector3.Cross(Axis.Y, pickNormal);
  313. let axis2 = Vector3.Cross(pickNormal, axis1);
  314. Vector3.RotationFromAxisToRef(axis2, pickNormal, axis1, controllerData.selectionMesh.rotation);
  315. controllerData.selectionMesh.position.addInPlace(pickNormal.scale(deltaFighting));
  316. }
  317. controllerData.selectionMesh.isVisible = true && this.displaySelectionMesh;
  318. controllerData.meshUnderPointer = pick.pickedMesh;
  319. } else {
  320. controllerData.selectionMesh.isVisible = false;
  321. controllerData.meshUnderPointer = null;
  322. }
  323. });
  324. }
  325. private _attachGazeMode(xrController?: WebXRInputSource) {
  326. const controllerData = this._controllers[(xrController && xrController.uniqueId) || "camera"];
  327. // attached when touched, detaches when raised
  328. const timeToSelect = this._options.timeToSelect || 3000;
  329. const sceneToRenderTo = this._options.useUtilityLayer ? this._options.customUtilityLayerScene || UtilityLayerRenderer.DefaultUtilityLayer.utilityLayerScene : this._scene;
  330. let oldPick = new PickingInfo();
  331. let discMesh = TorusBuilder.CreateTorus(
  332. "selection",
  333. {
  334. diameter: 0.0035 * 15,
  335. thickness: 0.0025 * 6,
  336. tessellation: 20,
  337. },
  338. sceneToRenderTo
  339. );
  340. discMesh.isVisible = false;
  341. discMesh.isPickable = false;
  342. discMesh.parent = controllerData.selectionMesh;
  343. let timer = 0;
  344. let downTriggered = false;
  345. controllerData.onFrameObserver = this._xrSessionManager.onXRFrameObservable.add(() => {
  346. if (!controllerData.pick) {
  347. return;
  348. }
  349. controllerData.laserPointer.material!.alpha = 0;
  350. discMesh.isVisible = false;
  351. if (controllerData.pick.hit) {
  352. if (!this._pickingMoved(oldPick, controllerData.pick)) {
  353. if (timer > timeToSelect / 10) {
  354. discMesh.isVisible = true;
  355. }
  356. timer += this._scene.getEngine().getDeltaTime();
  357. if (timer >= timeToSelect) {
  358. this._scene.simulatePointerDown(controllerData.pick, { pointerId: controllerData.id });
  359. downTriggered = true;
  360. // pointer up right after down, if disable on touch out
  361. if (this._options.disablePointerUpOnTouchOut) {
  362. this._scene.simulatePointerUp(controllerData.pick, { pointerId: controllerData.id });
  363. }
  364. discMesh.isVisible = false;
  365. } else {
  366. const scaleFactor = 1 - timer / timeToSelect;
  367. discMesh.scaling.set(scaleFactor, scaleFactor, scaleFactor);
  368. }
  369. } else {
  370. if (downTriggered) {
  371. if (!this._options.disablePointerUpOnTouchOut) {
  372. this._scene.simulatePointerUp(controllerData.pick, { pointerId: controllerData.id });
  373. }
  374. }
  375. downTriggered = false;
  376. timer = 0;
  377. }
  378. } else {
  379. downTriggered = false;
  380. timer = 0;
  381. }
  382. this._scene.simulatePointerMove(controllerData.pick, { pointerId: controllerData.id });
  383. oldPick = controllerData.pick;
  384. });
  385. if (this._options.renderingGroupId !== undefined) {
  386. discMesh.renderingGroupId = this._options.renderingGroupId;
  387. }
  388. if (xrController) {
  389. xrController.onDisposeObservable.addOnce(() => {
  390. if (controllerData.pick && !this._options.disablePointerUpOnTouchOut && downTriggered) {
  391. this._scene.simulatePointerUp(controllerData.pick, { pointerId: controllerData.id });
  392. }
  393. discMesh.dispose();
  394. });
  395. }
  396. }
  397. private _attachScreenRayMode(xrController: WebXRInputSource) {
  398. const controllerData = this._controllers[xrController.uniqueId];
  399. let downTriggered = false;
  400. controllerData.onFrameObserver = this._xrSessionManager.onXRFrameObservable.add(() => {
  401. if (!controllerData.pick || (this._options.disablePointerUpOnTouchOut && downTriggered)) {
  402. return;
  403. }
  404. if (!downTriggered) {
  405. this._scene.simulatePointerDown(controllerData.pick, { pointerId: controllerData.id });
  406. downTriggered = true;
  407. if (this._options.disablePointerUpOnTouchOut) {
  408. this._scene.simulatePointerUp(controllerData.pick, { pointerId: controllerData.id });
  409. }
  410. } else {
  411. this._scene.simulatePointerMove(controllerData.pick, { pointerId: controllerData.id });
  412. }
  413. });
  414. xrController.onDisposeObservable.addOnce(() => {
  415. if (controllerData.pick && downTriggered && !this._options.disablePointerUpOnTouchOut) {
  416. this._scene.simulatePointerUp(controllerData.pick, { pointerId: controllerData.id });
  417. }
  418. });
  419. }
  420. private _attachTrackedPointerRayMode(xrController: WebXRInputSource) {
  421. const controllerData = this._controllers[xrController.uniqueId];
  422. if (this._options.forceGazeMode) {
  423. return this._attachGazeMode(xrController);
  424. }
  425. controllerData.onFrameObserver = this._xrSessionManager.onXRFrameObservable.add(() => {
  426. controllerData.laserPointer.isVisible = this.displayLaserPointer;
  427. (<StandardMaterial>controllerData.laserPointer.material).disableLighting = this.disablePointerLighting;
  428. (<StandardMaterial>controllerData.selectionMesh.material).disableLighting = this.disableSelectionMeshLighting;
  429. if (controllerData.pick) {
  430. this._scene.simulatePointerMove(controllerData.pick, { pointerId: controllerData.id });
  431. }
  432. });
  433. if (xrController.inputSource.gamepad) {
  434. const init = (motionController: WebXRAbstractMotionController) => {
  435. if (this._options.overrideButtonId) {
  436. controllerData.selectionComponent = motionController.getComponent(this._options.overrideButtonId);
  437. }
  438. if (!controllerData.selectionComponent) {
  439. controllerData.selectionComponent = motionController.getMainComponent();
  440. }
  441. controllerData.onButtonChangedObserver = controllerData.selectionComponent.onButtonStateChangedObservable.add((component) => {
  442. if (component.changes.pressed) {
  443. const pressed = component.changes.pressed.current;
  444. if (controllerData.pick) {
  445. if (pressed) {
  446. this._scene.simulatePointerDown(controllerData.pick, { pointerId: controllerData.id });
  447. (<StandardMaterial>controllerData.selectionMesh.material).emissiveColor = this.selectionMeshPickedColor;
  448. (<StandardMaterial>controllerData.laserPointer.material).emissiveColor = this.laserPointerPickedColor;
  449. } else {
  450. this._scene.simulatePointerUp(controllerData.pick, { pointerId: controllerData.id });
  451. (<StandardMaterial>controllerData.selectionMesh.material).emissiveColor = this.selectionMeshDefaultColor;
  452. (<StandardMaterial>controllerData.laserPointer.material).emissiveColor = this.laserPointerDefaultColor;
  453. }
  454. }
  455. }
  456. });
  457. };
  458. if (xrController.motionController) {
  459. init(xrController.motionController);
  460. } else {
  461. xrController.onMotionControllerInitObservable.add(init);
  462. }
  463. } else {
  464. // use the select and squeeze events
  465. const selectStartListener = (event: XRInputSourceEvent) => {
  466. if (controllerData.xrController && event.inputSource === controllerData.xrController.inputSource && controllerData.pick) {
  467. this._scene.simulatePointerDown(controllerData.pick, { pointerId: controllerData.id });
  468. (<StandardMaterial>controllerData.selectionMesh.material).emissiveColor = this.selectionMeshPickedColor;
  469. (<StandardMaterial>controllerData.laserPointer.material).emissiveColor = this.laserPointerPickedColor;
  470. }
  471. };
  472. const selectEndListener = (event: XRInputSourceEvent) => {
  473. if (controllerData.xrController && event.inputSource === controllerData.xrController.inputSource && controllerData.pick) {
  474. this._scene.simulatePointerUp(controllerData.pick, { pointerId: controllerData.id });
  475. (<StandardMaterial>controllerData.selectionMesh.material).emissiveColor = this.selectionMeshDefaultColor;
  476. (<StandardMaterial>controllerData.laserPointer.material).emissiveColor = this.laserPointerDefaultColor;
  477. }
  478. };
  479. controllerData.eventListeners = {
  480. selectend: selectEndListener,
  481. selectstart: selectStartListener,
  482. };
  483. this._xrSessionManager.session.addEventListener("selectstart", selectStartListener);
  484. this._xrSessionManager.session.addEventListener("selectend", selectEndListener);
  485. }
  486. }
  487. private _convertNormalToDirectionOfRay(normal: Nullable<Vector3>, ray: Ray) {
  488. if (normal) {
  489. let angle = Math.acos(Vector3.Dot(normal, ray.direction));
  490. if (angle < Math.PI / 2) {
  491. normal.scaleInPlace(-1);
  492. }
  493. }
  494. return normal;
  495. }
  496. private _detachController(xrControllerUniqueId: string) {
  497. const controllerData = this._controllers[xrControllerUniqueId];
  498. if (!controllerData) {
  499. return;
  500. }
  501. if (controllerData.selectionComponent) {
  502. if (controllerData.onButtonChangedObserver) {
  503. controllerData.selectionComponent.onButtonStateChangedObservable.remove(controllerData.onButtonChangedObserver);
  504. }
  505. }
  506. if (controllerData.onFrameObserver) {
  507. this._xrSessionManager.onXRFrameObservable.remove(controllerData.onFrameObserver);
  508. }
  509. if (controllerData.eventListeners) {
  510. Object.keys(controllerData.eventListeners).forEach((eventName: string) => {
  511. const func = controllerData.eventListeners && controllerData.eventListeners[eventName as XREventType];
  512. if (func) {
  513. this._xrSessionManager.session.removeEventListener(eventName, func);
  514. }
  515. });
  516. }
  517. controllerData.selectionMesh.dispose();
  518. controllerData.laserPointer.dispose();
  519. // remove from the map
  520. delete this._controllers[xrControllerUniqueId];
  521. }
  522. private _generateNewMeshPair(meshParent: Node) {
  523. const sceneToRenderTo = this._options.useUtilityLayer ? this._options.customUtilityLayerScene || UtilityLayerRenderer.DefaultUtilityLayer.utilityLayerScene : this._scene;
  524. const laserPointer = CylinderBuilder.CreateCylinder(
  525. "laserPointer",
  526. {
  527. height: 1,
  528. diameterTop: 0.0002,
  529. diameterBottom: 0.004,
  530. tessellation: 20,
  531. subdivisions: 1,
  532. },
  533. sceneToRenderTo
  534. );
  535. laserPointer.parent = meshParent;
  536. let laserPointerMaterial = new StandardMaterial("laserPointerMat", sceneToRenderTo);
  537. laserPointerMaterial.emissiveColor = this.laserPointerDefaultColor;
  538. laserPointerMaterial.alpha = 0.7;
  539. laserPointer.material = laserPointerMaterial;
  540. laserPointer.rotation.x = Math.PI / 2;
  541. this._updatePointerDistance(laserPointer, 1);
  542. laserPointer.isPickable = false;
  543. // Create a gaze tracker for the XR controller
  544. const selectionMesh = TorusBuilder.CreateTorus(
  545. "gazeTracker",
  546. {
  547. diameter: 0.0035 * 3,
  548. thickness: 0.0025 * 3,
  549. tessellation: 20,
  550. },
  551. sceneToRenderTo
  552. );
  553. selectionMesh.bakeCurrentTransformIntoVertices();
  554. selectionMesh.isPickable = false;
  555. selectionMesh.isVisible = false;
  556. let targetMat = new StandardMaterial("targetMat", sceneToRenderTo);
  557. targetMat.specularColor = Color3.Black();
  558. targetMat.emissiveColor = this.selectionMeshDefaultColor;
  559. targetMat.backFaceCulling = false;
  560. selectionMesh.material = targetMat;
  561. if (this._options.renderingGroupId !== undefined) {
  562. laserPointer.renderingGroupId = this._options.renderingGroupId;
  563. selectionMesh.renderingGroupId = this._options.renderingGroupId;
  564. }
  565. return {
  566. laserPointer,
  567. selectionMesh,
  568. };
  569. }
  570. private _pickingMoved(oldPick: PickingInfo, newPick: PickingInfo) {
  571. if (!oldPick.hit || !newPick.hit) {
  572. return true;
  573. }
  574. if (!oldPick.pickedMesh || !oldPick.pickedPoint || !newPick.pickedMesh || !newPick.pickedPoint) {
  575. return true;
  576. }
  577. if (oldPick.pickedMesh !== newPick.pickedMesh) {
  578. return true;
  579. }
  580. oldPick.pickedPoint?.subtractToRef(newPick.pickedPoint, this._tmpVectorForPickCompare);
  581. this._tmpVectorForPickCompare.set(Math.abs(this._tmpVectorForPickCompare.x), Math.abs(this._tmpVectorForPickCompare.y), Math.abs(this._tmpVectorForPickCompare.z));
  582. const delta = (this._options.gazeModePointerMovedFactor || 1) * 0.01 * newPick.distance;
  583. const length = this._tmpVectorForPickCompare.length();
  584. if (length > delta) {
  585. return true;
  586. }
  587. return false;
  588. }
  589. private _updatePointerDistance(_laserPointer: AbstractMesh, distance: number = 100) {
  590. _laserPointer.scaling.y = distance;
  591. // a bit of distance from the controller
  592. if (this._scene.useRightHandedSystem) {
  593. distance *= -1;
  594. }
  595. _laserPointer.position.z = distance / 2 + 0.05;
  596. }
  597. /** @hidden */
  598. public get lasterPointerDefaultColor(): Color3 {
  599. // here due to a typo
  600. return this.laserPointerDefaultColor;
  601. }
  602. }
  603. //register the plugin
  604. WebXRFeaturesManager.AddWebXRFeature(
  605. WebXRControllerPointerSelection.Name,
  606. (xrSessionManager, options) => {
  607. return () => new WebXRControllerPointerSelection(xrSessionManager, options);
  608. },
  609. WebXRControllerPointerSelection.Version,
  610. true
  611. );