@shopware-ag/dive 1.12.0 → 1.13.0

package/build/dive.d.cts

@@ -1,7 +1,9 @@
-import { ShadowMapType, ToneMapping, WebGLRenderer, Scene, Camera, PerspectiveCamera, Box3, Vector3Like, Texture, Mesh, ColorRepresentation, Object3D, Intersection, Vector2, Raycaster, Vector3 } from 'three';
+import { ShadowMapType, ToneMapping, WebGLRenderer, Scene, Camera, PerspectiveCamera, Box3, Vector3Like, Texture, Object3D, Color, Mesh, ColorRepresentation, Intersection, Vector2, Raycaster, Vector3 } from 'three';
 import { OrbitControls } from 'three/examples/jsm/controls/OrbitControls';
 import { Tween } from '@tweenjs/tween.js';
-import { TransformControls } from 'three/examples/jsm/Addons';
+import { TransformControls, GLTF } from 'three/examples/jsm/Addons.js';
+import { TransformControls as TransformControls$1 } from 'three/examples/jsm/controls/TransformControls';
+import { TransformControls as TransformControls$2 } from 'three/examples/jsm/Addons';
 
 type DIVERendererSettings = {
     antialias: boolean;
@@ -202,17 +204,24 @@ interface PLACE_ON_FLOOR {
     'RETURN': boolean;
 }
 
+type COMEntityType = 'pov' | 'light' | 'model' | 'primitive' | 'group';
+
 type COMBaseEntity = {
     id: string;
     name: string;
-    entityType: 'pov' | 'light' | 'model' | 'primitive';
+    entityType: COMEntityType;
     visible: boolean;
+    parent?: Partial<COMBaseEntity> & {
+        id: string;
+    } | null;
 };
+
 type COMPov = COMBaseEntity & {
     position: Vector3Like;
     target: Vector3Like;
     locked?: boolean;
 };
+
 type COMLight = COMBaseEntity & {
     type: 'ambient' | 'point' | 'scene';
     intensity: number;
@@ -220,6 +229,18 @@ type COMLight = COMBaseEntity & {
     enabled: boolean;
     position?: Vector3Like;
 };
+
+type COMMaterial = {
+    vertexColors: boolean;
+    color: string | number;
+    map: Texture | null;
+    normalMap: Texture | null;
+    roughness: number;
+    roughnessMap: Texture | null;
+    metalness: number;
+    metalnessMap: Texture | null;
+};
+
 type COMModel = COMBaseEntity & {
     uri: string;
     position: Vector3Like;
@@ -228,22 +249,14 @@ type COMModel = COMBaseEntity & {
     loaded: boolean;
     material?: Partial<COMMaterial>;
 };
+
 type COMGeometry = {
     name: string;
     width: number;
     height: number;
     depth: number;
 };
-type COMMaterial = {
-    vertexColors: boolean;
-    color: string | number;
-    map: Texture | null;
-    normalMap: Texture | null;
-    roughness: number;
-    roughnessMap: Texture | null;
-    metalness: number;
-    metalnessMap: Texture | null;
-};
+
 type COMPrimitive = COMBaseEntity & {
     position: Vector3Like;
     rotation: Vector3Like;
@@ -251,7 +264,15 @@ type COMPrimitive = COMBaseEntity & {
     geometry: COMGeometry;
     material?: Partial<COMMaterial>;
 };
-type COMEntity = COMPov | COMLight | COMModel | COMPrimitive;
+
+type COMGroup = COMBaseEntity & {
+    position: Vector3Like;
+    rotation: Vector3Like;
+    scale: Vector3Like;
+    bbVisible?: boolean;
+};
+
+type COMEntity = COMPov | COMLight | COMModel | COMPrimitive | COMGroup;
 
 interface GET_ALL_OBJECTS {
     'PAYLOAD': Map<string, COMEntity>;
@@ -379,49 +400,247 @@ interface COMPUTE_ENCOMPASSING_VIEW {
 }
 
 /**
- * A basic floor geometry.
+ * Interface for objects that can be moved in the scene.
  *
- * Can change the color and visibility of the floor.
+ * @module
+ */
+interface DIVEMoveable {
+    isMoveable: true;
+    onMove?: () => void;
+}
+
+/**
+ * Interface for objects that can be selected in the scene.
  *
  * @module
  */
-declare class DIVEFloor extends Mesh {
-    isFloor: true;
+
+interface DIVESelectable {
+    isSelectable: true;
+    onSelect?: () => void;
+    onDeselect?: () => void;
+}
+
+declare class DIVEGroup extends Object3D implements DIVESelectable, DIVEMoveable {
+    readonly isDIVEGroup: true;
+    readonly isSelectable: true;
+    readonly isMoveable: true;
+    private _bb;
+    private _boxMesh;
     constructor();
+    SetPosition(position: Vector3Like): void;
+    SetRotation(rotation: Vector3Like): void;
+    SetScale(scale: Vector3Like): void;
     SetVisibility(visible: boolean): void;
-    SetColor(color: ColorRepresentation): void;
+    SetBoundingBoxVisibility(visible: boolean): void;
+    attach(object: DIVESceneObject): this;
+    remove(object: DIVESceneObject): this;
+    /**
+     * Recalculates the position of the group based on it's bounding box.
+     * Children's world positions are kept.
+     */
+    private recalculatePosition;
+    /**
+     * Updates the bounding box of the group.
+     * @returns {Vector3} The new center of the bounding box.
+     */
+    private updateBB;
+    private updateBoxMesh;
 }
 
 /**
- * A basic grid for the scene.
+ * A basic ambient light.
+ *
+ * Can change the color, intensity, and visibility of the light.
  *
  * @module
  */
-declare class DIVEGrid extends Object3D {
+declare class DIVEAmbientLight extends Object3D {
+    readonly isDIVELight: true;
+    readonly isDIVEAmbientLight: true;
+    private _light;
+    constructor();
+    SetColor(color: Color): void;
+    SetIntensity(intensity: number): void;
+    SetEnabled(enabled: boolean): void;
+}
+
+/**
+ * A basic point light.
+ *
+ * Can change the color, intensity, and visibility of the light.
+ *
+ * Can be moved and selected.
+ *
+ * @module
+ */
+declare class DIVEPointLight extends Object3D implements DIVESelectable, DIVEMoveable {
+    readonly isDIVELight: true;
+    readonly isDIVEPointLight: true;
+    readonly isMoveable: true;
+    readonly isSelectable: true;
+    gizmo: TransformControls | null;
+    private light;
+    private mesh;
+    constructor();
+    SetColor(color: Color): void;
+    SetIntensity(intensity: number): void;
+    SetEnabled(enabled: boolean): void;
+    onMove(): void;
+    onSelect(): void;
+    onDeselect(): void;
+}
+
+/**
+ * A complex scene light.
+ *
+ * Can change the color, intensity, and visibility of the light.
+ *
+ * @module
+ */
+declare class DIVESceneLight extends Object3D {
+    readonly isDIVELight: true;
+    readonly isDIVESceneLight: true;
+    private _hemiLight;
+    private _dirLight;
+    constructor();
+    SetColor(color: Color): void;
+    SetIntensity(intensity: number): void;
+    SetEnabled(enabled: boolean): void;
+}
+
+/**
+ * A basic model class.
+ *
+ * It does calculate it's own bounding box which is used for positioning on the floor.
+ *
+ * Can be moved and selected.
+ *
+ * @module
+ */
+declare class DIVEModel extends Object3D implements DIVESelectable, DIVEMoveable {
+    readonly isDIVEModel: true;
+    readonly isSelectable: true;
+    readonly isMoveable: true;
+    gizmo: TransformControls | null;
+    private boundingBox;
+    private _mesh;
+    private _material;
     constructor();
+    SetModel(gltf: GLTF): void;
+    SetPosition(position: Vector3Like): void;
+    SetRotation(rotation: Vector3Like): void;
+    SetScale(scale: Vector3Like): void;
     SetVisibility(visible: boolean): void;
+    SetMaterial(material: Partial<COMMaterial>): void;
+    SetToWorldOrigin(): void;
+    PlaceOnFloor(): void;
+    DropIt(): void;
+    onMove(): void;
+    onSelect(): void;
+    onDeselect(): void;
 }
 
+/**
+ * A basic model class.
+ *
+ * It does calculate it's own bounding box which is used for positioning on the floor.
+ *
+ * Can be moved and selected.
+ *
+ * @module
+ */
+declare class DIVEPrimitive extends Object3D implements DIVESelectable, DIVEMoveable {
+    readonly isDIVEPrimitive: true;
+    readonly isSelectable: true;
+    readonly isMoveable: true;
+    gizmo: TransformControls$1 | null;
+    private _mesh;
+    private _boundingBox;
+    constructor();
+    SetGeometry(geometry: COMGeometry): void;
+    SetPosition(position: Vector3Like): void;
+    SetRotation(rotation: Vector3Like): void;
+    SetScale(scale: Vector3Like): void;
+    SetVisibility(visible: boolean): void;
+    SetMaterial(material: Partial<COMMaterial>): void;
+    SetToWorldOrigin(): void;
+    PlaceOnFloor(): void;
+    DropIt(): void;
+    onMove(): void;
+    onSelect(): void;
+    onDeselect(): void;
+    private assembleGeometry;
+    private createCylinderGeometry;
+    private createSphereGeometry;
+    private createPyramidGeometry;
+    private createBoxGeometry;
+    private createConeGeometry;
+    private createWallGeometry;
+    private createPlaneGeometry;
+}
+
+type DIVESceneObject = DIVEModel | DIVEGroup | DIVEPrimitive | DIVEAmbientLight | DIVEPointLight | DIVESceneLight;
+
 /**
  * A basic scene node to hold grid, floor and all lower level roots.
  *
  * @module
  */
 declare class DIVERoot extends Object3D {
-    private lightRoot;
-    private modelRoot;
-    private primitiveRoot;
-    private floor;
-    private grid;
-    get Floor(): DIVEFloor;
-    get Grid(): DIVEGrid;
+    readonly isDIVERoot: true;
+    private loadingManager;
     constructor();
     ComputeSceneBB(): Box3;
-    GetSceneObject(object: Partial<COMEntity>): Object3D | undefined;
+    GetSceneObject<T extends DIVESceneObject>(object: Partial<COMEntity> & {
+        id: string;
+    }): T | undefined;
     AddSceneObject(object: COMEntity): void;
-    UpdateSceneObject(object: Partial<COMEntity>): void;
-    DeleteSceneObject(object: Partial<COMEntity>): void;
-    PlaceOnFloor(object: Partial<COMEntity>): void;
+    UpdateSceneObject(object: Partial<COMEntity> & {
+        id: string;
+    }): void;
+    DeleteSceneObject(object: Partial<COMEntity> & {
+        id: string;
+    }): void;
+    PlaceOnFloor(object: Partial<COMEntity> & {
+        id: string;
+    }): void;
+    private updateLight;
+    private updateModel;
+    private updatePrimitive;
+    private updateGroup;
+    private deleteLight;
+    private deleteModel;
+    private deletePrimitive;
+    private deleteGroup;
+    private placeOnFloor;
+    private setParent;
+    private detachTransformControls;
+    private findScene;
+}
+
+/**
+ * A basic grid for the scene.
+ *
+ * @module
+ */
+declare class DIVEGrid extends Object3D {
+    constructor();
+    SetVisibility(visible: boolean): void;
+}
+
+/**
+ * A basic floor geometry.
+ *
+ * Can change the color and visibility of the floor.
+ *
+ * @module
+ */
+declare class DIVEFloor extends Mesh {
+    isFloor: true;
+    constructor();
+    SetVisibility(visible: boolean): void;
+    SetColor(color: ColorRepresentation): void;
 }
 
 /**
@@ -433,15 +652,27 @@ declare class DIVERoot extends Object3D {
  */
 declare class DIVEScene extends Scene {
     private root;
+    private floor;
+    private grid;
     get Root(): DIVERoot;
+    get Floor(): DIVEFloor;
+    get Grid(): DIVEGrid;
     constructor();
     SetBackground(color: ColorRepresentation): void;
     ComputeSceneBB(): Box3;
-    GetSceneObject(object: Partial<COMEntity>): Object3D | undefined;
+    GetSceneObject<T extends DIVESceneObject>(object: Partial<COMEntity> & {
+        id: string;
+    }): T | undefined;
     AddSceneObject(object: COMEntity): void;
-    UpdateSceneObject(object: Partial<COMEntity>): void;
-    DeleteSceneObject(object: Partial<COMEntity>): void;
-    PlaceOnFloor(object: Partial<COMModel>): void;
+    UpdateSceneObject(object: Partial<COMEntity> & {
+        id: string;
+    }): void;
+    DeleteSceneObject(object: Partial<COMEntity> & {
+        id: string;
+    }): void;
+    PlaceOnFloor(object: Partial<COMModel> & {
+        id: string;
+    }): void;
 }
 
 interface DIVEDraggable {
@@ -511,25 +742,13 @@ declare abstract class DIVEBaseTool {
  */
 declare class DIVETransformTool extends DIVEBaseTool {
     readonly isTransformTool: boolean;
-    protected _gizmo: TransformControls;
+    protected _gizmo: TransformControls$2;
     constructor(scene: DIVEScene, controller: DIVEOrbitControls);
     Activate(): void;
     SetGizmoMode(mode: 'translate' | 'rotate' | 'scale'): void;
     SetGizmoVisibility(active: boolean): void;
 }
 
-/**
- * Interface for objects that can be selected in the scene.
- *
- * @module
- */
-
-interface DIVESelectable {
-    isSelectable: true;
-    onSelect?: () => void;
-    onDeselect?: () => void;
-}
-
 /**
  * A Tool to select and move objects in the scene.
  *
@@ -582,6 +801,18 @@ interface USE_TOOL {
     'RETURN': boolean;
 }
 
+interface SET_PARENT {
+    'PAYLOAD': {
+        object: Partial<COMEntity> & {
+            id: string;
+        };
+        parent: Partial<COMEntity> & {
+            id: string;
+        } | null;
+    };
+    'RETURN': boolean;
+}
+
 type Actions = {
     GET_ALL_SCENE_DATA: GET_ALL_SCENE_DATA;
     GET_ALL_OBJECTS: GET_ALL_OBJECTS;
@@ -607,6 +838,7 @@ type Actions = {
     MODEL_LOADED: MODEL_LOADED;
     UPDATE_SCENE: UPDATE_SCENE;
     GENERATE_MEDIA: GENERATE_MEDIA;
+    SET_PARENT: SET_PARENT;
 };
 
 type EventListener<Action extends keyof Actions> = (payload: Actions[Action]['PAYLOAD']) => void;
@@ -672,36 +904,9 @@ declare class DIVECommunication {
     private modelLoaded;
     private updateScene;
     private generateMedia;
+    private setParent;
 }
 
-declare function ceilExp(number: number, decimals?: number): number;
-
-declare function floorExp(number: number, decimals?: number): number;
-
-declare function roundExponential(number: number, decimals?: number): number;
-
-/**
- * Calculate the signed angle between two vectors. Only works when the vectors are on the same plane.
- * @param vecB Start Vector
- * @param vecA Target Vector
- * @param planeNormal The vector's plane normal
- * @returns Signed angle in radians
- */
-declare function signedAngleTo(vecA: Vector3, vecB: Vector3, planeNormal: Vector3): number;
-
-declare function toFixedExp(number: number, decimals?: number): string;
-
-declare function truncateExp(number: number, decimals?: number): number;
-
-declare const DIVEMath: {
-    ceilExp: typeof ceilExp;
-    floorExp: typeof floorExp;
-    roundExp: typeof roundExponential;
-    toFixedExp: typeof toFixedExp;
-    truncateExp: typeof truncateExp;
-    signedAngleTo: typeof signedAngleTo;
-};
-
 declare class DIVEInfo {
     private static _supportsWebXR;
     /**
@@ -731,6 +936,34 @@ declare class DIVEInfo {
     static GetIsARCapable(): Promise<boolean>;
 }
 
+declare function ceilExp(number: number, decimals?: number): number;
+
+declare function floorExp(number: number, decimals?: number): number;
+
+declare function roundExponential(number: number, decimals?: number): number;
+
+/**
+ * Calculate the signed angle between two vectors. Only works when the vectors are on the same plane.
+ * @param vecB Start Vector
+ * @param vecA Target Vector
+ * @param planeNormal The vector's plane normal
+ * @returns Signed angle in radians
+ */
+declare function signedAngleTo(vecA: Vector3, vecB: Vector3, planeNormal: Vector3): number;
+
+declare function toFixedExp(number: number, decimals?: number): string;
+
+declare function truncateExp(number: number, decimals?: number): number;
+
+declare const DIVEMath: {
+    ceilExp: typeof ceilExp;
+    floorExp: typeof floorExp;
+    roundExp: typeof roundExponential;
+    toFixedExp: typeof toFixedExp;
+    truncateExp: typeof truncateExp;
+    signedAngleTo: typeof signedAngleTo;
+};
+
 type DIVESettings = {
     autoResize: boolean;
     displayAxes: boolean;
@@ -786,4 +1019,4 @@ declare class DIVE {
     private removeResizeObserver;
 }
 
-export { type Actions, type COMEntity, type COMLight, type COMModel, type COMPov, DIVE, DIVECommunication, DIVEDefaultSettings, DIVEMath, type DIVESettings, DIVE as default };
+export { type Actions, type COMEntity, type COMEntityType, type COMGeometry, type COMGroup, type COMLight, type COMMaterial, type COMModel, type COMPov, type COMPrimitive, DIVE, DIVECommunication, DIVEDefaultSettings, DIVEMath, type DIVESettings, DIVE as default };