@shopware-ag/dive 1.16.25 → 1.16.26-beta.1

package/build/dive.d.cts

@@ -3,7 +3,6 @@ import { OrbitControls } from 'three/examples/jsm/controls/OrbitControls';
 import { Tween } from '@tweenjs/tween.js';
 import { TransformControls } from 'three/examples/jsm/controls/TransformControls';
 import { TransformControls as TransformControls$1, GLTF } from 'three/examples/jsm/Addons.js';
-import { TransformControls as TransformControls$2 } from 'three/examples/jsm/Addons';
 import { GLTF as GLTF$1 } from 'three/examples/jsm/loaders/GLTFLoader';
 
 type DIVERendererSettings = {
@@ -15,6 +14,7 @@ type DIVERendererSettings = {
     toneMapping: ToneMapping;
     canvas?: HTMLCanvasElement;
 };
+type DIVERenderCallback = (time: DOMHighResTimeStamp, frame: XRFrame) => void;
 /**
  * A changed version of the WebGLRenderer.
  *
@@ -40,7 +40,7 @@ declare class DIVERenderer extends WebGLRenderer {
      * @param callback Executed before rendering.
      * @returns uuid to remove the callback.
      */
-    AddPreRenderCallback(callback: () => void): string;
+    AddPreRenderCallback(callback: DIVERenderCallback): string;
     /**
      * Removes a callback from the render loop before actual render call.
      * @param uuid of callback to remove.
@@ -52,7 +52,7 @@ declare class DIVERenderer extends WebGLRenderer {
      * @param callback Executed after rendering.
      * @returns uuid to remove the callback.
      */
-    AddPostRenderCallback(callback: () => void): string;
+    AddPostRenderCallback(callback: DIVERenderCallback): string;
     /**
      * Removes a callback from the render loop after actual render call.
      * @param uuid of callback to remove.
@@ -669,6 +669,30 @@ declare class DIVEFloor extends Mesh {
     SetColor(color: ColorRepresentation): void;
 }
 
+declare class DIVEXRLightRoot extends Object3D {
+    private _scene;
+    private _xrLight;
+    private _lightRoot;
+    constructor(scene: DIVEScene);
+    InitLightEstimation(renderer: DIVERenderer): void;
+    DisposeLightEstimation(): void;
+    private onEstimationStart;
+    private onEstimationEnd;
+}
+
+declare class DIVEXRRoot extends Object3D {
+    private _xrLightRoot;
+    private _xrModelRoot;
+    private _xrHandNode;
+    get XRModelRoot(): DIVERoot;
+    get XRLightRoot(): DIVEXRLightRoot;
+    get XRHandNode(): Object3D;
+    private _xrShadowPlane;
+    constructor(scene: DIVEScene);
+    InitLightEstimation(renderer: DIVERenderer): void;
+    DisposeLightEstimation(): void;
+}
+
 /**
  * A basic scene class.
  *
@@ -677,13 +701,17 @@ declare class DIVEFloor extends Mesh {
  * @module
  */
 declare class DIVEScene extends Scene {
-    private root;
-    private floor;
-    private grid;
+    private _root;
+    private _floor;
+    private _grid;
     get Root(): DIVERoot;
+    private _xrRoot;
+    get XRRoot(): DIVEXRRoot;
     get Floor(): DIVEFloor;
     get Grid(): DIVEGrid;
     constructor();
+    InitXR(renderer: DIVERenderer): void;
+    DisposeXR(): void;
     SetBackground(color: ColorRepresentation): void;
     ComputeSceneBB(): Box3;
     GetSceneObject<T extends DIVESceneObject>(object: Partial<COMEntity> & {
@@ -783,7 +811,7 @@ declare abstract class DIVEBaseTool {
  */
 declare class DIVETransformTool extends DIVEBaseTool {
     readonly isTransformTool: boolean;
-    protected _gizmo: TransformControls$2;
+    protected _gizmo: TransformControls;
     constructor(scene: DIVEScene, controller: DIVEOrbitControls);
     Activate(): void;
     SetGizmoMode(mode: 'translate' | 'rotate' | 'scale'): void;
@@ -891,6 +919,7 @@ interface Actions {
     GENERATE_MEDIA: GENERATE_MEDIA;
     SET_PARENT: SET_PARENT;
     EXPORT_SCENE: EXPORT_SCENE;
+    LAUNCH_AR: any;
 }
 
 type EventListener<Action extends keyof Actions> = (payload: Actions[Action]['PAYLOAD']) => void;
@@ -927,6 +956,8 @@ declare class DIVECommunication {
     private get mediaGenerator();
     private _io;
     private get io();
+    private _ar;
+    private get ar();
     private registered;
     private listeners;
     constructor(renderer: DIVERenderer, scene: DIVEScene, controls: DIVEOrbitControls, toolbox: DIVEToolbox);
@@ -962,8 +993,15 @@ declare class DIVECommunication {
     private exportScene;
 }
 
+declare enum WebXRUnsupportedReason {
+    'UNKNWON_ERROR' = 0,
+    'NO_HTTPS' = 1,
+    'IMMERSIVE_AR_NOT_SUPPORTED_BY_DEVICE' = 2,
+    'AR_SESSION_NOT_ALLOWED' = 3
+}
 declare class DIVEInfo {
     private static _supportsWebXR;
+    private static _webXRUnsupportedReason;
     /**
      *
      * @returns The system the user is using. Possible values are "Android", "iOS", "Windows", "MacOS", "Linux" or "Unknown".
@@ -973,6 +1011,10 @@ declare class DIVEInfo {
      * @returns A promise that resolves to a boolean indicating whether the user's device supports WebXR.
      */
     static GetSupportsWebXR(): Promise<boolean>;
+    /**
+     * @returns The reason why WebXR is not supported on the user's device. Returns null if WebXR is supported nor not has been checked yet.
+     */
+    static GetWebXRUnsupportedReason(): WebXRUnsupportedReason | null;
     /**
      * @returns A boolean indicating whether the user's device supports AR Quick Look.
      */
@@ -1056,7 +1098,7 @@ declare const DIVEDefaultSettings: DIVESettings;
  * @module
  */
 declare class DIVE {
-    static QuickView(uri: string): DIVE;
+    static QuickView(uri: string, settings?: Partial<DIVESettings>): DIVE;
     private _settings;
     private _resizeObserverId;
     private _width;

package/build/dive.d.ts

@@ -3,7 +3,6 @@ import { OrbitControls } from 'three/examples/jsm/controls/OrbitControls';
 import { Tween } from '@tweenjs/tween.js';
 import { TransformControls } from 'three/examples/jsm/controls/TransformControls';
 import { TransformControls as TransformControls$1, GLTF } from 'three/examples/jsm/Addons.js';
-import { TransformControls as TransformControls$2 } from 'three/examples/jsm/Addons';
 import { GLTF as GLTF$1 } from 'three/examples/jsm/loaders/GLTFLoader';
 
 type DIVERendererSettings = {
@@ -15,6 +14,7 @@ type DIVERendererSettings = {
     toneMapping: ToneMapping;
     canvas?: HTMLCanvasElement;
 };
+type DIVERenderCallback = (time: DOMHighResTimeStamp, frame: XRFrame) => void;
 /**
  * A changed version of the WebGLRenderer.
  *
@@ -40,7 +40,7 @@ declare class DIVERenderer extends WebGLRenderer {
      * @param callback Executed before rendering.
      * @returns uuid to remove the callback.
      */
-    AddPreRenderCallback(callback: () => void): string;
+    AddPreRenderCallback(callback: DIVERenderCallback): string;
     /**
      * Removes a callback from the render loop before actual render call.
      * @param uuid of callback to remove.
@@ -52,7 +52,7 @@ declare class DIVERenderer extends WebGLRenderer {
      * @param callback Executed after rendering.
      * @returns uuid to remove the callback.
      */
-    AddPostRenderCallback(callback: () => void): string;
+    AddPostRenderCallback(callback: DIVERenderCallback): string;
     /**
      * Removes a callback from the render loop after actual render call.
      * @param uuid of callback to remove.
@@ -669,6 +669,30 @@ declare class DIVEFloor extends Mesh {
     SetColor(color: ColorRepresentation): void;
 }
 
+declare class DIVEXRLightRoot extends Object3D {
+    private _scene;
+    private _xrLight;
+    private _lightRoot;
+    constructor(scene: DIVEScene);
+    InitLightEstimation(renderer: DIVERenderer): void;
+    DisposeLightEstimation(): void;
+    private onEstimationStart;
+    private onEstimationEnd;
+}
+
+declare class DIVEXRRoot extends Object3D {
+    private _xrLightRoot;
+    private _xrModelRoot;
+    private _xrHandNode;
+    get XRModelRoot(): DIVERoot;
+    get XRLightRoot(): DIVEXRLightRoot;
+    get XRHandNode(): Object3D;
+    private _xrShadowPlane;
+    constructor(scene: DIVEScene);
+    InitLightEstimation(renderer: DIVERenderer): void;
+    DisposeLightEstimation(): void;
+}
+
 /**
  * A basic scene class.
  *
@@ -677,13 +701,17 @@ declare class DIVEFloor extends Mesh {
  * @module
  */
 declare class DIVEScene extends Scene {
-    private root;
-    private floor;
-    private grid;
+    private _root;
+    private _floor;
+    private _grid;
     get Root(): DIVERoot;
+    private _xrRoot;
+    get XRRoot(): DIVEXRRoot;
     get Floor(): DIVEFloor;
     get Grid(): DIVEGrid;
     constructor();
+    InitXR(renderer: DIVERenderer): void;
+    DisposeXR(): void;
     SetBackground(color: ColorRepresentation): void;
     ComputeSceneBB(): Box3;
     GetSceneObject<T extends DIVESceneObject>(object: Partial<COMEntity> & {
@@ -783,7 +811,7 @@ declare abstract class DIVEBaseTool {
  */
 declare class DIVETransformTool extends DIVEBaseTool {
     readonly isTransformTool: boolean;
-    protected _gizmo: TransformControls$2;
+    protected _gizmo: TransformControls;
     constructor(scene: DIVEScene, controller: DIVEOrbitControls);
     Activate(): void;
     SetGizmoMode(mode: 'translate' | 'rotate' | 'scale'): void;
@@ -891,6 +919,7 @@ interface Actions {
     GENERATE_MEDIA: GENERATE_MEDIA;
     SET_PARENT: SET_PARENT;
     EXPORT_SCENE: EXPORT_SCENE;
+    LAUNCH_AR: any;
 }
 
 type EventListener<Action extends keyof Actions> = (payload: Actions[Action]['PAYLOAD']) => void;
@@ -927,6 +956,8 @@ declare class DIVECommunication {
     private get mediaGenerator();
     private _io;
     private get io();
+    private _ar;
+    private get ar();
     private registered;
     private listeners;
     constructor(renderer: DIVERenderer, scene: DIVEScene, controls: DIVEOrbitControls, toolbox: DIVEToolbox);
@@ -962,8 +993,15 @@ declare class DIVECommunication {
     private exportScene;
 }
 
+declare enum WebXRUnsupportedReason {
+    'UNKNWON_ERROR' = 0,
+    'NO_HTTPS' = 1,
+    'IMMERSIVE_AR_NOT_SUPPORTED_BY_DEVICE' = 2,
+    'AR_SESSION_NOT_ALLOWED' = 3
+}
 declare class DIVEInfo {
     private static _supportsWebXR;
+    private static _webXRUnsupportedReason;
     /**
      *
      * @returns The system the user is using. Possible values are "Android", "iOS", "Windows", "MacOS", "Linux" or "Unknown".
@@ -973,6 +1011,10 @@ declare class DIVEInfo {
      * @returns A promise that resolves to a boolean indicating whether the user's device supports WebXR.
      */
     static GetSupportsWebXR(): Promise<boolean>;
+    /**
+     * @returns The reason why WebXR is not supported on the user's device. Returns null if WebXR is supported nor not has been checked yet.
+     */
+    static GetWebXRUnsupportedReason(): WebXRUnsupportedReason | null;
     /**
      * @returns A boolean indicating whether the user's device supports AR Quick Look.
      */
@@ -1056,7 +1098,7 @@ declare const DIVEDefaultSettings: DIVESettings;
  * @module
  */
 declare class DIVE {
-    static QuickView(uri: string): DIVE;
+    static QuickView(uri: string, settings?: Partial<DIVESettings>): DIVE;
     private _settings;
     private _resizeObserverId;
     private _width;