@babylonjs/viewer 7.41.1-alpha → 7.42.0

package/configuration/mappers.js

@@ -0,0 +1,193 @@
+import { Tools } from "@babylonjs/core/Misc/tools.js";
+// eslint-disable-next-line import/no-internal-modules
+import { kebabToCamel } from "../helper/index.js";
+/**
+ * This is a simple HTML mapper.
+ * This mapper parses a single HTML element and returns the configuration from its attributes.
+ * it parses numbers and boolean values to the corresponding variable types.
+ * The following HTML element:
+ *  <div test="1" random-flag="true" a.string.object="test"> will result in the following configuration:
+ *
+ *  {
+ *      test: 1, //a number!
+ *      randomFlag: boolean, //camelCase and boolean
+ *      a: {
+ *          string: {
+ *              object: "test" //dot-separated object levels
+ *          }
+ *      }
+ *  }
+ */
+var HTMLMapper = /** @class */ (function () {
+    function HTMLMapper() {
+    }
+    /**
+     * Map a specific element and get configuration from it
+     * @param element the HTML element to analyze.
+     * @returns a ViewerConfiguration object from the provided HTML Element
+     */
+    HTMLMapper.prototype.map = function (element) {
+        var config = {};
+        var _loop_1 = function (attrIdx) {
+            var attr = element.attributes.item(attrIdx);
+            if (!attr) {
+                return "continue";
+            }
+            // map "object.property" to the right configuration place.
+            var split = attr.nodeName.split(".");
+            split.reduce(function (currentConfig, key, idx) {
+                //convert html-style to json-style
+                var camelKey = kebabToCamel(key);
+                if (idx === split.length - 1) {
+                    var val = attr.nodeValue; // firefox warns nodeValue is deprecated, but I found no sign of it anywhere.
+                    if (val === "true") {
+                        val = true;
+                    }
+                    else if (val === "false") {
+                        val = false;
+                    }
+                    else if (val === "undefined") {
+                        val = undefined;
+                    }
+                    else if (val === "null") {
+                        val = null;
+                    }
+                    else {
+                        var isnum = !isNaN(parseFloat(val)) && isFinite(val); ///^\d+$/.test(val);
+                        if (isnum) {
+                            var number = parseFloat(val);
+                            if (!isNaN(number)) {
+                                val = number;
+                            }
+                        }
+                    }
+                    currentConfig[camelKey] = val;
+                }
+                else {
+                    currentConfig[camelKey] = currentConfig[camelKey] || {};
+                }
+                return currentConfig[camelKey];
+            }, config);
+        };
+        for (var attrIdx = 0; attrIdx < element.attributes.length; ++attrIdx) {
+            _loop_1(attrIdx);
+        }
+        return config;
+    };
+    return HTMLMapper;
+}());
+/**
+ * A simple string-to-JSON mapper.
+ * This is the main mapper, used to analyze downloaded JSON-Configuration or JSON payload
+ */
+var JSONMapper = /** @class */ (function () {
+    function JSONMapper() {
+    }
+    JSONMapper.prototype.map = function (rawSource) {
+        return JSON.parse(rawSource);
+    };
+    return JSONMapper;
+}());
+/**
+ * The DOM Mapper will traverse an entire DOM Tree and will load the configuration from the
+ * DOM elements and attributes.
+ */
+var DOMMapper = /** @class */ (function () {
+    function DOMMapper() {
+    }
+    /**
+     * The mapping function that will convert HTML data to a viewer configuration object
+     * @param baseElement the baseElement from which to start traversing
+     * @returns a ViewerConfiguration object from the provided HTML Element
+     */
+    DOMMapper.prototype.map = function (baseElement) {
+        var htmlMapper = new HTMLMapper();
+        var config = htmlMapper.map(baseElement);
+        var traverseChildren = function (element, partConfig) {
+            var children = element.children;
+            if (children.length) {
+                for (var i = 0; i < children.length; ++i) {
+                    var item = children.item(i);
+                    // use the HTML Mapper to read configuration from a single element
+                    var configMapped = htmlMapper.map(item);
+                    var key = kebabToCamel(item.nodeName.toLowerCase());
+                    if (item.attributes.getNamedItem("array") && item.attributes.getNamedItem("array").nodeValue === "true") {
+                        partConfig[key] = [];
+                    }
+                    else {
+                        if (element.attributes.getNamedItem("array") && element.attributes.getNamedItem("array").nodeValue === "true") {
+                            partConfig.push(configMapped);
+                        }
+                        else if (partConfig[key]) {
+                            //exists already! probably an array
+                            element.setAttribute("array", "true");
+                            var oldItem = partConfig[key];
+                            partConfig = [oldItem, configMapped];
+                        }
+                        else {
+                            partConfig[key] = configMapped;
+                        }
+                    }
+                    traverseChildren(item, partConfig[key] || configMapped);
+                }
+            }
+            return partConfig;
+        };
+        traverseChildren(baseElement, config);
+        return config;
+    };
+    return DOMMapper;
+}());
+/**
+ * The MapperManager manages the different implemented mappers.
+ * It allows the user to register new mappers as well and use them to parse their own configuration data
+ */
+var MapperManager = /** @class */ (function () {
+    function MapperManager() {
+        this._mappers = {
+            html: new HTMLMapper(),
+            json: new JSONMapper(),
+            dom: new DOMMapper(),
+        };
+    }
+    /**
+     * Get a specific configuration mapper.
+     *
+     * @param type the name of the mapper to load
+     * @returns the mapper
+     */
+    MapperManager.prototype.getMapper = function (type) {
+        if (!this._mappers[type]) {
+            Tools.Error("No mapper defined for " + type);
+        }
+        return this._mappers[type];
+    };
+    /**
+     * Use this function to register your own configuration mapper.
+     * After a mapper is registered, it can be used to parse the specific type fo configuration to the standard ViewerConfiguration.
+     * @param type the name of the mapper. This will be used to define the configuration type and/or to get the mapper
+     * @param mapper The implemented mapper
+     */
+    MapperManager.prototype.registerMapper = function (type, mapper) {
+        this._mappers[type] = mapper;
+    };
+    /**
+     * Dispose the mapper manager and all of its mappers.
+     */
+    MapperManager.prototype.dispose = function () {
+        this._mappers = {};
+    };
+    /**
+     * The default mapper is the JSON mapper.
+     */
+    MapperManager.DefaultMapper = "json";
+    return MapperManager;
+}());
+export { MapperManager };
+/**
+ * mapperManager is a singleton of the type MapperManager.
+ * The mapperManager can be disposed directly with calling mapperManager.dispose()
+ * or indirectly with using BabylonViewer.disposeAll()
+ */
+export var mapperManager = new MapperManager();
+//# sourceMappingURL=mappers.js.map

