@shopware-ag/dive 1.19.0 → 1.19.1-beta.1

package/src/ar/arquicklook/ARQuickLook.ts

@@ -1,93 +0,0 @@
-import { type DIVEScene } from '../../scene/Scene';
-import { type DIVEAROptions } from '../AR';
-
-export class DIVEARQuickLook {
-    public static Launch(
-        scene: DIVEScene,
-        options?: DIVEAROptions,
-    ): Promise<void> {
-        const url = this.findARQuickLookSrc(scene);
-
-        // launch ARQuickLook
-        return this.launchARQuickLook(url, options);
-    }
-
-    private static launchARQuickLook(
-        uri: string,
-        options?: DIVEAROptions,
-    ): Promise<void> {
-        return new Promise((resolve) => {
-            if (options?.arScale === 'fixed') {
-                uri = uri.concat('#allowsContentScaling=0');
-            }
-
-            // launch ARQuickLook
-            const a = document.createElement('a');
-            a.innerHTML = '<picture></picture>'; // This is actually needed so the viewer opens instantly
-            a.rel = 'ar';
-            a.href = uri;
-            a.download = 'scene.usdz';
-            resolve();
-            a.click();
-        });
-    }
-
-    private static findARQuickLookSrc(scene: DIVEScene): string {
-        let uri: string | null = null;
-
-        scene.traverse((object) => {
-            if (uri) return;
-            if (object.userData.uri) {
-                uri = object.userData.uri;
-            }
-        });
-
-        if (!uri) {
-            throw new Error('No model found in scene');
-        }
-
-        return uri;
-    }
-
-    // private static extractModels(scene: DIVEScene): Object3D[] {
-    //     // extract models
-    //     return scene.Root.children;
-    // }
-
-    // private static launchARFromNode(
-    //     node: Object3D,
-    //     options?: DIVEAROptions,
-    // ): Promise<void> {
-    //     // bundle USDZ
-    //     return this._usdzExporter
-    //         .parse(node, {
-    //             quickLookCompatible: true,
-    //             ar: {
-    //                 anchoring: { type: 'plane' },
-    //                 planeAnchoring: {
-    //                     alignment:
-    //                         options?.arPlacement === 'vertical'
-    //                             ? 'vertical'
-    //                             : 'horizontal',
-    //                 },
-    //             },
-    //         })
-    //         .then((usdz: Uint8Array) => {
-    //             // create blob
-    //             const blob = new Blob([usdz], { type: 'model/vnd.usdz+zip' });
-    //             let url = URL.createObjectURL(blob);
-
-    //             if (options?.arScale === 'fixed') {
-    //                 url = url.concat('#allowsContentScaling=0');
-    //             }
-
-    //             // launch ARQuickLook
-    //             const a = document.createElement('a');
-    //             a.innerHTML = '<picture></picture>'; // This is actually needed so the viewer opens instantly
-    //             a.rel = 'ar';
-    //             a.href = url;
-    //             a.download = 'scene.usdz';
-    //             a.click();
-    //         });
-    // }
-}

package/src/ar/arquicklook/__test__/ARQuickLook.test.ts

