@shopware-ag/dive 1.12.1 → 1.14.0

package/src/toolbox/BaseTool.ts

@@ -1,6 +1,6 @@
 import { Intersection, Object3D, Raycaster, Vector2, Vector3 } from "three";
 import { PRODUCT_LAYER_MASK, UI_LAYER_MASK } from "../constant/VisibilityLayerMask";
-import DIVEScene from "../scene/Scene";
+import { DIVEScene } from "../scene/Scene";
 import DIVEOrbitControls from "../controls/OrbitControls";
 import { DIVEDraggable, findDraggableInterface } from "../interface/Draggable";
 import { DIVEHoverable, findHoverableInterface } from "../interface/Hoverable";

package/src/toolbox/Toolbox.ts

@@ -1,5 +1,5 @@
 import type DIVEOrbitControls from "../controls/OrbitControls.ts";
-import type DIVEScene from "../scene/Scene.ts";
+import type { DIVEScene } from "../scene/Scene.ts";
 import { type DIVEBaseTool } from "./BaseTool.ts";
 import { type DIVESelectTool } from "./select/SelectTool.ts";
 

package/src/toolbox/__test__/BaseTool.test.ts

@@ -1,7 +1,7 @@
 
 import { DIVEBaseTool } from '../BaseTool';
 import type DIVEOrbitControls from '../../controls/OrbitControls';
-import type DIVEScene from '../../scene/Scene';
+import type { DIVEScene } from '../../scene/Scene';
 import { type Object3D, type Vector3 } from 'three';
 import { type DIVEHoverable } from '../../interface/Hoverable';
 import { type DIVEDraggable } from '../../interface/Draggable';

package/src/toolbox/__test__/Toolbox.test.ts

@@ -1,6 +1,6 @@
 import DIVEToolbox, { type ToolType } from '../Toolbox';
 import type DIVEOrbitControls from '../../controls/OrbitControls';