package/configuration/mappers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mappers.js","sourceRoot":"","sources":["../../../../tools/viewer/src/configuration/mappers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,sCAAwB;AAGxC,sDAAsD;AACtD,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAS/C;;;;;;;;;;;;;;;;GAgBG;AACH;IAAA;IA+CA,CAAC;IA9CG;;;;OAIG;IACH,wBAAG,GAAH,UAAI,OAAoB;QACpB,IAAM,MAAM,GAAG,EAAE,CAAC;gCACT,OAAO;YACZ,IAAM,IAAI,GAAG,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAC9C,IAAI,CAAC,IAAI,EAAE,CAAC;;YAEZ,CAAC;YACD,0DAA0D;YAC1D,IAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACvC,KAAK,CAAC,MAAM,CAAC,UAAC,aAAqC,EAAE,GAAG,EAAE,GAAG;gBACzD,kCAAkC;gBAClC,IAAM,QAAQ,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC;gBACnC,IAAI,GAAG,KAAK,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBAC3B,IAAI,GAAG,GAAQ,IAAK,CAAC,SAAS,CAAC,CAAC,6EAA6E;oBAC7G,IAAI,GAAG,KAAK,MAAM,EAAE,CAAC;wBACjB,GAAG,GAAG,IAAI,CAAC;oBACf,CAAC;yBAAM,IAAI,GAAG,KAAK,OAAO,EAAE,CAAC;wBACzB,GAAG,GAAG,KAAK,CAAC;oBAChB,CAAC;yBAAM,IAAI,GAAG,KAAK,WAAW,EAAE,CAAC;wBAC7B,GAAG,GAAG,SAAS,CAAC;oBACpB,CAAC;yBAAM,IAAI,GAAG,KAAK,MAAM,EAAE,CAAC;wBACxB,GAAG,GAAG,IAAI,CAAC;oBACf,CAAC;yBAAM,CAAC;wBACJ,IAAM,KAAK,GAAG,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,IAAI,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,oBAAoB;wBAC5E,IAAI,KAAK,EAAE,CAAC;4BACR,IAAM,MAAM,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC;4BAC/B,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;gCACjB,GAAG,GAAG,MAAM,CAAC;4BACjB,CAAC;wBACL,CAAC;oBACL,CAAC;oBACD,aAAa,CAAC,QAAQ,CAAC,GAAG,GAAG,CAAC;gBAClC,CAAC;qBAAM,CAAC;oBACJ,aAAa,CAAC,QAAQ,CAAC,GAAG,aAAa,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;gBAC5D,CAAC;gBACD,OAAO,aAAa,CAAC,QAAQ,CAAC,CAAC;YACnC,CAAC,EAAE,MAAM,CAAC,CAAC;;QAlCf,KAAK,IAAI,OAAO,GAAG,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,UAAU,CAAC,MAAM,EAAE,EAAE,OAAO;oBAA3D,OAAO;SAmCf;QAED,OAAO,MAAM,CAAC;IAClB,CAAC;IACL,iBAAC;AAAD,CAAC,AA/CD,IA+CC;AAED;;;GAGG;AACH;IAAA;IAIA,CAAC;IAHG,wBAAG,GAAH,UAAI,SAAiB;QACjB,OAAO,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC;IACL,iBAAC;AAAD,CAAC,AAJD,IAIC;AAED;;;GAGG;AACH;IAAA;IA0CA,CAAC;IAzCG;;;;OAIG;IACH,uBAAG,GAAH,UAAI,WAAwB;QACxB,IAAM,UAAU,GAAG,IAAI,UAAU,EAAE,CAAC;QACpC,IAAM,MAAM,GAAG,UAAU,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QAE3C,IAAM,gBAAgB,GAAG,UAAU,OAAoB,EAAE,UAAe;YACpE,IAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;YAClC,IAAI,QAAQ,CAAC,MAAM,EAAE,CAAC;gBAClB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;oBACvC,IAAM,IAAI,GAAgB,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;oBAC3C,kEAAkE;oBAClE,IAAM,YAAY,GAAG,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;oBAC1C,IAAM,GAAG,GAAG,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC,CAAC;oBACtD,IAAI,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,OAAO,CAAE,CAAC,SAAS,KAAK,MAAM,EAAE,CAAC;wBACvG,UAAU,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC;oBACzB,CAAC;yBAAM,CAAC;wBACJ,IAAI,OAAO,CAAC,UAAU,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,OAAO,CAAC,UAAU,CAAC,YAAY,CAAC,OAAO,CAAE,CAAC,SAAS,KAAK,MAAM,EAAE,CAAC;4BAC7G,UAAU,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;wBAClC,CAAC;6BAAM,IAAI,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;4BACzB,mCAAmC;4BACnC,OAAO,CAAC,YAAY,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;4BACtC,IAAM,OAAO,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC;4BAChC,UAAU,GAAG,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;wBACzC,CAAC;6BAAM,CAAC;4BACJ,UAAU,CAAC,GAAG,CAAC,GAAG,YAAY,CAAC;wBACnC,CAAC;oBACL,CAAC;oBACD,gBAAgB,CAAC,IAAI,EAAE,UAAU,CAAC,GAAG,CAAC,IAAI,YAAY,CAAC,CAAC;gBAC5D,CAAC;YACL,CAAC;YACD,OAAO,UAAU,CAAC;QACtB,CAAC,CAAC;QAEF,gBAAgB,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;QAEtC,OAAO,MAAM,CAAC;IAClB,CAAC;IACL,gBAAC;AAAD,CAAC,AA1CD,IA0CC;AAED;;;GAGG;AACH;IAOI;QACI,IAAI,CAAC,QAAQ,GAAG;YACZ,IAAI,EAAE,IAAI,UAAU,EAAE;YACtB,IAAI,EAAE,IAAI,UAAU,EAAE;YACtB,GAAG,EAAE,IAAI,SAAS,EAAE;SACvB,CAAC;IACN,CAAC;IAED;;;;;OAKG;IACI,iCAAS,GAAhB,UAAiB,IAAY;QACzB,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YACvB,KAAK,CAAC,KAAK,CAAC,wBAAwB,GAAG,IAAI,CAAC,CAAC;QACjD,CAAC;QACD,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;IAED;;;;;OAKG;IACI,sCAAc,GAArB,UAAsB,IAAY,EAAE,MAAe;QAC/C,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC;IACjC,CAAC;IAED;;OAEG;IACI,+BAAO,GAAd;QACI,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;IACvB,CAAC;IAzCD;;OAEG;IACW,2BAAa,GAAG,MAAM,CAAC;IAuCzC,oBAAC;CAAA,AA5CD,IA4CC;SA5CY,aAAa;AA8C1B;;;;GAIG;AACH,MAAM,CAAC,IAAM,aAAa,GAAG,IAAI,aAAa,EAAE,CAAC","sourcesContent":["import { Tools } from \"core/Misc/tools\";\r\nimport type { ViewerConfiguration } from \"./configuration\";\r\n\r\n// eslint-disable-next-line import/no-internal-modules\r\nimport { kebabToCamel } from \"../helper/index\";\r\n\r\n/**\r\n * This is the mapper's interface. Implement this function to create your own mapper and register it at the mapper manager\r\n */\r\nexport interface IMapper {\r\n    map(rawSource: any): ViewerConfiguration;\r\n}\r\n\r\n/**\r\n * This is a simple HTML mapper.\r\n * This mapper parses a single HTML element and returns the configuration from its attributes.\r\n * it parses numbers and boolean values to the corresponding variable types.\r\n * The following HTML element:\r\n *  <div test=\"1\" random-flag=\"true\" a.string.object=\"test\"> will result in the following configuration:\r\n *\r\n *  {\r\n *      test: 1, //a number!\r\n *      randomFlag: boolean, //camelCase and boolean\r\n *      a: {\r\n *          string: {\r\n *              object: \"test\" //dot-separated object levels\r\n *          }\r\n *      }\r\n *  }\r\n */\r\nclass HTMLMapper implements IMapper {\r\n    /**\r\n     * Map a specific element and get configuration from it\r\n     * @param element the HTML element to analyze.\r\n     * @returns a ViewerConfiguration object from the provided HTML Element\r\n     */\r\n    map(element: HTMLElement): ViewerConfiguration {\r\n        const config = {};\r\n        for (let attrIdx = 0; attrIdx < element.attributes.length; ++attrIdx) {\r\n            const attr = element.attributes.item(attrIdx);\r\n            if (!attr) {\r\n                continue;\r\n            }\r\n            // map \"object.property\" to the right configuration place.\r\n            const split = attr.nodeName.split(\".\");\r\n            split.reduce((currentConfig: { [key: string]: any }, key, idx) => {\r\n                //convert html-style to json-style\r\n                const camelKey = kebabToCamel(key);\r\n                if (idx === split.length - 1) {\r\n                    let val: any = attr!.nodeValue; // firefox warns nodeValue is deprecated, but I found no sign of it anywhere.\r\n                    if (val === \"true\") {\r\n                        val = true;\r\n                    } else if (val === \"false\") {\r\n                        val = false;\r\n                    } else if (val === \"undefined\") {\r\n                        val = undefined;\r\n                    } else if (val === \"null\") {\r\n                        val = null;\r\n                    } else {\r\n                        const isnum = !isNaN(parseFloat(val)) && isFinite(val); ///^\\d+$/.test(val);\r\n                        if (isnum) {\r\n                            const number = parseFloat(val);\r\n                            if (!isNaN(number)) {\r\n                                val = number;\r\n                            }\r\n                        }\r\n                    }\r\n                    currentConfig[camelKey] = val;\r\n                } else {\r\n                    currentConfig[camelKey] = currentConfig[camelKey] || {};\r\n                }\r\n                return currentConfig[camelKey];\r\n            }, config);\r\n        }\r\n\r\n        return config;\r\n    }\r\n}\r\n\r\n/**\r\n * A simple string-to-JSON mapper.\r\n * This is the main mapper, used to analyze downloaded JSON-Configuration or JSON payload\r\n */\r\nclass JSONMapper implements IMapper {\r\n    map(rawSource: string) {\r\n        return JSON.parse(rawSource);\r\n    }\r\n}\r\n\r\n/**\r\n * The DOM Mapper will traverse an entire DOM Tree and will load the configuration from the\r\n * DOM elements and attributes.\r\n */\r\nclass DOMMapper implements IMapper {\r\n    /**\r\n     * The mapping function that will convert HTML data to a viewer configuration object\r\n     * @param baseElement the baseElement from which to start traversing\r\n     * @returns a ViewerConfiguration object from the provided HTML Element\r\n     */\r\n    map(baseElement: HTMLElement): ViewerConfiguration {\r\n        const htmlMapper = new HTMLMapper();\r\n        const config = htmlMapper.map(baseElement);\r\n\r\n        const traverseChildren = function (element: HTMLElement, partConfig: any) {\r\n            const children = element.children;\r\n            if (children.length) {\r\n                for (let i = 0; i < children.length; ++i) {\r\n                    const item = <HTMLElement>children.item(i);\r\n                    // use the HTML Mapper to read configuration from a single element\r\n                    const configMapped = htmlMapper.map(item);\r\n                    const key = kebabToCamel(item.nodeName.toLowerCase());\r\n                    if (item.attributes.getNamedItem(\"array\") && item.attributes.getNamedItem(\"array\")!.nodeValue === \"true\") {\r\n                        partConfig[key] = [];\r\n                    } else {\r\n                        if (element.attributes.getNamedItem(\"array\") && element.attributes.getNamedItem(\"array\")!.nodeValue === \"true\") {\r\n                            partConfig.push(configMapped);\r\n                        } else if (partConfig[key]) {\r\n                            //exists already! probably an array\r\n                            element.setAttribute(\"array\", \"true\");\r\n                            const oldItem = partConfig[key];\r\n                            partConfig = [oldItem, configMapped];\r\n                        } else {\r\n                            partConfig[key] = configMapped;\r\n                        }\r\n                    }\r\n                    traverseChildren(item, partConfig[key] || configMapped);\r\n                }\r\n            }\r\n            return partConfig;\r\n        };\r\n\r\n        traverseChildren(baseElement, config);\r\n\r\n        return config;\r\n    }\r\n}\r\n\r\n/**\r\n * The MapperManager manages the different implemented mappers.\r\n * It allows the user to register new mappers as well and use them to parse their own configuration data\r\n */\r\nexport class MapperManager {\r\n    private _mappers: { [key: string]: IMapper };\r\n    /**\r\n     * The default mapper is the JSON mapper.\r\n     */\r\n    public static DefaultMapper = \"json\";\r\n\r\n    constructor() {\r\n        this._mappers = {\r\n            html: new HTMLMapper(),\r\n            json: new JSONMapper(),\r\n            dom: new DOMMapper(),\r\n        };\r\n    }\r\n\r\n    /**\r\n     * Get a specific configuration mapper.\r\n     *\r\n     * @param type the name of the mapper to load\r\n     * @returns the mapper\r\n     */\r\n    public getMapper(type: string) {\r\n        if (!this._mappers[type]) {\r\n            Tools.Error(\"No mapper defined for \" + type);\r\n        }\r\n        return this._mappers[type];\r\n    }\r\n\r\n    /**\r\n     * Use this function to register your own configuration mapper.\r\n     * After a mapper is registered, it can be used to parse the specific type fo configuration to the standard ViewerConfiguration.\r\n     * @param type the name of the mapper. This will be used to define the configuration type and/or to get the mapper\r\n     * @param mapper The implemented mapper\r\n     */\r\n    public registerMapper(type: string, mapper: IMapper) {\r\n        this._mappers[type] = mapper;\r\n    }\r\n\r\n    /**\r\n     * Dispose the mapper manager and all of its mappers.\r\n     */\r\n    public dispose() {\r\n        this._mappers = {};\r\n    }\r\n}\r\n\r\n/**\r\n * mapperManager is a singleton of the type MapperManager.\r\n * The mapperManager can be disposed directly with calling mapperManager.dispose()\r\n * or indirectly with using BabylonViewer.disposeAll()\r\n */\r\nexport const mapperManager = new MapperManager();\r\n"]}