@@ -1,93 +0,0 @@
-import { Box3, Color, Euler, Mesh, Object3D, Vector3 } from 'three';
-import { DIVEScene } from '../../../scene/Scene';
-import { DIVEAROptions } from '../../AR';
-import { DIVEARQuickLook } from '../ARQuickLook';
-
-jest.mock('../../../scene/Scene', () => {
-    return {
-        DIVEScene: jest.fn(function () {
-            this.add = jest.fn();
-            this.children = [];
-            this.Root = {
-                children: [],
-            };
-            this.traverse = jest.fn((callback) => {
-                this.Root.children.forEach((child: Object3D) => {
-                    callback(child);
-                });
-            });
-            return this;
-        }),
-    };
-});
-
-URL.createObjectURL = jest.fn(() => 'blob:http://localhost:8080/');
-
-describe('DIVEARQuickLook', () => {
-    let mockScene: DIVEScene;
-    let mockOptions: DIVEAROptions;
-    let mockModels: Object3D[];
-
-    beforeEach(() => {
-        mockModels = [
-            new Object3D(),
-            new Object3D(),
-            new Object3D(),
-        ];
-        mockModels[1].userData = {
-            uri: 'https://example.com',
-        };
-        mockScene = new DIVEScene();
-        mockOptions = {
-            arPlacement: 'horizontal',
-            arScale: 'auto',
-        } as DIVEAROptions;
-    });
-
-    describe('Launch', () => {
-        it('should be a function', () => {
-            expect(DIVEARQuickLook.Launch).toBeInstanceOf(Function);
-        });
-
-        it('should not throw without options', () => {
-            mockScene.Root.children = mockModels;
-
-            expect(() => {
-                DIVEARQuickLook.Launch(mockScene);
-            }).not.toThrow();
-        });
-
-        it('should not throw with options', () => {
-            mockScene.Root.children = mockModels;
-
-            expect(() => {
-                DIVEARQuickLook.Launch(mockScene, mockOptions);
-            }).not.toThrow();
-        });
-
-        it('should not throw with alternated options', () => {
-            mockScene.Root.children = mockModels;
-
-            mockOptions = {
-                arPlacement: 'vertical',
-                arScale: 'fixed',
-            } as DIVEAROptions;
-
-            expect(() => {
-                DIVEARQuickLook.Launch(mockScene, mockOptions);
-            }).not.toThrow();
-        });
-
-        it('should throw if no url is found', () => {
-            mockScene.Root.children = [
-                new Object3D(),
-                new Object3D(),
-                new Object3D(),
-            ];
-
-            expect(() => {
-                DIVEARQuickLook.Launch(mockScene, mockOptions);
-            }).toThrow();
-        });
-    });
-});

package/src/ar/sceneviewer/SceneViewer.ts

@@ -1,74 +0,0 @@
-import { type DIVEScene } from '../../scene/Scene';
-import { type DIVEAROptions } from '../AR';
-
-export class DIVESceneViewer {
-    public static Launch(scene: DIVEScene, options?: DIVEAROptions): void {
-        // find url in scene (first object found that has a set uri)
-        const url = this.findSceneViewerSrc(scene);
-
-        // launch SceneViewer
-        this.launchSceneViewer(url, options);
-    }
-
-    private static launchSceneViewer(
-        url: string,
-        options?: DIVEAROptions,
-    ): void {
-        const anchor = document.createElement('a');
-        const noArViewerSigil = '#model-viewer-no-ar-fallback';
-
-        const location = self.location.toString();
-        const locationUrl = new URL(location);
-        const modelUrl = new URL(url, location);
-        const params = new URLSearchParams(modelUrl.search);
-
-        locationUrl.hash = noArViewerSigil;
-
-        // modelUrl can contain title/link/sound etc.
-        params.set('mode', 'ar_only');
-
-        if (options?.arScale === 'fixed') {
-            params.set('resizable', 'false');
-        }
-
-        if (options?.arPlacement === 'vertical') {
-            params.set('enable_vertical_placement', 'true');
-        }
-
-        // will be added later if needed
-        // if (params.has('sound')) {
-        //     const soundUrl = new URL(params.get('sound')!, location);
-        //     params.set('sound', soundUrl.toString());
-        // }
-        // if (params.has('link')) {
-        //     const linkUrl = new URL(params.get('link')!, location);
-        //     params.set('link', linkUrl.toString());
-        // }
-
-        const intent = `intent://arvr.google.com/scene-viewer/1.2?${
-            params.toString() + '&file=' + modelUrl.toString()
-        }#Intent;scheme=https;package=com.google.android.googlequicksearchbox;action=android.intent.action.VIEW;S.browser_fallback_url=${encodeURIComponent(
-            locationUrl.toString(),
-        )};end;`;
-
-        anchor.setAttribute('href', intent);
-        anchor.click();
-    }
-
-    private static findSceneViewerSrc(scene: DIVEScene): string {
-        let uri: string | null = null;
-
-        scene.traverse((object) => {
-            if (uri) return;
-            if (object.userData.uri) {
-                uri = object.userData.uri;
-            }
-        });
-
-        if (!uri) {
-            throw new Error('No model found in scene');
-        }
-
-        return uri;
-    }
-}

