@combeenation/3d-viewer 8.0.0 → 8.1.0-alpha1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@combeenation/3d-viewer",
-  "version": "8.0.0",
+  "version": "8.1.0-alpha1",
   "description": "Combeenation 3D Viewer",
   "homepage": "https://github.com/Combeenation/3d-viewer#readme",
   "bugs": {
@@ -32,7 +32,7 @@
     "dist-full": "npm run clean-dist && npm run lint && cross-env NODE_ENV='production' webpack --config build/webpack.conf.js --progress && npm run replace-version",
     "docs-local": "typedoc --tsconfig tsconfig.json --media doc/assets --out docs-local",
     "docs-publish": "typedoc --tsconfig tsconfig.json --media doc/assets --out docs",
-    "format": "prettier --write .",
+    "format": "prettier --write ./src",
     "generate-profile": "cross-env NODE_ENV='dev' webpack --config build/webpack.conf.js --profile --json > dist/webpack-stats.json",
     "lint": "eslint src/**",
     "pack": "npm run dist-cjs && npm pack",

package/src/api/classes/parameter.ts

@@ -139,6 +139,36 @@ export class Parameter {
    */
   public static readonly ROTATION = 'rotation';
 
+  /**
+   * Mutates the color.
+   *
+   * Scopes:
+   * * {@link Material} via {@link TagManager}
+   *
+   * @parser {@link parseColor}
+   */
+  public static readonly COLOR = 'color';
+
+  /**
+   * Mutates the metallness.
+   *
+   * Scopes:
+   * * {@link Material} via {@link TagManager}
+   *
+   * @parser {@link parseNumber}
+   */
+  public static readonly METALLNESS = 'metallness';
+
+  /**
+   * Mutates the roughness.
+   *
+   * Scopes:
+   * * {@link Material} via {@link TagManager}
+   *
+   * @parser {@link parseNumber}
+   */
+  public static readonly ROUGHNESS = 'roughness';
+
   /**
    * Mutates whether a shadow should be casted or not.
    *

package/src/api/classes/variant.ts

@@ -244,6 +244,20 @@ export class Variant extends Parameterizable {
     return this.elements.reduce((a, c) => [...a, ...c.nodesFlat], [] as TransformNode[]);
   }
 
+  /**
+   * The cloned Meshes of all {@link Element}s created for this {@link Variant} flattened.
+   */
+  get elementMeshesFlat(): Mesh[] {
+    return this.elements.reduce((a, c) => [...a, ...c.meshesFlat], [] as Mesh[]);
+  }
+
+  /**
+   * The cloned Meshes of all {@link Element}s created for this {@link Variant} flattened.
+   */
+  get elementAbstractMeshesFlat(): AbstractMesh[] {
+    return this.elements.reduce((a, c) => [...a, ...c.abstractMeshesFlat], [] as AbstractMesh[]);
+  }
+
   /**
    * All {@link Element}s from this {@link Variant}'s parents.
    */

package/src/api/classes/viewer.ts

@@ -10,7 +10,7 @@ import { backgroundDomeName, envHelperMetadataName } from '../util/babylonHelper
 import { debounce, loadJavascript, loadJson } from '../util/resourceHelper';
 import { getCustomCbnBabylonLoaderPlugin } from '../util/sceneLoaderHelper';
 import { replaceDots } from '../util/stringHelper';
-import { isMeshIncludedInExclusionList } from '../util/structureHelper';
+import { isNodeIncludedInExclusionList } from '../util/structureHelper';
 import * as Index from './../../index';
 import { AnimationInterface } from './animationInterface';
 import { Event } from './event';
@@ -35,7 +35,7 @@ import { Mesh } from '@babylonjs/core/Meshes/mesh';
 import { ScreenshotTools } from '@babylonjs/core/Misc/screenshotTools';
 import { WebXRSessionManager } from '@babylonjs/core/XR/webXRSessionManager';
 import { Scene } from '@babylonjs/core/scene';
-import { isArray, isString } from 'lodash-es';
+import { isString } from 'lodash-es';
 
 /**
  * The main exposed object. This is the entry point into the application
@@ -308,6 +308,10 @@ export class Viewer extends EventBroadcaster {
       indexJson.scene = sceneJson;
     }
     this._scene = await this.initScene();
+    // set initial tag manager parameter values
+    if (tagManagerParameterValues) {
+      await this.tagManager.setParameterValues(tagManagerParameterValues);
+    }
     // create instance manager
     this._variantInstances = await VariantInstanceManager.create(this);
     // create optional default instances
@@ -317,7 +321,7 @@ export class Viewer extends EventBroadcaster {
         indexJson.setup = setupJson;
       }
       this.printInstanceDefinitions(indexJson.setup);
-      await this.createVariantInstances(tagManagerParameterValues);
+      await this.createVariantInstances();
     }
     this.broadcastEvent(Event.VARIANT_INSTANCES_READY, this);
     // create gltf export manager
@@ -486,7 +490,7 @@ export class Viewer extends EventBroadcaster {
         // ignore meshes with infinite distance, typically these are sky boxes
         const hasInfiniteDistance = mesh.infiniteDistance;
         // ignore excluded meshes
-        const isExcluded = excludeGeometry ? isMeshIncludedInExclusionList(mesh as Mesh, excludeGeometry) : false;
+        const isExcluded = excludeGeometry ? isNodeIncludedInExclusionList(mesh, excludeGeometry) : false;
         return isEnabled && isNotBBoxMesh && hasValidBBoxInfo && !hasInfiniteDistance && !isExcluded;
       })
       .reduce(
@@ -579,7 +583,7 @@ export class Viewer extends EventBroadcaster {
    * Resets everything by calling {@link destroy} to clear all references and {@link bootstrap} to setup a clean
    * environment
    */
-  public async reset(tagManagerParameterValues: TagManagerParameterValue[]): Promise<Viewer> {
+  public async reset(tagManagerParameterValues?: TagManagerParameterValue[]): Promise<Viewer> {
     await this.destroy();
     return this.bootstrap(tagManagerParameterValues);
   }
@@ -723,7 +727,7 @@ export class Viewer extends EventBroadcaster {
       this._cloneMaterialsOnMutation = sceneJson.cloneMaterialsOnMutation;
     }
     // register observers for tag manager
-    this.tagManager.registerNewTransformNodeObservers(scene);
+    this.tagManager.registerNewObjectObservers(scene);
     this.broadcastEvent(Event.SCENE_PROCESSING_END, scene);
     return scene;
   }
@@ -743,15 +747,10 @@ export class Viewer extends EventBroadcaster {
   /**
    * Batch creation of multiple {@link VariantInstance} objects with a {@link SetupJson} object passed
    */
-  protected async createVariantInstances(
-    tagManagerParameterValues?: TagManagerParameterValue[]
-  ): Promise<VariantInstance[]> {
+  protected async createVariantInstances(): Promise<VariantInstance[]> {
     const setupJson = SpecStorage.get<SetupJson>('setup');
     const instances: VariantInstance[] = [];
     for (const instanceDefinition of setupJson.instances) {
-      if (isArray(tagManagerParameterValues)) {
-        instanceDefinition.tagManagerParameterValues = tagManagerParameterValues;
-      }
       // don't create the instance right away if `lazy` is set, register it for later creation (on first usage) instead
       // however if the variant should be `visible` by default, `lazy` loading doesn't make sense and should therefore
       // be overruled by the `visible` flag
@@ -762,8 +761,7 @@ export class Viewer extends EventBroadcaster {
       const instance = await this.variantInstances.create(
         instanceDefinition.variant,
         instanceDefinition.name,
-        instanceDefinition.parameters,
-        instanceDefinition.tagManagerParameterValues
+        instanceDefinition.parameters
       );
       instances.push(instance);
     }

package/src/api/manager/gltfExportManager.ts

@@ -1,5 +1,6 @@
 import { Viewer } from '../classes/viewer';
-import { isMeshIncludedInExclusionList } from '../util/structureHelper';
+import { injectNodeMetadata } from '../util/babylonHelper';
+import { isNodeIncludedInExclusionList } from '../util/structureHelper';
 import { Engine } from '@babylonjs/core/Engines/engine';
 import { SceneLoader } from '@babylonjs/core/Loading/sceneLoader';
 import { PBRMaterial } from '@babylonjs/core/Materials/PBR/pbrMaterial';
@@ -15,6 +16,7 @@ import { has, merge } from 'lodash-es';
 type MetadataMap = { [key: string]: any };
 export class GltfExportManager {
   protected static readonly _CLONED_FROM_MAT_METADATA_PROPERTY = 'clonedFrom';
+  public static readonly NAME_BEFORE_EXPORT_METADATA_PROPERTY = 'nameBeforeExport';
 
   /**
    * Constructor.
@@ -111,7 +113,7 @@ export class GltfExportManager {
         if ((node.name as string).startsWith(Viewer.BOUNDING_BOX_NAME)) {
           return false;
         }
-        if (excluded && node instanceof Mesh && isMeshIncludedInExclusionList(node, excluded)) {
+        if (excluded && node instanceof TransformNode && isNodeIncludedInExclusionList(node, excluded)) {
           return false;
         }
         return true;
@@ -268,7 +270,10 @@ export class GltfExportManager {
    */
   protected setUniqueMeshNames(scene: Scene): void {
     const allNodes = scene.getNodes().filter(node => node instanceof TransformNode) as TransformNode[];
-    allNodes.forEach(currMesh => (currMesh.name = `${currMesh.name}_${currMesh.uniqueId}`));
+    allNodes.forEach(currMesh => {
+      injectNodeMetadata(currMesh, { [GltfExportManager.NAME_BEFORE_EXPORT_METADATA_PROPERTY]: currMesh.name }, false);
+      currMesh.name = `${currMesh.name}_${currMesh.uniqueId}`;
+    });
   }
 
   /**