package/configuration/renderOnlyLoader.d.ts

@@ -0,0 +1,33 @@
+import type { ViewerConfiguration } from "./configuration";
+/**
+ * The configuration loader will load the configuration object from any source and will use the defined mapper to
+ * parse the object and return a conform ViewerConfiguration.
+ * It is a private member of the scene.
+ */
+export declare class RenderOnlyConfigurationLoader {
+    private _enableCache;
+    private _configurationCache;
+    private _loadRequests;
+    constructor(_enableCache?: boolean);
+    private _getConfigurationTypeExcludeTemplate;
+    protected getExtendedConfig(type: string | undefined): ViewerConfiguration;
+    /**
+     * load a configuration object that is defined in the initial configuration provided.
+     * The viewer configuration can extend different types of configuration objects and have an extra configuration defined.
+     *
+     * @param initConfig the initial configuration that has the definitions of further configuration to load.
+     * @param callback an optional callback that will be called sync, if noconfiguration needs to be loaded or configuration is payload-only
+     * @returns A promise that delivers the extended viewer configuration, when done.
+     */
+    loadConfiguration(initConfig?: ViewerConfiguration, callback?: (config: ViewerConfiguration) => void): Promise<ViewerConfiguration>;
+    /**
+     * Dispose the configuration loader. This will cancel file requests, if active.
+     */
+    dispose(): void;
+    /**
+     * This function will process the initial configuration and make needed changes for the viewer to work.
+     * @param config the mutable(!) initial configuration to process
+     */
+    private _processInitialConfiguration;
+    private _loadFile;
+}

