@shopware-ag/dive 1.6.4 → 1.7.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: licenst" 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

@@ -705,7 +705,7 @@ var _DIVECommunication = class _DIVECommunication {
     this.registered = /* @__PURE__ */ new Map();
     // private listeners: { [key: string]: EventListener[] } = {};
     this.listeners = /* @__PURE__ */ new Map();
-    this.id = (0, import_MathUtils.generateUUID)();
+    this._id = (0, import_MathUtils.generateUUID)();
     this.renderer = renderer;
     this.scene = scene;
     this.controller = controls;
@@ -714,8 +714,13 @@ var _DIVECommunication = class _DIVECommunication {
     _DIVECommunication.__instances.push(this);
   }
   static get(id) {
+    const fromComID = this.__instances.find((instance) => instance.id === id);
+    if (fromComID) return fromComID;
     return this.__instances.find((instance) => Array.from(instance.registered.values()).find((object) => object.id === id));
   }
+  get id() {
+    return this._id;
+  }
   get mediaGenerator() {
     if (!this._mediaGenerator) {
       const DIVEMediaCreator2 = (init_MediaCreator(), __toCommonJS(MediaCreator_exports)).DIVEMediaCreator;
@@ -1586,6 +1591,8 @@ var _DIVEOrbitControls = class _DIVEOrbitControls extends import_Addons3.OrbitCo
     };
     this.stopRevertLast = () => {
     };
+    this._removePreRenderCallback = () => {
+    };
     this.preRenderCallback = () => {
       if (this.locked) return;
       this.update();
@@ -1593,12 +1600,19 @@ var _DIVEOrbitControls = class _DIVEOrbitControls extends import_Addons3.OrbitCo
     this._animationSystem = animationSystem;
     this.domElement = renderer.domElement;
     this.object = camera;
-    renderer.AddPreRenderCallback(() => {
+    const id = renderer.AddPreRenderCallback(() => {
       this.preRenderCallback();
     });
+    this._removePreRenderCallback = () => {
+      renderer.RemovePreRenderCallback(id);
+    };
     this.enableDamping = settings.enableDamping;
     this.dampingFactor = settings.dampingFactor;
   }
+  Dispose() {
+    this._removePreRenderCallback();
+    this.dispose();
+  }
   ComputeEncompassingView(bb) {
     const center = bb.getCenter(new import_three14.Vector3());
     const size = bb.getSize(new import_three14.Vector3());
@@ -1947,6 +1961,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,
@@ -2010,6 +2123,9 @@ var DIVE = class _DIVE {
   get Canvas() {
     return this.renderer.domElement;
   }
+  get Info() {
+    return DIVEInfo;
+  }
   // setters
   set Settings(settings) {
     var _a;
@@ -2071,6 +2187,7 @@ var DIVE = class _DIVE {
     var _a;
     this.removeResizeObserver();
     this.renderer.Dispose();
+    this.orbitControls.Dispose();
     (_a = this.axisCamera) == null ? void 0 : _a.Dispose();
     this.animationSystem.Dispose();
     this.toolbox.Dispose();