@shapediver/viewer.data-engine.material-database-engine 3.13.4

package/LICENSE

@@ -0,0 +1,73 @@
+Required Notice: Copyright 2025 ShapeDiver GmbH (https://www.shapediver.com) 
+
+https://polyformproject.org/licenses/noncommercial/1.0.0
+
+Acceptance
+
+In order to get any license under these terms, you must agree to them as both strict obligations and conditions to all your licenses.
+
+Copyright License
+
+The licensor grants you a copyright license for the software to do everything you might do with the software that would otherwise infringe the licensor’s copyright in it for any permitted purpose. However, you may only distribute the software according to Distribution License and make changes or new works based on the software according to Changes and New Works License.
+
+Distribution License
+
+The licensor grants you an additional copyright license to distribute copies of the software. Your license to distribute covers distributing the software with changes and new works permitted by Changes and New Works License.
+
+Notices
+
+You must ensure that anyone who gets a copy of any part of the software from you also gets a copy of these terms or the URL for them above, as well as copies of any plain-text lines beginning with Required Notice: that the licensor provided with the software. For example:
+
+Required Notice: Copyright 2025 ShapeDiver GmbH (https://www.shapediver.com) 
+
+Changes and New Works License
+
+The licensor grants you an additional copyright license to make changes and new works based on the software for any permitted purpose.
+
+Patent License
+
+The licensor grants you a patent license for the software that covers patent claims the licensor can license, or becomes able to license, that you would infringe by using the software.
+
+Noncommercial Purposes
+
+Any noncommercial purpose is a permitted purpose.
+
+Personal Uses
+
+Personal use for research, experiment, and testing for the benefit of public knowledge, personal study, private entertainment, hobby projects, amateur pursuits, or religious observance, without any anticipated commercial application, is use for a permitted purpose.
+
+Noncommercial Organizations
+
+Use by any charitable organization, educational institution, public research organization, public safety or health organization, environmental protection organization, or government institution is use for a permitted purpose regardless of the source of funding or obligations resulting from the funding.
+
+Fair Use
+
+You may have “fair use” rights for the software under the law. These terms do not limit them.
+
+No Other Rights
+
+These terms do not allow you to sublicense or transfer any of your licenses to anyone else, or prevent the licensor from granting licenses to anyone else. These terms do not imply any other licenses.
+
+Patent Defense
+
+If you make any written claim that the software infringes or contributes to infringement of any patent, your patent license for the software granted under these terms ends immediately. If your company makes such a claim, your patent license ends immediately for work on behalf of your company.
+
+Violations
+
+The first time you are notified in writing that you have violated any of these terms, or done anything with the software not covered by your licenses, your licenses can nonetheless continue if you come into full compliance with these terms, and take practical steps to correct past violations, within 32 days of receiving notice. Otherwise, all your licenses end immediately.
+
+No Liability
+
+As far as the law allows, the software comes as is, without any warranty or condition, and the licensor will not be liable to you for any damages arising out of these terms or the use or nature of the software, under any kind of legal claim.
+
+Definitions
+
+The licensor is the individual or entity offering these terms, and the software is the software the licensor makes available under these terms.
+
+You refers to the individual or entity agreeing to these terms.
+
+Your company is any legal entity, sole proprietorship, or other kind of organization that you work for, plus all organizations that have control over, are under the control of, or are under common control with that organization. Control means ownership of substantially all the assets of an entity, or the power to direct its management and policies by vote, contract, or otherwise. Control can be direct or indirect.
+
+Your licenses are all the licenses granted to you for the software under these terms.
+
+Use means anything you do with the software requiring one of your licenses.

package/README.md

@@ -0,0 +1,3 @@
+# `@shapediver/viewer.data-engine.material-database-engine`
+
+This package is part of the [`@shapediver/viewer`](https://www.npmjs.com/package/@shapediver/viewer), you can find all information [here](https://viewer.shapediver.com/v3/latest/api/index.html).

package/dist/MaterialDatabaseEngine.d.ts

@@ -0,0 +1,25 @@
+import { ResOutputContent } from "@shapediver/sdk.geometry-api-sdk-v2";
+import { ITreeNode } from "@shapediver/viewer.shared.node-tree";
+export declare class MaterialDatabaseEngine {
+    private readonly _converter;
+    private readonly _httpClient;
+    private readonly _logger;
+    private readonly _materialDatabase;
+    private readonly _materialEngine;
+    private static _instance;
+    static get instance(): MaterialDatabaseEngine;
+    /**
+     * Assigns materials from the material database to the geometry data in the given node.
+     *
+     * @param node the scene graph node
+     */
+    assignMaterialFromDatabase(node: ITreeNode): Promise<void>;
+    /**
+     * Load the material database from the given output content.
+     *
+     * @param content the output content
+     * @returns a scene graph node placeholder for the material database
+     */
+    loadContent(content: ResOutputContent): Promise<ITreeNode>;
+}
+//# sourceMappingURL=MaterialDatabaseEngine.d.ts.map

package/dist/MaterialDatabaseEngine.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MaterialDatabaseEngine.d.ts","sourceRoot":"","sources":["../src/MaterialDatabaseEngine.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,gBAAgB,EAAC,MAAM,qCAAqC,CAAC;AAErE,OAAO,EAAC,SAAS,EAAW,MAAM,qCAAqC,CAAC;AAaxE,qBAAa,sBAAsB;IAClC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAiC;IAC5D,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAmC;IAC/D,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA2B;IACnD,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAO3B;IACP,OAAO,CAAC,QAAQ,CAAC,eAAe,CAA2C;IAE3E,OAAO,CAAC,MAAM,CAAC,SAAS,CAAyB;IAEjD,WAAkB,QAAQ,2BAEzB;IAED;;;;OAIG;IACU,0BAA0B,CAAC,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAmEvE;;;;;OAKG;IACU,WAAW,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,SAAS,CAAC;CA4BvE"}

package/dist/MaterialDatabaseEngine.js

@@ -0,0 +1,124 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MaterialDatabaseEngine = void 0;
+const viewer_data_engine_material_engine_1 = require("@shapediver/viewer.data-engine.material-engine");
+const viewer_shared_node_tree_1 = require("@shapediver/viewer.shared.node-tree");
+const viewer_shared_services_1 = require("@shapediver/viewer.shared.services");
+const viewer_shared_types_1 = require("@shapediver/viewer.shared.types");
+class MaterialDatabaseEngine {
+    constructor() {
+        this._converter = viewer_shared_services_1.Converter.instance;
+        this._httpClient = viewer_shared_services_1.HttpClient.instance;
+        this._logger = viewer_shared_services_1.Logger.instance;
+        this._materialDatabase = {};
+        this._materialEngine = viewer_data_engine_material_engine_1.MaterialEngine.instance;
+    }
+    static get instance() {
+        return this._instance || (this._instance = new this());
+    }
+    /**
+     * Assigns materials from the material database to the geometry data in the given node.
+     *
+     * @param node the scene graph node
+     */
+    assignMaterialFromDatabase(node) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (Object.keys(this._materialDatabase).length === 0)
+                return;
+            // gather the materials that still need to be created
+            // and the corresponding geometry data to assign the created material to
+            const materialsToCreate = {};
+            node.traverse((n) => {
+                var _a;
+                // check if the name of the material is corresponding to a material in the material database output
+                for (let i = 0; i < n.data.length; i++) {
+                    const data = n.data[i];
+                    if (data instanceof viewer_shared_types_1.GeometryData) {
+                        const materialName = (_a = data.material) === null || _a === void 0 ? void 0 : _a.name;
+                        if (materialName) {
+                            if (this._materialDatabase[materialName]) {
+                                if (!this._materialDatabase[materialName].material) {
+                                    if (!materialsToCreate[materialName])
+                                        materialsToCreate[materialName] = [];
+                                    materialsToCreate[materialName].push(data);
+                                }
+                                else if (data.material !==
+                                    this._materialDatabase[materialName].material) {
+                                    data.material =
+                                        this._materialDatabase[materialName]
+                                            .material || null;
+                                    // trigger an update of the geometry and the node
+                                    data.updateVersion();
+                                    node.updateVersion();
+                                }
+                            }
+                        }
+                    }
+                }
+            });
+            // create the materials that are missing
+            const materialNames = Object.keys(materialsToCreate);
+            if (materialNames.length === 0)
+                return;
+            const promises = [];
+            for (const materialName of materialNames) {
+                promises.push(this._materialEngine.createMaterialDataFromDefinition(this._materialDatabase[materialName].definition));
+            }
+            // create the materials
+            const materials = yield Promise.all(promises);
+            // assign the created materials to the corresponding geometry data
+            for (let i = 0; i < materialNames.length; i++) {
+                const material = materials[i];
+                material.name = materialNames[i];
+                this._materialDatabase[material.name].material = material;
+                const geometryData = materialsToCreate[material.name];
+                for (const data of geometryData) {
+                    data.material = material;
+                    data.updateVersion();
+                    node.updateVersion();
+                }
+            }
+        });
+    }
+    /**
+     * Load the material database from the given output content.
+     *
+     * @param content the output content
+     * @returns a scene graph node placeholder for the material database
+     */
+    loadContent(content) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const materialDatabaseData = content.data;
+            const materialDatabase = new viewer_shared_node_tree_1.TreeNode("materialDatabase");
+            if (!materialDatabaseData)
+                return materialDatabase;
+            for (const key in materialDatabaseData) {
+                if (this._materialDatabase[key]) {
+                    if (JSON.stringify(this._materialDatabase[key].definition) !==
+                        JSON.stringify(materialDatabaseData[key])) {
+                        this._materialDatabase[key] = {
+                            definition: materialDatabaseData[key],
+                        };
+                    }
+                }
+                else {
+                    this._materialDatabase[key] = {
+                        definition: materialDatabaseData[key],
+                    };
+                }
+            }
+            return materialDatabase;
+        });
+    }
+}
+exports.MaterialDatabaseEngine = MaterialDatabaseEngine;
+//# sourceMappingURL=MaterialDatabaseEngine.js.map