package/configuration/renderOnlyLoader.js

@@ -0,0 +1,162 @@
+import { mapperManager } from "./mappers.js";
+import { processConfigurationCompatibility } from "./configurationCompatibility.js";
+// eslint-disable-next-line import/no-internal-modules
+import { deepmerge } from "../helper/index.js";
+import { Tools } from "@babylonjs/core/Misc/tools.js";
+import { extendedConfiguration } from "./types/extended.js";
+import { renderOnlyDefaultConfiguration } from "./types/renderOnlyDefault.js";
+/**
+ * The configuration loader will load the configuration object from any source and will use the defined mapper to
+ * parse the object and return a conform ViewerConfiguration.
+ * It is a private member of the scene.
+ */
+var RenderOnlyConfigurationLoader = /** @class */ (function () {
+    function RenderOnlyConfigurationLoader(_enableCache) {
+        if (_enableCache === void 0) { _enableCache = false; }
+        this._enableCache = _enableCache;
+        this._configurationCache = {};
+        this._loadRequests = [];
+    }
+    RenderOnlyConfigurationLoader.prototype._getConfigurationTypeExcludeTemplate = function (types) {
+        var _this = this;
+        var config = {};
+        var typesSeparated = types.split(",");
+        typesSeparated.forEach(function (type) {
+            switch (type.trim()) {
+                case "default":
+                    config = deepmerge(config, renderOnlyDefaultConfiguration);
+                    break;
+                case "none":
+                    break;
+                case "extended":
+                default:
+                    config = deepmerge(config, extendedConfiguration);
+                    break;
+            }
+            if (config.extends) {
+                config = deepmerge(config, _this._getConfigurationTypeExcludeTemplate(config.extends));
+            }
+        });
+        return config;
+    };
+    // eslint-disable-next-line @typescript-eslint/naming-convention
+    RenderOnlyConfigurationLoader.prototype.getExtendedConfig = function (type) {
+        return this._getConfigurationTypeExcludeTemplate(type || "extended");
+    };
+    /**
+     * load a configuration object that is defined in the initial configuration provided.
+     * The viewer configuration can extend different types of configuration objects and have an extra configuration defined.
+     *
+     * @param initConfig the initial configuration that has the definitions of further configuration to load.
+     * @param callback an optional callback that will be called sync, if noconfiguration needs to be loaded or configuration is payload-only
+     * @returns A promise that delivers the extended viewer configuration, when done.
+     */
+    RenderOnlyConfigurationLoader.prototype.loadConfiguration = function (initConfig, callback) {
+        var _this = this;
+        if (initConfig === void 0) { initConfig = {}; }
+        var loadedConfig = deepmerge({}, initConfig);
+        this._processInitialConfiguration(loadedConfig);
+        var extendedConfiguration = this.getExtendedConfig(loadedConfig.extends);
+        if (loadedConfig.configuration) {
+            var mapperType_1 = "json";
+            return Promise.resolve()
+                .then(function () {
+                if (typeof loadedConfig.configuration === "string" || (loadedConfig.configuration && loadedConfig.configuration.url)) {
+                    // a file to load
+                    var url = "";
+                    if (typeof loadedConfig.configuration === "string") {
+                        url = loadedConfig.configuration;
+                    }
+                    // if configuration is an object
+                    if (typeof loadedConfig.configuration === "object" && loadedConfig.configuration.url) {
+                        url = loadedConfig.configuration.url;
+                        var type = loadedConfig.configuration.mapper;
+                        // empty string?
+                        if (!type) {
+                            // load mapper type from filename / url
+                            type = loadedConfig.configuration.url.split(".").pop();
+                        }
+                        mapperType_1 = type || mapperType_1;
+                    }
+                    return _this._loadFile(url);
+                }
+                else {
+                    if (typeof loadedConfig.configuration === "object") {
+                        mapperType_1 = loadedConfig.configuration.mapper || mapperType_1;
+                        return loadedConfig.configuration.payload || {};
+                    }
+                    return {};
+                }
+            })
+                .then(function (data) {
+                var mapper = mapperManager.getMapper(mapperType_1);
+                var parsed = deepmerge(mapper.map(data), loadedConfig);
+                var merged = deepmerge(extendedConfiguration, parsed);
+                processConfigurationCompatibility(merged);
+                if (callback) {
+                    callback(merged);
+                }
+                return merged;
+            });
+        }
+        else {
+            loadedConfig = deepmerge(extendedConfiguration, loadedConfig);
+            processConfigurationCompatibility(loadedConfig);
+            if (callback) {
+                callback(loadedConfig);
+            }
+            return Promise.resolve(loadedConfig);
+        }
+    };
+    /**
+     * Dispose the configuration loader. This will cancel file requests, if active.
+     */
+    RenderOnlyConfigurationLoader.prototype.dispose = function () {
+        this._loadRequests.forEach(function (request) {
+            request.abort();
+        });
+        this._loadRequests.length = 0;
+    };
+    /**
+     * This function will process the initial configuration and make needed changes for the viewer to work.
+     * @param config the mutable(!) initial configuration to process
+     */
+    RenderOnlyConfigurationLoader.prototype._processInitialConfiguration = function (config) {
+        if (config.model) {
+            if (typeof config.model === "string") {
+                config.model = {
+                    url: config.model,
+                };
+            }
+        }
+    };
+    RenderOnlyConfigurationLoader.prototype._loadFile = function (url) {
+        var _this = this;
+        var cacheReference = this._configurationCache;
+        if (this._enableCache && cacheReference[url]) {
+            return Promise.resolve(cacheReference[url]);
+        }
+        return new Promise(function (resolve, reject) {
+            var fileRequest = Tools.LoadFile(url, function (result) {
+                var idx = _this._loadRequests.indexOf(fileRequest);
+                if (idx !== -1) {
+                    _this._loadRequests.splice(idx, 1);
+                }
+                if (_this._enableCache) {
+                    cacheReference[url] = result;
+                }
+                resolve(result);
+            }, undefined, undefined, false, function (request, error) {
+                var idx = _this._loadRequests.indexOf(fileRequest);
+                if (idx !== -1) {
+                    _this._loadRequests.splice(idx, 1);
+                }
+                reject(error);
+            });
+            _this._loadRequests.push(fileRequest);
+        });
+    };
+    return RenderOnlyConfigurationLoader;
+}());
+export { RenderOnlyConfigurationLoader };
+//# sourceMappingURL=renderOnlyLoader.js.map

