@shopware-ag/dive 1.6.5 → 1.8.0

package/README.md

@@ -5,16 +5,13 @@
 
 <p align="center">
     <a href="#badge">
-        <img alt="dive: downloads" src="https://img.shields.io/npm/v/%40shopware-ag%2Fdive">
+        <img alt="dive: npm" src="https://img.shields.io/npm/v/%40shopware-ag%2Fdive">
     </a>
     <a href="#badge">
-        <img alt="dive: downloads" src="https://img.shields.io/npm/d18m/%40shopware-ag%2Fdive">
+        <img alt="dive: license" src="https://img.shields.io/npm/l/%40shopware-ag%2Fdive">
     </a>
     <a href="#badge">
-        <img alt="dive: downloads" src="https://img.shields.io/npm/l/%40shopware-ag%2Fdive">
-    </a>
-    <a href="#badge">
-        <img alt="dive: downloads" src="https://img.shields.io/npm/types/%40shopware-ag%2Fdive">
+        <img alt="dive: types" src="https://img.shields.io/npm/types/%40shopware-ag%2Fdive">
     </a>
 </p>
 
@@ -169,14 +166,14 @@ com.PerformAction('SET_CAMERA_TRANSFORM', {
 unsubscribe(); // <-- execute unsubscribe callback when done
 ```
 
-In the following you find a list of all available actions to perform on DIVECommunication class via `com.PerformAction()`.
+# Actions (List)
+In the following you find a list of all available actions to perform on DIVECommunication class via [`com.PerformAction()`](https://github.com/shopware/dive/blob/2e193c58843939ce07a1d35bfbd5b3c9d26eeeca/src/com/Communication.ts#L85).
 
 | Action                                                                                | Description
 |:--------------------------------------------------------------------------------------| :---
 | [GET_ALL_SCENE_DATA](./src/com/actions/scene/getallscenedata.ts)                      | Return all scene data that is currently set
 | [GET_ALL_OBJECTS](./src/com/actions/object/getallobjects.ts)                          | Return a map of all objects
 | [GET_OBJECTS](./src/com/actions/object/getobjects.ts)                                 | Return an array of all objects with given ids
-| [PLACE_ON_FLOOR](./src/com/actions/object/model/placeonfloor.ts)                      | Set a model onto to the floor
 | [ADD_OBJECT](./src/com/actions/object/addobject.ts)                                   | Add an object to the scene
 | [UPDATE_OBJECT](./src/com/actions/object/updateobject.ts)                             | Update an existing object
 | [DELETE_OBJECT](./src/com/actions/object/deleteobject.ts)                             | Delete an existing object
@@ -194,6 +191,7 @@ In the following you find a list of all available actions to perform on DIVEComm
 | [ZOOM_CAMERA](./src/com/actions/camera/zoomcamera.ts)                                 | Zoom in or out
 | [SET_GIZMO_MODE](./src/com/actions/toolbox/select/setgizmomode.ts)                    | Set gizmo mode
 | [SET_GIZMO_VISIBILITY](./src/com/actions/toolbox/select/setgizmovisibility.ts)        | Set gizmo visibility
+| [USE_TOOL](./src/com/actions/toolbox/usetool.ts)                                      | Use a specific tool
 | [MODEL_LOADED](./src/com/actions/object/model/modelloaded.ts)                         | Is performed when a model file is completely loaded
 | [UPDATE_SCENE](./src/com/actions/scene/updatescene.ts)                                | Update scene data
 | [GENERATE_MEDIA](./src/com/actions/media/generatemedia.ts)                            | Generate a screenshot with the specified parameters

package/build/dive.cjs

@@ -460,7 +460,12 @@ var init_PerspectiveCamera = __esm({
     };
     _DIVEPerspectiveCamera = class _DIVEPerspectiveCamera extends import_three4.PerspectiveCamera {
       constructor(settings = DIVEPerspectiveCameraDefaultSettings) {
-        super(settings.fov, 1, settings.near, settings.far);
+        super(
+          settings.fov || DIVEPerspectiveCameraDefaultSettings.fov,
+          1,
+          settings.near || DIVEPerspectiveCameraDefaultSettings.near,
+          settings.far || DIVEPerspectiveCameraDefaultSettings.far
+        );
         this.onSetCameraLayer = () => {
         };
         this.layers.mask = _DIVEPerspectiveCamera.EDITOR_VIEW_LAYER_MASK;
@@ -546,14 +551,16 @@ var DIVERendererDefaultSettings = {
   stencil: false,
   shadowMapEnabled: true,
   shadowMapType: import_three.PCFSoftShadowMap,
-  toneMapping: import_three.NoToneMapping
+  toneMapping: import_three.NoToneMapping,
+  canvas: void 0
 };
 var DIVERenderer = class extends import_three.WebGLRenderer {
   constructor(rendererSettings = DIVERendererDefaultSettings) {
     super({
-      antialias: rendererSettings.antialias,
-      alpha: rendererSettings.alpha,
-      preserveDrawingBuffer: true
+      antialias: rendererSettings.antialias || DIVERendererDefaultSettings.antialias,
+      alpha: rendererSettings.alpha || DIVERendererDefaultSettings.alpha,
+      preserveDrawingBuffer: true,
+      canvas: rendererSettings.canvas
     });
     // basic functionality members
     this.paused = false;
@@ -563,9 +570,9 @@ var DIVERenderer = class extends import_three.WebGLRenderer {
     this.preRenderCallbacks = /* @__PURE__ */ new Map();
     this.postRenderCallbacks = /* @__PURE__ */ new Map();
     this.setPixelRatio(window.devicePixelRatio);
-    this.shadowMap.enabled = rendererSettings.shadowMapEnabled;
-    this.shadowMap.type = rendererSettings.shadowMapType;
-    this.toneMapping = rendererSettings.toneMapping;
+    this.shadowMap.enabled = rendererSettings.shadowMapEnabled || DIVERendererDefaultSettings.shadowMapEnabled;
+    this.shadowMap.type = rendererSettings.shadowMapType || DIVERendererDefaultSettings.shadowMapType;
+    this.toneMapping = rendererSettings.toneMapping || DIVERendererDefaultSettings.toneMapping;
     this.debug.checkShaderErrors = false;
   }
   // Stops renderings and disposes the renderer.
@@ -1574,14 +1581,14 @@ var DIVEScene = class extends import_three13.Scene {
 init_PerspectiveCamera();
 
 // src/controls/OrbitControls.ts
-var import_Addons3 = require("three/examples/jsm/Addons.js");
+var import_OrbitControls = require("three/examples/jsm/controls/OrbitControls");
 var import_three14 = require("three");
 var import_tween = require("@tweenjs/tween.js");
 var DIVEOrbitControlsDefaultSettings = {
   enableDamping: true,
   dampingFactor: 0.04
 };
-var _DIVEOrbitControls = class _DIVEOrbitControls extends import_Addons3.OrbitControls {
+var _DIVEOrbitControls = class _DIVEOrbitControls extends import_OrbitControls.OrbitControls {
   constructor(camera, renderer, animationSystem, settings = DIVEOrbitControlsDefaultSettings) {
     super(camera, renderer.domElement);
     this.last = null;
@@ -1606,8 +1613,11 @@ var _DIVEOrbitControls = class _DIVEOrbitControls extends import_Addons3.OrbitCo
     this._removePreRenderCallback = () => {
       renderer.RemovePreRenderCallback(id);
     };
-    this.enableDamping = settings.enableDamping;
-    this.dampingFactor = settings.dampingFactor;
+    this.enableDamping = settings.enableDamping || DIVEOrbitControlsDefaultSettings.enableDamping;
+    this.dampingFactor = settings.dampingFactor || DIVEOrbitControlsDefaultSettings.dampingFactor;
+    this.object.position.set(0, 2, 2);
+    this.target.copy({ x: 0, y: 0.5, z: 0 });
+    this.update();
   }
   Dispose() {
     this._removePreRenderCallback();
@@ -1961,6 +1971,105 @@ var DIVEMath = {
 
 // src/dive.ts
 var import_MathUtils2 = require("three/src/math/MathUtils");
+
+// src/info/Info.ts
+var DIVEInfo = class {
+  /**
+   *
+   * @returns The system the user is using. Possible values are "Android", "iOS", "Windows", "MacOS", "Linux" or "Unknown".
+   */
+  static GetSystem() {
+    const platform = navigator.platform;
+    if (/Android/.test(navigator.userAgent)) {
+      return "Android";
+    } else if (/iPhone|iPad|iPod/.test(navigator.userAgent)) {
+      return "iOS";
+    } else if (platform.startsWith("Win")) {
+      return "Windows";
+    } else if (platform.startsWith("Mac")) {
+      return "MacOS";
+    } else if (platform.startsWith("Linux")) {
+      return "Linux";
+    } else {
+      return "Unknown";
+    }
+  }
+  /**
+   * @returns A promise that resolves to a boolean indicating whether the user's device supports WebXR.
+   */
+  static GetSupportsWebXR() {
+    return __async(this, null, function* () {
+      if (this._supportsWebXR !== null) {
+        return this._supportsWebXR;
+      }
+      if (!navigator.xr) {
+        this._supportsWebXR = false;
+        return this._supportsWebXR;
+      }
+      try {
+        const supported = yield navigator.xr.isSessionSupported("immersive-ar");
+        this._supportsWebXR = supported;
+      } catch (error) {
+        this._supportsWebXR = false;
+      }
+      return this._supportsWebXR;
+    });
+  }
+  /**
+   * @returns A boolean indicating whether the user's device supports AR Quick Look.
+   */
+  static GetSupportsARQuickLook() {
+    const a = document.createElement("a");
+    if (a.relList.supports("ar")) {
+      return true;
+    }
+    const userAgent = navigator.userAgent;
+    const isIOS = /iPad|iPhone|iPod/.test(userAgent) && !window.MSStream;
+    if (!isIOS) {
+      return false;
+    }
+    const match = userAgent.match(/OS (\d+)_/);
+    if (!match || match.length < 2) {
+      return false;
+    }
+    const iOSVersion = parseInt(match[1], 10);
+    const minQuickLookVersion = 12;
+    if (iOSVersion < minQuickLookVersion) {
+      return false;
+    }
+    const isSupportedBrowser = /^((?!chrome|android).)*safari|CriOS|FxiOS/i.test(userAgent);
+    if (isSupportedBrowser) {
+      return true;
+    }
+    return false;
+  }
+  /**
+   * @returns A boolean indicating whether the user's device is a mobile device.
+   */
+  static get isMobile() {
+    return this.GetSystem() === "Android" || this.GetSystem() === "iOS";
+  }
+  /**
+   * @returns A boolean indicating whether the user's device is a desktop device.
+   */
+  static get isDesktop() {
+    return !this.isMobile;
+  }
+  /**
+   * @returns A promise that resolves to a boolean indicating whether the user's device is capable of AR.
+   */
+  static GetIsARCapable() {
+    return __async(this, null, function* () {
+      if (this.GetSupportsARQuickLook()) {
+        return true;
+      }
+      return yield this.GetSupportsWebXR();
+    });
+  }
+};
+DIVEInfo._supportsWebXR = null;
+
+// src/dive.ts
 var DIVEDefaultSettings = {
   autoResize: true,
   displayAxes: false,
@@ -2024,20 +2133,23 @@ var DIVE = class _DIVE {
   get Canvas() {
     return this.renderer.domElement;
   }
+  get Info() {
+    return DIVEInfo;
+  }
   // setters
   set Settings(settings) {
     var _a;
     const settingsDelta = getObjectDelta(this._settings, settings);
     if (settingsDelta.renderer) this.renderer = new DIVERenderer(this._settings.renderer);
     if (settingsDelta.perspectiveCamera) {
-      this.perspectiveCamera.fov = settingsDelta.perspectiveCamera.fov;
-      this.perspectiveCamera.near = settingsDelta.perspectiveCamera.near;
-      this.perspectiveCamera.far = settingsDelta.perspectiveCamera.far;
+      if (settingsDelta.perspectiveCamera.fov !== void 0) this.perspectiveCamera.fov = settingsDelta.perspectiveCamera.fov;
+      if (settingsDelta.perspectiveCamera.near !== void 0) this.perspectiveCamera.near = settingsDelta.perspectiveCamera.near;
+      if (settingsDelta.perspectiveCamera.far !== void 0) this.perspectiveCamera.far = settingsDelta.perspectiveCamera.far;
       this.perspectiveCamera.OnResize(this.renderer.domElement.width, this.renderer.domElement.height);
     }
     if (settingsDelta.orbitControls) {
-      this.orbitControls.enableDamping = settingsDelta.orbitControls.enableDamping;
-      this.orbitControls.dampingFactor = settingsDelta.orbitControls.dampingFactor;
+      if (settingsDelta.orbitControls.enableDamping !== void 0) this.orbitControls.enableDamping = settingsDelta.orbitControls.enableDamping;
+      if (settingsDelta.orbitControls.dampingFactor !== void 0) this.orbitControls.dampingFactor = settingsDelta.orbitControls.dampingFactor;
     }
     if (settingsDelta.autoResize !== this._settings.autoResize) {
       if (settingsDelta.autoResize) {
@@ -2080,6 +2192,7 @@ var DIVE = class _DIVE {
         console.log(this.scene);
       }
     };
+    console.log("DIVE initialized");
   }
   Dispose() {
     var _a;