package/src/ar/sceneviewer/__test__/SceneViewer.test.ts

@@ -1,93 +0,0 @@
-import { Box3, Color, Euler, Mesh, Object3D, Vector3 } from 'three';
-import { DIVEScene } from '../../../scene/Scene';
-import { DIVEAROptions } from '../../AR';
-import { DIVESceneViewer } from '../SceneViewer';
-
-jest.mock('../../../scene/Scene', () => {
-    return {
-        DIVEScene: jest.fn(function () {
-            this.add = jest.fn();
-            this.children = [];
-            this.Root = {
-                children: [],
-            };
-            this.traverse = jest.fn((callback) => {
-                this.Root.children.forEach((child: Object3D) => {
-                    callback(child);
-                });
-            });
-            return this;
-        }),
-    };
-});
-
-URL.createObjectURL = jest.fn(() => 'blob:http://localhost:8080/');
-
-describe('DIVESceneViewer', () => {
-    let mockScene: DIVEScene;
-    let mockOptions: DIVEAROptions;
-    let mockModels: Object3D[];
-
-    beforeEach(() => {
-        mockModels = [
-            new Object3D(),
-            new Object3D(),
-            new Object3D(),
-        ];
-        mockModels[1].userData = {
-            uri: 'https://example.com',
-        };
-        mockScene = new DIVEScene();
-        mockOptions = {
-            arPlacement: 'horizontal',
-            arScale: 'auto',
-        } as DIVEAROptions;
-    });
-
-    describe('Launch', () => {
-        it('should be a function', () => {
-            expect(DIVESceneViewer.Launch).toBeInstanceOf(Function);
-        });
-
-        it('should not throw without options', () => {
-            mockScene.Root.children = mockModels;
-
-            expect(() => {
-                DIVESceneViewer.Launch(mockScene);
-            }).not.toThrow();
-        });
-
-        it('should not throw with options', () => {
-            mockScene.Root.children = mockModels;
-
-            expect(() => {
-                DIVESceneViewer.Launch(mockScene, mockOptions);
-            }).not.toThrow();
-        });
-
-        it('should not throw with alternated options', () => {
-            mockScene.Root.children = mockModels;
-
-            mockOptions = {
-                arPlacement: 'vertical',
-                arScale: 'fixed',
-            } as DIVEAROptions;
-
-            expect(() => {
-                DIVESceneViewer.Launch(mockScene, mockOptions);
-            }).not.toThrow();
-        });
-
-        it('should throw if no url is found', () => {
-            mockScene.Root.children = [
-                new Object3D(),
-                new Object3D(),
-                new Object3D(),
-            ];
-
-            expect(() => {
-                DIVESceneViewer.Launch(mockScene, mockOptions);
-            }).toThrow();
-        });
-    });
-});

package/src/ar/webxr/WebXR.ts