package/configuration/renderOnlyLoader.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"renderOnlyLoader.js","sourceRoot":"","sources":["../../../../tools/viewer/src/configuration/renderOnlyLoader.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAE1C,OAAO,EAAE,iCAAiC,EAAE,MAAM,8BAA8B,CAAC;AAEjF,sDAAsD;AACtD,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,KAAK,EAAE,sCAAwB;AACxC,OAAO,EAAE,qBAAqB,EAAE,MAAM,kBAAkB,CAAC;AACzD,OAAO,EAAE,8BAA8B,EAAE,MAAM,2BAA2B,CAAC;AAG3E;;;;GAIG;AACH;IAKI,uCAAoB,YAA6B;QAA7B,6BAAA,EAAA,oBAA6B;QAA7B,iBAAY,GAAZ,YAAY,CAAiB;QAC7C,IAAI,CAAC,mBAAmB,GAAG,EAAE,CAAC;QAC9B,IAAI,CAAC,aAAa,GAAG,EAAE,CAAC;IAC5B,CAAC;IAEO,4EAAoC,GAA5C,UAA6C,KAAa;QAA1D,iBAoBC;QAnBG,IAAI,MAAM,GAAwB,EAAE,CAAC;QACrC,IAAM,cAAc,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACxC,cAAc,CAAC,OAAO,CAAC,UAAC,IAAI;YACxB,QAAQ,IAAI,CAAC,IAAI,EAAE,EAAE,CAAC;gBAClB,KAAK,SAAS;oBACV,MAAM,GAAG,SAAS,CAAC,MAAM,EAAE,8BAA8B,CAAC,CAAC;oBAC3D,MAAM;gBACV,KAAK,MAAM;oBACP,MAAM;gBACV,KAAK,UAAU,CAAC;gBAChB;oBACI,MAAM,GAAG,SAAS,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;oBAClD,MAAM;YACd,CAAC;YACD,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;gBACjB,MAAM,GAAG,SAAS,CAAC,MAAM,EAAE,KAAI,CAAC,oCAAoC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;YAC1F,CAAC;QACL,CAAC,CAAC,CAAC;QACH,OAAO,MAAM,CAAC;IAClB,CAAC;IAED,gEAAgE;IACtD,yDAAiB,GAA3B,UAA4B,IAAwB;QAChD,OAAO,IAAI,CAAC,oCAAoC,CAAC,IAAI,IAAI,UAAU,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;OAOG;IACI,yDAAiB,GAAxB,UAAyB,UAAoC,EAAE,QAAgD;QAA/G,iBAwDC;QAxDwB,2BAAA,EAAA,eAAoC;QACzD,IAAI,YAAY,GAAwB,SAAS,CAAC,EAAE,EAAE,UAAU,CAAC,CAAC;QAClE,IAAI,CAAC,4BAA4B,CAAC,YAAY,CAAC,CAAC;QAEhD,IAAM,qBAAqB,GAAG,IAAI,CAAC,iBAAiB,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;QAE3E,IAAI,YAAY,CAAC,aAAa,EAAE,CAAC;YAC7B,IAAI,YAAU,GAAG,MAAM,CAAC;YACxB,OAAO,OAAO,CAAC,OAAO,EAAE;iBACnB,IAAI,CAAC;gBACF,IAAI,OAAO,YAAY,CAAC,aAAa,KAAK,QAAQ,IAAI,CAAC,YAAY,CAAC,aAAa,IAAI,YAAY,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC;oBACnH,iBAAiB;oBAEjB,IAAI,GAAG,GAAW,EAAE,CAAC;oBACrB,IAAI,OAAO,YAAY,CAAC,aAAa,KAAK,QAAQ,EAAE,CAAC;wBACjD,GAAG,GAAG,YAAY,CAAC,aAAa,CAAC;oBACrC,CAAC;oBAED,gCAAgC;oBAChC,IAAI,OAAO,YAAY,CAAC,aAAa,KAAK,QAAQ,IAAI,YAAY,CAAC,aAAa,CAAC,GAAG,EAAE,CAAC;wBACnF,GAAG,GAAG,YAAY,CAAC,aAAa,CAAC,GAAG,CAAC;wBACrC,IAAI,IAAI,GAAG,YAAY,CAAC,aAAa,CAAC,MAAM,CAAC;wBAC7C,gBAAgB;wBAChB,IAAI,CAAC,IAAI,EAAE,CAAC;4BACR,uCAAuC;4BACvC,IAAI,GAAG,YAAY,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC;wBAC3D,CAAC;wBACD,YAAU,GAAG,IAAI,IAAI,YAAU,CAAC;oBACpC,CAAC;oBACD,OAAO,KAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;gBAC/B,CAAC;qBAAM,CAAC;oBACJ,IAAI,OAAO,YAAY,CAAC,aAAa,KAAK,QAAQ,EAAE,CAAC;wBACjD,YAAU,GAAG,YAAY,CAAC,aAAa,CAAC,MAAM,IAAI,YAAU,CAAC;wBAC7D,OAAO,YAAY,CAAC,aAAa,CAAC,OAAO,IAAI,EAAE,CAAC;oBACpD,CAAC;oBACD,OAAO,EAAE,CAAC;gBACd,CAAC;YACL,CAAC,CAAC;iBACD,IAAI,CAAC,UAAC,IAAS;gBACZ,IAAM,MAAM,GAAG,aAAa,CAAC,SAAS,CAAC,YAAU,CAAC,CAAC;gBACnD,IAAM,MAAM,GAAG,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,YAAY,CAAC,CAAC;gBACzD,IAAM,MAAM,GAAG,SAAS,CAAC,qBAAqB,EAAE,MAAM,CAAC,CAAC;gBACxD,iCAAiC,CAAC,MAAM,CAAC,CAAC;gBAC1C,IAAI,QAAQ,EAAE,CAAC;oBACX,QAAQ,CAAC,MAAM,CAAC,CAAC;gBACrB,CAAC;gBACD,OAAO,MAAM,CAAC;YAClB,CAAC,CAAC,CAAC;QACX,CAAC;aAAM,CAAC;YACJ,YAAY,GAAG,SAAS,CAAC,qBAAqB,EAAE,YAAY,CAAC,CAAC;YAC9D,iCAAiC,CAAC,YAAY,CAAC,CAAC;YAChD,IAAI,QAAQ,EAAE,CAAC;gBACX,QAAQ,CAAC,YAAY,CAAC,CAAC;YAC3B,CAAC;YACD,OAAO,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;QACzC,CAAC;IACL,CAAC;IAED;;OAEG;IACI,+CAAO,GAAd;QACI,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,UAAC,OAAO;YAC/B,OAAO,CAAC,KAAK,EAAE,CAAC;QACpB,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC;IAClC,CAAC;IAED;;;OAGG;IACK,oEAA4B,GAApC,UAAqC,MAA2B;QAC5D,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;YACf,IAAI,OAAO,MAAM,CAAC,KAAK,KAAK,QAAQ,EAAE,CAAC;gBACnC,MAAM,CAAC,KAAK,GAAG;oBACX,GAAG,EAAE,MAAM,CAAC,KAAK;iBACpB,CAAC;YACN,CAAC;QACL,CAAC;IACL,CAAC;IAEO,iDAAS,GAAjB,UAAkB,GAAW;QAA7B,iBAgCC;QA/BG,IAAM,cAAc,GAAG,IAAI,CAAC,mBAAmB,CAAC;QAChD,IAAI,IAAI,CAAC,YAAY,IAAI,cAAc,CAAC,GAAG,CAAC,EAAE,CAAC;YAC3C,OAAO,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC;QAChD,CAAC;QAED,OAAO,IAAI,OAAO,CAAC,UAAC,OAAO,EAAE,MAAM;YAC/B,IAAM,WAAW,GAAG,KAAK,CAAC,QAAQ,CAC9B,GAAG,EACH,UAAC,MAAM;gBACH,IAAM,GAAG,GAAG,KAAI,CAAC,aAAa,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;gBACpD,IAAI,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC;oBACb,KAAI,CAAC,aAAa,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;gBACtC,CAAC;gBACD,IAAI,KAAI,CAAC,YAAY,EAAE,CAAC;oBACpB,cAAc,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC;gBACjC,CAAC;gBACD,OAAO,CAAC,MAAM,CAAC,CAAC;YACpB,CAAC,EACD,SAAS,EACT,SAAS,EACT,KAAK,EACL,UAAC,OAAO,EAAE,KAAU;gBAChB,IAAM,GAAG,GAAG,KAAI,CAAC,aAAa,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;gBACpD,IAAI,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC;oBACb,KAAI,CAAC,aAAa,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;gBACtC,CAAC;gBACD,MAAM,CAAC,KAAK,CAAC,CAAC;YAClB,CAAC,CACJ,CAAC;YACF,KAAI,CAAC,aAAa,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACzC,CAAC,CAAC,CAAC;IACP,CAAC;IACL,oCAAC;AAAD,CAAC,AAhKD,IAgKC","sourcesContent":["import { mapperManager } from \"./mappers\";\r\nimport type { ViewerConfiguration } from \"./configuration\";\r\nimport { processConfigurationCompatibility } from \"./configurationCompatibility\";\r\n\r\n// eslint-disable-next-line import/no-internal-modules\r\nimport { deepmerge } from \"../helper/index\";\r\nimport { Tools } from \"core/Misc/tools\";\r\nimport { extendedConfiguration } from \"./types/extended\";\r\nimport { renderOnlyDefaultConfiguration } from \"./types/renderOnlyDefault\";\r\nimport type { IFileRequest } from \"core/Misc/fileRequest\";\r\n\r\n/**\r\n * The configuration loader will load the configuration object from any source and will use the defined mapper to\r\n * parse the object and return a conform ViewerConfiguration.\r\n * It is a private member of the scene.\r\n */\r\nexport class RenderOnlyConfigurationLoader {\r\n    private _configurationCache: { [url: string]: any };\r\n\r\n    private _loadRequests: Array<IFileRequest>;\r\n\r\n    constructor(private _enableCache: boolean = false) {\r\n        this._configurationCache = {};\r\n        this._loadRequests = [];\r\n    }\r\n\r\n    private _getConfigurationTypeExcludeTemplate(types: string): ViewerConfiguration {\r\n        let config: ViewerConfiguration = {};\r\n        const typesSeparated = types.split(\",\");\r\n        typesSeparated.forEach((type) => {\r\n            switch (type.trim()) {\r\n                case \"default\":\r\n                    config = deepmerge(config, renderOnlyDefaultConfiguration);\r\n                    break;\r\n                case \"none\":\r\n                    break;\r\n                case \"extended\":\r\n                default:\r\n                    config = deepmerge(config, extendedConfiguration);\r\n                    break;\r\n            }\r\n            if (config.extends) {\r\n                config = deepmerge(config, this._getConfigurationTypeExcludeTemplate(config.extends));\r\n            }\r\n        });\r\n        return config;\r\n    }\r\n\r\n    // eslint-disable-next-line @typescript-eslint/naming-convention\r\n    protected getExtendedConfig(type: string | undefined) {\r\n        return this._getConfigurationTypeExcludeTemplate(type || \"extended\");\r\n    }\r\n\r\n    /**\r\n     * load a configuration object that is defined in the initial configuration provided.\r\n     * The viewer configuration can extend different types of configuration objects and have an extra configuration defined.\r\n     *\r\n     * @param initConfig the initial configuration that has the definitions of further configuration to load.\r\n     * @param callback an optional callback that will be called sync, if noconfiguration needs to be loaded or configuration is payload-only\r\n     * @returns A promise that delivers the extended viewer configuration, when done.\r\n     */\r\n    public loadConfiguration(initConfig: ViewerConfiguration = {}, callback?: (config: ViewerConfiguration) => void): Promise<ViewerConfiguration> {\r\n        let loadedConfig: ViewerConfiguration = deepmerge({}, initConfig);\r\n        this._processInitialConfiguration(loadedConfig);\r\n\r\n        const extendedConfiguration = this.getExtendedConfig(loadedConfig.extends);\r\n\r\n        if (loadedConfig.configuration) {\r\n            let mapperType = \"json\";\r\n            return Promise.resolve()\r\n                .then(() => {\r\n                    if (typeof loadedConfig.configuration === \"string\" || (loadedConfig.configuration && loadedConfig.configuration.url)) {\r\n                        // a file to load\r\n\r\n                        let url: string = \"\";\r\n                        if (typeof loadedConfig.configuration === \"string\") {\r\n                            url = loadedConfig.configuration;\r\n                        }\r\n\r\n                        // if configuration is an object\r\n                        if (typeof loadedConfig.configuration === \"object\" && loadedConfig.configuration.url) {\r\n                            url = loadedConfig.configuration.url;\r\n                            let type = loadedConfig.configuration.mapper;\r\n                            // empty string?\r\n                            if (!type) {\r\n                                // load mapper type from filename / url\r\n                                type = loadedConfig.configuration.url.split(\".\").pop();\r\n                            }\r\n                            mapperType = type || mapperType;\r\n                        }\r\n                        return this._loadFile(url);\r\n                    } else {\r\n                        if (typeof loadedConfig.configuration === \"object\") {\r\n                            mapperType = loadedConfig.configuration.mapper || mapperType;\r\n                            return loadedConfig.configuration.payload || {};\r\n                        }\r\n                        return {};\r\n                    }\r\n                })\r\n                .then((data: any) => {\r\n                    const mapper = mapperManager.getMapper(mapperType);\r\n                    const parsed = deepmerge(mapper.map(data), loadedConfig);\r\n                    const merged = deepmerge(extendedConfiguration, parsed);\r\n                    processConfigurationCompatibility(merged);\r\n                    if (callback) {\r\n                        callback(merged);\r\n                    }\r\n                    return merged;\r\n                });\r\n        } else {\r\n            loadedConfig = deepmerge(extendedConfiguration, loadedConfig);\r\n            processConfigurationCompatibility(loadedConfig);\r\n            if (callback) {\r\n                callback(loadedConfig);\r\n            }\r\n            return Promise.resolve(loadedConfig);\r\n        }\r\n    }\r\n\r\n    /**\r\n     * Dispose the configuration loader. This will cancel file requests, if active.\r\n     */\r\n    public dispose() {\r\n        this._loadRequests.forEach((request) => {\r\n            request.abort();\r\n        });\r\n        this._loadRequests.length = 0;\r\n    }\r\n\r\n    /**\r\n     * This function will process the initial configuration and make needed changes for the viewer to work.\r\n     * @param config the mutable(!) initial configuration to process\r\n     */\r\n    private _processInitialConfiguration(config: ViewerConfiguration) {\r\n        if (config.model) {\r\n            if (typeof config.model === \"string\") {\r\n                config.model = {\r\n                    url: config.model,\r\n                };\r\n            }\r\n        }\r\n    }\r\n\r\n    private _loadFile(url: string): Promise<any> {\r\n        const cacheReference = this._configurationCache;\r\n        if (this._enableCache && cacheReference[url]) {\r\n            return Promise.resolve(cacheReference[url]);\r\n        }\r\n\r\n        return new Promise((resolve, reject) => {\r\n            const fileRequest = Tools.LoadFile(\r\n                url,\r\n                (result) => {\r\n                    const idx = this._loadRequests.indexOf(fileRequest);\r\n                    if (idx !== -1) {\r\n                        this._loadRequests.splice(idx, 1);\r\n                    }\r\n                    if (this._enableCache) {\r\n                        cacheReference[url] = result;\r\n                    }\r\n                    resolve(result);\r\n                },\r\n                undefined,\r\n                undefined,\r\n                false,\r\n                (request, error: any) => {\r\n                    const idx = this._loadRequests.indexOf(fileRequest);\r\n                    if (idx !== -1) {\r\n                        this._loadRequests.splice(idx, 1);\r\n                    }\r\n                    reject(error);\r\n                }\r\n            );\r\n            this._loadRequests.push(fileRequest);\r\n        });\r\n    }\r\n}\r\n"]}

