@shopware-ag/dive 1.12.1 → 1.14.0

package/src/scene/root/modelroot/__test__/ModelRoot.test.ts

@@ -1,189 +0,0 @@
-import DIVEModelRoot from '../ModelRoot';
-import DIVECommunication from '../../../../com/Communication';
-import { DIVEMoveable } from '../../../../interface/Moveable';
-import type DIVEScene from '../../../Scene';
-import { type COMMaterial } from '../../../../com/types';
-
-const mock_LoadGLTF = jest.fn().mockResolvedValue({});
-const mock_SetPosition = jest.fn();
-const mock_SetRotation = jest.fn();
-const mock_SetScale = jest.fn();
-const mock_PlaceOnFloor = jest.fn();
-const mock_SetModel = jest.fn();
-
-jest.mock('../../../../com/types.ts', () => {
-    return {
-        COMModel: {},
-    }
-});
-
-jest.mock('../../../../loadingmanager/LoadingManager.ts', () => {
-    return jest.fn(function () {
-        this.LoadGLTF = mock_LoadGLTF;
-        return this;
-    });
-});
-
-jest.mock('../../../../com/Communication.ts', () => {
-    return {
-        get: jest.fn(() => {
-            return {
-                PerformAction: jest.fn(),
-            }
-        }),
-    }
-});
-
-jest.mock('../../../../model/Model.ts', () => {
-    return jest.fn(function () {
-        this.isObject3D = true;
-        this.parent = null;
-        this.dispatchEvent = jest.fn();
-        this.userData = {
-            id: undefined,
-        };
-        this.SetModel = mock_SetModel;
-        this.SetPosition = mock_SetPosition;
-        this.SetRotation = mock_SetRotation;
-        this.SetScale = mock_SetScale;
-        this.SetVisibility = jest.fn();
-        this.SetMaterial = jest.fn();
-        this.PlaceOnFloor = mock_PlaceOnFloor;
-        this.removeFromParent = jest.fn();
-        return this;
-    });
-});
-
-jest.spyOn(DIVECommunication, 'get').mockReturnValue({ PerformAction: jest.fn() } as unknown as DIVECommunication);
-
-const consoleWarnSpy = jest.spyOn(console, 'warn').mockImplementation(() => { });
-
-describe('dive/scene/root/modelroot/DIVEModelRoot', () => {
-    beforeEach(() => {
-        consoleWarnSpy.mockClear();
-    });
-
-    it('should instantiate', () => {
-        const modelRoot = new DIVEModelRoot();
-        expect(modelRoot).toBeDefined();
-    });
-
-    it('should not add incorrect model', async () => {
-        const modelRoot = new DIVEModelRoot();
-        await expect(() => modelRoot.UpdateModel({ id: undefined })).not.toThrow();
-        expect(consoleWarnSpy).toHaveBeenCalled();
-        expect(modelRoot.children).toHaveLength(0);
-    });
-
-    it('should add basic model', async () => {
-        const modelRoot = new DIVEModelRoot();
-        await expect(() => modelRoot.UpdateModel({
-            id: 'test_id',
-            uri: 'not a real uri',
-            visible: false,
-        })).not.toThrow();
-        expect(mock_LoadGLTF).toHaveBeenCalledTimes(1);
-        expect(mock_SetModel).toHaveBeenCalledTimes(1);
-        expect(modelRoot.children).toHaveLength(1);
-        expect(modelRoot.children[0].userData.id).toBe('test_id');
-    });
-
-    it('should add configured model', async () => {
-        const modelRoot = new DIVEModelRoot();
-        modelRoot.userData.id = 'something';
-        await expect(() => modelRoot.UpdateModel({
-            id: 'test_id',
-            uri: 'not a real uri',
-            position: { x: 1, y: 2, z: 3 },
-            rotation: { x: 1, y: 2, z: 3 },
-            scale: { x: 1, y: 2, z: 3 },
-            material: {} as COMMaterial,
-        })).not.toThrow();
-
-        jest.spyOn(DIVECommunication, 'get').mockReturnValueOnce(undefined);
-        await expect(() => modelRoot.UpdateModel({
-            id: 'test_id',
-            uri: 'not a real uri',
-            position: { x: 1, y: 2, z: 3 },
-            rotation: { x: 1, y: 2, z: 3 },
-            scale: { x: 1, y: 2, z: 3 },
-        })).not.toThrow();
-
-        expect(modelRoot.children).toHaveLength(1);
-        expect(mock_SetPosition).toHaveBeenCalledTimes(2);
-        expect(mock_SetRotation).toHaveBeenCalledTimes(2);
-        expect(mock_SetScale).toHaveBeenCalledTimes(2);
-    });
-
-    it('should not place incorrect model on floor', async () => {
-        const modelRoot = new DIVEModelRoot();
-        expect(() => modelRoot.PlaceOnFloor({ id: undefined })).not.toThrow();
-        expect(consoleWarnSpy).toHaveBeenCalled();
-        expect(mock_PlaceOnFloor).toHaveBeenCalledTimes(0);
-    });
-
-    it('should not place non-existing model on floor', async () => {
-        const modelRoot = new DIVEModelRoot();
-        modelRoot.PlaceOnFloor({ id: 'test_id' });
-        expect(mock_PlaceOnFloor).toHaveBeenCalledTimes(0);
-    });
-
-    it('should place model on floor', async () => {
-        const modelRoot = new DIVEModelRoot();
-        await modelRoot.UpdateModel({
-            id: 'test_id',
-            uri: 'not a real uri',
-            position: { x: 1, y: 2, z: 3 },
-            rotation: { x: 1, y: 2, z: 3 },
-            scale: { x: 1, y: 2, z: 3 },
-        });
-        modelRoot.PlaceOnFloor({ id: 'test_id' });
-        expect(mock_PlaceOnFloor).toHaveBeenCalledTimes(1);
-    });
-
-    it('should get model', async () => {
-        const modelRoot = new DIVEModelRoot();
-        expect(() => modelRoot.GetModel({ id: undefined })).not.toThrow();
-        expect(consoleWarnSpy).toHaveBeenCalled();
-        expect(modelRoot.GetModel({ id: 'test_id' })).toBeUndefined();
-        await expect(() => modelRoot.UpdateModel({
-            id: 'test_id',
-            uri: 'not a real uri',
-            position: { x: 1, y: 2, z: 3 },
-            rotation: { x: 1, y: 2, z: 3 },
-            scale: { x: 1, y: 2, z: 3 },
-        })).not.toThrow();
-        expect(modelRoot.GetModel({ id: 'test_id' })).toBeDefined();
-    });
-
-    it('should delete model', async () => {
-        const modelRoot = new DIVEModelRoot();
-
-        const sceneParent = {
-            parent: null,
-            children: [
-                {
-                    isTransformControls: true,
-                    detach: jest.fn(),
-                }
-            ],
-        }
-        modelRoot.parent = sceneParent as unknown as DIVEScene;
-
-        expect(() => modelRoot.DeleteModel({ id: undefined })).not.toThrow();
-        expect(consoleWarnSpy).toHaveBeenCalled();
-        consoleWarnSpy.mockClear();
-        expect(() => modelRoot.DeleteModel({ id: 'test_id' })).not.toThrow();
-        expect(consoleWarnSpy).toHaveBeenCalled();
-        await expect(() => modelRoot.UpdateModel({
-            id: 'test_id',
-            uri: 'not a real uri',
-            position: { x: 1, y: 2, z: 3 },
-            rotation: { x: 1, y: 2, z: 3 },
-            scale: { x: 1, y: 2, z: 3 },
-        })).not.toThrow();
-        (modelRoot.children[0] as unknown as DIVEMoveable).isMoveable = true;
-        expect(() => modelRoot.DeleteModel({ id: 'test_id' })).not.toThrow();
-        expect(modelRoot.children).toHaveLength(0);
-    });
-});

