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

package/package.json

@@ -1,91 +1,94 @@
-{
-  "name": "@combeenation/3d-viewer",
-  "version": "14.0.1-rc1",
-  "description": "Combeenation 3D Viewer",
-  "homepage": "https://github.com/Combeenation/3d-viewer#readme",
-  "bugs": {
-    "url": "https://github.com/Combeenation/3d-viewer/issues"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/Combeenation/3d-viewer.git"
-  },
-  "license": "Apache 2.0",
-  "author": "",
-  "contributors": [],
-  "main": "dist/lib-cjs/index.js",
-  "module": "dist/lib-cjs/index.js",
-  "typings": "dist/lib-cjs/index.d.ts",
-  "directories": {
-    "doc": "docs"
-  },
-  "files": [
-    "dist",
-    "src"
-  ],
-  "scripts": {
-    "bundle-analyzer": "npm run generate-profile && webpack-bundle-analyzer dist/webpack-stats.json dist/lib-full",
-    "clean-dist": "rimraf dist",
-    "dev": "cross-env NODE_ENV='development' webpack serve --config build/webpack.debug.conf.js --progress --hot",
-    "dist-cjs": "npm run clean-dist && npm run lint && tsc --project commonjs.tsconfig.json && npm run replace-version",
-    "dist-full-dev": "npm run clean-dist && npm run lint && cross-env NODE_ENV='development' webpack --config build/webpack.build.conf.js --progress && npm run replace-version",
-    "dist-full-prod": "npm run clean-dist && npm run lint && cross-env NODE_ENV='production' webpack --config build/webpack.build.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 ./src",
-    "generate-profile": "cross-env NODE_ENV='development' webpack --config build/webpack.build.conf.js --profile --json > dist/webpack-stats.json",
-    "lint": "eslint src/**",
-    "pack": "npm run dist-cjs && npm pack",
-    "pack-to-cjs": "npm run dist-cjs && npm pack --pack-destination=\"/mnt/c/Data/dev/custom-js/MichaelTest/TextureLoadEventsTest/\"",
-    "pub-alpha": "npm run dist-cjs && npm publish --tag alpha",
-    "pub-beta": "npm run dist-cjs && npm publish --tag beta",
-    "pub-final": "npm run dist-cjs && npm publish",
-    "pub-rc": "npm run dist-cjs && npm publish --tag rc",
-    "replace-version": "cross-env-shell replace \"@VERSION@\" $npm_package_version dist -r",
-    "types": "tsc --project declaration.tsconfig.json"
-  },
-  "prettier": "@combeenation/prettier-config",
-  "dependencies": {
-    "@babylonjs/core": "7.0.0",
-    "@babylonjs/loaders": "7.0.0",
-    "@babylonjs/serializers": "7.0.0",
-    "eventemitter3": "4.0.7",
-    "is-svg": "^5.0.0",
-    "lodash-es": "4.17.21"
-  },
-  "devDependencies": {
-    "@combeenation/eslint-config": "0.0.5",
-    "@combeenation/prettier-config": "0.0.3",
-    "@combeenation/ts-config": "0.0.2",
-    "@knodes/typedoc-plugin-pages": "0.23.1",
-    "@types/lodash-es": "4.17.6",
-    "clean-webpack-plugin": "4.0.0",
-    "cross-env": "7.0.3",
-    "eslint": "8.25.0",
-    "html-webpack-plugin": "5.5.0",
-    "prettier": "2.7.1",
-    "replace": "1.2.1",
-    "rimraf": "3.0.2",
-    "terser-webpack-plugin": "5.3.6",
-    "ts-loader": "9.4.1",
-    "typedoc": "0.23.15",
-    "typedoc-plugin-merge-modules": "4.0.1",
-    "typescript": "4.8.4",
-    "webpack": "5.74.0",
-    "webpack-bundle-analyzer": "4.6.1",
-    "webpack-cli": "4.10.0",
-    "webpack-dev-server": "4.11.1",
-    "webpack-merge": "5.8.0"
-  },
-  "optionalDependencies": {
-    "@babylonjs/gui": "7.0.0",
-    "@babylonjs/gui-editor": "7.0.0",
-    "@babylonjs/inspector": "7.0.0",
-    "@babylonjs/materials": "7.0.0",
-    "@babylonjs/node-editor": "7.0.0",
-    "@babylonjs/node-geometry-editor": "7.0.0"
-  },
-  "optionalDependenciesComments": {
-    "@babylonjs": "Defining the inspector package (and it's dependencies) as optional is required to omit these packages in the production build of the CBN react-app (see CB-9269)"
-  }
-}
+{
+  "name": "@combeenation/3d-viewer",
+  "version": "15.0.0",
+  "description": "Combeenation 3D Viewer",
+  "homepage": "https://github.com/Combeenation/3d-viewer#readme",
+  "bugs": {
+    "url": "https://github.com/Combeenation/3d-viewer/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Combeenation/3d-viewer.git"
+  },
+  "license": "Apache 2.0",
+  "author": "",
+  "contributors": [],
+  "main": "dist/lib-cjs/index.js",
+  "module": "dist/lib-cjs/index.js",
+  "typings": "dist/lib-cjs/index.d.ts",
+  "directories": {
+    "doc": "docs"
+  },
+  "files": [
+    "dist",
+    "src"
+  ],
+  "scripts": {
+    "bundle-analyzer": "npm run generate-profile && webpack-bundle-analyzer dist/webpack-stats.json dist/lib-full",
+    "clean-dist": "rimraf dist",
+    "dev": "cross-env NODE_ENV='development' webpack serve --config build/webpack.debug.conf.js --progress --hot",
+    "dist-cjs": "npm run clean-dist && npm run lint && tsc --project commonjs.tsconfig.json && npm run replace-version",
+    "dist-full-dev": "npm run clean-dist && npm run lint && cross-env NODE_ENV='development' webpack --config build/webpack.build.conf.js --progress && npm run replace-version",
+    "dist-full-prod": "npm run clean-dist && npm run lint && cross-env NODE_ENV='production' webpack --config build/webpack.build.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 ./src",
+    "generate-profile": "cross-env NODE_ENV='development' webpack --config build/webpack.build.conf.js --profile --json > dist/webpack-stats.json",
+    "lint": "eslint src/**",
+    "pack": "npm run dist-cjs && npm pack",
+    "pack-to-cjs": "npm run dist-cjs && npm pack --pack-destination=\"/mnt/c/Data/dev/custom-js/MichaelTest/TextureLoadEventsTest/\"",
+    "pub-alpha": "npm run dist-cjs && npm publish --tag alpha",
+    "pub-beta": "npm run dist-cjs && npm publish --tag beta",
+    "pub-final": "npm run dist-cjs && npm publish",
+    "pub-rc": "npm run dist-cjs && npm publish --tag rc",
+    "replace-version": "cross-env-shell replace \"@VERSION@\" $npm_package_version dist -r",
+    "types": "tsc --project declaration.tsconfig.json"
+  },
+  "prettier": "@combeenation/prettier-config",
+  "dependencies": {
+    "@babylonjs/core": "7.15.2",
+    "@babylonjs/loaders": "7.15.2",
+    "@babylonjs/serializers": "7.15.2",
+    "eventemitter3": "4.0.7",
+    "is-svg": "^5.0.0",
+    "lodash-es": "4.17.21"
+  },
+  "devDependencies": {
+    "@combeenation/eslint-config": "0.0.5",
+    "@combeenation/prettier-config": "0.0.3",
+    "@combeenation/ts-config": "0.0.2",
+    "@knodes/typedoc-plugin-pages": "0.23.1",
+    "@types/lodash-es": "4.17.6",
+    "clean-webpack-plugin": "4.0.0",
+    "cross-env": "7.0.3",
+    "eslint": "8.25.0",
+    "html-webpack-plugin": "5.5.0",
+    "prettier": "2.7.1",
+    "replace": "1.2.1",
+    "rimraf": "3.0.2",
+    "terser-webpack-plugin": "5.3.6",
+    "ts-loader": "9.4.1",
+    "typedoc": "0.23.15",
+    "typedoc-plugin-merge-modules": "4.0.1",
+    "typescript": "4.8.4",
+    "webpack": "5.74.0",
+    "webpack-bundle-analyzer": "4.6.1",
+    "webpack-cli": "4.10.0",
+    "webpack-dev-server": "4.11.1",
+    "webpack-merge": "5.8.0"
+  },
+  "optionalDependencies": {
+    "@babylonjs/gui": "7.15.2",
+    "@babylonjs/gui-editor": "7.15.2",
+    "@babylonjs/inspector": "7.15.2",
+    "@babylonjs/materials": "7.15.2",
+    "@babylonjs/node-editor": "7.15.2",
+    "@babylonjs/node-geometry-editor": "7.15.2"
+  },
+  "dependenciesComments": {
+    "@babylonjs": "Latest version 7.15.2 is required for RTT screenshot fix, see https://forum.babylonjs.com/t/possible-issue-with-screenshots-rtt-and-instanced-meshes/51688/16"
+  },
+  "optionalDependenciesComments": {
+    "@babylonjs": "Defining the inspector package (and it's dependencies) as optional is required to omit these packages in the production build of the CBN react-app (see CB-9269)"
+  }
+}

