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

package/src/manager/scene-manager.ts

@@ -1,101 +1,101 @@
-import { ArcRotateCamera, CameraManager, Color4, CubeTexture, Vector3, Viewer } from '../index';
-import { merge } from 'lodash-es';
-
-/**
- * Settings for creating the default scene
- */
-export type DefaultSceneSettings = {
-  backgroundColor: Color4;
-  camera: {
-    create: boolean;
-    initialPosition: {
-      alpha: number;
-      beta: number;
-      radius: number;
-      target: Vector3;
-    };
-    settings: {
-      minZ: number;
-      lowerRadiusLimit: number;
-      wheelPrecision: number;
-      panningSensibility: number;
-    };
-  };
-  environment: {
-    create: boolean;
-    url: string;
-    intensity: number;
-  };
-};
-
-/**
- * Manager for tasks related to the Babylon.js scene.\
- * This contains creating or loading (WIP: Scene Asset) scenes with certain settings for lighting, cameras and
- * appearance in genereal.
- *
- * @internal
- */
-export class SceneManager {
-  protected static _DEFAULT_SCENE_NAME = '__defaultScene__';
-
-  // default scene settings
-  // will be overwritten in the constructor
-  protected _defaultSceneSettings: DefaultSceneSettings = {
-    backgroundColor: new Color4(0, 0, 0, 0),
-    camera: {
-      create: true,
-      initialPosition: CameraManager.DEFAULT_CAMERA_POSITION,
-      settings: {
-        minZ: 0.1,
-        lowerRadiusLimit: 2,
-        wheelPrecision: 100,
-        panningSensibility: 5000,
-      },
-    },
-
-    environment: {
-      create: true,
-      url: 'https://assets.babylonjs.com/environments/environmentSpecular.env',
-      intensity: 1,
-    },
-  };
-
-  public constructor(protected viewer: Viewer, defaultSceneSettings?: DeepPartial<DefaultSceneSettings>) {
-    merge(this._defaultSceneSettings, defaultSceneSettings);
-  }
-
-  /**
-   * Creates a camera and minimum lighting, so that the scene is set up good enough to show content.\
-   * Settings can be overwritten in the constructor.
-   */
-  public applyDefaultSettingsToScene(): void {
-    const cameraSettings = this._defaultSceneSettings.camera;
-    const envSettings = this._defaultSceneSettings.environment;
-
-    this.viewer.scene.clearColor = this._defaultSceneSettings.backgroundColor;
-
-    // camera
-    if (cameraSettings.create) {
-      const camera = new ArcRotateCamera(
-        `${SceneManager._DEFAULT_SCENE_NAME}.camera`,
-        cameraSettings.initialPosition.alpha,
-        cameraSettings.initialPosition.beta,
-        cameraSettings.initialPosition.radius,
-        cameraSettings.initialPosition.target,
-        this.viewer.scene
-      );
-      camera.attachControl(this.viewer.engine._workingCanvas, true);
-      camera.minZ = cameraSettings.settings.minZ;
-      camera.lowerRadiusLimit = cameraSettings.settings.lowerRadiusLimit;
-      camera.wheelPrecision = cameraSettings.settings.wheelPrecision;
-      camera.panningSensibility = cameraSettings.settings.panningSensibility;
-    }
-
-    // environment
-    if (envSettings.create) {
-      const envTexture = CubeTexture.CreateFromPrefilteredData(envSettings.url, this.viewer.scene);
-      this.viewer.scene.environmentTexture = envTexture;
-      this.viewer.scene.environmentIntensity = envSettings.intensity;
-    }
-  }
-}
+import { ArcRotateCamera, CameraManager, Color4, CubeTexture, Vector3, Viewer } from '../index';
+import { merge } from 'lodash-es';
+
+/**
+ * Settings for creating the default scene
+ */
+export type DefaultSceneSettings = {
+  backgroundColor: Color4;
+  camera: {
+    create: boolean;
+    initialPosition: {
+      alpha: number;
+      beta: number;
+      radius: number;
+      target: Vector3;
+    };
+    settings: {
+      minZ: number;
+      lowerRadiusLimit: number;
+      wheelPrecision: number;
+      panningSensibility: number;
+    };
+  };
+  environment: {
+    create: boolean;
+    url: string;
+    intensity: number;
+  };
+};
+
+/**
+ * Manager for tasks related to the Babylon.js scene.\
+ * This contains creating or loading (WIP: Scene Asset) scenes with certain settings for lighting, cameras and
+ * appearance in genereal.
+ *
+ * @internal
+ */
+export class SceneManager {
+  protected static _DEFAULT_SCENE_NAME = '__defaultScene__';
+
+  // default scene settings
+  // will be overwritten in the constructor
+  protected _defaultSceneSettings: DefaultSceneSettings = {
+    backgroundColor: new Color4(0, 0, 0, 0),
+    camera: {
+      create: true,
+      initialPosition: CameraManager.DEFAULT_CAMERA_POSITION,
+      settings: {
+        minZ: 0.1,
+        lowerRadiusLimit: 2,
+        wheelPrecision: 100,
+        panningSensibility: 5000,
+      },
+    },
+
+    environment: {
+      create: true,
+      url: 'https://assets.babylonjs.com/environments/environmentSpecular.env',
+      intensity: 1,
+    },
+  };
+
+  public constructor(protected viewer: Viewer, defaultSceneSettings?: DeepPartial<DefaultSceneSettings>) {
+    merge(this._defaultSceneSettings, defaultSceneSettings);
+  }
+
+  /**
+   * Creates a camera and minimum lighting, so that the scene is set up good enough to show content.\
+   * Settings can be overwritten in the constructor.
+   */
+  public applyDefaultSettingsToScene(): void {
+    const cameraSettings = this._defaultSceneSettings.camera;
+    const envSettings = this._defaultSceneSettings.environment;
+
+    this.viewer.scene.clearColor = this._defaultSceneSettings.backgroundColor;
+
+    // camera
+    if (cameraSettings.create) {
+      const camera = new ArcRotateCamera(
+        `${SceneManager._DEFAULT_SCENE_NAME}.camera`,
+        cameraSettings.initialPosition.alpha,
+        cameraSettings.initialPosition.beta,
+        cameraSettings.initialPosition.radius,
+        cameraSettings.initialPosition.target,
+        this.viewer.scene
+      );
+      camera.attachControl(this.viewer.engine._workingCanvas, true);
+      camera.minZ = cameraSettings.settings.minZ;
+      camera.lowerRadiusLimit = cameraSettings.settings.lowerRadiusLimit;
+      camera.wheelPrecision = cameraSettings.settings.wheelPrecision;
+      camera.panningSensibility = cameraSettings.settings.panningSensibility;
+    }
+
+    // environment
+    if (envSettings.create) {
+      const envTexture = CubeTexture.CreateFromPrefilteredData(envSettings.url, this.viewer.scene);
+      this.viewer.scene.environmentTexture = envTexture;
+      this.viewer.scene.environmentIntensity = envSettings.intensity;
+    }
+  }
+}

