@combeenation/3d-viewer 12.4.1 → 13.0.1

package/dist/lib-cjs/internal/cloning-helper.js

@@ -0,0 +1,164 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cloneMorphTargetManager = exports.cloneModelAssetContainer = void 0;
+const index_1 = require("../index");
+const metadata_helper_1 = require("./metadata-helper");
+const tags_helper_1 = require("./tags-helper");
+const _defaultNodeNamingStrategy = (node, newModelName) => {
+    return `${node.name}.${newModelName}`;
+};
+const _defaultTagNamingStrategy = (tag, newModelName) => {
+    // don't rename tags by default
+    return tag;
+};
+/**
+ * Clones the node hierarchy of the asset container with some special treatment that differs from Babylon.js default
+ * cloning behaviour, such as:
+ * - create new instances of morph target manager
+ * - deep cloning internal metadata
+ * - deep cloning metadata and tags for instanced meshes
+ * - reassigns source meshes in cloned asset container
+ * Furthermore there is the possibility to adjust naming of nodes and tags in the cloned asset container
+ */
+function cloneModelAssetContainer(sourceAssetContainer, newModelName, renaming, scene) {
+    const targetAssetContainer = new index_1.AssetContainer(scene);
+    sourceAssetContainer.rootNodes.forEach(node => {
+        if (node instanceof index_1.TransformNode) {
+            // this is the actual node tree cloning procedure
+            _cloneNode(node, newModelName, null, targetAssetContainer, {
+                nodeNamingStrategy: renaming === null || renaming === void 0 ? void 0 : renaming.nodeNamingStrategy,
+                tagNamingStrategy: renaming === null || renaming === void 0 ? void 0 : renaming.tagNamingStrategy,
+            });
+        }
+    });
+    targetAssetContainer.populateRootNodes();
+    targetAssetContainer.rootNodes.forEach(node => {
+        if (node instanceof index_1.TransformNode) {
+            // reassigning instanced meshes can only be done after the model has been fully cloned, as we can't be sure if
+            // the source or instanced mesh is handled prior
+            _reAssignSourceMesh(node, sourceAssetContainer.meshes, targetAssetContainer.meshes);
+        }
+    });
+    // morph target manager is not cloned per default, therefore morph targets would affect original and cloned model at
+    // the same time, which we don't want
+    sourceAssetContainer.morphTargetManagers.forEach(sourceMTM => {
+        cloneMorphTargetManager(sourceMTM, targetAssetContainer);
+    });
+    _clearCloningMetadata(sourceAssetContainer);
+    _clearCloningMetadata(targetAssetContainer);
+    // hide immediately, so that show model code can do it's thing (scene preparation) before finally showing the model
+    targetAssetContainer.removeAllFromScene();
+    return targetAssetContainer;
+}
+exports.cloneModelAssetContainer = cloneModelAssetContainer;
+/**
+ * Helper function for cloning a morph target manager and updating all the mesh assignments.
+ * Meshes need to be already available in the target asset container.
+ */
+function cloneMorphTargetManager(sourceMTM, targetAssetContainer) {
+    const clonedMTM = sourceMTM.clone();
+    clonedMTM._parentContainer = targetAssetContainer;
+    targetAssetContainer.morphTargetManagers.push(clonedMTM);
+    targetAssetContainer.meshes.forEach(mesh => {
+        if (mesh.morphTargetManager === sourceMTM) {
+            mesh.morphTargetManager = clonedMTM;
+        }
+    });
+    return clonedMTM;
+}
+exports.cloneMorphTargetManager = cloneMorphTargetManager;
+/**
+ * The actual geometry cloning function.
+ * Calls "clone" function of dedicated Node type and recourses into children to clone the whole node tree.
+ * Adds temporary metadata for special treatment of certain node types (e.g. InstancedMesh).
+ */
+function _cloneNode(node, newModelName, newParent, assetContainer, renaming) {
+    var _a, _b;
+    const nodeNamingStrategy = (_a = renaming.nodeNamingStrategy) !== null && _a !== void 0 ? _a : _defaultNodeNamingStrategy;
+    const tagNamingStrategy = (_b = renaming.tagNamingStrategy) !== null && _b !== void 0 ? _b : _defaultTagNamingStrategy;
+    const cloneName = nodeNamingStrategy(node, newModelName);
+    const clone = node.clone(cloneName, newParent, true);
+    if (!clone) {
+        throw new Error(`Cloning node "${node.name}" failed`);
+    }
+    clone.id = cloneName;
+    // create a deep clone for internal metadata, as the default clone function uses the same assignment of the sources
+    // internal metadata
+    (0, metadata_helper_1.cloneInternalMetadata)(node, clone);
+    // ATM the assignment from clone to source is needed for reassigning instanced meshes after cloning
+    // may be usefull for other node types in the future as well
+    (0, metadata_helper_1.setInternalMetadataValue)(clone, 'cloneSource', node.uniqueId);
+    (0, metadata_helper_1.setInternalMetadataValue)(node, 'cloneTarget', clone.uniqueId);
+    if (node instanceof index_1.InstancedMesh) {
+        _cloneInstancedMeshData(node, clone);
+    }
+    const sourceTags = (0, tags_helper_1.getTags)(node);
+    const mappedTags = sourceTags.map(tag => tagNamingStrategy(tag, newModelName));
+    (0, tags_helper_1.setTags)(clone, mappedTags);
+    clone._parentContainer = assetContainer;
+    // TODO WTT: create global helper function for distinguishing between transform nodes and meshes
+    if (clone instanceof index_1.AbstractMesh) {
+        assetContainer.meshes.push(clone);
+    }
+    else {
+        assetContainer.transformNodes.push(clone);
+    }
+    const children = node.getChildTransformNodes(true);
+    children.forEach(child => _cloneNode(child, newModelName, clone, assetContainer, renaming));
+}
+/**
+ * Cloned instanced meshes are having the same source mesh as their cloning source.
+ * However we want the cloned source mesh to be the actual source.
+ * Exchanging and reassigning is done within this function.
+ * Operates on the given `node` and all its children recursively.
+ */
+function _reAssignSourceMesh(node, sourceMeshes, clonedMeshes) {
+    if (node instanceof index_1.InstancedMesh) {
+        // find the cloned instance and source mesh
+        const clonedInstance = node;
+        const originalInstance = _findByUniqueId(sourceMeshes, (0, metadata_helper_1.getInternalMetadataValue)(clonedInstance, 'cloneSource'));
+        if (originalInstance instanceof index_1.InstancedMesh) {
+            const originalSource = originalInstance.sourceMesh;
+            const clonedSource = _findByUniqueId(clonedMeshes, (0, metadata_helper_1.getInternalMetadataValue)(originalSource, 'cloneTarget'));
+            if (clonedSource instanceof index_1.Mesh) {
+                // it's not possible to just exchange the source mesh => readonly property
+                // we have to create a new clone with the correct source mesh
+                const exchangedInstance = clonedInstance.clone(clonedInstance.name, clonedInstance.parent, true, clonedSource);
+                clonedInstance._parentContainer.meshes.push(exchangedInstance);
+                _cloneInstancedMeshData(clonedInstance, exchangedInstance);
+                // re-reference the childs of the cloned instance as well
+                const childs = clonedInstance.getChildTransformNodes(true);
+                childs.forEach(child => (child.parent = exchangedInstance));
+            }
+        }
+        // old instance mesh is not needed anymore and can be disposed
+        clonedInstance.dispose();
+    }
+    // recurse into childs
+    const children = node.getChildTransformNodes(true);
+    children.forEach(child => _reAssignSourceMesh(child, sourceMeshes, clonedMeshes));
+}
+/**
+ * Removes metadata entries "cloneSource" and "cloneTarget" from all meshes and transform nodes inside the asset
+ * container
+ */
+function _clearCloningMetadata(assetContainer) {
+    [...assetContainer.meshes, ...assetContainer.transformNodes].forEach(node => {
+        (0, metadata_helper_1.clearInternalMetadataValue)(node, 'cloneSource');
+        (0, metadata_helper_1.clearInternalMetadataValue)(node, 'cloneTarget');
+    });
+}
+/**
+ * "InstancedMesh.clone" function doesn't clone tags and metadata, also the enabled state doesn't seem to be cloned
+ * correctly.
+ * This function adjusts the behaviour to fulfill our expectations.
+ */
+function _cloneInstancedMeshData(sourceInstancedMesh, targetInstancedMesh) {
+    targetInstancedMesh.setEnabled(sourceInstancedMesh.isEnabled(false));
+    (0, metadata_helper_1.cloneMetadata)(sourceInstancedMesh, targetInstancedMesh);
+    (0, tags_helper_1.cloneTags)(sourceInstancedMesh, targetInstancedMesh);
+}
+function _findByUniqueId(nodes, uniqueId) {
+    return nodes.find(node => node.uniqueId === uniqueId);
+}
+//# sourceMappingURL=cloning-helper.js.map

