@combeenation/3d-viewer 14.0.1-rc1 → 15.0.0

package/src/manager/material-manager.ts

@@ -1,135 +1,135 @@
-import {
-  AbstractMesh,
-  BaseTexture,
-  Material,
-  StandardMaterial,
-  Viewer,
-  ViewerError,
-  ViewerErrorIds,
-  ViewerEvent,
-} from '../index';
-import {
-  clearInternalMetadataValue,
-  getInternalMetadataValue,
-  setInternalMetadataValue,
-} from '../internal/metadata-helper';
-
-/**
- * Manager for material related tasks
- */
-export class MaterialManager {
-  /**
-   * CAUTION: this has to be in sync with the Combeenation backend!
-   * @internal
-   */
-  public static readonly CBN_FALLBACK_MATERIAL_NAME = '$fallback';
-
-  protected _createMaterialPromises: { [materialId: string]: Promise<Material | null> } = {};
-
-  /** @internal */
-  public constructor(protected viewer: Viewer) {}
-
-  /**
-   * Assigns material with certain id to desired mesh.\
-   * Creates the material if not already available (see {@link getOrCreateMaterial}).
-   */
-  public async setMaterialOnMesh(materialId: string, mesh: AbstractMesh): Promise<void> {
-    setInternalMetadataValue(mesh, 'materialToBeSet', materialId);
-
-    const material = await this.getOrCreateMaterial(materialId, mesh);
-
-    // there may have been later "setMaterialOnMesh" calls with faster material creation
-    // make sure to assign the latest material!
-    if (getInternalMetadataValue(mesh, 'materialToBeSet') === materialId) {
-      mesh.material = material;
-      clearInternalMetadataValue(mesh, 'materialToBeSet');
-      clearInternalMetadataValue(mesh, 'deferredMaterial');
-    }
-  }
-
-  /**
-   * Returns material with certain id if already available in the scene.\
-   * If this is not the case material is created from a
-   * "[Material asset](https://docs.combeenation.com/docs/howto-create-and-use-babylon-and-material-asset)"
-   * on the Combeenation server.\
-   * Waits until textures of material are fully loaded and shader is compiled. In this way "flickering" effects
-   * will be avoided, since the material would be incomplete without its loaded textures.
-   *
-   * @param mesh Required for shader compilation check, can be omitted if this check should not be done.\
-   * Use {@link setMaterialOnMesh} instead if the material should be applied on the mesh immediately.
-   */
-  public async getOrCreateMaterial(materialId: string, mesh?: AbstractMesh): Promise<Material> {
-    let chosenMaterial: Material | null = this.viewer.scene.materials.find(mat => mat.id === materialId) ?? null;
-
-    if (!chosenMaterial) {
-      // material not available yet, request it from Combeenation assets
-      const existingCreationProm = this._createMaterialPromises[materialId];
-      if (existingCreationProm !== undefined) {
-        // request is already pending, just wait for the result
-        chosenMaterial = await existingCreationProm;
-      } else {
-        this.viewer.eventManager.fireEvent(ViewerEvent.MaterialCreationStart, materialId);
-
-        // request not pending, call the dedicated function
-        const newCreationProm = this._createMaterial(materialId, mesh);
-        // store the promise in a global map, so that subsequent requests can reference it
-        this._createMaterialPromises[materialId] = newCreationProm;
-        chosenMaterial = await newCreationProm;
-
-        delete this._createMaterialPromises[materialId];
-
-        const allMaterialsCreated = !Object.entries(this._createMaterialPromises).length;
-        // signalize event system that material is created now
-        // also check if there are other material creation processes still pending, as this is an important information
-        // e.g. for showing load masks
-        this.viewer.eventManager.fireEvent(ViewerEvent.MaterialCreationEnd, materialId, allMaterialsCreated);
-      }
-    }
-
-    return chosenMaterial as Material;
-  }
-
-  protected async _createMaterial(materialId: string, mesh?: AbstractMesh): Promise<Material> {
-    if (materialId === MaterialManager.CBN_FALLBACK_MATERIAL_NAME) {
-      const fallbackMaterial = new StandardMaterial(MaterialManager.CBN_FALLBACK_MATERIAL_NAME, this.viewer.scene);
-      fallbackMaterial.disableLighting = true;
-
-      return fallbackMaterial;
-    }
-
-    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
-    const material = materialDefinition && Material.Parse(materialDefinition, this.viewer.scene, '');
-
-    if (!material) {
-      throw new ViewerError({
-        id: ViewerErrorIds.MaterialCouldNotBeParsed,
-        message: `Material with id "${materialId}" could not be parsed`,
-      });
-    }
-
-    await this.viewer.parameterManager.applyParameterValuesToMaterial(material);
-
-    const matReadyProms = [
-      new Promise<void>(resolve => BaseTexture.WhenAllReady(material.getActiveTextures(), resolve)),
-    ];
-
-    if (mesh) {
-      // this promise should only take some time on the first call of the corresponding shader (eg: PBRMaterial shader)
-      // on each other call of the same material/shader type there should be not be a waiting time, or at maximum one
-      // frame
-      // https://forum.babylonjs.com/t/mesh-flickering-when-setting-material-initially/37312
-      matReadyProms.push(material.forceCompilationAsync(mesh));
-    }
-
-    // material needs to fulfill 2 criterias before it's ready to use
-    // - textures need to be "ready" => downloaded
-    // - dedicated shader needs to be compiled
-    // if this would not be the case you can see some "flickering" when setting the material
-    await Promise.all(matReadyProms);
-
-    return material;
-  }
-}
+import {
+  AbstractMesh,
+  BaseTexture,
+  Material,
+  StandardMaterial,
+  Viewer,
+  ViewerError,
+  ViewerErrorIds,
+  ViewerEvent,
+} from '../index';
+import {
+  clearInternalMetadataValue,
+  getInternalMetadataValue,
+  setInternalMetadataValue,
+} from '../internal/metadata-helper';
+
+/**
+ * Manager for material related tasks
+ */
+export class MaterialManager {
+  /**
+   * CAUTION: this has to be in sync with the Combeenation backend!
+   * @internal
+   */
+  public static readonly CBN_FALLBACK_MATERIAL_NAME = '$fallback';
+
+  protected _createMaterialPromises: { [materialId: string]: Promise<Material | null> } = {};
+
+  /** @internal */
+  public constructor(protected viewer: Viewer) {}
+
+  /**
+   * Assigns material with certain id to desired mesh.\
+   * Creates the material if not already available (see {@link getOrCreateMaterial}).
+   */
+  public async setMaterialOnMesh(materialId: string, mesh: AbstractMesh): Promise<void> {
+    setInternalMetadataValue(mesh, 'materialToBeSet', materialId);
+
+    const material = await this.getOrCreateMaterial(materialId, mesh);
+
+    // there may have been later "setMaterialOnMesh" calls with faster material creation
+    // make sure to assign the latest material!
+    if (getInternalMetadataValue(mesh, 'materialToBeSet') === materialId) {
+      mesh.material = material;
+      clearInternalMetadataValue(mesh, 'materialToBeSet');
+      clearInternalMetadataValue(mesh, 'deferredMaterial');
+    }
+  }
+
+  /**
+   * Returns material with certain id if already available in the scene.\
+   * If this is not the case material is created from a
+   * "[Material asset](https://docs.combeenation.com/docs/howto-create-and-use-babylon-and-material-asset)"
+   * on the Combeenation server.\
+   * Waits until textures of material are fully loaded and shader is compiled. In this way "flickering" effects
+   * will be avoided, since the material would be incomplete without its loaded textures.
+   *
+   * @param mesh Required for shader compilation check, can be omitted if this check should not be done.\
+   * Use {@link setMaterialOnMesh} instead if the material should be applied on the mesh immediately.
+   */
+  public async getOrCreateMaterial(materialId: string, mesh?: AbstractMesh): Promise<Material> {
+    let chosenMaterial: Material | null = this.viewer.scene.materials.find(mat => mat.id === materialId) ?? null;
+
+    if (!chosenMaterial) {
+      // material not available yet, request it from Combeenation assets
+      const existingCreationProm = this._createMaterialPromises[materialId];
+      if (existingCreationProm !== undefined) {
+        // request is already pending, just wait for the result
+        chosenMaterial = await existingCreationProm;
+      } else {
+        this.viewer.eventManager.fireEvent(ViewerEvent.MaterialCreationStart, materialId);
+
+        // request not pending, call the dedicated function
+        const newCreationProm = this._createMaterial(materialId, mesh);
+        // store the promise in a global map, so that subsequent requests can reference it
+        this._createMaterialPromises[materialId] = newCreationProm;
+        chosenMaterial = await newCreationProm;
+
+        delete this._createMaterialPromises[materialId];
+
+        const allMaterialsCreated = !Object.entries(this._createMaterialPromises).length;
+        // signalize event system that material is created now
+        // also check if there are other material creation processes still pending, as this is an important information
+        // e.g. for showing load masks
+        this.viewer.eventManager.fireEvent(ViewerEvent.MaterialCreationEnd, materialId, allMaterialsCreated);
+      }
+    }
+
+    return chosenMaterial as Material;
+  }
+
+  protected async _createMaterial(materialId: string, mesh?: AbstractMesh): Promise<Material> {
+    if (materialId === MaterialManager.CBN_FALLBACK_MATERIAL_NAME) {
+      const fallbackMaterial = new StandardMaterial(MaterialManager.CBN_FALLBACK_MATERIAL_NAME, this.viewer.scene);
+      fallbackMaterial.disableLighting = true;
+
+      return fallbackMaterial;
+    }
+
+    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
+    const material = materialDefinition && Material.Parse(materialDefinition, this.viewer.scene, '');
+
+    if (!material) {
+      throw new ViewerError({
+        id: ViewerErrorIds.MaterialCouldNotBeParsed,
+        message: `Material with id "${materialId}" could not be parsed`,
+      });
+    }
+
+    await this.viewer.parameterManager.applyParameterValuesToMaterial(material);
+
+    const matReadyProms = [
+      new Promise<void>(resolve => BaseTexture.WhenAllReady(material.getActiveTextures(), resolve)),
+    ];
+
+    if (mesh) {
+      // this promise should only take some time on the first call of the corresponding shader (eg: PBRMaterial shader)
+      // on each other call of the same material/shader type there should be not be a waiting time, or at maximum one
+      // frame
+      // https://forum.babylonjs.com/t/mesh-flickering-when-setting-material-initially/37312
+      matReadyProms.push(material.forceCompilationAsync(mesh));
+    }
+
+    // material needs to fulfill 2 criterias before it's ready to use
+    // - textures need to be "ready" => downloaded
+    // - dedicated shader needs to be compiled
+    // if this would not be the case you can see some "flickering" when setting the material
+    await Promise.all(matReadyProms);
+
+    return material;
+  }
+}