@combeenation/3d-viewer 10.0.0-alpha3 → 11.0.0-beta1

package/dist/lib-cjs/api/store/specStorage.js

@@ -1,66 +1,66 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SpecStorage = void 0;
-const lodash_es_1 = require("lodash-es");
-class SpecStorage {
-    /**
-     * Constructor.
-     */
-    constructor(spec) {
-        this.spec = spec;
-    }
-    /**
-     * Creates {@link SpecStorage} from spec.
-     */
-    static createFromSpec(structureJson) {
-        if (this.instance) {
-            throw new Error(`SpecStorage has already been created.`);
-        }
-        return (this.instance = new this(structureJson));
-    }
-    /**
-     * Gets the {@link SpecStorage} instance.
-     */
-    static getInstance() {
-        if (!this.instance || !this.instance.spec) {
-            throw new Error(`SpecStore has not been properly created.`);
-        }
-        return this.instance;
-    }
-    /**
-     * Gets the spec from the {@link SpecStorage}.
-     */
-    static getSpec() {
-        return this.getInstance().spec;
-    }
-    /**
-     * Destroys the current instance to allow reinstantiating the SpecStorage.
-     */
-    static destroy() {
-        this.instance = undefined;
-    }
-    /**
-     * Gets spec from key.
-     */
-    static get(key) {
-        if (!this.instance || !this.instance.spec) {
-            throw new Error(`SpecStore has not been properly created.`);
-        }
-        if (key) {
-            return (0, lodash_es_1.get)(this.instance.spec, key);
-        }
-        return this.instance.spec;
-    }
-    /**
-     * Sets value for spec for given key.
-     */
-    static set(key, value) {
-        if (!this.instance || !this.instance.spec) {
-            throw new Error(`SpecStore has not been properly created.`);
-        }
-        (0, lodash_es_1.set)(this.instance.spec, key, value);
-        return SpecStorage;
-    }
-}
-exports.SpecStorage = SpecStorage;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SpecStorage = void 0;
+const lodash_es_1 = require("lodash-es");
+class SpecStorage {
+    /**
+     * Constructor.
+     */
+    constructor(spec) {
+        this.spec = spec;
+    }
+    /**
+     * Creates {@link SpecStorage} from spec.
+     */
+    static createFromSpec(structureJson) {
+        if (this.instance) {
+            throw new Error(`SpecStorage has already been created.`);
+        }
+        return (this.instance = new this(structureJson));
+    }
+    /**
+     * Gets the {@link SpecStorage} instance.
+     */
+    static getInstance() {
+        if (!this.instance || !this.instance.spec) {
+            throw new Error(`SpecStore has not been properly created.`);
+        }
+        return this.instance;
+    }
+    /**
+     * Gets the spec from the {@link SpecStorage}.
+     */
+    static getSpec() {
+        return this.getInstance().spec;
+    }
+    /**
+     * Destroys the current instance to allow reinstantiating the SpecStorage.
+     */
+    static destroy() {
+        this.instance = undefined;
+    }
+    /**
+     * Gets spec from key.
+     */
+    static get(key) {
+        if (!this.instance || !this.instance.spec) {
+            throw new Error(`SpecStore has not been properly created.`);
+        }
+        if (key) {
+            return (0, lodash_es_1.get)(this.instance.spec, key);
+        }
+        return this.instance.spec;
+    }
+    /**
+     * Sets value for spec for given key.
+     */
+    static set(key, value) {
+        if (!this.instance || !this.instance.spec) {
+            throw new Error(`SpecStore has not been properly created.`);
+        }
+        (0, lodash_es_1.set)(this.instance.spec, key, value);
+        return SpecStorage;
+    }
+}
+exports.SpecStorage = SpecStorage;
 //# sourceMappingURL=specStorage.js.map

package/dist/lib-cjs/api/util/babylonHelper.d.ts