package/dist/lib-cjs/internal/cloning-helper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cloning-helper.js","sourceRoot":"","sources":["../../../src/internal/cloning-helper.ts"],"names":[],"mappings":";;;AAAA,oCAUkB;AAClB,uDAM2B;AAC3B,+CAA4D;AAE5D,MAAM,0BAA0B,GAAuB,CAAC,IAAmB,EAAE,YAAoB,EAAU,EAAE;IAC3G,OAAO,GAAG,IAAI,CAAC,IAAI,IAAI,YAAY,EAAE,CAAC;AACxC,CAAC,CAAC;AACF,MAAM,yBAAyB,GAAsB,CAAC,GAAW,EAAE,YAAoB,EAAU,EAAE;IACjG,+BAA+B;IAC/B,OAAO,GAAG,CAAC;AACb,CAAC,CAAC;AAEF;;;;;;;;GAQG;AACH,SAAgB,wBAAwB,CACtC,oBAAoC,EACpC,YAAoB,EACpB,QAGC,EACD,KAAY;IAEZ,MAAM,oBAAoB,GAAG,IAAI,sBAAc,CAAC,KAAK,CAAC,CAAC;IAEvD,oBAAoB,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;QAC5C,IAAI,IAAI,YAAY,qBAAa,EAAE;YACjC,iDAAiD;YACjD,UAAU,CAAC,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,oBAAoB,EAAE;gBACzD,kBAAkB,EAAE,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,kBAAkB;gBAChD,iBAAiB,EAAE,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,iBAAiB;aAC/C,CAAC,CAAC;SACJ;IACH,CAAC,CAAC,CAAC;IAEH,oBAAoB,CAAC,iBAAiB,EAAE,CAAC;IACzC,oBAAoB,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;QAC5C,IAAI,IAAI,YAAY,qBAAa,EAAE;YACjC,8GAA8G;YAC9G,gDAAgD;YAChD,mBAAmB,CAAC,IAAI,EAAE,oBAAoB,CAAC,MAAM,EAAE,oBAAoB,CAAC,MAAM,CAAC,CAAC;SACrF;IACH,CAAC,CAAC,CAAC;IAEH,oHAAoH;IACpH,qCAAqC;IACrC,oBAAoB,CAAC,mBAAmB,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE;QAC3D,uBAAuB,CAAC,SAAS,EAAE,oBAAoB,CAAC,CAAC;IAC3D,CAAC,CAAC,CAAC;IAEH,qBAAqB,CAAC,oBAAoB,CAAC,CAAC;IAC5C,qBAAqB,CAAC,oBAAoB,CAAC,CAAC;IAE5C,mHAAmH;IACnH,oBAAoB,CAAC,kBAAkB,EAAE,CAAC;IAE1C,OAAO,oBAAoB,CAAC;AAC9B,CAAC;AA3CD,4DA2CC;AAED;;;GAGG;AACH,SAAgB,uBAAuB,CACrC,SAA6B,EAC7B,oBAAoC;IAEpC,MAAM,SAAS,GAAG,SAAS,CAAC,KAAK,EAAE,CAAC;IAEpC,SAAS,CAAC,gBAAgB,GAAG,oBAAoB,CAAC;IAClD,oBAAoB,CAAC,mBAAmB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAEzD,oBAAoB,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;QACzC,IAAI,IAAI,CAAC,kBAAkB,KAAK,SAAS,EAAE;YACzC,IAAI,CAAC,kBAAkB,GAAG,SAAS,CAAC;SACrC;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,SAAS,CAAC;AACnB,CAAC;AAhBD,0DAgBC;AAED;;;;GAIG;AACH,SAAS,UAAU,CACjB,IAAmB,EACnB,YAAoB,EACpB,SAA+B,EAC/B,cAA8B,EAC9B,QAGC;;IAED,MAAM,kBAAkB,GAAG,MAAA,QAAQ,CAAC,kBAAkB,mCAAI,0BAA0B,CAAC;IACrF,MAAM,iBAAiB,GAAG,MAAA,QAAQ,CAAC,iBAAiB,mCAAI,yBAAyB,CAAC;IAElF,MAAM,SAAS,GAAG,kBAAkB,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;IACzD,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;IACrD,IAAI,CAAC,KAAK,EAAE;QACV,MAAM,IAAI,KAAK,CAAC,iBAAiB,IAAI,CAAC,IAAI,UAAU,CAAC,CAAC;KACvD;IAED,KAAK,CAAC,EAAE,GAAG,SAAS,CAAC;IACrB,mHAAmH;IACnH,oBAAoB;IACpB,IAAA,uCAAqB,EAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IACnC,mGAAmG;IACnG,4DAA4D;IAC5D,IAAA,0CAAwB,EAAC,KAAK,EAAE,aAAa,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC9D,IAAA,0CAAwB,EAAC,IAAI,EAAE,aAAa,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;IAE9D,IAAI,IAAI,YAAY,qBAAa,EAAE;QACjC,uBAAuB,CAAC,IAAI,EAAE,KAAsB,CAAC,CAAC;KACvD;IAED,MAAM,UAAU,GAAG,IAAA,qBAAO,EAAC,IAAI,CAAC,CAAC;IACjC,MAAM,UAAU,GAAG,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,iBAAiB,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC,CAAC;IAC/E,IAAA,qBAAO,EAAC,KAAK,EAAE,UAAU,CAAC,CAAC;IAE3B,KAAK,CAAC,gBAAgB,GAAG,cAAc,CAAC;IACxC,gGAAgG;IAChG,IAAI,KAAK,YAAY,oBAAY,EAAE;QACjC,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;KACnC;SAAM;QACL,cAAc,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;KAC3C;IAED,MAAM,QAAQ,GAAG,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC;IACnD,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,cAAc,EAAE,QAAQ,CAAC,CAAC,CAAC;AAC9F,CAAC;AAED;;;;;GAKG;AACH,SAAS,mBAAmB,CAAC,IAAmB,EAAE,YAA4B,EAAE,YAA4B;IAC1G,IAAI,IAAI,YAAY,qBAAa,EAAE;QACjC,2CAA2C;QAC3C,MAAM,cAAc,GAAG,IAAI,CAAC;QAC5B,MAAM,gBAAgB,GAAG,eAAe,CACtC,YAAY,EACZ,IAAA,0CAAwB,EAAC,cAAc,EAAE,aAAa,CAAW,CAClE,CAAC;QACF,IAAI,gBAAgB,YAAY,qBAAa,EAAE;YAC7C,MAAM,cAAc,GAAG,gBAAgB,CAAC,UAAU,CAAC;YACnD,MAAM,YAAY,GAAG,eAAe,CAClC,YAAY,EACZ,IAAA,0CAAwB,EAAC,cAAc,EAAE,aAAa,CAAW,CAClE,CAAC;YACF,IAAI,YAAY,YAAY,YAAI,EAAE;gBAChC,0EAA0E;gBAC1E,6DAA6D;gBAC7D,MAAM,iBAAiB,GAAG,cAAc,CAAC,KAAK,CAAC,cAAc,CAAC,IAAI,EAAE,cAAc,CAAC,MAAM,EAAE,IAAI,EAAE,YAAY,CAAC,CAAC;gBAC/G,cAAc,CAAC,gBAAiB,CAAC,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;gBAEhE,uBAAuB,CAAC,cAAc,EAAE,iBAAiB,CAAC,CAAC;gBAE3D,yDAAyD;gBACzD,MAAM,MAAM,GAAG,cAAc,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC;gBAC3D,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,iBAAiB,CAAC,CAAC,CAAC;aAC7D;SACF;QAED,8DAA8D;QAC9D,cAAc,CAAC,OAAO,EAAE,CAAC;KAC1B;IAED,sBAAsB;IACtB,MAAM,QAAQ,GAAG,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC;IACnD,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,mBAAmB,CAAC,KAAK,EAAE,YAAY,EAAE,YAAY,CAAC,CAAC,CAAC;AACpF,CAAC;AAED;;;GAGG;AACH,SAAS,qBAAqB,CAAC,cAA8B;IAC3D,CAAC,GAAG,cAAc,CAAC,MAAM,EAAE,GAAG,cAAc,CAAC,cAAc,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;QAC1E,IAAA,4CAA0B,EAAC,IAAI,EAAE,aAAa,CAAC,CAAC;QAChD,IAAA,4CAA0B,EAAC,IAAI,EAAE,aAAa,CAAC,CAAC;IAClD,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;GAIG;AACH,SAAS,uBAAuB,CAAC,mBAAkC,EAAE,mBAAkC;IACrG,mBAAmB,CAAC,UAAU,CAAC,mBAAmB,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;IACrE,IAAA,+BAAa,EAAC,mBAAmB,EAAE,mBAAmB,CAAC,CAAC;IACxD,IAAA,uBAAS,EAAC,mBAAmB,EAAE,mBAAmB,CAAC,CAAC;AACtD,CAAC;AAED,SAAS,eAAe,CAAC,KAAsB,EAAE,QAAgB;IAC/D,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC;AACxD,CAAC"}