package/src/scene/root/primitiveroot/PrimitiveRoot.ts

@@ -1,88 +0,0 @@
-import { Object3D } from "three";
-import { DIVEPrimitive } from "../../../primitive/Primitive.ts";
-import type DIVEScene from "../../Scene.ts";
-import { type COMPrimitive } from "../../../com/types";
-import { type TransformControls } from "three/examples/jsm/controls/TransformControls";
-
-/**
- * A basic scene node to hold all primitives.
- *
- * @module
- */
-export class DIVEPrimitiveRoot extends Object3D {
-    constructor() {
-        super();
-        this.name = "PrimitiveRoot";
-    }
-
-    public GetPrimitive(object: Partial<COMPrimitive>): Object3D | undefined {
-        if (object.id === undefined) {
-            console.warn('PrimitiveRoot.GetPrimitive: object.id is undefined')
-            return undefined;
-        }
-        return this.children.find(object3D => object3D.userData.id === object.id);
-    }
-
-    public UpdatePrimitive(object: Partial<COMPrimitive>): void {
-        if (object.id === undefined) {
-            console.warn('PrimitiveRoot.UpdatePrimitive: object.id is undefined')
-            return;
-        }
-
-        let sceneObject = this.children.find(object3D => object3D.userData.id === object.id);
-        if (!sceneObject && object.geometry !== undefined) {
-            const primitive = new DIVEPrimitive();
-            primitive.SetGeometry(object.geometry);
-            sceneObject = primitive;
-            sceneObject.userData.id = object.id;
-            this.add(sceneObject);
-        }
-
-        if (object.position !== undefined) (sceneObject as DIVEPrimitive).SetPosition(object.position);
-        if (object.rotation !== undefined) (sceneObject as DIVEPrimitive).SetRotation(object.rotation);
-        if (object.scale !== undefined) (sceneObject as DIVEPrimitive).SetScale(object.scale);
-        if (object.visible !== undefined) (sceneObject as DIVEPrimitive).SetVisibility(object.visible);
-        if (object.material !== undefined) (sceneObject as DIVEPrimitive).SetMaterial(object.material);
-    }
-
-    public DeletePrimitive(object: Partial<COMPrimitive>): void {
-        if (object.id === undefined) {
-            console.warn(`PrimitiveRoot.DeletePrimitive: object.id is undefined`)
-            return;
-        }
-
-        const sceneObject = this.children.find(object3D => object3D.userData.id === object.id);
-        if (!sceneObject) {
-            console.warn(`PrimitiveRoot.DeletePrimitive: Primitive with id ${object.id} not found`);
-            return;
-        }
-
-        // _______________________________________________________
-        // this is only neccessary due to using the old TransformControls instead of the new DIVEGizmo
-        const findScene = (object: Object3D): DIVEScene => {
-            if (object.parent !== null) {
-                return findScene(object.parent);
-            };
-            return object as DIVEScene;
-        }
-
-        const scene = findScene(sceneObject);
-        scene.children.find((object) => {
-            if ('isTransformControls' in object) {
-                (object as TransformControls).detach();
-            }
-        });
-        // _______________________________________________________
-
-        this.remove(sceneObject);
-    }
-
-    public PlaceOnFloor(object: Partial<COMPrimitive>): void {
-        if (object.id === undefined) console.warn('PrimitiveRoot.PlaceOnFloor: object.id is undefined');
-
-        const sceneObject = this.children.find(object3D => object3D.userData.id === object.id);
-        if (!sceneObject) return;
-
-        (sceneObject as DIVEPrimitive).PlaceOnFloor();
-    }
-}