package/src/manager/texture-manager.ts

@@ -1,32 +1,32 @@
-import { BaseTexture, Viewer } from '../index';
-
-/**
- * Manager for texture related tasks, like renaming textures that are based on Combeenation image assets.\
- * Doesn't have any public functionalities ATM.
- *
- * @internal
- */
-export class TextureManager {
-  public constructor(protected viewer: Viewer) {
-    this.viewer.scene.onNewTextureAddedObservable.add(texture => this._onTextureAdded(texture));
-  }
-
-  protected async _onTextureAdded(texture: BaseTexture): Promise<void> {
-    // Workaround:
-    // The texture object is not fully created when the "added observable" is called. E.g. the function
-    // `onLoadObservable` is not there at that point and the name is not even set.
-    // More details: https://forum.babylonjs.com/t/basetexture-whenallready-returns-too-early/34501/4
-    await new Promise(resolve => window.setTimeout(resolve, 0));
-
-    // textures based CBN image assets are hard to analyse in the inspector, since the asset url is set as name
-    // with this functionality we try to find these CBN image assets and crop the name accordingly
-    // => see CB-9558
-    const isUrl = texture.name.startsWith('https://');
-    const textureQueryString = '?name=';
-    const indexOfTextureQueryParam = texture.name.lastIndexOf(textureQueryString);
-
-    if (isUrl && indexOfTextureQueryParam > -1) {
-      texture.name = texture.name.substring(indexOfTextureQueryParam + textureQueryString.length);
-    }
-  }
-}
+import { BaseTexture, Viewer } from '../index';
+
+/**
+ * Manager for texture related tasks, like renaming textures that are based on Combeenation image assets.\
+ * Doesn't have any public functionalities ATM.
+ *
+ * @internal
+ */
+export class TextureManager {
+  public constructor(protected viewer: Viewer) {
+    this.viewer.scene.onNewTextureAddedObservable.add(texture => this._onTextureAdded(texture));
+  }
+
+  protected async _onTextureAdded(texture: BaseTexture): Promise<void> {
+    // Workaround:
+    // The texture object is not fully created when the "added observable" is called. E.g. the function
+    // `onLoadObservable` is not there at that point and the name is not even set.
+    // More details: https://forum.babylonjs.com/t/basetexture-whenallready-returns-too-early/34501/4
+    await new Promise(resolve => window.setTimeout(resolve, 0));
+
+    // textures based CBN image assets are hard to analyse in the inspector, since the asset url is set as name
+    // with this functionality we try to find these CBN image assets and crop the name accordingly
+    // => see CB-9558
+    const isUrl = texture.name.startsWith('https://');
+    const textureQueryString = '?name=';
+    const indexOfTextureQueryParam = texture.name.lastIndexOf(textureQueryString);
+
+    if (isUrl && indexOfTextureQueryParam > -1) {
+      texture.name = texture.name.substring(indexOfTextureQueryParam + textureQueryString.length);
+    }
+  }
+}