package/configuration/types/default.d.ts

@@ -0,0 +1,6 @@
+import type { ViewerConfiguration } from "../configuration";
+/**
+ * The default configuration of the viewer, including templates (canvas, overly, loading screen)
+ * This configuration doesn't hold specific parameters, and only defines objects that are needed for the viewer to fully work correctly.
+ */
+export declare const defaultConfiguration: ViewerConfiguration;

package/configuration/types/default.js

@@ -0,0 +1,121 @@
+import { babylonFont, defaultTemplate, fillContainer, loadingScreen, defaultViewer, navbar, overlay, help, share, error } from "babylonjs-viewer-assets";
+import * as images from "babylonjs-viewer-assets";
+import { renderOnlyDefaultConfiguration } from "./renderOnlyDefault.js";
+// eslint-disable-next-line import/no-internal-modules
+import { deepmerge } from "../../helper/index.js";
+/**
+ * The default configuration of the viewer, including templates (canvas, overly, loading screen)
+ * This configuration doesn't hold specific parameters, and only defines objects that are needed for the viewer to fully work correctly.
+ */
+export var defaultConfiguration = deepmerge(renderOnlyDefaultConfiguration, {
+    version: "3.2.0-alpha4",
+    templates: {
+        main: {
+            html: defaultTemplate,
+            params: {
+                babylonFont: babylonFont,
+                noEscape: true,
+            },
+        },
+        fillContainer: {
+            html: fillContainer,
+            params: {
+                disable: false,
+            },
+        },
+        loadingScreen: {
+            html: loadingScreen,
+            params: {
+                backgroundColor: "#000000",
+                loadingImage: images.loading,
+                staticLoadingImage: images.staticLoading,
+            },
+        },
+        viewer: {
+            html: defaultViewer,
+            params: {
+                enableDragAndDrop: false,
+            },
+        },
+        navBar: {
+            html: navbar,
+            params: {
+                speedList: {
+                    "0.5x": "0.5",
+                    "1.0x": "1.0",
+                    "1.5x": "1.5",
+                    "2.0x": "2.0",
+                },
+                logoImage: images.babylonLogo,
+                logoText: "BabylonJS",
+                logoLink: "https://babylonjs.com",
+                hideHelp: true,
+                hideHd: true,
+                hideVr: true,
+                hidePrint: true,
+                disableOnFullscreen: false,
+                text: {
+                    hdButton: "Toggle HD",
+                    fullscreenButton: "Toggle Fullscreen",
+                    helpButton: "Help",
+                    vrButton: "Toggle VR",
+                    printButton: "3D Print Object",
+                },
+            },
+            events: {
+                click: {
+                    ".navbar-control": true,
+                },
+                pointerdown: {
+                    ".help-button": true,
+                },
+                input: {
+                    ".progress-wrapper": true,
+                },
+                pointerup: {
+                    ".progress-wrapper": true,
+                },
+            },
+        },
+        overlay: {
+            html: overlay,
+            params: {
+                closeImage: images.close,
+                closeText: "Close",
+            },
+        },
+        help: {
+            html: help,
+        },
+        share: {
+            html: share,
+        },
+        error: {
+            html: error,
+        },
+    },
+    camera: {
+        behaviors: {
+            autoRotate: {
+                type: 0,
+            },
+            framing: {
+                type: 2,
+                zoomOnBoundingInfo: true,
+                zoomStopsAnimation: false,
+            },
+            bouncing: {
+                type: 1,
+            },
+        },
+    },
+    skybox: {},
+    ground: {
+        receiveShadows: true,
+    },
+    engine: {
+        antialiasing: true,
+    },
+    scene: {},
+});
+//# sourceMappingURL=default.js.map

