@combeenation/3d-viewer 12.1.1 → 12.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@combeenation/3d-viewer",
-  "version": "12.1.1",
+  "version": "12.2.0",
   "description": "Combeenation 3D Viewer",
   "homepage": "https://github.com/Combeenation/3d-viewer#readme",
   "bugs": {

package/src/api/classes/element.ts

@@ -34,6 +34,7 @@ import { PBRMaterial } from '@babylonjs/core/Materials/PBR/pbrMaterial';
 import { Material } from '@babylonjs/core/Materials/material';
 import { Color3 } from '@babylonjs/core/Maths/math.color';
 import { AbstractMesh } from '@babylonjs/core/Meshes/abstractMesh';
+import { InstancedMesh } from '@babylonjs/core/Meshes/instancedMesh';
 import { Mesh } from '@babylonjs/core/Meshes/mesh';
 import { TransformNode } from '@babylonjs/core/Meshes/transformNode';
 import { Tags } from '@babylonjs/core/Misc/tags';
@@ -78,7 +79,7 @@ export class Element extends VariantParameterizable {
     // this can only be done after the cloning process of the whole tree is finished, as we can't be sure if all
     // instanced meshes or all sources meshes are cloning prior
     const reassignSourceMesh = (node: TransformNode) => {
-      if (node.constructor.name === 'InstancedMesh') {
+      if (node instanceof InstancedMesh) {
         // find the cloned instance and source mesh
         const clonedInstance = node as InstancedMesh;
         const originalInstance = clonedInstance.metadata.cloneSource as InstancedMesh;

package/src/api/classes/viewer.ts

@@ -7,7 +7,7 @@ import { TagManager } from '../manager/tagManager';
 import { VariantInstanceManager } from '../manager/variantInstanceManager';
 import { SpecStorage } from '../store/specStorage';
 import { backgroundDomeName, envHelperMetadataName } from '../util/babylonHelper';
-import { showWorldCoordinates } from '../util/debugHelper';
+import { hideWorldCoordinates, isWorldCoordinatesDebugNode, showWorldCoordinates } from '../util/debugHelper';
 import { getIsScaledDownDevice } from '../util/deviceHelper';
 import { debounce, loadJson } from '../util/resourceHelper';
 import { getCustomCbnBabylonLoaderPlugin } from '../util/sceneLoaderHelper';
@@ -509,14 +509,23 @@ The inspector can only be used in development builds.`);
       .filter(mesh => {
         const isEnabled = mesh.isEnabled();
         // ignore the existing bounding box mesh for calculating the current one
-        const isNotBBoxMesh = Viewer.BOUNDING_BOX_NAME !== mesh.id;
+        const isNotBBoxMesh = Viewer.BOUNDING_BOX_NAME !== mesh.name;
+        // ignore debug world coordinates nodes
+        const isNotWorldCoordinatesDebugNode = !isWorldCoordinatesDebugNode(mesh.name);
         // ignore meshes with invalid bounding infos
         const hasValidBBoxInfo = mesh.getBoundingInfo().boundingSphere.radius > 0;
         // ignore meshes with infinite distance, typically these are sky boxes
         const hasInfiniteDistance = mesh.infiniteDistance;
         // ignore excluded meshes
         const isExcluded = excludeGeometry ? isNodeIncludedInExclusionList(mesh, excludeGeometry) : false;
-        return isEnabled && isNotBBoxMesh && hasValidBBoxInfo && !hasInfiniteDistance && !isExcluded;
+        return (
+          isEnabled &&
+          isNotBBoxMesh &&
+          isNotWorldCoordinatesDebugNode &&
+          hasValidBBoxInfo &&
+          !hasInfiniteDistance &&
+          !isExcluded
+        );
       })
       .reduce(
         (accBBoxMinMax, curMesh, idx) => {
@@ -627,12 +636,19 @@ The inspector can only be used in development builds.`);
   }
 
   /**
-   * Show coordinate system with given dimension (for debugging purpose).
+   * Show world coordinate system with given dimension (for debugging purpose).
    */
   public showWorldCoordinates(dimension: number) {
     showWorldCoordinates(this.scene, dimension);
   }
 
+  /**
+   * Hide world coordinate system.
+   */
+  public hideWorldCoordinates() {
+    hideWorldCoordinates(this.scene);
+  }
+
   /**
    * Pause render loop.
    */

package/src/api/manager/gltfExportManager.ts

@@ -1,5 +1,6 @@
 import { Viewer } from '../classes/viewer';
 import { injectMetadata } from '../util/babylonHelper';
+import { isWorldCoordinatesDebugNode } from '../util/debugHelper';
 import { getIsScaledDownDevice } from '../util/deviceHelper';
 import { bakeGeometryOfMesh, createMeshFromInstancedMesh, resetTransformation } from '../util/geometryHelper';
 import { isNodeIncludedInExclusionList } from '../util/structureHelper';
@@ -282,6 +283,9 @@ export class GltfExportManager {
     if (node.name === Viewer.BOUNDING_BOX_NAME) {
       return false;
     }
+    if (isWorldCoordinatesDebugNode(node.name)) {
+      return false;
+    }
     if (!node.isEnabled()) {
       return false;
     }

package/src/api/util/babylonHelper.ts

@@ -114,7 +114,7 @@ const cloneTransformNode = function (
     // if the cloned node is of type InstancedMesh, due to a bug(?),
     // the InstancedMesh.isEnabled state may have changed after cloning.
     // in that case, set the clone's enabled state to the original's state
-    if (node.constructor.name === 'InstancedMesh') {
+    if (node instanceof InstancedMesh) {
       clone.setEnabled(node.isEnabled(false));
 
       // tags are not cloned for instanced meshes by default

package/src/api/util/debugHelper.ts

@@ -16,27 +16,48 @@ const _DEBUG_AXIS_MAP: Record<DebugAxisKeys, DebugAxisConfig> = {
 };
 
 const _WORLD_COORD_ROOT_KEY = '__world_coordinates__';
+let _AXES_VIEWER: AxesViewer;
 
 /**
  * Create debug coordinate system located in world origin.
  * This function is based on Babylon.js `AxesViewer`, axis texts are added manually.
  */
 export function showWorldCoordinates(scene: Scene, dimension: number) {
-  const existingRoot = scene.getTransformNodeByName(_WORLD_COORD_ROOT_KEY);
-  if (existingRoot) {
-    // make sure to remove already existing debug coordinate systems
-    existingRoot.dispose();
-  }
+  // make sure to remove already existing debug coordinate systems
+  hideWorldCoordinates(scene);
 
   const worldCoordRoot = new TransformNode(_WORLD_COORD_ROOT_KEY, scene);
   // axes viewer coordinate system is a bit too large
   // multiply with unify factor to create arrows which exactly match the length of the input dimension
   const factor = _getWorldCoordinatesAxesUnifyFactor();
-  const axesViewer = new AxesViewer(scene, dimension * factor);
+  _AXES_VIEWER = new AxesViewer(scene, dimension * factor);
+
+  _prepareWorldCoordinateAxis('X', _AXES_VIEWER.xAxis, worldCoordRoot, dimension, scene);
+  _prepareWorldCoordinateAxis('Y', _AXES_VIEWER.yAxis, worldCoordRoot, dimension, scene);
+  _prepareWorldCoordinateAxis('Z', _AXES_VIEWER.zAxis, worldCoordRoot, dimension, scene);
+}
+
+/**
+ * Remove meshes and materials that are associated with the debug world coordinates system
+ */
+export function hideWorldCoordinates(scene: Scene) {
+  _AXES_VIEWER?.dispose();
 
-  _prepareWorldCoordinateAxis('X', axesViewer.xAxis, worldCoordRoot, dimension, scene);
-  _prepareWorldCoordinateAxis('Y', axesViewer.yAxis, worldCoordRoot, dimension, scene);
-  _prepareWorldCoordinateAxis('Z', axesViewer.zAxis, worldCoordRoot, dimension, scene);
+  const worldCoordRoot = scene.getTransformNodeByName(_WORLD_COORD_ROOT_KEY);
+  if (worldCoordRoot) {
+    worldCoordRoot.dispose(false, true);
+  }
+}
+
+/**
+ * Checks if the node is generated by the `showWorldCoordinates` function.
+ * These nodes need special treatment in certain cases, for example the `autofocusActiveCamera` function should ignore
+ * the values and GLB exports should also not include the nodes.
+ */
+export function isWorldCoordinatesDebugNode(nodeName: string) {
+  // ATM this is a plain name check, as we have some reserved names in the viewer (see Viewer.BOUNDING_BOX_NAME)
+  // Other solutions could be storing this info in the metadata or in a different global node store
+  return nodeName.startsWith(_WORLD_COORD_ROOT_KEY);
 }
 
 /**