package/dist/lib-cjs/internal/device-helper.d.ts

@@ -0,0 +1,9 @@
+import { LimitTextureSizeConfig } from '../index';
+/**
+ * Checks if the current device is an iPhone
+ */
+export declare function getIsIPhone(): boolean;
+/**
+ * Checks if the current device is "scaled down", as defined in the Spec
+ */
+export declare function getIsScaledDownDevice(limitTextureSize: LimitTextureSizeConfig | false): boolean;

package/dist/lib-cjs/{api/util/deviceHelper.js → internal/device-helper.js}

@@ -1,29 +1,25 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getIsScaledDownDevice = exports.getIsIPhone = void 0;
-const specStorage_1 = require("../store/specStorage");
 /**
  * Checks if the current device is an iPhone
  */
-const getIsIPhone = () => {
+function getIsIPhone() {
     const isIPhone = /iPhone/.test(navigator.userAgent);
     return isIPhone;
-};
+}
 exports.getIsIPhone = getIsIPhone;
 /**
  * Checks if the current device is "scaled down", as defined in the Spec
  */
-const getIsScaledDownDevice = () => {
-    var _a;
-    const sceneJson = specStorage_1.SpecStorage.get('scene');
-    if (!((_a = sceneJson.engine) === null || _a === void 0 ? void 0 : _a.limitTextureSize)) {
+function getIsScaledDownDevice(limitTextureSize) {
+    if (!limitTextureSize) {
         // no down scaling defined
         return false;
     }
     // check device
-    const deviceFits = sceneJson.engine.limitTextureSize.devices === 'all' ||
-        (sceneJson.engine.limitTextureSize.devices === 'iPhone' && getIsIPhone());
+    const deviceFits = limitTextureSize.devices === 'all' || (limitTextureSize.devices === 'iPhone' && getIsIPhone());
     return deviceFits;
-};
+}
 exports.getIsScaledDownDevice = getIsScaledDownDevice;
-//# sourceMappingURL=deviceHelper.js.map
+//# sourceMappingURL=device-helper.js.map

package/dist/lib-cjs/internal/device-helper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"device-helper.js","sourceRoot":"","sources":["../../../src/internal/device-helper.ts"],"names":[],"mappings":";;;AAEA;;GAEG;AACH,SAAgB,WAAW;IACzB,MAAM,QAAQ,GAAG,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;IAEpD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAJD,kCAIC;AAED;;GAEG;AACH,SAAgB,qBAAqB,CAAC,gBAAgD;IACpF,IAAI,CAAC,gBAAgB,EAAE;QACrB,0BAA0B;QAC1B,OAAO,KAAK,CAAC;KACd;IAED,eAAe;IACf,MAAM,UAAU,GAAG,gBAAgB,CAAC,OAAO,KAAK,KAAK,IAAI,CAAC,gBAAgB,CAAC,OAAO,KAAK,QAAQ,IAAI,WAAW,EAAE,CAAC,CAAC;IAElH,OAAO,UAAU,CAAC;AACpB,CAAC;AAVD,sDAUC"}

