@shopware-ag/dive 1.4.2 → 1.6.0

package/build/dive.d.ts

@@ -1,5 +1,6 @@
-import { ShadowMapType, ToneMapping, WebGLRenderer, Scene, Camera, PerspectiveCamera, Vector3Like, Mesh, ColorRepresentation, Object3D, Intersection, Vector2, Raycaster, Vector3 } from 'three';
+import { ShadowMapType, ToneMapping, WebGLRenderer, Scene, Camera, PerspectiveCamera, Box3, Vector3Like, Mesh, ColorRepresentation, Object3D, Intersection, Vector2, Raycaster, Vector3 } from 'three';
 import { OrbitControls } from 'three/examples/jsm/Addons.js';
+import { TransformControls } from 'three/examples/jsm/Addons';
 
 type DIVERendererSettings = {
     antialias: boolean;
@@ -23,6 +24,7 @@ declare class DIVERenderer extends WebGLRenderer {
     private preRenderCallbacks;
     private postRenderCallbacks;
     constructor(rendererSettings?: DIVERendererSettings);
+    Dispose(): void;
     StartRenderer(scene: Scene, cam: Camera): void;
     PauseRenderer(): void;
     ResumeRenderer(): void;
@@ -104,6 +106,10 @@ declare class DIVEOrbitControls extends OrbitControls {
     object: DIVEPerspectiveCamera;
     domElement: HTMLCanvasElement;
     constructor(camera: DIVEPerspectiveCamera, renderer: DIVERenderer, settings?: DIVEOrbitControlsSettings);
+    ComputeEncompassingView(bb: Box3): {
+        position: Vector3Like;
+        target: Vector3Like;
+    };
     ZoomIn(by?: number): void;
     ZoomOut(by?: number): void;
     MoveTo(pos: Vector3Like | undefined, target: Vector3Like | undefined, duration: number, lock: boolean): void;
@@ -111,95 +117,6 @@ declare class DIVEOrbitControls extends OrbitControls {
     private preRenderCallback;
 }
 
-type COMBaseEntity = {
-    id: string;
-    name: string;
-    entityType: 'pov' | 'light' | 'model';
-    visible: boolean;
-};
-type COMPov = COMBaseEntity & {
-    position: Vector3Like;
-    target: Vector3Like;
-    locked?: boolean;
-};
-type COMLight = COMBaseEntity & {
-    type: 'ambient' | 'point' | 'scene';
-    intensity: number;
-    color: string | number;
-    enabled: boolean;
-    position?: Vector3Like;
-};
-type COMModel = COMBaseEntity & {
-    uri: string;
-    position: Vector3Like;
-    rotation: Vector3Like;
-    scale: Vector3Like;
-    loaded: boolean;
-};
-type COMEntity = COMPov | COMLight | COMModel;
-
-/**
- * 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;
-}
-
-/**
- * A basic grid for the scene.
- *
- * @module
- */
-declare class DIVEGrid extends Object3D {
-    constructor();
-}
-
-/**
- * A basic scene node to hold grid, floor and all lower level roots.
- *
- * @module
- */
-declare class DIVERoot extends Object3D {
-    private lightRoot;
-    private modelRoot;
-    private floor;
-    private grid;
-    get Floor(): DIVEFloor;
-    get Grid(): DIVEGrid;
-    constructor();
-    GetSceneObject(object: Partial<COMEntity>): Object3D | undefined;
-    AddSceneObject(object: COMEntity): void;
-    UpdateSceneObject(object: Partial<COMEntity>): void;
-    DeleteSceneObject(object: Partial<COMEntity>): void;
-    PlaceOnFloor(object: Partial<COMModel>): void;
-}
-
-/**
- * A basic scene class.
- *
- * Comes with a root object that contains all the scene objects.
- *
- * @module
- */
-declare class DIVEScene extends Scene {
-    private root;
-    get Root(): DIVERoot;
-    constructor();
-    SetBackground(color: ColorRepresentation): void;
-    GetSceneObject(object: Partial<COMEntity>): Object3D | undefined;
-    AddSceneObject(object: COMEntity): void;
-    UpdateSceneObject(object: Partial<COMEntity>): void;
-    DeleteSceneObject(object: Partial<COMEntity>): void;
-    PlaceOnFloor(object: Partial<COMModel>): void;
-}
-
 interface SET_BACKGROUND {
     'PAYLOAD': {
         color: string | number;
@@ -265,6 +182,33 @@ interface PLACE_ON_FLOOR {
     'RETURN': boolean;
 }
 
+type COMBaseEntity = {
+    id: string;
+    name: string;
+    entityType: 'pov' | 'light' | 'model';
+    visible: boolean;
+};
+type COMPov = COMBaseEntity & {
+    position: Vector3Like;
+    target: Vector3Like;
+    locked?: boolean;
+};
+type COMLight = COMBaseEntity & {
+    type: 'ambient' | 'point' | 'scene';
+    intensity: number;
+    color: string | number;
+    enabled: boolean;
+    position?: Vector3Like;
+};
+type COMModel = COMBaseEntity & {
+    uri: string;
+    position: Vector3Like;
+    rotation: Vector3Like;
+    scale: Vector3Like;
+    loaded: boolean;
+};
+type COMEntity = COMPov | COMLight | COMModel;
+
 interface GET_ALL_OBJECTS {
     'PAYLOAD': Map<string, COMEntity>;
     'RETURN': Map<string, COMEntity>;
@@ -307,6 +251,7 @@ interface UPDATE_SCENE {
     'PAYLOAD': {
         name?: string;
         backgroundColor?: string | number;
+        gridEnabled?: boolean;
         floorEnabled?: boolean;
         floorColor?: string | number;
     };
@@ -376,6 +321,19 @@ interface DROP_IT {
     'RETURN': boolean;
 }
 
+interface SET_GIZMO_VISIBILITY {
+    'PAYLOAD': boolean;
+    'RETURN': boolean;
+}
+
+interface COMPUTE_ENCOMPASSING_VIEW {
+    'PAYLOAD': object;
+    'RETURN': {
+        position: Vector3Like;
+        target: Vector3Like;
+    };
+}
+
 type Actions = {
     GET_ALL_SCENE_DATA: GET_ALL_SCENE_DATA;
     GET_ALL_OBJECTS: GET_ALL_OBJECTS;
@@ -392,14 +350,81 @@ type Actions = {
     GET_CAMERA_TRANSFORM: GET_CAMERA_TRANSFORM;
     MOVE_CAMERA: MOVE_CAMERA;
     RESET_CAMERA: RESET_CAMERA;
+    COMPUTE_ENCOMPASSING_VIEW: COMPUTE_ENCOMPASSING_VIEW;
     SET_CAMERA_LAYER: SET_CAMERA_LAYER;
     ZOOM_CAMERA: ZOOM_CAMERA;
     SET_GIZMO_MODE: SET_GIZMO_MODE;
+    SET_GIZMO_VISIBILITY: SET_GIZMO_VISIBILITY;
     MODEL_LOADED: MODEL_LOADED;
     UPDATE_SCENE: UPDATE_SCENE;
     GENERATE_MEDIA: GENERATE_MEDIA;
 };
 
+/**
+ * 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;
+}
+
+/**
+ * A basic grid for the scene.
+ *
+ * @module
+ */
+declare class DIVEGrid extends Object3D {
+    constructor();
+    SetVisibility(visible: boolean): void;
+}
+
+/**
+ * A basic scene node to hold grid, floor and all lower level roots.
+ *
+ * @module
+ */
+declare class DIVERoot extends Object3D {
+    private lightRoot;
+    private modelRoot;
+    private floor;
+    private grid;
+    get Floor(): DIVEFloor;
+    get Grid(): DIVEGrid;
+    constructor();
+    ComputeSceneBB(): Box3;
+    GetSceneObject(object: Partial<COMEntity>): Object3D | undefined;
+    AddSceneObject(object: COMEntity): void;
+    UpdateSceneObject(object: Partial<COMEntity>): void;
+    DeleteSceneObject(object: Partial<COMEntity>): void;
+    PlaceOnFloor(object: Partial<COMModel>): void;
+}
+
+/**
+ * A basic scene class.
+ *
+ * Comes with a root object that contains all the scene objects.
+ *
+ * @module
+ */
+declare class DIVEScene extends Scene {
+    private root;
+    get Root(): DIVERoot;
+    constructor();
+    SetBackground(color: ColorRepresentation): void;
+    ComputeSceneBB(): Box3;
+    GetSceneObject(object: Partial<COMEntity>): Object3D | undefined;
+    AddSceneObject(object: COMEntity): void;
+    UpdateSceneObject(object: Partial<COMEntity>): void;
+    DeleteSceneObject(object: Partial<COMEntity>): void;
+    PlaceOnFloor(object: Partial<COMModel>): void;
+}
+
 interface DIVEDraggable {
     isDraggable: true;
     onDragStart?: (e: DraggableEvent) => void;
@@ -458,6 +483,53 @@ declare abstract class DIVEBaseTool {
     private pointerWasDragged;
 }
 
+/**
+ * A Tool to select and move objects in the scene.
+ *
+ * Objects have to implement the DIVESelectable interface to be selectable and DIVEMoveable to be moveable.
+ *
+ * @module
+ */
+declare class DIVETransformTool extends DIVEBaseTool {
+    readonly isTransformTool: boolean;
+    protected _gizmo: TransformControls;
+    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.
+ *
+ * Objects have to implement the DIVESelectable interface to be selectable and DIVEMoveable to be moveable.
+ *
+ * @module
+ */
+declare class DIVESelectTool extends DIVETransformTool {
+    readonly isSelectTool: boolean;
+    constructor(scene: DIVEScene, controller: DIVEOrbitControls);
+    Activate(): void;
+    Select(selectable: DIVESelectable): void;
+    Deselect(selectable: DIVESelectable): void;
+    AttachGizmo(selectable: DIVESelectable): void;
+    DetachGizmo(): void;
+    onClick(e: PointerEvent): void;
+}
+
+type ToolType = 'select' | 'none';
 /**
  * A Toolbox to activate and deactivate tools to use with the pointer.
  *
@@ -465,32 +537,23 @@ declare abstract class DIVEBaseTool {
  */
 declare class DIVEToolbox {
     static readonly DefaultTool = "select";
-    private activeTool;
-    private selectTool;
-    private removeListenersCallback;
+    private _scene;
+    private _controller;
+    private _activeTool;
+    private _selectTool;
+    get selectTool(): DIVESelectTool;
     constructor(scene: DIVEScene, controller: DIVEOrbitControls);
-    dispose(): void;
-    GetActiveTool(): DIVEBaseTool;
-    UseTool(tool: string): void;
+    Dispose(): void;
+    GetActiveTool(): DIVEBaseTool | null;
+    UseTool(tool: ToolType): void;
     SetGizmoMode(mode: 'translate' | 'rotate' | 'scale'): void;
+    SetGizmoVisibility(active: boolean): void;
     onPointerMove(e: PointerEvent): void;
     onPointerDown(e: PointerEvent): void;
     onPointerUp(e: PointerEvent): void;
     onWheel(e: WheelEvent): void;
-}
-
-/**
- * Creates renderings of the current scene
- *
- * @module
- */
-declare class DIVEMediaCreator {
-    private renderer;
-    private scene;
-    private controller;
-    constructor(renderer: DIVERenderer, scene: DIVEScene, controller: DIVEOrbitControls);
-    GenerateMedia(position: Vector3Like, target: Vector3Like, width: number, height: number): string;
-    DrawCanvas(canvasElement?: HTMLCanvasElement): HTMLCanvasElement;
+    private addEventListeners;
+    private removeEventListeners;
 }
 
 type EventListener<Action extends keyof Actions> = (payload: Actions[Action]['PAYLOAD']) => void;
@@ -518,13 +581,15 @@ declare class DIVECommunication {
     private static __instances;
     static get(id: string): DIVECommunication | undefined;
     private id;
+    private renderer;
     private scene;
     private controller;
     private toolbox;
-    private mediaGenerator;
+    private _mediaGenerator;
+    private get mediaGenerator();
     private registered;
     private listeners;
-    constructor(scene: DIVEScene, controls: DIVEOrbitControls, toolbox: DIVEToolbox, mediaGenerator: DIVEMediaCreator);
+    constructor(renderer: DIVERenderer, scene: DIVEScene, controls: DIVEOrbitControls, toolbox: DIVEToolbox);
     DestroyInstance(): boolean;
     PerformAction<Action extends keyof Actions>(action: Action, payload: Actions[Action]['PAYLOAD']): Actions[Action]['RETURN'];
     Subscribe<Action extends keyof Actions>(type: Action, listener: EventListener<Action>): Unsubscribe;
@@ -545,8 +610,10 @@ declare class DIVECommunication {
     private moveCamera;
     private setCameraLayer;
     private resetCamera;
+    private computeEncompassingView;
     private zoomCamera;
     private setGizmoMode;
+    private setGizmoVisibility;
     private modelLoaded;
     private updateScene;
     private generateMedia;
@@ -582,6 +649,7 @@ declare const DIVEMath: {
 
 type DIVESettings = {
     autoResize: boolean;
+    displayAxes: boolean;
     renderer: DIVERendererSettings;
     perspectiveCamera: DIVEPerspectiveCameraSettings;
     orbitControls: DIVEOrbitControlsSettings;
@@ -610,6 +678,7 @@ declare const DIVEDefaultSettings: DIVESettings;
  * @module
  */
 declare class DIVE {
+    static QuickView(uri: string): DIVE;
     private _settings;
     private _resizeObserverId;
     private _width;
@@ -618,7 +687,6 @@ declare class DIVE {
     private scene;
     private perspectiveCamera;
     private orbitControls;
-    private mediaCreator;
     private toolbox;
     private communication;
     private animationSystem;
@@ -627,6 +695,7 @@ declare class DIVE {
     get Canvas(): HTMLCanvasElement;
     set Settings(settings: Partial<DIVESettings>);
     constructor(settings?: Partial<DIVESettings>);
+    Dispose(): void;
     OnResize(width: number, height: number): void;
     private addResizeObserver;
     private removeResizeObserver;