@@ -1,176 +0,0 @@
-import { Vector3 } from 'three';
-import DIVEOrbitControls from '../../controls/OrbitControls';
-import { type DIVERenderer } from '../../renderer/Renderer';
-import { type DIVEScene } from '../../scene/Scene';
-import { Overlay } from './overlay/Overlay';
-import { DIVEWebXRController } from './controller/WebXRController';
-
-export class DIVEWebXR {
-    // general members
-    private static _renderer: DIVERenderer;
-    private static _scene: DIVEScene;
-    private static _controller: DIVEOrbitControls;
-
-    // camera reset members
-    private static _cameraPosition: Vector3;
-    private static _cameraTarget: Vector3;
-
-    // render loop members
-    private static _renderCallbackId: string | null = null;
-
-    // setup members
-    private static _session: XRSession | null = null;
-    private static _referenceSpaceType: XRReferenceSpaceType = 'local';
-    private static _overlay: Overlay | null = null;
-    private static _options = {
-        requiredFeatures: [
-            'local',
-            'hit-test',
-        ],
-        optionalFeatures: [
-            'light-estimation',
-            'local-floor',
-            'dom-overlay',
-            'depth-sensing',
-        ],
-        depthSensing: {
-            usagePreference: ['gpu-optimized'],
-            dataFormatPreference: [],
-        },
-        domOverlay: { root: {} as HTMLElement },
-    };
-
-    private static _xrController: DIVEWebXRController | null = null;
-
-    public static async Launch(
-        renderer: DIVERenderer,
-        scene: DIVEScene,
-        controller: DIVEOrbitControls,
-    ): Promise<void> {
-        this._renderer = renderer;
-        this._scene = scene;
-        this._controller = controller;
-
-        // setting camera reset values
-        this._cameraPosition = this._controller.object.position.clone();
-        this._cameraTarget = this._controller.target.clone();
-
-        if (!navigator.xr) {
-            console.error('WebXR not supported');
-            return Promise.reject();
-        }
-
-        // setup current instance
-        this._renderer.xr.enabled = true;
-        this._scene.InitXR(renderer);
-
-        // creating overlay
-        if (!DIVEWebXR._overlay) {
-            const overlay = new Overlay();
-            DIVEWebXR._overlay = overlay;
-        }
-        DIVEWebXR._options.domOverlay = { root: DIVEWebXR._overlay.Element };
-
-        // request session
-        const session = await navigator.xr.requestSession(
-            'immersive-ar',
-            this._options,
-        );
-        session.addEventListener('end', () => {
-            this._onSessionEnded();
-        });
-
-        // build up session
-        renderer.xr.setReferenceSpaceType(this._referenceSpaceType);
-        await renderer.xr.setSession(session);
-        DIVEWebXR._overlay.Element.style.display = '';
-        this._session = session;
-
-        // add end session event listener
-        DIVEWebXR._overlay.CloseButton.addEventListener('click', () =>
-            this.End(),
-        );
-
-        // start session
-        await this._onSessionStarted();
-
-        return Promise.resolve();
-    }
-
-    public static Update(_time: DOMHighResTimeStamp, frame: XRFrame): void {
-        if (!this._session) return;
-
-        if (this._xrController) {
-            this._xrController.Update(frame);
-        }
-    }
-
-    public static End(): void {
-        if (!this._session) return;
-        this._session.end();
-    }
-
-    private static async _onSessionStarted(): Promise<void> {
-        if (!this._session) return;
-
-        // add update callback to render loop
-        this._renderCallbackId = this._renderer.AddPreRenderCallback(
-            (time: DOMHighResTimeStamp, frame: XRFrame) => {
-                this.Update(time, frame);
-            },
-        );
-
-        this._xrController = new DIVEWebXRController(
-            this._session,
-            this._renderer,
-            this._scene,
-        );
-        await this._xrController.Init().catch(() => {
-            this.End();
-        });
-
-        return Promise.resolve();
-    }
-
-    private static _onSessionEnded(): void {
-        if (!this._session) return;
-
-        if (this._xrController) {
-            this._xrController.Dispose();
-        }
-
-        // remove Update() callback
-        if (this._renderCallbackId) {
-            this._renderer.RemovePreRenderCallback(this._renderCallbackId);
-            this._renderCallbackId = null;
-        }
-
-        // disable XR on renderer to restore canvas rendering
-        this._renderer.xr.enabled = false;
-
-        // resize renderer
-        const canvasWrapper = this._renderer.domElement.parentElement;
-        if (canvasWrapper) {
-            const { clientWidth, clientHeight } = canvasWrapper;
-            this._renderer.OnResize(clientWidth, clientHeight);
-
-            // resize camera
-            this._controller.object.OnResize(clientWidth, clientHeight);
-        }
-
-        // reset camera
-        this._controller.object.position.copy(this._cameraPosition);
-        this._controller.target.copy(this._cameraTarget);
-
-        // reset camera values
-        this._cameraPosition.set(0, 0, 0);
-        this._cameraTarget.set(0, 0, 0);
-
-        // dispose xr scene
-        this._scene.DisposeXR();
-
-        this._session.removeEventListener('end', this._onSessionEnded);
-        DIVEWebXR._overlay!.Element.style.display = 'none';
-        this._session = null;
-    }
-}