package/src/viewer-error.ts

@@ -1,68 +1,69 @@
-/**
- * Combeenation configurators are explicitly catching and handling some specific errors thrown by the viewer.
- * We use this custom error class which adds a unique ID to each error so that we can safely distinguish the different
- * errors without having to look at the thrown text.
- */
-
-type ViewerErrorData = {
-  /** One of `GlobalViewerErrorIds` */
-  id: string;
-  message: string;
-};
-
-/**
- * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
- * !!! Note: Combeenation viewer ctrl needs to be adjusted, whenever changing existing keys here. !!!
- * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
- *
- * IDs here shall only include "word characters" (`/w` in RegEx) as `GetViewerErrorIdFromMsg` wouldn't work correctly
- * otherwise.
- * @internal
- */
-export const ViewerErrorIds = {
-  InvalidParameterValue: 'InvalidParameterValue',
-  ModelNotRegistered: 'ModelNotRegistered',
-  ModelAlreadyExists: 'ModelAlreadyExists',
-  ModelIsNotAClone: 'ModelIsNotAClone',
-  AssetLoadingFailed: 'AssetLoadingFailed',
-  MaterialCouldNotBeParsed: 'MaterialCouldNotBeParsed',
-};
-
-/** @internal */
-export class ViewerError extends Error {
-  viewerErrorId: string;
-
-  constructor(data: ViewerErrorData) {
-    // Unfortunately we can't access the custom `viewerErrorId` property when catching global errors in Combeenation so
-    // we also have to add the ID to the message itself.
-    super(`[${data.id}] ${data.message}`);
-    this.viewerErrorId = data.id;
-  }
-
-  /**
-   * Splits the given error message into a known viewer error id and the message itself.
-   *
-   * E.g.:
-   * Message `[InvalidParameterValue] Some error msg` returns `{ id: 'InvalidParameterValue', msg: 'Some error msg' }`
-   *
-   * @param message An error message in the form `[KnownErrorId] Some error msg`
-   * @returns id = The extracted error id (one of `GlobalViewerErrorIds`) or `undefined` if no valid ID has been found
-   *          msg = The error message without the prefixed ID. Returns the whole given `message` if it isn't prefixed
-   *                with a known ID in the correct format.
-   */
-  static SplitViewerErrorMsg(message: string): { id: string | undefined; msg: string } {
-    const knownIds = Object.values(ViewerErrorIds).join('|');
-
-    // RegEx:
-    //   `^`                  = Start of string
-    //   `\\[`                = Literal `[`
-    //   `(?<id>abc|xyz|...)` = Named capture group `id` which looks for one of the existing error ids
-    //   `] `                 = Literal `] `
-    //   `(?<msg>.*)`         = Named capture group `msg` which looks for everything after the matched group id
-    const result = new RegExp('^\\[(?<id>' + knownIds + ')] (?<msg>.*)').exec(message);
-    const id = result?.groups?.id;
-    const msg = result?.groups?.msg || message;
-
-    return { id, msg };
-  }
-}
+/**
+ * Combeenation configurators are explicitly catching and handling some specific errors thrown by the viewer.
+ * We use this custom error class which adds a unique ID to each error so that we can safely distinguish the different
+ * errors without having to look at the thrown text.
+ */
+
+type ViewerErrorData = {
+  /** One of `GlobalViewerErrorIds` */
+  id: string;
+  message: string;
+};
+
+/**
+ * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+ * !!! Note: Combeenation viewer ctrl needs to be adjusted, whenever changing existing keys here. !!!
+ * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+ *
+ * IDs here shall only include "word characters" (`/w` in RegEx) as `GetViewerErrorIdFromMsg` wouldn't work correctly
+ * otherwise.
+ * @internal
+ */
+export const ViewerErrorIds = {
+  InvalidParameterValue: 'InvalidParameterValue',
+  ModelNotRegistered: 'ModelNotRegistered',
+  ModelAlreadyExists: 'ModelAlreadyExists',
+  ModelIsNotAClone: 'ModelIsNotAClone',
+  AssetLoadingFailed: 'AssetLoadingFailed',
+  MaterialCouldNotBeParsed: 'MaterialCouldNotBeParsed',
+  TextureCouldNotBeParsed: 'TextureCouldNotBeParsed',
+};
+
+/** @internal */
+export class ViewerError extends Error {
+  viewerErrorId: string;
+
+  constructor(data: ViewerErrorData) {
+    // Unfortunately we can't access the custom `viewerErrorId` property when catching global errors in Combeenation so
+    // we also have to add the ID to the message itself.
+    super(`[${data.id}] ${data.message}`);
+    this.viewerErrorId = data.id;
+  }
+
+  /**
+   * Splits the given error message into a known viewer error id and the message itself.
+   *
+   * E.g.:
+   * Message `[InvalidParameterValue] Some error msg` returns `{ id: 'InvalidParameterValue', msg: 'Some error msg' }`
+   *
+   * @param message An error message in the form `[KnownErrorId] Some error msg`
+   * @returns id = The extracted error id (one of `GlobalViewerErrorIds`) or `undefined` if no valid ID has been found
+   *          msg = The error message without the prefixed ID. Returns the whole given `message` if it isn't prefixed
+   *                with a known ID in the correct format.
+   */
+  static SplitViewerErrorMsg(message: string): { id: string | undefined; msg: string } {
+    const knownIds = Object.values(ViewerErrorIds).join('|');
+
+    // RegEx:
+    //   `^`                  = Start of string
+    //   `\\[`                = Literal `[`
+    //   `(?<id>abc|xyz|...)` = Named capture group `id` which looks for one of the existing error ids
+    //   `] `                 = Literal `] `
+    //   `(?<msg>.*)`         = Named capture group `msg` which looks for everything after the matched group id
+    const result = new RegExp('^\\[(?<id>' + knownIds + ')] (?<msg>.*)').exec(message);
+    const id = result?.groups?.id;
+    const msg = result?.groups?.msg || message;
+
+    return { id, msg };
+  }
+}