-import type DIVEScene from '../../scene/Scene';
+import type { DIVEScene } from '../../scene/Scene';
 
 /**
  * @jest-environment jsdom

package/src/toolbox/select/SelectTool.ts

@@ -1,5 +1,5 @@
 import { type Object3D } from "three";
-import DIVEScene from "../../scene/Scene.ts";
+import { DIVEScene } from "../../scene/Scene.ts";
 import DIVETransformTool from "../transform/TransformTool.ts";
 import type DIVEOrbitControls from "../../controls/OrbitControls.ts";
 import { type DIVESelectable, findSelectableInterface } from "../../interface/Selectable.ts";

package/src/toolbox/select/__test__/SelectTool.test.ts

@@ -1,5 +1,5 @@
 import { DIVESelectTool, isSelectTool } from '../SelectTool';
-import DIVEScene from '../../../scene/Scene';
+import { DIVEScene } from '../../../scene/Scene';
 import DIVEOrbitControls from '../../../controls/OrbitControls';
 import { DIVERenderer, DIVERendererDefaultSettings } from '../../../renderer/Renderer';
 import { DIVESelectable } from '../../../interface/Selectable';
@@ -65,14 +65,16 @@ jest.mock('../../../animation/AnimationSystem', () => {
 });
 
 jest.mock('../../../scene/Scene', () => {
-    return jest.fn(function () {
-        this.add = jest.fn();
-        this.children = [];
-        this.Root = {
-            children: [],
-        }
-        return this;
-    });
+    return {
+        DIVEScene: jest.fn(function () {
+            this.add = jest.fn();
+            this.children = [];
+            this.Root = {
+                children: [],
+            }
+            return this;
+        })
+    };
 });
 
 const mock_intersectObjects = jest.fn().mockReturnValue([]);

package/src/toolbox/transform/TransformTool.ts

@@ -1,5 +1,5 @@
 import { DIVEBaseTool } from "../BaseTool.ts";
-import DIVEScene from "../../scene/Scene.ts";
+import { DIVEScene } from "../../scene/Scene.ts";
 import DIVEOrbitControls from "../../controls/OrbitControls.ts";
 import { TransformControls } from "three/examples/jsm/Addons";
 import { type DIVEMoveable } from "../../interface/Moveable.ts";

package/src/toolbox/transform/__test__/TransformTool.test.ts

@@ -1,5 +1,5 @@
 import DIVETransformTool, { isTransformTool } from '../TransformTool';
-import DIVEScene from '../../../scene/Scene';
+import { DIVEScene } from '../../../scene/Scene';
 import DIVEOrbitControls from '../../../controls/OrbitControls';
 import DIVEPerspectiveCamera from '../../../camera/PerspectiveCamera';
 import { DIVERenderer } from '../../../renderer/Renderer';
@@ -47,15 +47,17 @@ jest.mock('../../../controls/OrbitControls', () => {
 });
 
 jest.mock('../../../scene/Scene', () => {
-    return jest.fn(function () {
-        this.add = jest.fn();
-        this.remove = jest.fn();
-        this.Root = {
-            children: [],
-        }
-        this.children = [];
-        return this;
-    });
+    return {
+        DIVEScene: jest.fn(function () {
+            this.add = jest.fn();
+            this.remove = jest.fn();
+            this.Root = {
+                children: [],
+            }
+            this.children = [];
+            return this;
+        })
+    };
 });
 
 jest.mock('../../../animation/AnimationSystem', () => {

package/src/types/SceneObjects.ts

@@ -0,0 +1,14 @@
+import { DIVEGroup } from "../group/Group";
+import DIVEAmbientLight from "../light/AmbientLight";
+import DIVEPointLight from "../light/PointLight";
+import DIVESceneLight from "../light/SceneLight";
+import { DIVEModel } from "../model/Model";
+import { DIVEPrimitive } from "../primitive/Primitive";
+
+export type DIVESceneObject =
+    DIVEModel
+    | DIVEGroup
+    | DIVEPrimitive
+    | DIVEAmbientLight
+    | DIVEPointLight
+    | DIVESceneLight;

package/src/types/index.ts

@@ -0,0 +1,5 @@
+import { type DIVESceneObject } from "./SceneObjects";
+
+export {
+    type DIVESceneObject,
+}

package/src/com/index.ts

@@ -1,3 +0,0 @@
-import DIVECommunication from './Communication.ts';
-export type { Actions } from './actions/index.ts';
-export default DIVECommunication;

package/src/com/types.ts

@@ -1,58 +0,0 @@
-import { type Texture, type Vector3Like } from "three";
-
-type COMBaseEntity = {
-    id: string;
-    name: string;
-    entityType: 'pov' | 'light' | 'model' | 'primitive';
-    visible: boolean;
-}
-export type COMPov = COMBaseEntity & {
-    position: Vector3Like;
-    target: Vector3Like;
-    locked?: boolean;
-};
-
-export type COMLight = COMBaseEntity & {
-    type: 'ambient' | 'point' | 'scene';
-    intensity: number;
-    color: string | number;
-    enabled: boolean;
-    position?: Vector3Like;
-};
-
-export type COMModel = COMBaseEntity & {
-    uri: string;
-    position: Vector3Like;
-    rotation: Vector3Like;
-    scale: Vector3Like;
-    loaded: boolean;
-    material?: Partial<COMMaterial>;
-};
-
-export type COMGeometry = {
-    name: string
-    width: number;
-    height: number;
-    depth: number;
-}
-
-export type COMMaterial = {
-    vertexColors: boolean;
-    color: string | number;
-    map: Texture | null;
-    normalMap: Texture | null;
-    roughness: number;
-    roughnessMap: Texture | null;
-    metalness: number;
-    metalnessMap: Texture | null;
-}
-
-export type COMPrimitive = COMBaseEntity & {
-    position: Vector3Like;
-    rotation: Vector3Like;
-    scale: Vector3Like;
-    geometry: COMGeometry;
-    material?: Partial<COMMaterial>;
-};
-
-export type COMEntity = COMPov | COMLight | COMModel | COMPrimitive;

package/src/scene/root/lightroot/LightRoot.ts

@@ -1,99 +0,0 @@
-import { Color, Object3D } from "three";
-import { type COMLight } from "../../../com/types.ts";
-import DIVEAmbientLight from "../../../light/AmbientLight.ts";
-import DIVEPointLight from "../../../light/PointLight.ts";
-import DIVESceneLight from "../../../light/SceneLight.ts";
-import { type TransformControls } from "three/examples/jsm/Addons";
-import type DIVEScene from "../../Scene.ts";
-
-/**
- * A basic scene node to hold all lights.
- *
- * @module
- */
-
-export default class DIVELightRoot extends Object3D {
-    constructor() {
-        super();
-        this.name = "LightRoot";
-    }
-
-    public GetLight(object: Partial<COMLight>): Object3D | undefined {
-        if (object.id === undefined) {
-            console.warn('LightRoot.GetLight: object.id is undefined')
-            return undefined;
-        }
-        return this.children.find(object3D => object3D.userData.id === object.id);
-    }
-
-    public UpdateLight(light: Partial<COMLight>): void {
-        // update scene here for light
-        if (light.id === undefined) {
-            console.warn(`LightRoot.UpdateLight: light.id is undefined`)
-            return;
-        }
-
-        let sceneObject = this.children.find(object3D => object3D.userData.id === light.id);
-        if (!sceneObject) {
-            switch (light.type) {
-                case 'scene': {
-                    sceneObject = new DIVESceneLight();
-                    break;
-                }
-                case 'ambient': {
-                    sceneObject = new DIVEAmbientLight();
-                    break;
-                }
-                case 'point': {
-                    sceneObject = new DIVEPointLight();
-                    break;
-                }
-                default: {
-                    console.warn(`LightRoot.UpdateLight: Unknown light type: ${light.type}`);
-                    return;
-                }
-            }
-            sceneObject.userData.id = light.id;
-            this.add(sceneObject);
-        }
-
-        if (light.name !== undefined && light.name !== null) sceneObject.name = light.name;
-        if (light.position !== undefined && light.position !== null) sceneObject.position.set(light.position.x, light.position.y, light.position.z);
-        if (light.intensity !== undefined && light.intensity !== null) (sceneObject as (DIVEAmbientLight | DIVEPointLight)).SetIntensity(light.intensity);
-        if (light.enabled !== undefined && light.enabled !== null) (sceneObject as (DIVEAmbientLight | DIVEPointLight)).SetEnabled(light.enabled);
-        if (light.color !== undefined && light.color !== null) (sceneObject as (DIVEAmbientLight | DIVEPointLight)).SetColor(new Color(light.color));
-        if (light.visible !== undefined && light.visible !== null) (sceneObject as (DIVEAmbientLight | DIVEPointLight)).visible = light.visible;
-    }
-
-    public DeleteLight(light: Partial<COMLight>): void {
-        if (light.id === undefined) {
-            console.warn('LightRoot.DeleteLight: light.id is undefined')
-            return;
-        }
-
-        const sceneObject = this.children.find(object3D => object3D.userData.id === light.id);
-        if (!sceneObject) {
-            console.warn(`LightRoot.DeleteLight: Light with id ${light.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);
-    }
-}

package/src/scene/root/lightroot/__test__/LightRoot.test.ts

@@ -1,145 +0,0 @@
-import DIVELightRoot from '../LightRoot';
-import type DIVEScene from '../../../Scene';
-import { type COMLight } from '../../../../com/types';
-import { type DIVEMoveable } from '../../../../interface/Moveable';
-
-const mock_SetPosition = jest.fn();
-const mock_SetIntensity = jest.fn();
-const mock_SetEnabled = jest.fn();
-const mock_SetColor = jest.fn();
-
-jest.mock('../../../../light/AmbientLight.ts', () => {
-    return jest.fn(function () {
-        this.isObject3D = true;
-        this.parent = null;
-        this.dispatchEvent = jest.fn();
-        this.position = {
-            set: mock_SetPosition,
-        }
-        this.SetIntensity = mock_SetIntensity;
-        this.SetEnabled = mock_SetEnabled;
-        this.SetColor = mock_SetColor;
-        this.userData = {
-            id: undefined,
-        }
-        this.removeFromParent = jest.fn();
-        return this;
-    });
-});
-
-jest.mock('../../../../light/PointLight.ts', () => {
-    return jest.fn(function () {
-        this.isObject3D = true;
-        this.parent = null;
-        this.dispatchEvent = jest.fn();
-        this.position = {
-            set: mock_SetPosition,
-        }
-        this.SetIntensity = mock_SetIntensity;
-        this.SetEnabled = mock_SetEnabled;
-        this.SetColor = mock_SetColor;
-        this.userData = {
-            id: undefined,
-        }
-        this.removeFromParent = jest.fn();
-        return this;
-    });
-});
-
-const consoleWarnSpy = jest.spyOn(console, 'warn').mockImplementation(() => { });
-
-describe('dive/scene/root/lightroot/DIVELightRoot', () => {
-    beforeEach(() => {
-        consoleWarnSpy.mockClear();
-    });
-
-    it('should instantiate', () => {
-        const lightRoot = new DIVELightRoot();
-        expect(lightRoot).toBeDefined();
-    });
-
-    it('should not add incorrect light without id', () => {
-        const lightRoot = new DIVELightRoot();
-        expect(() => lightRoot.UpdateLight({ id: undefined })).not.toThrow();
-        expect(consoleWarnSpy).toHaveBeenCalled();
-        expect(lightRoot.children).toHaveLength(0);
-    });
-
-    it('should not add incorrect light', () => {
-        const lightRoot = new DIVELightRoot();
-        expect(() => lightRoot.UpdateLight(({ id: 'test_id', name: 'test', type: 'this not a real light type' }) as unknown as COMLight)).not.toThrow();
-        expect(consoleWarnSpy).toHaveBeenCalled();
-        expect(lightRoot.children).toHaveLength(0);
-    });
-
-    it('should update basic scene light', () => {
-        const lightRoot = new DIVELightRoot();
-        lightRoot.UpdateLight({ id: 'test_id', type: 'scene', name: 'test', position: undefined, enabled: true, visible: false });
-        expect(lightRoot.children).toHaveLength(1);
-        expect(lightRoot.children[0].userData.id).toBe('test_id');
-    });
-
-    it('should update basic ambient light', () => {
-        const lightRoot = new DIVELightRoot();
-        lightRoot.UpdateLight({ id: 'test_id', type: 'ambient', position: undefined });
-        expect(lightRoot.children).toHaveLength(1);
-        expect(lightRoot.children[0].userData.id).toBe('test_id');
-    });
-
-    it('should update basic point light', () => {
-        const lightRoot = new DIVELightRoot();
-        lightRoot.UpdateLight({ id: 'test_id', type: 'point', position: undefined });
-        expect(lightRoot.children).toHaveLength(1);
-        expect(lightRoot.children[0].userData.id).toBe('test_id');
-    });
-
-    it('should update configured light', () => {
-        const lightRoot = new DIVELightRoot();
-        lightRoot.UpdateLight({ id: 'test_id', type: 'point', position: { x: 1, y: 2, z: 3 }, intensity: 0.5, color: 0x123456 });
-        expect(consoleWarnSpy).not.toHaveBeenCalled();
-        expect(lightRoot.children).toHaveLength(1);
-        expect(lightRoot.children[0].userData.id).toBe('test_id');
-        expect(mock_SetIntensity).toHaveBeenCalledTimes(1);
-        expect(mock_SetColor).toHaveBeenCalledTimes(1);
-        expect(mock_SetPosition).toHaveBeenCalledTimes(1);
-    });
-
-    it('should get light', () => {
-        const lightRoot = new DIVELightRoot();
-        expect(() => lightRoot.GetLight({ id: undefined })).not.toThrow();
-        expect(lightRoot.GetLight({ id: 'test_id' })).toBeUndefined();
-        lightRoot.UpdateLight({ id: 'test_id', type: 'point', position: { x: 1, y: 2, z: 3 }, intensity: 0.5, color: 0x123456 });
-        expect(consoleWarnSpy).toHaveBeenCalled();
-        expect(lightRoot.GetLight({ id: 'test_id' })).toBeDefined();
-    });
-
-    it('should delete light', () => {
-        const lightRoot = new DIVELightRoot();
-
-        const sceneParent = {
-            parent: null,
-            children: [
-                {
-                    isTransformControls: true,
-                    detach: jest.fn(),
-                }
-            ],
-        }
-        lightRoot.parent = sceneParent as unknown as DIVEScene;
-        expect(() => lightRoot.DeleteLight({ id: undefined })).not.toThrow();
-
-        expect(() => lightRoot.DeleteLight({ id: 'test_id' })).not.toThrow();
-
-        lightRoot.UpdateLight({ id: 'test_id', type: 'point', position: { x: 1, y: 2, z: 3 }, intensity: 0.5, color: 0x123456 });
-        expect(() => lightRoot.DeleteLight({ id: 'test_id' })).not.toThrow();
-
-        lightRoot.UpdateLight({ id: 'test_id', type: 'point', position: { x: 1, y: 2, z: 3 }, intensity: 0.5, color: 0x123456 });
-        (lightRoot.children[0] as unknown as DIVEMoveable).isMoveable = true;
-        expect(() => lightRoot.DeleteLight({ id: 'test_id' })).not.toThrow();
-
-        lightRoot.UpdateLight({ id: 'test_id', type: 'point', position: { x: 1, y: 2, z: 3 }, intensity: 0.5, color: 0x123456 });
-        (lightRoot.children[0] as unknown as DIVEMoveable).isMoveable = true;
-        expect(() => lightRoot.DeleteLight({ id: 'test_id' })).not.toThrow();
-        expect(lightRoot.children).toHaveLength(0);
-    });
-});

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

@@ -1,98 +0,0 @@
-import { Object3D } from "three";
-import { COMModel } from "../../../com/types.ts";
-import Model from "../../../model/Model.ts";
-import DIVELoadingManager from "../../../loadingmanager/LoadingManager.ts";
-import DIVECommunication from "../../../com/Communication.ts";
-import { type TransformControls } from "three/examples/jsm/Addons";
-import type DIVEScene from "../../Scene.ts";
-
-/**
- * A basic scene node to hold all models.
- *
- * @module
- */
-export default class DIVEModelRoot extends Object3D {
-    private loadingManager: DIVELoadingManager;
-
-    constructor() {
-        super();
-        this.name = "ModelRoot";
-
-        this.loadingManager = new DIVELoadingManager();
-    }
-
-    public GetModel(object: Partial<COMModel>): Object3D | undefined {
-        if (object.id === undefined) {
-            console.warn('ModelRoot.GetModel: object.id is undefined')
-            return undefined;
-        }
-        return this.children.find(object3D => object3D.userData.id === object.id);
-    }
-
-    public UpdateModel(object: Partial<COMModel>): void {
-        if (object.id === undefined) {
-            console.warn('ModelRoot.UpdateModel: object.id is undefined')
-            return;
-        }
-
-        let sceneObject = this.children.find(object3D => object3D.userData.id === object.id);
-        if (!sceneObject && object.uri !== undefined) {
-            const model = new Model();
-            sceneObject = model;
-            sceneObject.userData.id = object.id;
-            this.add(sceneObject);
-
-            this.loadingManager.LoadGLTF(object.uri).then((gltf) => {
-                model.SetModel(gltf);
-                DIVECommunication.get(object.id!)?.PerformAction('MODEL_LOADED', { id: object.id! });
-            });
-        }
-
-        if (object.position !== undefined) (sceneObject as Model).SetPosition(object.position);
-        if (object.rotation !== undefined) (sceneObject as Model).SetRotation(object.rotation);
-        if (object.scale !== undefined) (sceneObject as Model).SetScale(object.scale);
-        if (object.visible !== undefined) (sceneObject as Model).SetVisibility(object.visible);
-        if (object.material !== undefined) (sceneObject as Model).SetMaterial(object.material);
-    }
-
-    public DeleteModel(object: Partial<COMModel>): void {
-        if (object.id === undefined) {
-            console.warn(`ModelRoot.DeleteModel: object.id is undefined`)
-            return;
-        }
-
-        const sceneObject = this.children.find(object3D => object3D.userData.id === object.id);
-        if (!sceneObject) {
-            console.warn(`ModelRoot.DeleteModel: Model 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<COMModel>): void {
-        if (object.id === undefined) console.warn('ModelRoot.PlaceOnFloor: object.id is undefined');
-
-        const sceneObject = this.children.find(object3D => object3D.userData.id === object.id);
-        if (!sceneObject) return;
-
-        (sceneObject as Model).PlaceOnFloor();
-    }
-}