package/src/scene/root/primitiveroot/__test__/PrimitiveRoot.test.ts

@@ -1,181 +0,0 @@
-import DIVECommunication from '../../../../com/Communication';
-import { DIVEPrimitiveRoot } from '../PrimitiveRoot';
-import type DIVEScene from '../../../Scene';
-import { type DIVEMoveable } from '../../../../interface/Moveable';
-import { type COMMaterial, type COMGeometry } from '../../../../com/types';
-
-const mock_SetPosition = jest.fn();
-const mock_SetRotation = jest.fn();
-const mock_SetScale = jest.fn();
-const mock_PlaceOnFloor = jest.fn();
-const mock_SetGeometry = jest.fn();
-const mock_SetMaterial = jest.fn();
-
-jest.mock('../../../../com/types.ts', () => {
-    return {
-        COMPrimitive: {},
-    }
-});
-
-jest.mock('../../../../com/Communication.ts', () => {
-    return {
-        get: jest.fn(() => {
-            return {
-                PerformAction: jest.fn(),
-            }
-        }),
-    }
-});
-
-jest.mock('../../../../primitive/Primitive.ts', () => {
-    return {
-        DIVEPrimitive: jest.fn(function () {
-            this.isObject3D = true;
-            this.parent = null;
-            this.dispatchEvent = jest.fn();
-            this.userData = {
-                id: undefined,
-            };
-            this.SetGeometry = mock_SetGeometry;
-            this.SetMaterial = mock_SetMaterial;
-            this.SetPosition = mock_SetPosition;
-            this.SetRotation = mock_SetRotation;
-            this.SetScale = mock_SetScale;
-            this.SetVisibility = jest.fn();
-            this.PlaceOnFloor = mock_PlaceOnFloor;
-            this.removeFromParent = jest.fn();
-            return this;
-        })
-    };
-});
-
-jest.spyOn(DIVECommunication, 'get').mockReturnValue({ PerformAction: jest.fn() } as unknown as DIVECommunication);
-
-const consoleWarnSpy = jest.spyOn(console, 'warn').mockImplementation(() => { });
-let primitiveRoot = new DIVEPrimitiveRoot();
-
-describe('dive/scene/root/primitiveroot/DIVEPrimitiveRoot', () => {
-    beforeEach(() => {
-        consoleWarnSpy.mockClear();
-
-        primitiveRoot = new DIVEPrimitiveRoot();
-    });
-
-    it('should instantiate', () => {
-        expect(primitiveRoot).toBeDefined();
-    });
-
-    it('should not add incorrect primitive', async () => {
-        expect(() => primitiveRoot.UpdatePrimitive({ id: undefined })).not.toThrow();
-        expect(consoleWarnSpy).toHaveBeenCalled();
-        expect(primitiveRoot.children).toHaveLength(0);
-    });
-
-    it('should add basic primitive', async () => {
-        expect(() => primitiveRoot.UpdatePrimitive({
-            id: 'test_id',
-            geometry: {} as COMGeometry,
-            visible: false,
-        })).not.toThrow();
-        expect(mock_SetGeometry).toHaveBeenCalledTimes(1);
-        expect(primitiveRoot.children).toHaveLength(1);
-        expect(primitiveRoot.children[0].userData.id).toBe('test_id');
-    });
-
-    it('should add configured primitive', async () => {
-        primitiveRoot.userData.id = 'something';
-        expect(() => primitiveRoot.UpdatePrimitive({
-            id: 'test_id',
-            position: { x: 1, y: 2, z: 3 },
-            rotation: { x: 1, y: 2, z: 3 },
-            scale: { x: 1, y: 2, z: 3 },
-            geometry: {} as COMGeometry,
-            material: {} as COMMaterial,
-        })).not.toThrow();
-
-        jest.spyOn(DIVECommunication, 'get').mockReturnValueOnce(undefined);
-        expect(() => primitiveRoot.UpdatePrimitive({
-            id: 'test_id',
-            position: { x: 1, y: 2, z: 3 },
-            rotation: { x: 1, y: 2, z: 3 },
-            scale: { x: 1, y: 2, z: 3 },
-            geometry: {} as COMGeometry,
-            material: {} as COMMaterial,
-        }
-        )).not.toThrow();
-
-        expect(primitiveRoot.children).toHaveLength(1);
-        expect(mock_SetPosition).toHaveBeenCalledTimes(2);
-        expect(mock_SetRotation).toHaveBeenCalledTimes(2);
-        expect(mock_SetScale).toHaveBeenCalledTimes(2);
-        expect(mock_SetGeometry).toHaveBeenCalledTimes(2);
-        expect(mock_SetMaterial).toHaveBeenCalledTimes(2);
-    });
-
-    it('should not place incorrect primitive on floor', async () => {
-        expect(() => primitiveRoot.PlaceOnFloor({ id: undefined })).not.toThrow();
-        expect(consoleWarnSpy).toHaveBeenCalled();
-        expect(mock_PlaceOnFloor).toHaveBeenCalledTimes(0);
-    });
-
-    it('should not place non-existing primitive on floor', async () => {
-        primitiveRoot.PlaceOnFloor({ id: 'test_id' });
-        expect(mock_PlaceOnFloor).toHaveBeenCalledTimes(0);
-    });
-
-    it('should place primitive on floor', async () => {
-        primitiveRoot.UpdatePrimitive({
-            id: 'test_id',
-            position: { x: 1, y: 2, z: 3 },
-            rotation: { x: 1, y: 2, z: 3 },
-            scale: { x: 1, y: 2, z: 3 },
-            geometry: {} as COMGeometry,
-        });
-        primitiveRoot.PlaceOnFloor({ id: 'test_id' });
-        expect(mock_PlaceOnFloor).toHaveBeenCalledTimes(1);
-    });
-
-    it('should get primitive', async () => {
-        expect(() => primitiveRoot.GetPrimitive({ id: undefined })).not.toThrow();
-        expect(consoleWarnSpy).toHaveBeenCalled();
-        expect(primitiveRoot.GetPrimitive({ id: 'test_id' })).toBeUndefined();
-        expect(() => primitiveRoot.UpdatePrimitive({
-            id: 'test_id',
-            position: { x: 1, y: 2, z: 3 },
-            rotation: { x: 1, y: 2, z: 3 },
-            scale: { x: 1, y: 2, z: 3 },
-            geometry: {} as COMGeometry,
-        })).not.toThrow();
-        expect(primitiveRoot.GetPrimitive({ id: 'test_id' })).toBeDefined();
-    });
-
-    it('should delete primitive', async () => {
-
-        const sceneParent = {
-            parent: null,
-            children: [
-                {
-                    isTransformControls: true,
-                    detach: jest.fn(),
-                }
-            ],
-        }
-        primitiveRoot.parent = sceneParent as unknown as DIVEScene;
-
-        expect(() => primitiveRoot.DeletePrimitive({ id: undefined })).not.toThrow();
-        expect(consoleWarnSpy).toHaveBeenCalled();
-        consoleWarnSpy.mockClear();
-        expect(() => primitiveRoot.DeletePrimitive({ id: 'test_id' })).not.toThrow();
-        expect(consoleWarnSpy).toHaveBeenCalled();
-        expect(() => primitiveRoot.UpdatePrimitive({
-            id: 'test_id',
-            position: { x: 1, y: 2, z: 3 },
-            rotation: { x: 1, y: 2, z: 3 },
-            scale: { x: 1, y: 2, z: 3 },
-            geometry: {} as COMGeometry,
-        })).not.toThrow();
-        (primitiveRoot.children[0] as unknown as DIVEMoveable).isMoveable = true;
-        expect(() => primitiveRoot.DeletePrimitive({ id: 'test_id' })).not.toThrow();
-        expect(primitiveRoot.children).toHaveLength(0);
-    });
-});