package/src/buildinfo.json

@@ -1,3 +1,3 @@
-{
-  "version": "@VERSION@"
-}
+{
+  "version": "@VERSION@"
+}

package/src/dev.ts

@@ -1,47 +1,47 @@
-import { Viewer } from '.';
-import {
-  afterViewerSetup,
-  createUIelements,
-  getDefaultSceneSettings,
-  getMaterial,
-  getViewerSettings,
-} from '../assets/index';
-import { mockMaterials } from '../assets/mock-materials';
-import { set } from 'lodash-es';
-
-document.addEventListener('DOMContentLoaded', main);
-
-window.Cbn = {
-  Assets: {
-    async getMaterial(materialId: string): Promise<object> {
-      //! this creates a new function on the object that uses the imported function of the same name..
-      const material = await getMaterial(materialId);
-      if (material) return material;
-
-      // Fallback to random mock material
-      return mockMaterials[Math.floor(Math.random() * mockMaterials.length)];
-    },
-    assertMaterialExists(materialId: string): boolean {
-      return true;
-    },
-  },
-  utils: {
-    Viewer3dHelper: {
-      getCfgrParentDomElementForInspector(): HTMLElement | undefined {
-        // render in parent of viewer
-        return document.querySelector<HTMLElement>('display-container') ?? undefined;
-      },
-    },
-  },
-};
-
-async function main(): Promise<void> {
-  const canvas = document.getElementById('babylon-canvas') as HTMLCanvasElement;
-  const viewer = new Viewer(canvas, getViewerSettings(), getDefaultSceneSettings());
-
-  await afterViewerSetup(viewer);
-  await createUIelements(viewer);
-
-  // "Export" for console testing...
-  set(window, 'viewer', viewer);
-}
+import { Viewer } from '.';
+import {
+  afterViewerSetup,
+  createUIelements,
+  getDefaultSceneSettings,
+  getMaterial,
+  getViewerSettings,
+} from '../assets/index';
+import { mockMaterials } from '../assets/utils/mock-materials';
+import { set } from 'lodash-es';
+
+document.addEventListener('DOMContentLoaded', main);
+
+window.Cbn = {
+  Assets: {
+    async getMaterial(materialId: string): Promise<object> {
+      //! this creates a new function on the object that uses the imported function of the same name..
+      const material = await getMaterial(materialId);
+      if (material) return material;
+
+      // Fallback to random mock material
+      return mockMaterials[Math.floor(Math.random() * mockMaterials.length)];
+    },
+    assertMaterialExists(materialId: string): boolean {
+      return true;
+    },
+  },
+  utils: {
+    Viewer3dHelper: {
+      getCfgrParentDomElementForInspector(): HTMLElement | undefined {
+        // render in parent of viewer
+        return document.querySelector<HTMLElement>('display-container') ?? undefined;
+      },
+    },
+  },
+};
+
+async function main(): Promise<void> {
+  const canvas = document.getElementById('babylon-canvas') as HTMLCanvasElement;
+  const viewer = new Viewer(canvas, getViewerSettings(), getDefaultSceneSettings());
+
+  await afterViewerSetup(viewer);
+  await createUIelements(viewer);
+
+  // "Export" for console testing...
+  set(window, 'viewer', viewer);
+}