package/dist/lib-cjs/internal/geometry-helper.d.ts

@@ -0,0 +1,21 @@
+import { ExcludedGeometryList, InstancedMesh, Mesh, TransformNode } from '../index';
+/**
+ * Find out if a node is part of a list of excluded geometry
+ * @param node BJS node
+ * @param list list of excluded geometry
+ * @returns boolean based on whether node (or one of its parents) was found in list
+ */
+export declare function isNodeExcluded(nodeToCheck: TransformNode, list: ExcludedGeometryList): boolean;
+/**
+ * Creates a "standard" mesh from an instanced mesh, by cloning the source mesh and applying transformation data
+ */
+export declare function createMeshFromInstancedMesh(instancedMesh: InstancedMesh, newName: string, clonedParent: TransformNode): Mesh;
+/**
+ * Removes transformation data from the mesh and stores it in the geometry, which is called "baking".
+ * Also considers the geometry change from morph targets.
+ */
+export declare function bakeGeometryOfMesh(mesh: Mesh): void;
+/**
+ * Resets transformation to initial state
+ */
+export declare function resetTransformation(node: TransformNode): void;

package/dist/lib-cjs/{api/util/geometryHelper.js → internal/geometry-helper.js}

@@ -1,14 +1,47 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.resetTransformation = exports.bakeGeometryOfMesh = exports.createMeshFromInstancedMesh = void 0;
-const buffer_1 = require("@babylonjs/core/Buffers/buffer");
-const math_vector_1 = require("@babylonjs/core/Maths/math.vector");
+exports.resetTransformation = exports.bakeGeometryOfMesh = exports.createMeshFromInstancedMesh = exports.isNodeExcluded = void 0;
+const index_1 = require("../index");
+const metadata_helper_1 = require("./metadata-helper");
+const tags_helper_1 = require("./tags-helper");
+/**
+ * Find out if a node is part of a list of excluded geometry
+ * @param node BJS node
+ * @param list list of excluded geometry
+ * @returns boolean based on whether node (or one of its parents) was found in list
+ */
+function isNodeExcluded(nodeToCheck, list) {
+    // CAUTION: node has to be the same instance
+    const checkNode = (excludedNode) => excludedNode === nodeToCheck;
+    const checkTagManagerSubject = (excludedSubject) => {
+        const nameMatches = !!excludedSubject.nodeName && excludedSubject.nodeName === nodeToCheck.name;
+        const tagMatches = !!excludedSubject.tagName && (0, tags_helper_1.hasTag)(nodeToCheck, excludedSubject.tagName);
+        return nameMatches || tagMatches;
+    };
+    const check = (geometryToExclude) => {
+        if (geometryToExclude instanceof index_1.TransformNode) {
+            return checkNode(geometryToExclude);
+        }
+        if (geometryToExclude.tagName || geometryToExclude.nodeName) {
+            return checkTagManagerSubject(geometryToExclude);
+        }
+        return false;
+    };
+    let isExcluded = list.some(geometryToExclude => check(geometryToExclude));
+    // consider parent as well
+    if (!isExcluded && nodeToCheck.parent instanceof index_1.TransformNode) {
+        isExcluded = isNodeExcluded(nodeToCheck.parent, list);
+    }
+    return isExcluded;
+}
+exports.isNodeExcluded = isNodeExcluded;
 /**
  * Creates a "standard" mesh from an instanced mesh, by cloning the source mesh and applying transformation data
  */
