@preference-sl/pref-viewer 2.11.0-beta.8 → 2.11.0

package/package.json

@@ -1,53 +1,64 @@
 {
-  "name": "@preference-sl/pref-viewer",
-  "version": "2.11.0-beta.8",
-  "description": "Web Component to preview GLTF models with Babylon.js",
-  "author": "Alex Moreno Palacio <amoreno@preference.es>",
-  "scripts": {
-    "release": "standard-version --releaseCommitMessageFormat \"chore(release): {{currentTag}} [skip ci]\"",
-    "release:beta": "standard-version --prerelease beta --releaseCommitMessageFormat \"chore(release): {{currentTag}} [skip ci]\"",
-    "build": "esbuild src/index.js --bundle --platform=node --outfile=dist/bundle.js --sourcemap",
-    "start": "npm run build && http-server -c-1 . -p 8080",
-    "test": "vitest"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://bitbucket.org/preferencesl/pref-viewer.git"
-  },
-  "publishConfig": {
-    "access": "public"
-  },
-  "license": "MIT",
-  "type": "module",
-  "main": "src/index.js",
-  "types": "index.d.ts",
-  "exports": {
-    ".": {
-      "import": "./src/index.js",
-      "require": "./src/index.js"
+    "name": "@preference-sl/pref-viewer",
+    "version": "2.11.0",
+    "description": "Web Component to preview GLTF models with Babylon.js",
+    "author": "Alex Moreno Palacio <amoreno@preference.es>",
+    "scripts": {
+        "build:prefweb": "webpack --config webpack.config.cjs --mode production",
+        "build:prefweb:dev": "webpack --config webpack.config.cjs --mode development",
+        "release": "standard-version --releaseCommitMessageFormat \"chore(release): {{currentTag}} [skip ci]\"",
+        "release:beta": "standard-version --prerelease beta --releaseCommitMessageFormat \"chore(release): {{currentTag}} [skip ci]\"",
+        "build": "esbuild src/index.js --bundle --platform=node --format=esm --outfile=dist/bundle.js --sourcemap",
+        "start": "npm run build && http-server -c-1 . -p 8080",
+        "test": "vitest"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://bitbucket.org/preferencesl/pref-viewer.git"
+    },
+    "publishConfig": {
+        "access": "public"
+    },
+    "license": "MIT",
+    "type": "module",
+    "main": "src/index.js",
+    "types": "index.d.ts",
+    "exports": {
+        ".": {
+            "import": "./src/index.js",
+            "require": "./src/index.js"
+        }
+    },
+    "sideEffects": false,
+    "files": [
+        "src",
+        "index.d.ts"
+    ],
+    "dependencies": {
+        "@babylonjs/core": "^8.39.2",
+        "@babylonjs/loaders": "^8.39.2",
+        "@babylonjs/serializers": "^8.39.2",
+        "@panzoom/panzoom": "^4.6.0",
+        "babylonjs-gltf2interface": "^8.39.2",
+        "buffer": "^6.0.3",
+        "idb": "^8.0.3",
+        "is-svg": "^6.1.0",
+        "jszip": "^3.10.1",
+        "stream": "^0.0.3",
+        "string_decoder": "^1.3.0"
+    },
+    "devDependencies": {
+        "@babel/core": "^7.22.0",
+        "@babel/preset-env": "^7.22.0",
+        "babel-loader": "^9.2.1",
+        "clean-webpack-plugin": "^4.0.0",
+        "esbuild": "^0.25.10",
+        "http-server": "^14.1.1",
+        "jsdom": "^26.1.0",
+        "standard-version": "^9.5.0",
+        "terser-webpack-plugin": "^5.3.6",
+        "vitest": "^3.2.3",
+        "webpack": "^5.88.2",
+        "webpack-cli": "^5.1.4"
     }
-  },
-  "sideEffects": false,
-  "files": [
-    "src",
-    "index.d.ts"
-  ],
-  "dependencies": {
-    "@babylonjs/core": "^8.36.1",
-    "@babylonjs/gui": "^8.36.1",
-    "@babylonjs/loaders": "^8.36.1",
-    "@babylonjs/serializers": "^8.36.1",
-    "@panzoom/panzoom": "^4.6.0",
-    "babylonjs-gltf2interface": "^8.36.1",
-    "idb": "^8.0.3",
-    "is-svg": "^6.1.0",
-    "jszip": "^3.10.1"
-  },
-  "devDependencies": {
-    "esbuild": "^0.25.10",
-    "http-server": "^14.1.1",
-    "jsdom": "^26.1.0",
-    "standard-version": "^9.5.0",
-    "vitest": "^3.2.3"
-  }
 }

package/src/babylonjs-animation-controller.js

@@ -1,28 +1,35 @@
-import { Color3, HighlightLayer, Mesh, PickingInfo, PointerEventTypes, Scene } from "@babylonjs/core";
-import { AdvancedDynamicTexture } from "@babylonjs/gui";
-import { OpeningAnimation } from "./babylonjs-animation-opening.js";
+import { Color3, HighlightLayer, Mesh, PickingInfo, Scene } from "@babylonjs/core";
+import { PrefViewerColors } from "./styles.js";
+import OpeningAnimation from "./babylonjs-animation-opening.js";
 
 /**
- * BabylonJSAnimationController - Manages animation playback and interactive highlighting for model containers in Babylon.js scenes.
+ * BabylonJSAnimationController - Manages animation playback, highlighting, and interactive controls for animated nodes in Babylon.js scenes.
  *
- * Responsibilities:
+ * Summary:
+ *  This class detects, groups, and manages opening/closing animations for scene nodes, provides interactive highlighting of animated nodes and their meshes, and displays a menu for animation control. It is designed for integration with product configurators and interactive 3D applications using Babylon.js.
+ *
+ * Key features:
  *  - Detects and groups opening/closing animations in the scene.
  *  - Tracks animated transformation nodes and their relationships to meshes.
- *  - Highlights animated nodes and their child meshes when hovered.
- *  - Displays and disposes the animation control menu (GUI) for animated nodes.
- *  - Provides API for interaction and animation control.
+ *  - Highlights animated nodes and their child meshes on pointer hover.
+ *  - Displays and disposes the animation control menu for animated nodes.
+ *  - Provides public API for highlighting, showing the animation menu, and disposing resources.
+ *  - Cleans up all resources and observers to prevent memory leaks.
  *
  * Public Methods:
  *  - dispose(): Disposes all resources managed by the animation controller.
+ *  - hightlightMeshes(pickingInfo): Highlights meshes that are children of an animated node when hovered.
+ *  - hideMenu(): Hides and disposes the animation control menu if it exists.
+ *  - showMenu(pickingInfo): Displays the animation control menu for the animated node under the pointer.
  *
  * @class
  */
 export default class BabylonJSAnimationController {
     #scene = null;
+    #canvas = null;
     #animatedNodes = [];
     #highlightLayer = null;
-    #highlightColor = new Color3(0, 1, 0); // Color para resaltar los elementos animados (Verde)
-    #advancedDynamicTexture = null;
+    #highlightColor = Color3.FromHexString(PrefViewerColors.primary);
     #openingAnimations = [];
 
     /**
@@ -31,8 +38,8 @@ export default class BabylonJSAnimationController {
      */
     constructor(scene) {
         this.#scene = scene;
+        this.#canvas = this.#scene._engine._renderingCanvas;
         this.#initializeAnimations();
-        this.#setupPointerObservers();
     }
 
     /**
@@ -40,11 +47,12 @@ export default class BabylonJSAnimationController {
      * @private
      */
     #initializeAnimations() {
+        this.hideMenu(); // Clean up any existing menus
         if (!this.#scene.animationGroups.length) {
             return;
         }
         this.#getAnimatedNodes();
-        this.#getOpeneingAnimations();
+        this.#getOpeningAnimations();
     }
 
     /**
@@ -71,7 +79,7 @@ export default class BabylonJSAnimationController {
      * @description
      * Uses animation group names with the pattern "animation_open_<name>" and "animation_close_<name>".
      */
-    #getOpeneingAnimations() {
+    #getOpeningAnimations() {
         const openings = {};
         this.#scene.animationGroups.forEach((animationGroup) => {
             const match = animationGroup.name.match(/^animation_(open|close)_(.+)$/);
@@ -122,12 +130,36 @@ export default class BabylonJSAnimationController {
         return nodeId;
     };
 
+    /**
+     * ---------------------------
+     * Public methods
+     * ---------------------------
+     */
+
+    /**
+     * Disposes all resources managed by the animation controller.
+     * Cleans up the highlight layer, animation menu, and internal animation/node lists.
+     * Should be called when the controller is no longer needed to prevent memory leaks.
+     * @public
+     */
+    dispose() {
+        if (this.#highlightLayer) {
+            this.#highlightLayer.removeAllMeshes();
+            this.#highlightLayer.dispose();
+            this.#highlightLayer = null;
+        }
+        this.hideMenu();
+        this.#animatedNodes = [];
+        this.#openingAnimations.forEach((openingAnimation) => openingAnimation.dispose());
+        this.#openingAnimations = [];
+    }
+
     /**
      * Highlights meshes that are children of an animated node when hovered.
-     * @private
+     * @public
      * @param {PickingInfo} pickingInfo - Raycast info from pointer position.
      */
-    #hightlightMeshesForAnimation(pickingInfo) {
+    hightlightMeshes(pickingInfo) {
         if (!this.#highlightLayer) {
             this.#highlightLayer = new HighlightLayer("hl_animations", this.#scene);
         }
@@ -150,52 +182,27 @@ export default class BabylonJSAnimationController {
     }
 
     /**
-     * Sets up pointer observers to highlight animated nodes on hover and show the animation menu on click.
-     * @private
-     */
-    #setupPointerObservers() {
-        if (this.#openingAnimations.length === 0) {
-            return;
-        }
-        this.#scene.onPointerObservable.add(this.#onAnimationPointerObservable.bind(this));
-    }
-
-    /**
-     * Handles pointer events in the Babylon.js scene for animation interaction.
-     * On pointer move, highlights meshes belonging to animated nodes under the cursor.
-     * On pointer up (click), disposes any existing GUI and displays the animation control menu for the selected node.
-     *
-     * @private
-     * @param {PointerInfo} pointerInfo - The pointer event information from Babylon.js.
+     * Hides and disposes the animation control menu if it exists.
+     * @public
+     * @returns {void}
      */
-    #onAnimationPointerObservable(pointerInfo) {
-        if (pointerInfo.type === PointerEventTypes.POINTERMOVE) {
-            const pickingInfo = this.#scene.pick(pointerInfo.event.clientX, pointerInfo.event.clientY);
-            this.#hightlightMeshesForAnimation(pickingInfo);
-        }
-        if (pointerInfo.type === PointerEventTypes.POINTERUP) {
-            // Remove any previously created Babylon GUI
-            if (this.#advancedDynamicTexture) {
-                this.#advancedDynamicTexture.dispose();
-                this.#advancedDynamicTexture = null;
-            }
-            const pickingInfo = this.#scene.pick(pointerInfo.event.clientX, pointerInfo.event.clientY);
-            this.#showMenu(pickingInfo);
-        }
+    hideMenu() {
+        this.#openingAnimations.forEach((openingAnimation) => openingAnimation.hideControls());
+        this.#canvas.parentElement.querySelectorAll("div.pref-viewer-3d.animation-menu").forEach((menu) => menu.remove());
     }
 
     /**
      * Displays the animation control menu for the animated node under the pointer.
-     * @private
+     * @public
      * @param {PickingInfo} pickingInfo - Raycast info from pointer position.
-     * @description
-     * Creates the GUI if needed and invokes OpeningAnimation.showControls.
      */
-    #showMenu(pickingInfo) {
+    showMenu(pickingInfo) {
         if (!pickingInfo?.hit && !pickingInfo?.pickedMesh) {
             return;
         }
 
+        this.hideMenu();
+
         const nodeId = this.#getNodeAnimatedByMesh(pickingInfo.pickedMesh);
         if (!nodeId) {
             return;
@@ -204,32 +211,7 @@ export default class BabylonJSAnimationController {
         if (!openingAnimation) {
             return;
         }
-        if (!this.#advancedDynamicTexture) {
-            this.#advancedDynamicTexture = AdvancedDynamicTexture.CreateFullscreenUI("UI_Animation");
-        }
-        openingAnimation.showControls(this.#advancedDynamicTexture);
-    }
 
-    /**
-     * Disposes all resources managed by the animation controller.
-     * Cleans up the highlight layer, GUI texture, and internal animation/node lists.
-     * Should be called when the controller is no longer needed to prevent memory leaks.
-     * @public
-     */
-    dispose() {
-        if (this.#highlightLayer) {
-            this.#highlightLayer.dispose();
-            this.#highlightLayer = null;
-        }
-        if (this.#advancedDynamicTexture) {
-            this.#advancedDynamicTexture.dispose();
-            this.#advancedDynamicTexture = null;
-        }
-        this.#animatedNodes = [];
-        this.#openingAnimations = [];
-        const observer = this.#scene.onPointerObservable._observers.find((observer) => observer.callback.name.includes("#onAnimationPointerObservable"));
-        if (observer) {
-            this.#scene.onPointerObservable.remove(observer);
-        }
+        openingAnimation.showControls(this.#canvas);
     }
 }