package/src/global-types.d.ts

@@ -1,39 +1,39 @@
-/**
- * Enhancement of Typescripts default `Partial` typing, which only creates shallow partials
- */
-type DeepPartial<T> = {
-  [K in keyof T]?: T[K] extends object ? DeepPartial<T[K]> : T[K];
-};
-
-interface Window {
-  Cbn:
-    | undefined /* window.Cbn is only available when viewer runs inside Combeenation configurator */
-    | {
-        Assets: {
-          /**
-           * 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!
-           *
-           * @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): Promise<object | undefined>;
-
-          /**
-           * Checks if a definition for a given material name exists in the configurator and issues a warning if not
-           */
-          assertMaterialExists(materialId: string): boolean;
-        };
-        utils: {
-          Viewer3dHelper: {
-            /**
-             * Returns parent DOM element of a Combeenation configurator, which can be used as root for the inspector.
-             * Also adjusts styling of some configurator parent sub elements to fix the inspector layout.
-             */
-            getCfgrParentDomElementForInspector(): HTMLElement | undefined;
-          };
-        };
-      };
-}
+/**
+ * Enhancement of Typescripts default `Partial` typing, which only creates shallow partials
+ */
+type DeepPartial<T> = {
+  [K in keyof T]?: T[K] extends object ? DeepPartial<T[K]> : T[K];
+};
+
+interface Window {
+  Cbn:
+    | undefined /* window.Cbn is only available when viewer runs inside Combeenation configurator */
+    | {
+        Assets: {
+          /**
+           * 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!
+           *
+           * @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): Promise<object | undefined>;
+
+          /**
+           * Checks if a definition for a given material name exists in the configurator and issues a warning if not
+           */
+          assertMaterialExists(materialId: string): boolean;
+        };
+        utils: {
+          Viewer3dHelper: {
+            /**
+             * Returns parent DOM element of a Combeenation configurator, which can be used as root for the inspector.
+             * Also adjusts styling of some configurator parent sub elements to fix the inspector layout.
+             */
+            getCfgrParentDomElementForInspector(): HTMLElement | undefined;
+          };
+        };
+      };
+}