package/dist/MaterialDatabaseEngine.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MaterialDatabaseEngine.js","sourceRoot":"","sources":["../src/MaterialDatabaseEngine.ts"],"names":[],"mappings":";;;;;;;;;;;;AACA,uGAA8E;AAC9E,iFAAwE;AACxE,+EAI4C;AAC5C,yEAKyC;AAEzC,MAAa,sBAAsB;IAAnC;QACkB,eAAU,GAAc,kCAAS,CAAC,QAAQ,CAAC;QAC3C,gBAAW,GAAe,mCAAU,CAAC,QAAQ,CAAC;QAC9C,YAAO,GAAW,+BAAM,CAAC,QAAQ,CAAC;QAClC,sBAAiB,GAO9B,EAAE,CAAC;QACU,oBAAe,GAAmB,mDAAc,CAAC,QAAQ,CAAC;IAkH5E,CAAC;IA9GO,MAAM,KAAK,QAAQ;QACzB,OAAO,IAAI,CAAC,SAAS,IAAI,CAAC,IAAI,CAAC,SAAS,GAAG,IAAI,IAAI,EAAE,CAAC,CAAC;IACxD,CAAC;IAED;;;;OAIG;IACU,0BAA0B,CAAC,IAAe;;YACtD,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,MAAM,KAAK,CAAC;gBAAE,OAAO;YAE7D,qDAAqD;YACrD,wEAAwE;YACxE,MAAM,iBAAiB,GAAoC,EAAE,CAAC;YAC9D,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,EAAE;;gBACnB,mGAAmG;gBACnG,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;oBACvC,MAAM,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;oBACvB,IAAI,IAAI,YAAY,kCAAY,EAAE;wBACjC,MAAM,YAAY,GAAG,MAAA,IAAI,CAAC,QAAQ,0CAAE,IAAI,CAAC;wBACzC,IAAI,YAAY,EAAE;4BACjB,IAAI,IAAI,CAAC,iBAAiB,CAAC,YAAY,CAAC,EAAE;gCACzC,IACC,CAAC,IAAI,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAC,QAAQ,EAC7C;oCACD,IAAI,CAAC,iBAAiB,CAAC,YAAY,CAAC;wCACnC,iBAAiB,CAAC,YAAY,CAAC,GAAG,EAAE,CAAC;oCACtC,iBAAiB,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;iCAC3C;qCAAM,IACN,IAAI,CAAC,QAAQ;oCACb,IAAI,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAC,QAAQ,EAC5C;oCACD,IAAI,CAAC,QAAQ;wCACZ,IAAI,CAAC,iBAAiB,CAAC,YAAY,CAAC;6CAClC,QAAQ,IAAI,IAAI,CAAC;oCACpB,iDAAiD;oCACjD,IAAI,CAAC,aAAa,EAAE,CAAC;oCACrB,IAAI,CAAC,aAAa,EAAE,CAAC;iCACrB;6BACD;yBACD;qBACD;iBACD;YACF,CAAC,CAAC,CAAC;YAEH,wCAAwC;YACxC,MAAM,aAAa,GAAG,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;YACrD,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC;gBAAE,OAAO;YAEvC,MAAM,QAAQ,GAAG,EAAE,CAAC;YACpB,KAAK,MAAM,YAAY,IAAI,aAAa,EAAE;gBACzC,QAAQ,CAAC,IAAI,CACZ,IAAI,CAAC,eAAe,CAAC,gCAAgC,CACpD,IAAI,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAC,UAAU,CAC/C,CACD,CAAC;aACF;YAED,uBAAuB;YACvB,MAAM,SAAS,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;YAE9C,kEAAkE;YAClE,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,aAAa,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;gBAC9C,MAAM,QAAQ,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;gBAC9B,QAAQ,CAAC,IAAI,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC;gBACjC,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,QAAQ,GAAG,QAAQ,CAAC;gBAC1D,MAAM,YAAY,GAAG,iBAAiB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;gBACtD,KAAK,MAAM,IAAI,IAAI,YAAY,EAAE;oBAChC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;oBACzB,IAAI,CAAC,aAAa,EAAE,CAAC;oBACrB,IAAI,CAAC,aAAa,EAAE,CAAC;iBACrB;aACD;QACF,CAAC;KAAA;IAED;;;;;OAKG;IACU,WAAW,CAAC,OAAyB;;YACjD,MAAM,oBAAoB,GAAG,OAAO,CAAC,IAIpC,CAAC;YACF,MAAM,gBAAgB,GAAG,IAAI,kCAAQ,CAAC,kBAAkB,CAAC,CAAC;YAC1D,IAAI,CAAC,oBAAoB;gBAAE,OAAO,gBAAgB,CAAC;YAEnD,KAAK,MAAM,GAAG,IAAI,oBAAoB,EAAE;gBACvC,IAAI,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,EAAE;oBAChC,IACC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC,UAAU,CAAC;wBACtD,IAAI,CAAC,SAAS,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC,EACxC;wBACD,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,GAAG;4BAC7B,UAAU,EAAE,oBAAoB,CAAC,GAAG,CAAC;yBACrC,CAAC;qBACF;iBACD;qBAAM;oBACN,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,GAAG;wBAC7B,UAAU,EAAE,oBAAoB,CAAC,GAAG,CAAC;qBACrC,CAAC;iBACF;aACD;YAED,OAAO,gBAAgB,CAAC;QACzB,CAAC;KAAA;CACD;AA9HD,wDA8HC"}

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+import { MaterialDatabaseEngine } from "./MaterialDatabaseEngine";
+export { MaterialDatabaseEngine };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,sBAAsB,EAAC,MAAM,0BAA0B,CAAC;AAEhE,OAAO,EAAC,sBAAsB,EAAC,CAAC"}

