@babylonjs/viewer 5.0.0 → 5.0.3

package/templating/plugins/printButton.d.ts

@@ -1,9 +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;
-}
+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

@@ -1,41 +1,41 @@
-import { __extends } from "tslib";
-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 };
+import { __extends } from "tslib";
+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/templateManager.d.ts

@@ -1,190 +1,190 @@
-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
-     */
-    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
-     */
-    private _buildHTMLTree;
-    /**
-     * Get the canvas in the template tree.
-     * There must be one and only one canvas inthe template.
-     */
-    getCanvas(): HTMLCanvasElement | null;
-    /**
-     * Get a specific template from the template tree
-     * @param name the name of the template to load
-     */
-    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.
-     */
-    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.
-     */
-    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.
-     */
-    hide(visibilityFunction?: (template: Template) => Promise<Template>): Promise<Template>;
-    /**
-     * Dispose this template
-     */
-    dispose(): void;
-    private _getTemplateAsHtml;
-    private _registeredEvents;
-    private _registerEvents;
-    private _getTemplateLocation;
-}
+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
+     */
+    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
+     */
+    private _buildHTMLTree;
+    /**
+     * Get the canvas in the template tree.
+     * There must be one and only one canvas inthe template.
+     */
+    getCanvas(): HTMLCanvasElement | null;
+    /**
+     * Get a specific template from the template tree
+     * @param name the name of the template to load
+     */
+    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.
+     */
+    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.
+     */
+    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.
+     */
+    hide(visibilityFunction?: (template: Template) => Promise<Template>): Promise<Template>;
+    /**
+     * Dispose this template
+     */
+    dispose(): void;
+    private _getTemplateAsHtml;
+    private _registeredEvents;
+    private _registerEvents;
+    private _getTemplateLocation;
+}