package/configuration/types/default.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"default.js","sourceRoot":"","sources":["../../../../../tools/viewer/src/configuration/types/default.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,aAAa,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,yBAAyB,CAAC;AACzJ,OAAO,KAAK,MAAM,MAAM,yBAAyB,CAAC;AAClD,OAAO,EAAE,8BAA8B,EAAE,MAAM,qBAAqB,CAAC;AACrE,sDAAsD;AACtD,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAE/C;;;GAGG;AACH,MAAM,CAAC,IAAM,oBAAoB,GAAwB,SAAS,CAAC,8BAA8B,EAAE;IAC/F,OAAO,EAAE,cAAc;IACvB,SAAS,EAAE;QACP,IAAI,EAAE;YACF,IAAI,EAAE,eAAe;YACrB,MAAM,EAAE;gBACJ,WAAW,EAAE,WAAW;gBACxB,QAAQ,EAAE,IAAI;aACjB;SACJ;QACD,aAAa,EAAE;YACX,IAAI,EAAE,aAAa;YACnB,MAAM,EAAE;gBACJ,OAAO,EAAE,KAAK;aACjB;SACJ;QACD,aAAa,EAAE;YACX,IAAI,EAAE,aAAa;YACnB,MAAM,EAAE;gBACJ,eAAe,EAAE,SAAS;gBAC1B,YAAY,EAAE,MAAM,CAAC,OAAO;gBAC5B,kBAAkB,EAAE,MAAM,CAAC,aAAa;aAC3C;SACJ;QACD,MAAM,EAAE;YACJ,IAAI,EAAE,aAAa;YACnB,MAAM,EAAE;gBACJ,iBAAiB,EAAE,KAAK;aAC3B;SACJ;QACD,MAAM,EAAE;YACJ,IAAI,EAAE,MAAM;YACZ,MAAM,EAAE;gBACJ,SAAS,EAAE;oBACP,MAAM,EAAE,KAAK;oBACb,MAAM,EAAE,KAAK;oBACb,MAAM,EAAE,KAAK;oBACb,MAAM,EAAE,KAAK;iBAChB;gBACD,SAAS,EAAE,MAAM,CAAC,WAAW;gBAC7B,QAAQ,EAAE,WAAW;gBACrB,QAAQ,EAAE,uBAAuB;gBACjC,QAAQ,EAAE,IAAI;gBACd,MAAM,EAAE,IAAI;gBACZ,MAAM,EAAE,IAAI;gBACZ,SAAS,EAAE,IAAI;gBACf,mBAAmB,EAAE,KAAK;gBAC1B,IAAI,EAAE;oBACF,QAAQ,EAAE,WAAW;oBACrB,gBAAgB,EAAE,mBAAmB;oBACrC,UAAU,EAAE,MAAM;oBAClB,QAAQ,EAAE,WAAW;oBACrB,WAAW,EAAE,iBAAiB;iBACjC;aACJ;YACD,MAAM,EAAE;gBACJ,KAAK,EAAE;oBACH,iBAAiB,EAAE,IAAI;iBAC1B;gBACD,WAAW,EAAE;oBACT,cAAc,EAAE,IAAI;iBACvB;gBACD,KAAK,EAAE;oBACH,mBAAmB,EAAE,IAAI;iBAC5B;gBACD,SAAS,EAAE;oBACP,mBAAmB,EAAE,IAAI;iBAC5B;aACJ;SACJ;QACD,OAAO,EAAE;YACL,IAAI,EAAE,OAAO;YACb,MAAM,EAAE;gBACJ,UAAU,EAAE,MAAM,CAAC,KAAK;gBACxB,SAAS,EAAE,OAAO;aACrB;SACJ;QACD,IAAI,EAAE;YACF,IAAI,EAAE,IAAI;SACb;QACD,KAAK,EAAE;YACH,IAAI,EAAE,KAAK;SACd;QACD,KAAK,EAAE;YACH,IAAI,EAAE,KAAK;SACd;KACJ;IACD,MAAM,EAAE;QACJ,SAAS,EAAE;YACP,UAAU,EAAE;gBACR,IAAI,EAAE,CAAC;aACV;YACD,OAAO,EAAE;gBACL,IAAI,EAAE,CAAC;gBACP,kBAAkB,EAAE,IAAI;gBACxB,kBAAkB,EAAE,KAAK;aAC5B;YACD,QAAQ,EAAE;gBACN,IAAI,EAAE,CAAC;aACV;SACJ;KACJ;IACD,MAAM,EAAE,EAAE;IACV,MAAM,EAAE;QACJ,cAAc,EAAE,IAAI;KACvB;IACD,MAAM,EAAE;QACJ,YAAY,EAAE,IAAI;KACrB;IACD,KAAK,EAAE,EAAE;CACZ,CAAC,CAAC","sourcesContent":["/* eslint-disable @typescript-eslint/naming-convention */\r\nimport type { ViewerConfiguration } from \"../configuration\";\r\nimport { babylonFont, defaultTemplate, fillContainer, loadingScreen, defaultViewer, navbar, overlay, help, share, error } from \"babylonjs-viewer-assets\";\r\nimport * as images from \"babylonjs-viewer-assets\";\r\nimport { renderOnlyDefaultConfiguration } from \"./renderOnlyDefault\";\r\n// eslint-disable-next-line import/no-internal-modules\r\nimport { deepmerge } from \"../../helper/index\";\r\n\r\n/**\r\n * The default configuration of the viewer, including templates (canvas, overly, loading screen)\r\n * This configuration doesn't hold specific parameters, and only defines objects that are needed for the viewer to fully work correctly.\r\n */\r\nexport const defaultConfiguration: ViewerConfiguration = deepmerge(renderOnlyDefaultConfiguration, {\r\n    version: \"3.2.0-alpha4\",\r\n    templates: {\r\n        main: {\r\n            html: defaultTemplate,\r\n            params: {\r\n                babylonFont: babylonFont,\r\n                noEscape: true,\r\n            },\r\n        },\r\n        fillContainer: {\r\n            html: fillContainer,\r\n            params: {\r\n                disable: false,\r\n            },\r\n        },\r\n        loadingScreen: {\r\n            html: loadingScreen,\r\n            params: {\r\n                backgroundColor: \"#000000\",\r\n                loadingImage: images.loading,\r\n                staticLoadingImage: images.staticLoading,\r\n            },\r\n        },\r\n        viewer: {\r\n            html: defaultViewer,\r\n            params: {\r\n                enableDragAndDrop: false,\r\n            },\r\n        },\r\n        navBar: {\r\n            html: navbar,\r\n            params: {\r\n                speedList: {\r\n                    \"0.5x\": \"0.5\",\r\n                    \"1.0x\": \"1.0\",\r\n                    \"1.5x\": \"1.5\",\r\n                    \"2.0x\": \"2.0\",\r\n                },\r\n                logoImage: images.babylonLogo,\r\n                logoText: \"BabylonJS\",\r\n                logoLink: \"https://babylonjs.com\",\r\n                hideHelp: true,\r\n                hideHd: true,\r\n                hideVr: true,\r\n                hidePrint: true,\r\n                disableOnFullscreen: false,\r\n                text: {\r\n                    hdButton: \"Toggle HD\",\r\n                    fullscreenButton: \"Toggle Fullscreen\",\r\n                    helpButton: \"Help\",\r\n                    vrButton: \"Toggle VR\",\r\n                    printButton: \"3D Print Object\",\r\n                },\r\n            },\r\n            events: {\r\n                click: {\r\n                    \".navbar-control\": true,\r\n                },\r\n                pointerdown: {\r\n                    \".help-button\": true,\r\n                },\r\n                input: {\r\n                    \".progress-wrapper\": true,\r\n                },\r\n                pointerup: {\r\n                    \".progress-wrapper\": true,\r\n                },\r\n            },\r\n        },\r\n        overlay: {\r\n            html: overlay,\r\n            params: {\r\n                closeImage: images.close,\r\n                closeText: \"Close\",\r\n            },\r\n        },\r\n        help: {\r\n            html: help,\r\n        },\r\n        share: {\r\n            html: share,\r\n        },\r\n        error: {\r\n            html: error,\r\n        },\r\n    },\r\n    camera: {\r\n        behaviors: {\r\n            autoRotate: {\r\n                type: 0,\r\n            },\r\n            framing: {\r\n                type: 2,\r\n                zoomOnBoundingInfo: true,\r\n                zoomStopsAnimation: false,\r\n            },\r\n            bouncing: {\r\n                type: 1,\r\n            },\r\n        },\r\n    },\r\n    skybox: {},\r\n    ground: {\r\n        receiveShadows: true,\r\n    },\r\n    engine: {\r\n        antialiasing: true,\r\n    },\r\n    scene: {},\r\n});\r\n"]}