package/dist/index.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MaterialDatabaseEngine = void 0;
+const viewer_shared_global_access_objects_1 = require("@shapediver/viewer.shared.global-access-objects");
+const MaterialDatabaseEngine_1 = require("./MaterialDatabaseEngine");
+Object.defineProperty(exports, "MaterialDatabaseEngine", { enumerable: true, get: function () { return MaterialDatabaseEngine_1.MaterialDatabaseEngine; } });
+const instance = MaterialDatabaseEngine_1.MaterialDatabaseEngine.instance;
+viewer_shared_global_access_objects_1.GlobalAccessObjects.instance.assignMaterialFromDatabase =
+    instance.assignMaterialFromDatabase.bind(instance);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,yGAAoF;AACpF,qEAAgE;AAExD,uGAFA,+CAAsB,OAEA;AAC9B,MAAM,QAAQ,GAAG,+CAAsB,CAAC,QAAQ,CAAC;AACjD,yDAAmB,CAAC,QAAQ,CAAC,0BAA0B;IACtD,QAAQ,CAAC,0BAA0B,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC"}

package/package.json

@@ -0,0 +1,50 @@
+{
+	"name": "@shapediver/viewer.data-engine.material-database-engine",
+	"version": "3.13.4",
+	"description": "",
+	"keywords": [],
+	"author": "Michael Oppitz <michael@shapediver.com>",
+	"license": "polyform-noncommercial-1.0.0",
+	"main": "dist/index.js",
+	"directories": {
+		"test": "__tests__"
+	},
+	"files": [
+		"package.json",
+		"dist/",
+		"README.md",
+		"LICENSE"
+	],
+	"publishConfig": {
+		"access": "public"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/shapediver/Viewer.git"
+	},
+	"scripts": {
+		"check": "tsc --noEmit",
+		"build": "bash ../../scripts/building/build.sh",
+		"build-watch": "bash ../../scripts/building/build-watch.sh",
+		"build-dep": "bash ../../scripts/building/build-dep.sh"
+	},
+	"bugs": {
+		"url": "https://github.com/shapediver/Viewer/issues"
+	},
+	"homepage": "https://github.com/shapediver/Viewer#readme",
+	"typings": "dist/index.d.ts",
+	"jest": {
+		"preset": "ts-jest",
+		"testEnvironment": "node"
+	},
+	"dependencies": {
+		"@shapediver/viewer.data-engine.material-engine": "3.13.4",
+		"@shapediver/viewer.data-engine.shared-types": "3.13.4",
+		"@shapediver/viewer.shared.global-access-objects": "3.13.4",
+		"@shapediver/viewer.shared.node-tree": "3.13.4",
+		"@shapediver/viewer.shared.services": "3.13.4",
+		"@shapediver/viewer.shared.types": "3.13.4",
+		"gl-matrix": "3.3.0"
+	},
+	"gitHead": "e93748d2f46c1ffcbe6170a654e81d5b9e81ef5b"
+}