@babylonjs/viewer 7.41.0-alpha → 7.41.0

package/templating/plugins/hdButtonPlugin.js

@@ -0,0 +1,22 @@
+import { __extends } from "@babylonjs/core/tslib.es6.js";
+import { AbstractViewerNavbarButton } from "../viewerTemplatePlugin.js";
+var HDButtonPlugin = /** @class */ (function (_super) {
+    __extends(HDButtonPlugin, _super);
+    function HDButtonPlugin(_viewer) {
+        var _this = _super.call(this, "hd", "hd-button", HDButtonPlugin.HtmlTemplate) || this;
+        _this._viewer = _viewer;
+        return _this;
+    }
+    HDButtonPlugin.prototype.onEvent = function (event) {
+        var button = event.template.parent.querySelector(".hd-button");
+        if (button) {
+            button.classList.contains("hd-toggled") ? button.classList.remove("hd-toggled") : button.classList.add("hd-toggled");
+        }
+        this._viewer.toggleHD();
+    };
+    // eslint-disable-next-line @typescript-eslint/naming-convention
+    HDButtonPlugin.HtmlTemplate = "\n{{#unless hideHd}}\n<style>\n.hd-icon:after {\n    font-size: 16px;\n    content: \"\\F765\";\n}\n\n.hd-toggled span.hd-icon:after {\n    content: \"\\F766\";\n}\n</style>\n<button class=\"hd-button\" title=\"{{text.hdButton}}\">\n     <span class=\"icon hd-icon\"></span>\n </button>\n {{/unless}}\n";
+    return HDButtonPlugin;
+}(AbstractViewerNavbarButton));
+export { HDButtonPlugin };
+//# sourceMappingURL=hdButtonPlugin.js.map

package/templating/plugins/hdButtonPlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hdButtonPlugin.js","sourceRoot":"","sources":["../../../../../tools/viewer/src/templating/plugins/hdButtonPlugin.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,0BAA0B,EAAE,MAAM,yBAAyB,CAAC;AAIrE;IAAoC,kCAA0B;IAC1D,wBAAoB,OAAsB;QACtC,YAAA,MAAK,YAAC,IAAI,EAAE,WAAW,EAAE,cAAc,CAAC,YAAY,CAAC,SAAC;QADtC,aAAO,GAAP,OAAO,CAAe;;IAE1C,CAAC;IAED,gCAAO,GAAP,UAAQ,KAAoB;QACxB,IAAM,MAAM,GAAG,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;QACjE,IAAI,MAAM,EAAE,CAAC;YACT,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;QACzH,CAAC;QACD,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;IAC5B,CAAC;IAED,gEAAgE;IAC/C,2BAAY,GAAW,gTAgB3C,CAAC;IACF,qBAAC;CAAA,AA/BD,CAAoC,0BAA0B,GA+B7D;SA/BY,cAAc","sourcesContent":["import { AbstractViewerNavbarButton } from \"../viewerTemplatePlugin\";\r\nimport type { DefaultViewer } from \"../../viewer/defaultViewer\";\r\nimport type { EventCallback } from \"../templateManager\";\r\n\r\nexport class HDButtonPlugin extends AbstractViewerNavbarButton {\r\n    constructor(private _viewer: DefaultViewer) {\r\n        super(\"hd\", \"hd-button\", HDButtonPlugin.HtmlTemplate);\r\n    }\r\n\r\n    onEvent(event: EventCallback): void {\r\n        const button = event.template.parent.querySelector(\".hd-button\");\r\n        if (button) {\r\n            button.classList.contains(\"hd-toggled\") ? button.classList.remove(\"hd-toggled\") : button.classList.add(\"hd-toggled\");\r\n        }\r\n        this._viewer.toggleHD();\r\n    }\r\n\r\n    // eslint-disable-next-line @typescript-eslint/naming-convention\r\n    protected static HtmlTemplate: string = `\r\n{{#unless hideHd}}\r\n<style>\r\n.hd-icon:after {\r\n    font-size: 16px;\r\n    content: \"\\\\F765\";\r\n}\r\n\r\n.hd-toggled span.hd-icon:after {\r\n    content: \"\\\\F766\";\r\n}\r\n</style>\r\n<button class=\"hd-button\" title=\"{{text.hdButton}}\">\r\n     <span class=\"icon hd-icon\"></span>\r\n </button>\r\n {{/unless}}\r\n`;\r\n}\r\n"]}