package/configuration/types/environmentMap.d.ts

@@ -0,0 +1,5 @@
+import type { ViewerConfiguration } from "./../configuration";
+/**
+ * Lab-oriented default .env support
+ */
+export declare const environmentMapConfiguration: ViewerConfiguration;

package/configuration/types/environmentMap.js

@@ -0,0 +1,14 @@
+/**
+ * Lab-oriented default .env support
+ */
+export var environmentMapConfiguration = {
+    lab: {
+        assetsRootURL: "/assets/environment/",
+        environmentMap: {
+            texture: "EnvMap_3.0-256.env",
+            rotationY: 0,
+            tintLevel: 0.4,
+        },
+    },
+};
+//# sourceMappingURL=environmentMap.js.map

package/configuration/types/environmentMap.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"environmentMap.js","sourceRoot":"","sources":["../../../../../tools/viewer/src/configuration/types/environmentMap.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,CAAC,IAAM,2BAA2B,GAAwB;IAC5D,GAAG,EAAE;QACD,aAAa,EAAE,sBAAsB;QACrC,cAAc,EAAE;YACZ,OAAO,EAAE,oBAAoB;YAC7B,SAAS,EAAE,CAAC;YACZ,SAAS,EAAE,GAAG;SACjB;KACJ;CACJ,CAAC","sourcesContent":["import type { ViewerConfiguration } from \"./../configuration\";\r\n\r\n/**\r\n * Lab-oriented default .env support\r\n */\r\nexport const environmentMapConfiguration: ViewerConfiguration = {\r\n    lab: {\r\n        assetsRootURL: \"/assets/environment/\",\r\n        environmentMap: {\r\n            texture: \"EnvMap_3.0-256.env\",\r\n            rotationY: 0,\r\n            tintLevel: 0.4,\r\n        },\r\n    },\r\n};\r\n"]}

package/configuration/types/extended.d.ts

@@ -0,0 +1,6 @@
+import type { ViewerConfiguration } from "./../configuration";
+/**
+ * The viewer's "extended" configuration.
+ * This configuration defines specific objects and parameters that we think make any model look good.
+ */
+export declare const extendedConfiguration: ViewerConfiguration;