package/src/index.ts

@@ -1,81 +1,71 @@
-/// <reference path="global-types.d.ts" />
-// Babylon.js extensions
-import '@babylonjs/loaders/glTF/2.0/Extensions/KHR_draco_mesh_compression';
-import '@babylonjs/loaders/glTF/2.0/Extensions/KHR_materials_clearcoat';
-import '@babylonjs/loaders/glTF/2.0/Extensions/KHR_materials_ior';
-import '@babylonjs/loaders/glTF/2.0/Extensions/KHR_materials_pbrSpecularGlossiness';
-import '@babylonjs/loaders/glTF/2.0/Extensions/KHR_materials_sheen';
-import '@babylonjs/loaders/glTF/2.0/Extensions/KHR_materials_specular';
-import '@babylonjs/loaders/glTF/2.0/Extensions/KHR_materials_translucency';
-import '@babylonjs/loaders/glTF/2.0/Extensions/KHR_materials_transmission';
-import '@babylonjs/loaders/glTF/2.0/Extensions/KHR_materials_unlit';
-import '@babylonjs/loaders/glTF/2.0/Extensions/KHR_materials_variants';
-import '@babylonjs/loaders/glTF/2.0/Extensions/KHR_texture_basisu';
-import '@babylonjs/loaders/glTF/2.0/Extensions/KHR_texture_transform';
-import '@babylonjs/serializers/glTF/2.0/Extensions/KHR_texture_transform';
-
-// Babylon.js modules
-// All used Babylyon.js modules should be re-exported here.
-// In this way consumers have access to all of them as well via an import of "@combeenation/3d-viewer" instead of having
-// to make single imports from "@babylonjs/..."
-// When using Babylon.js modules inside the viewer repo make sure to import from the viewer root as well.
-// E.g. `import { BaseTexture, Material, Node } from '../index';`
-export * from '@babylonjs/core/abstractScene';
-export * from '@babylonjs/core/Animations';
-export * from '@babylonjs/core/assetContainer';
-export * from '@babylonjs/core/Buffers';
-export * from '@babylonjs/core/Cameras/arcRotateCamera';
-export * from '@babylonjs/core/Cameras/camera';
-export * from '@babylonjs/core/Culling';
-export * from '@babylonjs/core/Debug/axesViewer';
-export * from '@babylonjs/core/Debug/debugLayer';
-export * from '@babylonjs/core/Engines/engine';
-export * from '@babylonjs/core/Engines/thinEngine';
-export * from '@babylonjs/core/Lights';
-export * from '@babylonjs/core/Loading';
-export * from '@babylonjs/core/Materials/material';
-export * from '@babylonjs/core/Materials/PBR';
-export * from '@babylonjs/core/Materials/standardMaterial';
-export * from '@babylonjs/core/Materials/Textures';
-export * from '@babylonjs/core/Maths';
-export * from '@babylonjs/core/Meshes/abstractMesh';
-export * from '@babylonjs/core/Meshes/geometry';
-export * from '@babylonjs/core/Meshes/instancedMesh';
-export * from '@babylonjs/core/Meshes/mesh';
-export * from '@babylonjs/core/Meshes/meshBuilder';
-export * from '@babylonjs/core/Meshes/transformNode';
-export * from '@babylonjs/core/Misc/interfaces/screenshotSize';
-export * from '@babylonjs/core/Misc/screenshotTools';
-export * from '@babylonjs/core/Morph';
-export * from '@babylonjs/core/node';
-export * from '@babylonjs/core/Rendering/utilityLayerRenderer';
-export * from '@babylonjs/core/scene';
-export * from '@babylonjs/core/types';
-export * from '@babylonjs/loaders/glTF/2.0/glTFLoader';
-export * from '@babylonjs/serializers/glTF/2.0/glTFSerializer';
-
-// Additional Babylon.js modules
-// These are not used in the "@combeenation/3d-viewer" repository directly, but required in consuming code for various
-// reasons
-// for checking camera collions with ground and wall meshes
-export * from '@babylonjs/core/Collisions';
-// for Scene.createDefaultEnvironment
-export * from '@babylonjs/core/Helpers/sceneHelpers';
-// support BackgroundMaterial on Combeenation platform
-export * from '@babylonjs/core/Materials/Background';
-// support NodeMaterial on Combeenation platform
-export * from '@babylonjs/core/Materials/Node';
-
-// Viewer modules
-// all viewer modules that are not located in "internal" should be exported from here
-export * from './viewer';
-export * from './viewer-error';
-export * from './manager/camera-manager';
-export * from './manager/debug-manager';
-export * from './manager/event-manager';
-export * from './manager/gltf-export-manager';
-export * from './manager/material-manager';
-export * from './manager/model-manager';
-export * from './manager/parameter-manager';
-export * from './manager/scene-manager';
-export * from './manager/texture-manager';
+/// <reference path="global-types.d.ts" />
+// Babylon.js extensions
+// All gltf extensions to support maximum feature set
+import '@babylonjs/loaders/glTF/2.0/Extensions';
+import '@babylonjs/serializers/glTF/2.0/Extensions';
+
+// Babylon.js modules
+// All used Babylyon.js modules should be re-exported here.
+// In this way consumers have access to all of them as well via an import of "@combeenation/3d-viewer" instead of having
+// to make single imports from "@babylonjs/..."
+// When using Babylon.js modules inside the viewer repo make sure to import from the viewer root as well.
+// E.g. `import { BaseTexture, Material, Node } from '../index';`
+export * from '@babylonjs/core/abstractScene';
+export * from '@babylonjs/core/Animations';
+export * from '@babylonjs/core/assetContainer';
+export * from '@babylonjs/core/Buffers';
+export * from '@babylonjs/core/Cameras/arcRotateCamera';
+export * from '@babylonjs/core/Cameras/camera';
+export * from '@babylonjs/core/Culling';
+export * from '@babylonjs/core/Debug/axesViewer';
+export * from '@babylonjs/core/Debug/debugLayer';
+export * from '@babylonjs/core/Engines/engine';
+export * from '@babylonjs/core/Engines/thinEngine';
+export * from '@babylonjs/core/Lights';
+export * from '@babylonjs/core/Loading';
+export * from '@babylonjs/core/Materials/material';
+export * from '@babylonjs/core/Materials/PBR';
+export * from '@babylonjs/core/Materials/standardMaterial';
+export * from '@babylonjs/core/Materials/Textures';
+export * from '@babylonjs/core/Maths';
+export * from '@babylonjs/core/Meshes/abstractMesh';
+export * from '@babylonjs/core/Meshes/geometry';
+export * from '@babylonjs/core/Meshes/instancedMesh';
+export * from '@babylonjs/core/Meshes/mesh';
+export * from '@babylonjs/core/Meshes/meshBuilder';
+export * from '@babylonjs/core/Meshes/transformNode';
+export * from '@babylonjs/core/Misc/interfaces/screenshotSize';
+export * from '@babylonjs/core/Misc/screenshotTools';
+export * from '@babylonjs/core/Morph';
+export * from '@babylonjs/core/node';
+export * from '@babylonjs/core/Rendering/utilityLayerRenderer';
+export * from '@babylonjs/core/scene';
+export * from '@babylonjs/core/types';
+export * from '@babylonjs/loaders/glTF/2.0/glTFLoader';
+export * from '@babylonjs/serializers/glTF/2.0/glTFSerializer';
+
+// Additional Babylon.js modules
+// These are not used in the "@combeenation/3d-viewer" repository directly, but required in consuming code for various
+// reasons
+// for checking camera collions with ground and wall meshes
+export * from '@babylonjs/core/Collisions';
+// for Scene.createDefaultEnvironment
+export * from '@babylonjs/core/Helpers/sceneHelpers';
+// support BackgroundMaterial on Combeenation platform
+export * from '@babylonjs/core/Materials/Background';
+// support NodeMaterial on Combeenation platform
+export * from '@babylonjs/core/Materials/Node';
+
+// Viewer modules
+// all viewer modules that are not located in "internal" should be exported from here
+export * from './viewer';
+export * from './viewer-error';
+export * from './manager/camera-manager';
+export * from './manager/debug-manager';
+export * from './manager/event-manager';
+export * from './manager/gltf-export-manager';
+export * from './manager/material-manager';
+export * from './manager/model-manager';
+export * from './manager/parameter-manager';
+export * from './manager/scene-manager';
+export * from './manager/texture-manager';