-const createMeshFromInstancedMesh = function (instancedMesh, newName, clonedParent) {
+function createMeshFromInstancedMesh(instancedMesh, newName, clonedParent) {
     // first create a clone of the source mesh
     const newMesh = instancedMesh.sourceMesh.clone(newName, clonedParent, true);
+    (0, metadata_helper_1.cloneInternalMetadata)(instancedMesh.sourceMesh, newMesh);
     // apply the transformation data, it's important to create clones of the transformations to not touch the original
     // transformation when applying changes (eg: geometry baking)
     newMesh.position = instancedMesh.position.clone();
@@ -21,13 +54,13 @@ const createMeshFromInstancedMesh = function (instancedMesh, newName, clonedPare
     // also sync the enabled state from the original instanced mesh
     newMesh.setEnabled(instancedMesh.isEnabled(false));
     return newMesh;
-};
+}
 exports.createMeshFromInstancedMesh = createMeshFromInstancedMesh;
 /**
  * Removes transformation data from the mesh and stores it in the geometry, which is called "baking".
  * Also considers the geometry change from morph targets.
  */
-const bakeGeometryOfMesh = function (mesh) {
+function bakeGeometryOfMesh(mesh) {
     if (!mesh.geometry) {
         // no geometry available, nothing to do
         return;
@@ -52,32 +85,32 @@ const bakeGeometryOfMesh = function (mesh) {
     if (morphTargetManager === null || morphTargetManager === void 0 ? void 0 : morphTargetManager.numTargets) {
         // apply morph target vertices data to mesh geometry
         // mostly only the "PositionKind" is implemented
-        _bakeMorphTargetManagerIntoVertices(buffer_1.VertexBuffer.PositionKind, morphTargetManager, geometry);
-        _bakeMorphTargetManagerIntoVertices(buffer_1.VertexBuffer.NormalKind, morphTargetManager, geometry);
-        _bakeMorphTargetManagerIntoVertices(buffer_1.VertexBuffer.TangentKind, morphTargetManager, geometry);
-        _bakeMorphTargetManagerIntoVertices(buffer_1.VertexBuffer.UVKind, morphTargetManager, geometry);
+        _bakeMorphTargetManagerIntoVertices(index_1.VertexBuffer.PositionKind, morphTargetManager, geometry);
+        _bakeMorphTargetManagerIntoVertices(index_1.VertexBuffer.NormalKind, morphTargetManager, geometry);
+        _bakeMorphTargetManagerIntoVertices(index_1.VertexBuffer.TangentKind, morphTargetManager, geometry);
+        _bakeMorphTargetManagerIntoVertices(index_1.VertexBuffer.UVKind, morphTargetManager, geometry);
         // remove morph target manager with all it's morph targets
         mesh.morphTargetManager = null;
     }
     // bake the transformation data in the mesh geometry, fortunately there is already a help function from Babylon.js
     mesh.bakeCurrentTransformIntoVertices();
-};
+}
 exports.bakeGeometryOfMesh = bakeGeometryOfMesh;
 /**
  * Resets transformation to initial state
  */
-const resetTransformation = function (node) {
-    node.position = new math_vector_1.Vector3(0, 0, 0);
-    node.rotation = new math_vector_1.Vector3(0, 0, 0);
+function resetTransformation(node) {
+    node.position = new index_1.Vector3(0, 0, 0);
+    node.rotation = new index_1.Vector3(0, 0, 0);
     node.rotationQuaternion = null;
-    node.scaling = new math_vector_1.Vector3(1, 1, 1);
-};
+    node.scaling = new index_1.Vector3(1, 1, 1);
+}
 exports.resetTransformation = resetTransformation;
 /**
  * @param kind morph targets can affect various vertices kinds, whereas "position" is the most common one
  * still other kinds (like normals or tangents) can be affected as well and can be provided on this input
  */
-const _bakeMorphTargetManagerIntoVertices = function (kind, morphTargetManager, geometry) {
+function _bakeMorphTargetManagerIntoVertices(kind, morphTargetManager, geometry) {
     const origVerticesData = geometry.getVerticesData(kind);
     if (!origVerticesData) {
         // no vertices data for this kind availabe on the mesh geometry
@@ -96,18 +129,18 @@ const _bakeMorphTargetManagerIntoVertices = function (kind, morphTargetManager,
     }
     // apply the updated vertices data
     geometry.setVerticesData(kind, verticesData);
-};
-const _getVerticesDataFromMorphTarget = function (kind, morphTarget) {
+}
+function _getVerticesDataFromMorphTarget(kind, morphTarget) {
     switch (kind) {
-        case buffer_1.VertexBuffer.PositionKind:
+        case index_1.VertexBuffer.PositionKind:
             return morphTarget.getPositions();
-        case buffer_1.VertexBuffer.NormalKind:
+        case index_1.VertexBuffer.NormalKind:
             return morphTarget.getNormals();
-        case buffer_1.VertexBuffer.TangentKind:
+        case index_1.VertexBuffer.TangentKind:
             return morphTarget.getTangents();
-        case buffer_1.VertexBuffer.UVKind:
+        case index_1.VertexBuffer.UVKind:
             return morphTarget.getUVs();
     }
     return null;
-};
-//# sourceMappingURL=geometryHelper.js.map
+}
+//# sourceMappingURL=geometry-helper.js.map

package/dist/lib-cjs/internal/geometry-helper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"geometry-helper.js","sourceRoot":"","sources":["../../../src/internal/geometry-helper.ts"],"names":[],"mappings":";;;AAAA,oCAakB;AAClB,uDAA0D;AAC1D,+CAAuC;AAEvC;;;;;GAKG;AACH,SAAgB,cAAc,CAAC,WAA0B,EAAE,IAA0B;IACnF,4CAA4C;IAC5C,MAAM,SAAS,GAAG,CAAC,YAA2B,EAAW,EAAE,CAAC,YAAY,KAAK,WAAW,CAAC;IACzF,MAAM,sBAAsB,GAAG,CAAC,eAAiC,EAAW,EAAE;QAC5E,MAAM,WAAW,GAAG,CAAC,CAAC,eAAe,CAAC,QAAQ,IAAI,eAAe,CAAC,QAAQ,KAAK,WAAW,CAAC,IAAI,CAAC;QAChG,MAAM,UAAU,GAAG,CAAC,CAAC,eAAe,CAAC,OAAO,IAAI,IAAA,oBAAM,EAAC,WAAW,EAAE,eAAe,CAAC,OAAO,CAAC,CAAC;QAC7F,OAAO,WAAW,IAAI,UAAU,CAAC;IACnC,CAAC,CAAC;IACF,MAAM,KAAK,GAAG,CAAC,iBAAmC,EAAW,EAAE;QAC7D,IAAI,iBAAiB,YAAY,qBAAa,EAAE;YAC9C,OAAO,SAAS,CAAC,iBAAiB,CAAC,CAAC;SACrC;QACD,IAAK,iBAAsC,CAAC,OAAO,IAAK,iBAAsC,CAAC,QAAQ,EAAE;YACvG,OAAO,sBAAsB,CAAC,iBAAqC,CAAC,CAAC;SACtE;QACD,OAAO,KAAK,CAAC;IACf,CAAC,CAAC;IAEF,IAAI,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,EAAE,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,CAAC;IAC1E,0BAA0B;IAC1B,IAAI,CAAC,UAAU,IAAI,WAAW,CAAC,MAAM,YAAY,qBAAa,EAAE;QAC9D,UAAU,GAAG,cAAc,CAAC,WAAW,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;KACvD;IAED,OAAO,UAAU,CAAC;AACpB,CAAC;AAzBD,wCAyBC;AAED;;GAEG;AACH,SAAgB,2BAA2B,CACzC,aAA4B,EAC5B,OAAe,EACf,YAA2B;IAE3B,0CAA0C;IAC1C,MAAM,OAAO,GAAG,aAAa,CAAC,UAAU,CAAC,KAAK,CAAC,OAAO,EAAE,YAAY,EAAE,IAAI,CAAC,CAAC;IAC5E,IAAA,uCAAqB,EAAC,aAAa,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IACzD,kHAAkH;IAClH,6DAA6D;IAC7D,OAAO,CAAC,QAAQ,GAAG,aAAa,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;IAClD,OAAO,CAAC,QAAQ,GAAG,aAAa,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;IAClD,OAAO,CAAC,OAAO,GAAG,aAAa,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;IAEhD,kCAAkC;IAClC,IAAI,aAAa,CAAC,kBAAkB,EAAE;QACpC,OAAO,CAAC,kBAAkB,GAAG,aAAa,CAAC,kBAAkB,CAAC,KAAK,EAAE,CAAC;KACvE;IAED,+DAA+D;IAC/D,OAAO,CAAC,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;IAEnD,OAAO,OAAO,CAAC;AACjB,CAAC;AAvBD,kEAuBC;AAED;;;GAGG;AACH,SAAgB,kBAAkB,CAAC,IAAU;IAC3C,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;QAClB,uCAAuC;QACvC,OAAO;KACR;IAED,gGAAgG;IAChG,IAAI,CAAC,kBAAkB,EAAE,CAAC;IAE1B,mGAAmG;IACnG,IAAI,IAAI,CAAC,QAAQ,EAAE;QACjB,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAClC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;KACtB;IAED,2GAA2G;IAC3G,kHAAkH;IAClH,mFAAmF;IACnF,kFAAkF;IAClF,4FAA4F;IAC5F,gHAAgH;IAChH,WAAW;IACX,yEAAyE;IACzE,MAAM,kBAAkB,GAAG,IAAI,CAAC,kBAAkB,CAAC;IACnD,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;IAE/B,IAAI,kBAAkB,aAAlB,kBAAkB,uBAAlB,kBAAkB,CAAE,UAAU,EAAE;QAClC,oDAAoD;QACpD,gDAAgD;QAChD,mCAAmC,CAAC,oBAAY,CAAC,YAAY,EAAE,kBAAkB,EAAE,QAAQ,CAAC,CAAC;QAC7F,mCAAmC,CAAC,oBAAY,CAAC,UAAU,EAAE,kBAAkB,EAAE,QAAQ,CAAC,CAAC;QAC3F,mCAAmC,CAAC,oBAAY,CAAC,WAAW,EAAE,kBAAkB,EAAE,QAAQ,CAAC,CAAC;QAC5F,mCAAmC,CAAC,oBAAY,CAAC,MAAM,EAAE,kBAAkB,EAAE,QAAQ,CAAC,CAAC;QAEvF,0DAA0D;QAC1D,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC;KAChC;IAED,kHAAkH;IAClH,IAAI,CAAC,gCAAgC,EAAE,CAAC;AAC1C,CAAC;AAxCD,gDAwCC;AAED;;GAEG;AACH,SAAgB,mBAAmB,CAAC,IAAmB;IACrD,IAAI,CAAC,QAAQ,GAAG,IAAI,eAAO,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IACrC,IAAI,CAAC,QAAQ,GAAG,IAAI,eAAO,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IACrC,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC;IAC/B,IAAI,CAAC,OAAO,GAAG,IAAI,eAAO,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;AACtC,CAAC;AALD,kDAKC;AAED;;;GAGG;AACH,SAAS,mCAAmC,CAC1C,IAAY,EACZ,kBAAsC,EACtC,QAAkB;IAElB,MAAM,gBAAgB,GAAG,QAAQ,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;IACxD,IAAI,CAAC,gBAAgB,EAAE;QACrB,+DAA+D;QAC/D,OAAO;KACR;IAED,IAAI,YAAY,GAAG,CAAC,GAAG,gBAAgB,CAAC,CAAC;IACzC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,kBAAkB,CAAC,UAAU,EAAE,CAAC,EAAE,EAAE;QACtD,MAAM,MAAM,GAAG,kBAAkB,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;QAC/C,MAAM,kBAAkB,GAAG,+BAA+B,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACzE,IAAI,kBAAkB,EAAE;YACtB,iEAAiE;YACjE,8DAA8D;YAC9D,sGAAsG;YACtG,YAAY,GAAG,YAAY,CAAC,GAAG,CAC7B,CAAC,MAAM,EAAE,GAAG,EAAE,EAAE,CAAC,MAAM,GAAG,CAAC,kBAAkB,CAAC,GAAG,CAAC,GAAG,gBAAgB,CAAC,GAAG,CAAC,CAAC,GAAG,MAAM,CAAC,SAAS,CAC/F,CAAC;SACH;KACF;IAED,kCAAkC;IAClC,QAAQ,CAAC,eAAe,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;AAC/C,CAAC;AAED,SAAS,+BAA+B,CAAC,IAAY,EAAE,WAAwB;IAC7E,QAAQ,IAAI,EAAE;QACZ,KAAK,oBAAY,CAAC,YAAY;YAC5B,OAAO,WAAW,CAAC,YAAY,EAAE,CAAC;QACpC,KAAK,oBAAY,CAAC,UAAU;YAC1B,OAAO,WAAW,CAAC,UAAU,EAAE,CAAC;QAClC,KAAK,oBAAY,CAAC,WAAW;YAC3B,OAAO,WAAW,CAAC,WAAW,EAAE,CAAC;QACnC,KAAK,oBAAY,CAAC,MAAM;YACtB,OAAO,WAAW,CAAC,MAAM,EAAE,CAAC;KAC/B;IAED,OAAO,IAAI,CAAC;AACd,CAAC"}

package/dist/lib-cjs/internal/metadata-helper.d.ts

@@ -0,0 +1,26 @@
+import { BaseTexture, Material, Node } from '../index';
+declare type MetadataValue = string | number | boolean | undefined;
+declare type MetadataTarget = Node | Material | BaseTexture;
+declare type MetadataKeys = 'deferredMaterial' | 'materialToBeSet' | 'exportNode' | 'deleteAfterExport' | 'exchangeMaterialWith' | 'cloneSource' | 'cloneTarget';
+/**
+ * Sets certain metadata on the objects INTERNAL metadata storage.
+ * "object._internalMetadata.cbn" is reserved for CBN specific metadata information.
+ * The objects public metadata ("object.metadata") is not affected and should therefore not interfere with metadata
+ * that is used in consumer projects.
+ */
+export declare function setInternalMetadataValue(object: MetadataTarget, key: MetadataKeys, value: MetadataValue): void;
+export declare function clearInternalMetadataValue(object: MetadataTarget, key: MetadataKeys): void;
+export declare function getInternalMetadataValue(object: MetadataTarget, key: MetadataKeys): MetadataValue;
+/**
+ * Creates a deep clone from the source objects internal metadata and assigns it to the target objects metadata.
+ * This is required as Babylon.js only creates shallow clones of the internal metadata, which would be problematic for
+ * our needs.
+ */
+export declare function cloneInternalMetadata(sourceObject: MetadataTarget, targetObject: MetadataTarget): void;
+/**
+ * Clones the metadata from one object to another.
+ * CAUTION: this is now the public available "object.metadata" object.
+ * We need this function internally when cloning instanced meshes.
+ */
+export declare function cloneMetadata(sourceObject: MetadataTarget, targetObject: MetadataTarget): void;
+export {};

package/dist/lib-cjs/internal/metadata-helper.js

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cloneMetadata = exports.cloneInternalMetadata = exports.getInternalMetadataValue = exports.clearInternalMetadataValue = exports.setInternalMetadataValue = void 0;
+const lodash_es_1 = require("lodash-es");
+// TODO WTT: use generics or some kind of logic that is able to type the metadata according to their key
+/**
+ * Sets certain metadata on the objects INTERNAL metadata storage.
+ * "object._internalMetadata.cbn" is reserved for CBN specific metadata information.
+ * The objects public metadata ("object.metadata") is not affected and should therefore not interfere with metadata
+ * that is used in consumer projects.
+ */
+function setInternalMetadataValue(object, key, value) {
+    if (!object._internalMetadata) {
+        object._internalMetadata = {};
+    }
+    if (!object._internalMetadata.cbn) {
+        object._internalMetadata.cbn = {};
+    }
+    object._internalMetadata.cbn[key] = value;
+}
+exports.setInternalMetadataValue = setInternalMetadataValue;
+function clearInternalMetadataValue(object, key) {
+    var _a, _b;
+    (_b = (_a = object._internalMetadata) === null || _a === void 0 ? void 0 : _a.cbn) === null || _b === void 0 ? true : delete _b[key];
+}
+exports.clearInternalMetadataValue = clearInternalMetadataValue;
+function getInternalMetadataValue(object, key) {
+    var _a, _b;
+    return (_b = (_a = object._internalMetadata) === null || _a === void 0 ? void 0 : _a.cbn) === null || _b === void 0 ? void 0 : _b[key];
+}
+exports.getInternalMetadataValue = getInternalMetadataValue;
+/**
+ * Creates a deep clone from the source objects internal metadata and assigns it to the target objects metadata.
+ * This is required as Babylon.js only creates shallow clones of the internal metadata, which would be problematic for
+ * our needs.
+ */
+function cloneInternalMetadata(sourceObject, targetObject) {
+    targetObject._internalMetadata = (0, lodash_es_1.cloneDeep)(sourceObject._internalMetadata);
+}
+exports.cloneInternalMetadata = cloneInternalMetadata;
+/**
+ * Clones the metadata from one object to another.
+ * CAUTION: this is now the public available "object.metadata" object.
+ * We need this function internally when cloning instanced meshes.
+ */
+function cloneMetadata(sourceObject, targetObject) {
+    const clonedMetadata = (0, lodash_es_1.cloneDeep)(sourceObject.metadata);
+    targetObject.metadata = clonedMetadata;
+}
+exports.cloneMetadata = cloneMetadata;
+//# sourceMappingURL=metadata-helper.js.map

package/dist/lib-cjs/internal/metadata-helper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"metadata-helper.js","sourceRoot":"","sources":["../../../src/internal/metadata-helper.ts"],"names":[],"mappings":";;;AACA,yCAAsC;AAiBtC,wGAAwG;AACxG;;;;;GAKG;AACH,SAAgB,wBAAwB,CAAC,MAAsB,EAAE,GAAiB,EAAE,KAAoB;IACtG,IAAI,CAAC,MAAM,CAAC,iBAAiB,EAAE;QAC7B,MAAM,CAAC,iBAAiB,GAAG,EAAE,CAAC;KAC/B;IACD,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC,GAAG,EAAE;QACjC,MAAM,CAAC,iBAAiB,CAAC,GAAG,GAAG,EAAE,CAAC;KACnC;IAED,MAAM,CAAC,iBAAiB,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;AAC5C,CAAC;AATD,4DASC;AAED,SAAgB,0BAA0B,CAAC,MAAsB,EAAE,GAAiB;;IAC3E,MAAA,MAAA,MAAM,CAAC,iBAAiB,0CAAE,GAAG,+CAAG,GAAG,CAAC,CAAC;AAC9C,CAAC;AAFD,gEAEC;AAED,SAAgB,wBAAwB,CAAC,MAAsB,EAAE,GAAiB;;IAChF,OAAO,MAAA,MAAA,MAAM,CAAC,iBAAiB,0CAAE,GAAG,0CAAG,GAAG,CAAC,CAAC;AAC9C,CAAC;AAFD,4DAEC;AAED;;;;GAIG;AACH,SAAgB,qBAAqB,CAAC,YAA4B,EAAE,YAA4B;IAC9F,YAAY,CAAC,iBAAiB,GAAG,IAAA,qBAAS,EAAC,YAAY,CAAC,iBAAiB,CAAC,CAAC;AAC7E,CAAC;AAFD,sDAEC;AAED;;;;GAIG;AACH,SAAgB,aAAa,CAAC,YAA4B,EAAE,YAA4B;IACtF,MAAM,cAAc,GAAG,IAAA,qBAAS,EAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IAExD,YAAY,CAAC,QAAQ,GAAG,cAAc,CAAC;AACzC,CAAC;AAJD,sCAIC"}

package/dist/lib-cjs/internal/paintable-helper.d.ts

@@ -0,0 +1,40 @@
+import { Material, ParameterValue, Scene } from '../index';
+declare type PaintableValue = {
+    src: string;
+    options?: PaintableOptions;
+};
+declare type PaintableOptions = {
+    uScale?: number;
+    uOffset?: number;
+    vScale?: number;
+    vOffset?: number;
+};
+/**
+ * Observer implementation for "paintable" parameter.
+ * Basically creates a dynamic texture from the source image and assigns it as albedo (or diffuse) texture.
+ */
+export declare function paintableParameterObserver(newValue: ParameterValue, materials: Material[], scene: Scene): Promise<void>;
+/**
+ * Parser for paintable value.
+ * ATM this is only used internally, but it could theoretically be used to create ones own paintable implementation.
+ *
+ * @param value The value to parse. Examples:
+ *              ```ts
+ *              // Default definition as JSON object:
+ *              '{ "src": "https://path.to/image.jpg", "uScale": 0.5 }'
+ *
+ *              // Short hand definition, only contains source string:
+ *              'https://path.to/image.jpg'
+ *
+ *              // Full content, paintable texture is flipped in both directions
+ *              '{ "src": "https://path.to/image.jpg", "uScale": -1, "vScale": -1, "uOffset": 0, "vOffset": 0 }'
+ *
+ *              // SVG content can be used directly:
+ *              '<svg>...</svg>'
+ *
+ *              // SVG in src property works as well:
+ *              '{ "src": "<svg>...</svg>", "uScale": 0.5 }'
+ *              ```
+ */
+export declare function parsePaintable(value: ParameterValue): PaintableValue;
+export {};