@@ -1,238 +1,238 @@
-import { DottedPath } from '../classes/dottedPath';
-import { HighlightLayer } from '@babylonjs/core/Layers/highlightLayer';
-import { ShadowGenerator } from '@babylonjs/core/Lights/Shadows/shadowGenerator';
-import { BaseTexture } from '@babylonjs/core/Materials/Textures/baseTexture';
-import { Texture } from '@babylonjs/core/Materials/Textures/texture';
-import { Material } from '@babylonjs/core/Materials/material';
-import { Color3 } from '@babylonjs/core/Maths/math.color';
-import { AbstractMesh } from '@babylonjs/core/Meshes/abstractMesh';
-import { TransformNode } from '@babylonjs/core/Meshes/transformNode';
-import { Observable } from '@babylonjs/core/Misc/observable';
-import { Node } from '@babylonjs/core/node';
-import { Scene } from '@babylonjs/core/scene';
-declare const backgroundDomeName = "BackgroundDome_ViewerGenerated";
-declare const envHelperMetadataName = "viewerEnvHelper";
-/**
- * @param node
- * @return Node
- */
-declare const getRootNode: (node: Node) => Node;
-/**
- * @param nodes
- * @param predicate
- * @return Map<DottedPath, T>
- */
-declare const mapToDottedNodes: <T>(nodes: Node[], predicate?: ((node: Node) => boolean) | undefined) => Map<DottedPath, T>;
-/**
- * @param node
- * @return DottedPath
- */
-declare const getDottedPathForNode: (node: Node) => DottedPath;
-/**
- * @param node
- * @param nodeNamingStrategy
- * @param predicate
- * @param deep
- * @return TransformNode | null
- */
-declare const cloneTransformNode: (node: TransformNode, nodeNamingStrategy: NodeNamingStrategy, predicate?: ((node: TransformNode) => boolean) | undefined, deep?: boolean) => TransformNode | null;
-/**
- * @param node
- */
-declare const cloneNodeWithParents: (node: Node | null) => Node | null;
-/**
- * @param node
- * @param deep
- * @param prefix
- * @return TransformNode
- */
-declare const cloneTransformNodeMaterial: (node: TransformNode, prefix?: DottedPathArgument, deep?: boolean) => TransformNode;
-/**
- * @param object
- * @param deep
- * @param metadata
- */
-declare const injectMetadata: (object: Node | Material, metadata: {}, deep?: boolean) => void;
-/**
- * @param node
- * @param assertCallable
- * @param callableParameters
- * @param deep
- */
-declare const assertTransformNode: (node: TransformNode, assertCallable: (node: TransformNode, ...args: any[]) => void, callableParameters?: any[], deep?: boolean) => void;
-/**
- * @param node
- * @param parameter
- */
-declare const assertMeshCapability: (node: TransformNode, parameter: string) => void;
-/**
- * @param node
- * @param deep
- */
-declare const activateTransformNode: (node: TransformNode, deep?: boolean) => void;
-/**
- * @param node
- * @param deep
- */
-declare const deactivateTransformNode: (node: TransformNode, deep?: boolean) => void;
-/**
- * @param node
- */
-declare const enableNodeWithParents: (node: Node) => void;
-/**
- * @param node
- */
-declare const disableNodeWithParents: (node: Node) => void;
-/**
- * Applies a {@link TransformationDefinition} consecutively to ensure dependencies in positioning etc.
- * @param node
- * @param transformation
- */
-declare const transformTransformNode: (node: TransformNode, transformation: TransformationDefinition) => void;
-/**
- * Apply changes of environment (background texture, etc.) consecutively in order to avoid dependency related issues.
- * @param scene
- * @param envDef
- */
-declare const changeEnvironment: (scene: Scene, envDef: EnvironmentDefinition) => void;
-/**
- * Sets a material by a given material id as material property on the given node.
- *
- * If the material is not already available in the scene, the viewer tries to create a material based on a Combeenation
- * [material asset](https://docs.combeenation.com/docs/howto-create-and-use-babylon-and-material-asset).
- * This of course only works if the viewer is used inside a Combeenation configurator.
- *
- * Furthermore this function also defers the material creation if the node is not visible yet to improve network &
- * viewer bootstrap performance as textures are automatically being lazy loaded only when they are actually visible in
- * the scene.
- *
- * Finally the material will not be applied before all its textures have been loaded. In this way "flickering" effects
- * will be avoided, since the material would be incomplete without its loaded textures.
- */
-declare const setMaterial: (node: TransformNode, materialId: string, deep?: boolean, variant?: Variant) => void;
-/**
- * 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.
- */
-declare const getOrCreateMaterial: (scene: Scene, materialId: string, variant?: Variant) => Promise<Material>;
-/**
- * Waits until the materials textures are loaded and shaders are compiled.
- * Then sets the material on the node if there is no newer "set material" request
- */
-declare const applyMaterial: (material: Material, node: AbstractMesh) => Promise<void>;
-/**
- * !!! Warning !!!
- * This function is not public API. Whilst it can help solving certain problems, it only works reliably in well defined
- * situations and can cause unwanted side effects under some conditions. Use carefully at your own risk!
- *
- * See https://combeenation.myjetbrains.com/youtrack/issue/CB-5906 for further details regarding this warning.
- *
- * Set material of an instanced meshes source mesh.
- * Changes the material of all instanced meshes which have the same source mesh.
- *
- * @param node
- * @param material
- * @param deep
- *
- * @ignore
- */
-declare const setSourceNodeMaterial: (node: TransformNode, material: Material, deep?: boolean) => void;
-/**
- * @param node
- * @param color
- * @param deep
- */
-declare const setMaterialColor: (node: TransformNode, color: Color3, deep?: boolean) => void;
-/**
- * @param node
- * @param texture
- * @param deep
- */
-declare const setMaterialTexture: (node: TransformNode, texture: Texture, deep?: boolean) => void;
-/**
- * @param node
- * @param metallness
- * @param deep
- */
-declare const setMaterialMetallness: (node: TransformNode, metallness: number, deep?: boolean) => void;
-/**
- * @param node
- * @param roughness
- * @param deep
- */
-declare const setMaterialRoughness: (node: TransformNode, roughness: number, deep?: boolean) => void;
-/**
- * @param node
- * @param layer
- * @param color
- * @param deep
- */
-declare const addToHighlightLayer: (layer: HighlightLayer, color: Color3, node: TransformNode, deep?: boolean) => void;
-/**
- * @param node
- * @param layer
- * @param deep
- */
-declare const removeFromHighlightLayer: (layer: HighlightLayer, node: TransformNode, deep?: boolean) => void;
-/**
- * @param node
- * @param receiveShadows
- * @param deep
- */
-declare const setReceiveShadows: (node: TransformNode, receiveShadows: boolean, deep?: boolean) => void;
-/**
- * @param node
- * @param generator
- * @param deep
- */
-declare const addToShadowGenerator: (generator: ShadowGenerator, node: TransformNode, deep?: boolean) => void;
-/**
- * @param node
- * @param generator
- * @param deep
- */
-declare const removeFromShadowGenerator: (generator: ShadowGenerator, node: TransformNode, deep?: boolean) => void;
-/**
- * https://forum.babylonjs.com/t/get-mesh-bounding-box-position-and-size-in-2d-screen-coordinates/1058/3
- * @param mesh
- * @param scene
- * @param canvas
- */
-declare const getClientRectFromMesh: (mesh: AbstractMesh, scene: Scene, canvas: HTMLCanvasElement) => ClientRect;
-declare type LoadableBaseTexture = BaseTexture & {
-    url: string;
-    onLoadObservable: Observable<BaseTexture>;
-};
-/**
- * This type guard checks whether the given `BaseTextures` is any of its subtypes which comes with an url and
- * `onLoadObservable`.
- *
- * !!! Timing of when this function is called is important !!!
- * See the following for more details: https://forum.babylonjs.com/t/basetexture-whenallready-returns-too-early/34501/6
- */
-declare const isLoadableTexture: (texture: BaseTexture) => texture is LoadableBaseTexture;
-/**
- * @param objects
- * @param tagMapping
- */
-declare const mapTags: (objects: object[], tagMapping: TagMapping) => string[];
-/**
- * Gets an array of ids for nodeIds that exist in both TransformNode arrays.
- * @param nodes1
- * @param nodes2
- * @param predicate
- */
-declare const intersectingNodeNames: (nodes1: Node[], nodes2: Node[], predicate?: ((node: Node) => boolean) | undefined) => string[];
-/**
- * Gets an array of ids for duplicate nodeIds in given node array.
- * @param nodes
- * @param predicate
- */
-declare const duplicateNodeNames: (nodes: Node[], predicate?: ((node: Node) => boolean) | undefined) => string[];
-/**
- * Reports duplicate nodeIds.
- * @param nodeNames
- */
-declare const reportDuplicateNodeNames: (nodeNames: string[]) => void;
-declare const drawPaintableOnMaterial: (material: Material, imageSource: CanvasImageSource, scene: Scene, options?: PaintableOptions) => void;
-export { getRootNode, isLoadableTexture, mapToDottedNodes, getDottedPathForNode, cloneTransformNode, cloneNodeWithParents, cloneTransformNodeMaterial, getOrCreateMaterial, applyMaterial, injectMetadata, assertTransformNode, assertMeshCapability, activateTransformNode, deactivateTransformNode, enableNodeWithParents, disableNodeWithParents, transformTransformNode, setMaterial, setSourceNodeMaterial, setMaterialColor, setMaterialTexture, setMaterialMetallness, setMaterialRoughness, addToHighlightLayer, removeFromHighlightLayer, setReceiveShadows, addToShadowGenerator, removeFromShadowGenerator, getClientRectFromMesh, changeEnvironment, backgroundDomeName, envHelperMetadataName, mapTags, intersectingNodeNames, duplicateNodeNames, reportDuplicateNodeNames, drawPaintableOnMaterial, };
+import { DottedPath } from '../classes/dottedPath';
+import { HighlightLayer } from '@babylonjs/core/Layers/highlightLayer';
+import { ShadowGenerator } from '@babylonjs/core/Lights/Shadows/shadowGenerator';
+import { BaseTexture } from '@babylonjs/core/Materials/Textures/baseTexture';
+import { Texture } from '@babylonjs/core/Materials/Textures/texture';
+import { Material } from '@babylonjs/core/Materials/material';
+import { Color3 } from '@babylonjs/core/Maths/math.color';
+import { AbstractMesh } from '@babylonjs/core/Meshes/abstractMesh';
+import { TransformNode } from '@babylonjs/core/Meshes/transformNode';
+import { Observable } from '@babylonjs/core/Misc/observable';
+import { Node } from '@babylonjs/core/node';
+import { Scene } from '@babylonjs/core/scene';
+declare const backgroundDomeName = "BackgroundDome_ViewerGenerated";
+declare const envHelperMetadataName = "viewerEnvHelper";
+/**
+ * @param node
+ * @return Node
+ */
+declare const getRootNode: (node: Node) => Node;
+/**
+ * @param nodes
+ * @param predicate
+ * @return Map<DottedPath, T>
+ */
+declare const mapToDottedNodes: <T>(nodes: Node[], predicate?: ((node: Node) => boolean) | undefined) => Map<DottedPath, T>;
+/**
+ * @param node
+ * @return DottedPath
+ */
+declare const getDottedPathForNode: (node: Node) => DottedPath;
+/**
+ * @param node
+ * @param nodeNamingStrategy
+ * @param predicate
+ * @param deep
+ * @return TransformNode | null
+ */
+declare const cloneTransformNode: (node: TransformNode, nodeNamingStrategy: NodeNamingStrategy, predicate?: ((node: TransformNode) => boolean) | undefined, deep?: boolean) => TransformNode | null;
+/**
+ * @param node
+ */
+declare const cloneNodeWithParents: (node: Node | null) => Node | null;
+/**
+ * @param node
+ * @param deep
+ * @param prefix
+ * @return TransformNode
+ */
+declare const cloneTransformNodeMaterial: (node: TransformNode, prefix?: DottedPathArgument, deep?: boolean) => TransformNode;
+/**
+ * @param object
+ * @param deep
+ * @param metadata
+ */
+declare const injectMetadata: (object: Node | Material, metadata: {}, deep?: boolean) => void;
+/**
+ * @param node
+ * @param assertCallable
+ * @param callableParameters
+ * @param deep
+ */
+declare const assertTransformNode: (node: TransformNode, assertCallable: (node: TransformNode, ...args: any[]) => void, callableParameters?: any[], deep?: boolean) => void;
+/**
+ * @param node
+ * @param parameter
+ */
+declare const assertMeshCapability: (node: TransformNode, parameter: string) => void;
+/**
+ * @param node
+ * @param deep
+ */
+declare const activateTransformNode: (node: TransformNode, deep?: boolean) => void;
+/**
+ * @param node
+ * @param deep
+ */
+declare const deactivateTransformNode: (node: TransformNode, deep?: boolean) => void;
+/**
+ * @param node
+ */
+declare const enableNodeWithParents: (node: Node) => void;
+/**
+ * @param node
+ */
+declare const disableNodeWithParents: (node: Node) => void;
+/**
+ * Applies a {@link TransformationDefinition} consecutively to ensure dependencies in positioning etc.
+ * @param node
+ * @param transformation
+ */
+declare const transformTransformNode: (node: TransformNode, transformation: TransformationDefinition) => void;
+/**
+ * Apply changes of environment (background texture, etc.) consecutively in order to avoid dependency related issues.
+ * @param scene
+ * @param envDef
+ */
+declare const changeEnvironment: (scene: Scene, envDef: EnvironmentDefinition) => void;
+/**
+ * Sets a material by a given material id as material property on the given node.
+ *
+ * If the material is not already available in the scene, the viewer tries to create a material based on a Combeenation
+ * [material asset](https://docs.combeenation.com/docs/howto-create-and-use-babylon-and-material-asset).
+ * This of course only works if the viewer is used inside a Combeenation configurator.
+ *
+ * Furthermore this function also defers the material creation if the node is not visible yet to improve network &
+ * viewer bootstrap performance as textures are automatically being lazy loaded only when they are actually visible in
+ * the scene.
+ *
+ * Finally the material will not be applied before all its textures have been loaded. In this way "flickering" effects
+ * will be avoided, since the material would be incomplete without its loaded textures.
+ */
+declare const setMaterial: (node: TransformNode, materialId: string, deep?: boolean, variant?: Variant) => void;
+/**
+ * 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.
+ */
+declare const getOrCreateMaterial: (scene: Scene, materialId: string, variant?: Variant) => Promise<Material>;
+/**
+ * Waits until the materials textures are loaded and shaders are compiled.
+ * Then sets the material on the node if there is no newer "set material" request
+ */
+declare const applyMaterial: (material: Material, node: AbstractMesh) => Promise<void>;
+/**
+ * !!! Warning !!!
+ * This function is not public API. Whilst it can help solving certain problems, it only works reliably in well defined
+ * situations and can cause unwanted side effects under some conditions. Use carefully at your own risk!
+ *
+ * See https://combeenation.myjetbrains.com/youtrack/issue/CB-5906 for further details regarding this warning.
+ *
+ * Set material of an instanced meshes source mesh.
+ * Changes the material of all instanced meshes which have the same source mesh.
+ *
+ * @param node
+ * @param material
+ * @param deep
+ *
+ * @ignore
+ */
+declare const setSourceNodeMaterial: (node: TransformNode, material: Material, deep?: boolean) => void;
+/**
+ * @param node
+ * @param color
+ * @param deep
+ */
+declare const setMaterialColor: (node: TransformNode, color: Color3, deep?: boolean) => void;
+/**
+ * @param node
+ * @param texture
+ * @param deep
+ */
+declare const setMaterialTexture: (node: TransformNode, texture: Texture, deep?: boolean) => void;
+/**
+ * @param node
+ * @param metallness
+ * @param deep
+ */
+declare const setMaterialMetallness: (node: TransformNode, metallness: number, deep?: boolean) => void;
+/**
+ * @param node
+ * @param roughness
+ * @param deep
+ */
+declare const setMaterialRoughness: (node: TransformNode, roughness: number, deep?: boolean) => void;
+/**
+ * @param node
+ * @param layer
+ * @param color
+ * @param deep
+ */
+declare const addToHighlightLayer: (layer: HighlightLayer, color: Color3, node: TransformNode, deep?: boolean) => void;
+/**
+ * @param node
+ * @param layer
+ * @param deep
+ */
+declare const removeFromHighlightLayer: (layer: HighlightLayer, node: TransformNode, deep?: boolean) => void;
+/**
+ * @param node
+ * @param receiveShadows
+ * @param deep
+ */
+declare const setReceiveShadows: (node: TransformNode, receiveShadows: boolean, deep?: boolean) => void;
+/**
+ * @param node
+ * @param generator
+ * @param deep
+ */
+declare const addToShadowGenerator: (generator: ShadowGenerator, node: TransformNode, deep?: boolean) => void;
+/**
+ * @param node
+ * @param generator
+ * @param deep
+ */
+declare const removeFromShadowGenerator: (generator: ShadowGenerator, node: TransformNode, deep?: boolean) => void;
+/**
+ * https://forum.babylonjs.com/t/get-mesh-bounding-box-position-and-size-in-2d-screen-coordinates/1058/3
+ * @param mesh
+ * @param scene
+ * @param canvas
+ */
+declare const getClientRectFromMesh: (mesh: AbstractMesh, scene: Scene, canvas: HTMLCanvasElement) => ClientRect;
+declare type LoadableBaseTexture = BaseTexture & {
+    url: string;
+    onLoadObservable: Observable<BaseTexture>;
+};
+/**
+ * This type guard checks whether the given `BaseTextures` is any of its subtypes which comes with an url and
+ * `onLoadObservable`.
+ *
+ * !!! Timing of when this function is called is important !!!
+ * See the following for more details: https://forum.babylonjs.com/t/basetexture-whenallready-returns-too-early/34501/6
+ */
+declare const isLoadableTexture: (texture: BaseTexture) => texture is LoadableBaseTexture;
+/**
+ * @param objects
+ * @param tagMapping
+ */
+declare const mapTags: (objects: object[], tagMapping: TagMapping) => string[];
+/**
+ * Gets an array of ids for nodeIds that exist in both TransformNode arrays.
+ * @param nodes1
+ * @param nodes2
+ * @param predicate
+ */
+declare const intersectingNodeNames: (nodes1: Node[], nodes2: Node[], predicate?: ((node: Node) => boolean) | undefined) => string[];
+/**
+ * Gets an array of ids for duplicate nodeIds in given node array.
+ * @param nodes
+ * @param predicate
+ */
+declare const duplicateNodeNames: (nodes: Node[], predicate?: ((node: Node) => boolean) | undefined) => string[];
+/**
+ * Reports duplicate nodeIds.
+ * @param nodeNames
+ */
+declare const reportDuplicateNodeNames: (nodeNames: string[]) => void;
+declare const drawPaintableOnMaterial: (material: Material, imageSource: CanvasImageSource, scene: Scene, options?: PaintableOptions) => void;
+export { getRootNode, isLoadableTexture, mapToDottedNodes, getDottedPathForNode, cloneTransformNode, cloneNodeWithParents, cloneTransformNodeMaterial, getOrCreateMaterial, applyMaterial, injectMetadata, assertTransformNode, assertMeshCapability, activateTransformNode, deactivateTransformNode, enableNodeWithParents, disableNodeWithParents, transformTransformNode, setMaterial, setSourceNodeMaterial, setMaterialColor, setMaterialTexture, setMaterialMetallness, setMaterialRoughness, addToHighlightLayer, removeFromHighlightLayer, setReceiveShadows, addToShadowGenerator, removeFromShadowGenerator, getClientRectFromMesh, changeEnvironment, backgroundDomeName, envHelperMetadataName, mapTags, intersectingNodeNames, duplicateNodeNames, reportDuplicateNodeNames, drawPaintableOnMaterial, };