package/templating/plugins/printButton.d.ts

@@ -0,0 +1,9 @@
+import { AbstractViewerNavbarButton } from "../viewerTemplatePlugin";
+import type { DefaultViewer } from "../../viewer/defaultViewer";
+export declare class PrintButtonPlugin extends AbstractViewerNavbarButton {
+    private _viewer;
+    private _currentModelUrl;
+    constructor(_viewer: DefaultViewer);
+    onEvent(): void;
+    protected static HtmlTemplate: string;
+}

package/templating/plugins/printButton.js

@@ -0,0 +1,41 @@
+import { __extends } from "@babylonjs/core/tslib.es6.js";
+import { AbstractViewerNavbarButton } from "../viewerTemplatePlugin.js";
+import { Tools } from "@babylonjs/core/Misc/tools.js";
+var PrintButtonPlugin = /** @class */ (function (_super) {
+    __extends(PrintButtonPlugin, _super);
+    function PrintButtonPlugin(_viewer) {
+        var _this = _super.call(this, "print", "print-button", PrintButtonPlugin.HtmlTemplate) || this;
+        _this._viewer = _viewer;
+        _this._viewer.onModelLoadedObservable.add(function (model) {
+            _this._currentModelUrl = "";
+            if (model.configuration.url) {
+                var filename = Tools.GetFilename(model.configuration.url) || model.configuration.url;
+                var baseUrl = model.configuration.root || Tools.GetFolderPath(model.configuration.url);
+                //gltf, obj, stl
+                var extension_1 = model.configuration.loader || filename.split(".").pop() || "";
+                var printable_1 = false;
+                // not using .some sue to IE11
+                ["gltf", "glb", "obj", "stl"].forEach(function (ext) {
+                    if (extension_1.indexOf(ext) !== -1) {
+                        printable_1 = true;
+                    }
+                });
+                if (printable_1) {
+                    _this._currentModelUrl = baseUrl + filename;
+                }
+            }
+        });
+        return _this;
+    }
+    PrintButtonPlugin.prototype.onEvent = function () {
+        if (this._currentModelUrl) {
+            var printUrl = this._currentModelUrl.replace(/https?:\/\//, "com.microsoft.builder3d://");
+            window.open(printUrl, "_self");
+        }
+    };
+    // eslint-disable-next-line @typescript-eslint/naming-convention
+    PrintButtonPlugin.HtmlTemplate = "\n{{#unless hidePrint}}\n<style>\n\n/* Show only if it's a windows 10 printer  */\n.print-icon.not-win-10 {\n    display: none;\n}\n\n.print-icon:after {\n    font-size: 16px;\n    content: \"\\E914\";\n}\n\n</style>\n<button class=\"print-button ".concat(window.navigator.userAgent.indexOf("Windows NT 10.0") === -1 ? "no-win-10" : "", "\" title=\"{{text.printButton}}\">\n     <span class=\"icon print-icon\"></span>\n </button>\n {{/unless}}\n");
+    return PrintButtonPlugin;
+}(AbstractViewerNavbarButton));
+export { PrintButtonPlugin };
+//# sourceMappingURL=printButton.js.map

package/templating/plugins/printButton.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"printButton.js","sourceRoot":"","sources":["../../../../../tools/viewer/src/templating/plugins/printButton.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,0BAA0B,EAAE,MAAM,yBAAyB,CAAC;AAErE,OAAO,EAAE,KAAK,EAAE,sCAAwB;AAExC;IAAuC,qCAA0B;IAG7D,2BAAoB,OAAsB;QACtC,YAAA,MAAK,YAAC,OAAO,EAAE,cAAc,EAAE,iBAAiB,CAAC,YAAY,CAAC,SAAC;QAD/C,aAAO,GAAP,OAAO,CAAe;QAGtC,KAAI,CAAC,OAAO,CAAC,uBAAuB,CAAC,GAAG,CAAC,UAAC,KAAK;YAC3C,KAAI,CAAC,gBAAgB,GAAG,EAAE,CAAC;YAC3B,IAAI,KAAK,CAAC,aAAa,CAAC,GAAG,EAAE,CAAC;gBAC1B,IAAM,QAAQ,GAAG,KAAK,CAAC,WAAW,CAAC,KAAK,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC,aAAa,CAAC,GAAG,CAAC;gBACvF,IAAM,OAAO,GAAG,KAAK,CAAC,aAAa,CAAC,IAAI,IAAI,KAAK,CAAC,aAAa,CAAC,KAAK,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;gBAEzF,gBAAgB;gBAChB,IAAM,WAAS,GAAG,KAAK,CAAC,aAAa,CAAC,MAAM,IAAI,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC;gBAChF,IAAI,WAAS,GAAG,KAAK,CAAC;gBACtB,8BAA8B;gBAC9B,CAAC,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,OAAO,CAAC,UAAC,GAAG;oBACtC,IAAI,WAAS,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;wBAChC,WAAS,GAAG,IAAI,CAAC;oBACrB,CAAC;gBACL,CAAC,CAAC,CAAC;gBACH,IAAI,WAAS,EAAE,CAAC;oBACZ,KAAI,CAAC,gBAAgB,GAAG,OAAO,GAAG,QAAQ,CAAC;gBAC/C,CAAC;YACL,CAAC;QACL,CAAC,CAAC,CAAC;;IACP,CAAC;IAED,mCAAO,GAAP;QACI,IAAI,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACxB,IAAM,QAAQ,GAAG,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,aAAa,EAAE,4BAA4B,CAAC,CAAC;YAC5F,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QACnC,CAAC;IACL,CAAC;IAED,gEAAgE;IAC/C,8BAAY,GAAW,iQAed,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,OAAO,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,iHAI5G,CAAC;IACF,wBAAC;CAAA,AAxDD,CAAuC,0BAA0B,GAwDhE;SAxDY,iBAAiB","sourcesContent":["import { AbstractViewerNavbarButton } from \"../viewerTemplatePlugin\";\r\nimport type { DefaultViewer } from \"../../viewer/defaultViewer\";\r\nimport { Tools } from \"core/Misc/tools\";\r\n\r\nexport class PrintButtonPlugin extends AbstractViewerNavbarButton {\r\n    private _currentModelUrl: string;\r\n\r\n    constructor(private _viewer: DefaultViewer) {\r\n        super(\"print\", \"print-button\", PrintButtonPlugin.HtmlTemplate);\r\n\r\n        this._viewer.onModelLoadedObservable.add((model) => {\r\n            this._currentModelUrl = \"\";\r\n            if (model.configuration.url) {\r\n                const filename = Tools.GetFilename(model.configuration.url) || model.configuration.url;\r\n                const baseUrl = model.configuration.root || Tools.GetFolderPath(model.configuration.url);\r\n\r\n                //gltf, obj, stl\r\n                const extension = model.configuration.loader || filename.split(\".\").pop() || \"\";\r\n                let printable = false;\r\n                // not using .some sue to IE11\r\n                [\"gltf\", \"glb\", \"obj\", \"stl\"].forEach((ext) => {\r\n                    if (extension.indexOf(ext) !== -1) {\r\n                        printable = true;\r\n                    }\r\n                });\r\n                if (printable) {\r\n                    this._currentModelUrl = baseUrl + filename;\r\n                }\r\n            }\r\n        });\r\n    }\r\n\r\n    onEvent(): void {\r\n        if (this._currentModelUrl) {\r\n            const printUrl = this._currentModelUrl.replace(/https?:\\/\\//, \"com.microsoft.builder3d://\");\r\n            window.open(printUrl, \"_self\");\r\n        }\r\n    }\r\n\r\n    // eslint-disable-next-line @typescript-eslint/naming-convention\r\n    protected static HtmlTemplate: string = `\r\n{{#unless hidePrint}}\r\n<style>\r\n\r\n/* Show only if it's a windows 10 printer  */\r\n.print-icon.not-win-10 {\r\n    display: none;\r\n}\r\n\r\n.print-icon:after {\r\n    font-size: 16px;\r\n    content: \"\\\\E914\";\r\n}\r\n\r\n</style>\r\n<button class=\"print-button ${window.navigator.userAgent.indexOf(\"Windows NT 10.0\") === -1 ? \"no-win-10\" : \"\"}\" title=\"{{text.printButton}}\">\r\n     <span class=\"icon print-icon\"></span>\r\n </button>\r\n {{/unless}}\r\n`;\r\n}\r\n"]}

package/templating/templateManager.d.ts

@@ -0,0 +1,197 @@
+import { Observable } from "@babylonjs/core/Misc/observable.js";
+import { EventManager } from "./eventManager";
+import type { ITemplateConfiguration } from "../configuration/interfaces/templateConfiguration";
+/**
+ * The object sent when an event is triggered
+ */
+export interface EventCallback {
+    event: Event;
+    template: Template;
+    selector: string;
+    payload?: any;
+}
+/**
+ * The template manager, a member of the viewer class, will manage the viewer's templates and generate the HTML.
+ * The template manager managers a single viewer and can be seen as the collection of all sub-templates of the viewer.
+ */
+export declare class TemplateManager {
+    containerElement: Element;
+    /**
+     * Will be triggered when any template is initialized
+     */
+    onTemplateInit: Observable<Template>;
+    /**
+     * Will be triggered when any template is fully loaded
+     */
+    onTemplateLoaded: Observable<Template>;
+    /**
+     * Will be triggered when a template state changes
+     */
+    onTemplateStateChange: Observable<Template>;
+    /**
+     * Will be triggered when all templates finished loading
+     */
+    onAllLoaded: Observable<TemplateManager>;
+    /**
+     * Will be triggered when any event on any template is triggered.
+     */
+    onEventTriggered: Observable<EventCallback>;
+    /**
+     * This template manager's event manager. In charge of callback registrations to native event types
+     */
+    eventManager: EventManager;
+    private _templates;
+    constructor(containerElement: Element);
+    /**
+     * Initialize the template(s) for the viewer. Called bay the Viewer class
+     * @param templates the templates to be used to initialize the main template
+     * @returns a promise that will be fulfilled when the template is loaded
+     */
+    initTemplate(templates: {
+        [key: string]: ITemplateConfiguration;
+    }): Promise<void>;
+    /**
+     *
+     * This function will create a simple map with child-dependencies of the template html tree.
+     * It will compile each template, check if its children exist in the configuration and will add them if they do.
+     * It is expected that the main template will be called main!
+     *
+     * @param templates the templates to be used to initialize the main template
+     * @returns a promise that will be fulfilled when the template is loaded
+     */
+    private _buildHTMLTree;
+    /**
+     * Get the canvas in the template tree.
+     * There must be one and only one canvas inthe template.
+     * @returns the canvas element or null if not found
+     */
+    getCanvas(): HTMLCanvasElement | null;
+    /**
+     * Get a specific template from the template tree
+     * @param name the name of the template to load
+     * @returns the template or undefined if not found
+     */
+    getTemplate(name: string): Template | undefined;
+    private _checkLoadedState;
+    /**
+     * Dispose the template manager
+     */
+    dispose(): void;
+}
+/**
+ * This class represents a single template in the viewer's template tree.
+ * An example for a template is a single canvas, an overlay (containing sub-templates) or the navigation bar.
+ * A template is injected using the template manager in the correct position.
+ * The template is rendered using Handlebars and can use Handlebars' features (such as parameter injection)
+ *
+ * For further information please refer to the documentation page, https://doc.babylonjs.com
+ */
+export declare class Template {
+    name: string;
+    private _configuration;
+    /**
+     * Will be triggered when the template is loaded
+     */
+    onLoaded: Observable<Template>;
+    /**
+     * will be triggered when the template is appended to the tree
+     */
+    onAppended: Observable<Template>;
+    /**
+     * Will be triggered when the template's state changed (shown, hidden)
+     */
+    onStateChange: Observable<Template>;
+    /**
+     * Will be triggered when an event is triggered on ths template.
+     * The event is a native browser event (like mouse or pointer events)
+     */
+    onEventTriggered: Observable<EventCallback>;
+    onParamsUpdated: Observable<Template>;
+    onHTMLRendered: Observable<Template>;
+    /**
+     * is the template loaded?
+     */
+    isLoaded: boolean;
+    /**
+     * This is meant to be used to track the show and hide functions.
+     * This is NOT (!!) a flag to check if the element is actually visible to the user.
+     */
+    isShown: boolean;
+    /**
+     * Is this template a part of the HTML tree (the template manager injected it)
+     */
+    isInHtmlTree: boolean;
+    /**
+     * The HTML element containing this template
+     */
+    parent: HTMLElement;
+    /**
+     * A promise that is fulfilled when the template finished loading.
+     */
+    initPromise: Promise<Template>;
+    private _fragment;
+    private _addedFragment;
+    private _htmlTemplate;
+    private _rawHtml;
+    private _loadRequests;
+    constructor(name: string, _configuration: ITemplateConfiguration);
+    /**
+     * Some templates have parameters (like background color for example).
+     * The parameters are provided to Handlebars which in turn generates the template.
+     * This function will update the template with the new parameters
+     *
+     * Note that when updating parameters the events will be registered again (after being cleared).
+     *
+     * @param params the new template parameters
+     * @param append
+     */
+    updateParams(params: {
+        [key: string]: string | number | boolean | object;
+    }, append?: boolean): void;
+    redraw(): void;
+    /**
+     * Get the template'S configuration
+     */
+    get configuration(): ITemplateConfiguration;
+    /**
+     * A template can be a parent element for other templates or HTML elements.
+     * This function will deliver all child HTML elements of this template.
+     * @returns an array of strings, each string is the name of the child element
+     */
+    getChildElements(): Array<string>;
+    /**
+     * Appending the template to a parent HTML element.
+     * If a parent is already set and you wish to replace the old HTML with new one, forceRemove should be true.
+     * @param parent the parent to which the template is added
+     * @param forceRemove if the parent already exists, shoud the template be removed from it?
+     */
+    appendTo(parent: HTMLElement, forceRemove?: boolean): void;
+    private _isShowing;
+    private _isHiding;
+    /**
+     * Show the template using the provided visibilityFunction, or natively using display: flex.
+     * The provided function returns a promise that should be fulfilled when the element is shown.
+     * Since it is a promise async operations are more than possible.
+     * See the default viewer for an opacity example.
+     * @param visibilityFunction The function to execute to show the template.
+     * @returns a promise that will be fulfilled when the template is shown
+     */
+    show(visibilityFunction?: (template: Template) => Promise<Template>): Promise<Template>;
+    /**
+     * Hide the template using the provided visibilityFunction, or natively using display: none.
+     * The provided function returns a promise that should be fulfilled when the element is hidden.
+     * Since it is a promise async operations are more than possible.
+     * See the default viewer for an opacity example.
+     * @param visibilityFunction The function to execute to show the template.
+     * @returns a promise that will be fulfilled when the template is hidden
+     */
+    hide(visibilityFunction?: (template: Template) => Promise<Template>): Promise<Template>;
+    /**
+     * Dispose this template
+     */
+    dispose(): void;
+    private _getTemplateAsHtml;
+    private _registeredEvents;
+    private _registerEvents;
+    private _getTemplateLocation;
+}