@combeenation/3d-viewer 7.0.0-beta3 → 7.1.0-alpha1

package/package.json

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

package/src/api/classes/event.ts

@@ -30,7 +30,7 @@ export const emitter = new EventEmitter();
  * viewer.on(Event.SCENE_PROCESSING_END, scene => {
  *   scene.clearColor = new Color4(0, 0, 0, 0);
  * });
- * await viewer.bootstrap();
+ * await viewer.bootstrap([]);
  * ```
  */
 export class Event {
@@ -268,7 +268,7 @@ export class Event {
    * * {@link Viewer}
    *
    * Payload:
-   * * viewer: {@link viewer}
+   * * viewer: {@link Viewer}
    */
   public static readonly VARIANT_INSTANCES_READY = 'variantInstancesReady';
 

package/src/api/classes/parameterObservable.ts

@@ -31,7 +31,7 @@ export abstract class ParameterObservable extends EventBroadcaster {
    * The {@link ParameterObserver} gets 3 parameters: the {@link ParameterObservable}, the old {@link ParameterValue}
    * and the new {@link ParameterValue}.
    *
-   * See {@page ../../../doc/documentation/Parameters.md} for an example.
+   * See [Parameters](https://3dviewer.docs.combeenation.com/pages/documentation/Parameters.html) for an example.
    */
   public addParameterObserver(parameter: string, observer: ParameterObserver): ParameterObservable {
     if (this.parameterObservers.has(parameter)) {

package/src/api/classes/viewer.ts

@@ -270,7 +270,7 @@ export class Viewer extends EventBroadcaster {
    * @emits {@link Event.BOOTSTRAP_START}
    * @emits {@link Event.BOOTSTRAP_END}
    */
-  public async bootstrap(tagManagerParameterValues?: TagManagerParameterValue[]): Promise<Viewer> {
+  public async bootstrap(tagManagerParameterValues: TagManagerParameterValue[]): Promise<Viewer> {
     this.broadcastEvent(Event.BOOTSTRAP_START, this);
     let indexJson;
     if (isString(this.structureJson)) {
@@ -565,9 +565,9 @@ 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(): Promise<Viewer> {
+  public async reset(tagManagerParameterValues: TagManagerParameterValue[]): Promise<Viewer> {
     await this.destroy();
-    return this.bootstrap();
+    return this.bootstrap(tagManagerParameterValues);
   }
 
   /**

package/src/api/util/babylonHelper.ts

@@ -416,12 +416,13 @@ const setMaterial = function (node: TransformNode, materialId: string, deep: boo
       }
     } else {
       // create material and apply it when textures have been loaded
-      const material = getOrCreateMaterial(node.getScene(), materialId, variant);
-      applyMaterial(material, node).then(() => emitter.emit(Event.MESH_MATERIAL_APPLIED, node, material));
+      getOrCreateMaterial(node.getScene(), materialId, variant).then(material => {
+        applyMaterial(material, node).then(() => emitter.emit(Event.MESH_MATERIAL_APPLIED, node, material));
 
-      if (hasMissingMaterial) {
-        delete node.metadata[missingMaterialMetadataName];
-      }
+        if (hasMissingMaterial) {
+          delete node.metadata[missingMaterialMetadataName];
+        }
+      });
     }
   }
   // recursively set materials on children (if desired)
@@ -436,11 +437,11 @@ const setMaterial = function (node: TransformNode, materialId: string, deep: boo
  * Gets the Material either from the given {@link Variant}, the given scene or tries to create it from an Combeenation
  * material asset when inside a Combeenation configurator.
  */
-const getOrCreateMaterial = function (scene: Scene, materialId: string, variant?: Variant): Material {
+const getOrCreateMaterial = async function (scene: Scene, materialId: string, variant?: Variant): Promise<Material> {
   let chosenMaterial: Material | undefined | null;
   chosenMaterial = variant?.inheritedMaterials.find(mat => mat.id === materialId);
   chosenMaterial = chosenMaterial || scene.materials.find(mat => mat.id === materialId);
-  chosenMaterial = chosenMaterial || createMaterialFromCbnAssets(materialId, scene);
+  chosenMaterial = chosenMaterial || (await createMaterialFromCbnAssets(materialId, scene));
   if (chosenMaterial) {
     return chosenMaterial as Material;
   }

package/src/api/util/globalTypes.ts

@@ -456,6 +456,10 @@ type SpecGenerationData = {
   url: string;
 };
 
+/**
+ * Key = Old tag name\
+ * Value = New tag name
+ */
 type TagMapping = {
   [tagName: string]: string;
 };

package/src/api/util/sceneLoaderHelper.ts

@@ -67,7 +67,7 @@ export const getMaterialPostLoadObserver = function (concerningMesh: Mesh) {
     // get id of missing material
     const missingMatId = concerningMesh.metadata[missingMaterialMetadataName];
     // get material and apply it on the concerning mesh after all textures have been loaded
-    const material = getOrCreateMaterial(concerningMesh.getScene(), missingMatId);
+    const material = await getOrCreateMaterial(concerningMesh.getScene(), missingMatId);
     applyMaterial(material, concerningMesh).then(() =>
       emitter.emit(Event.MESH_MATERIAL_APPLIED, concerningMesh, material)
     );
@@ -160,8 +160,8 @@ export const removeMissingMaterialObserver = function (node: BjsNode) {
  * @param scene Babylon.js scene
  * @returns PBRMaterial | null
  */
-export const createMaterialFromCbnAssets = function (materialId: string, scene: Scene): Material | null {
-  const materialDefinition = window.Cbn?.Assets.getMaterial(materialId);
+export const createMaterialFromCbnAssets = async function (materialId: string, scene: Scene): Promise<Material | null> {
+  const materialDefinition = await window.Cbn?.Assets.getMaterial(materialId);
   // The generic `Material.Parse` actually returns a more specific material like `BABYLON.StandardMaterial`,
   // `BABYLON.PBRMaterial` or stuff like `BABYLON.PBRMetallicRoughnessMaterial` etc. based on the given `customType`
   // within the material JSON definition

package/src/dev.ts

@@ -23,7 +23,7 @@ document.addEventListener('DOMContentLoaded', main);
 
 window.Cbn = {
   Assets: {
-    getMaterial(materialId: string) {
+    async getMaterial(materialId: string) {
       //! this creates a new function on the object that uses the imported function of the same name..
       const material = getMaterial(materialId);
       if (material) return material;

package/src/types.d.ts

@@ -8,14 +8,17 @@ interface Window {
     | {
         Assets: {
           /**
-           * Retrieve material definition from configurator
+           * Retrieve material definition from configurator\
+           * Implementation depends on the Combeenation environment the viewer is used in
+           * - Configurator: Access pre-fetched material JSON objects from Cbn client => synchronous
+           * - Asset Editor: Load content from material asset on demand => asynchronous!
            *
            * @param materialId
            *
            * @return Undefined if no definition for the given material name exists, otherwise an "JSON object" which can
            *         be passed to `BABYLON.Material.Parse` to create a runtime material object.
            */
-          getMaterial(materialId: string): object | undefined;
+          getMaterial(materialId: string): Promise<object | undefined>;
 
           /**
            * Checks if a definition for a given material name exists in the configurator and issues a warning if not.