@babylonjs/viewer 5.0.0 → 5.0.3

package/templating/viewerTemplatePlugin.d.ts

@@ -1,21 +1,21 @@
-import type { EventCallback, Template } from "./templateManager";
-export interface IViewerTemplatePlugin {
-    readonly templateName: string;
-    readonly eventsToAttach?: Array<string>;
-    interactionPredicate(event: EventCallback): boolean;
-    onEvent?(event: EventCallback): void;
-    addHTMLTemplate?(template: Template): void;
-}
-export declare abstract class AbstractViewerNavbarButton implements IViewerTemplatePlugin {
-    readonly templateName: string;
-    readonly eventsToAttach: Array<string>;
-    protected _prepend: boolean;
-    protected _buttonName: string;
-    protected _buttonClass: string;
-    protected _htmlTemplate: string;
-    constructor(buttonName: string, buttonClass?: string, htmlTemplate?: string);
-    interactionPredicate(event: EventCallback): boolean;
-    abstract onEvent(event: EventCallback): void;
-    addHTMLTemplate(template: Template): void;
-    protected _generateHTMLElement(template: Template): Element | DocumentFragment;
-}
+import type { EventCallback, Template } from "./templateManager";
+export interface IViewerTemplatePlugin {
+    readonly templateName: string;
+    readonly eventsToAttach?: Array<string>;
+    interactionPredicate(event: EventCallback): boolean;
+    onEvent?(event: EventCallback): void;
+    addHTMLTemplate?(template: Template): void;
+}
+export declare abstract class AbstractViewerNavbarButton implements IViewerTemplatePlugin {
+    readonly templateName: string;
+    readonly eventsToAttach: Array<string>;
+    protected _prepend: boolean;
+    protected _buttonName: string;
+    protected _buttonClass: string;
+    protected _htmlTemplate: string;
+    constructor(buttonName: string, buttonClass?: string, htmlTemplate?: string);
+    interactionPredicate(event: EventCallback): boolean;
+    abstract onEvent(event: EventCallback): void;
+    addHTMLTemplate(template: Template): void;
+    protected _generateHTMLElement(template: Template): Element | DocumentFragment;
+}

package/templating/viewerTemplatePlugin.js

@@ -1,69 +1,69 @@
-import * as Handlebars from "handlebars";
-var AbstractViewerNavbarButton = /** @class */ (function () {
-    function AbstractViewerNavbarButton(buttonName, buttonClass, htmlTemplate) {
-        this.templateName = "navBar";
-        this.eventsToAttach = ["pointerdown"];
-        this._prepend = true;
-        this._buttonName = buttonName;
-        if (buttonClass) {
-            this._buttonClass = buttonClass;
-        }
-        else {
-            this._buttonClass = buttonName + "-button";
-        }
-        if (htmlTemplate) {
-            this._htmlTemplate = htmlTemplate;
-        }
-        else {
-            this._htmlTemplate = "\n<button class=\"".concat(this._buttonClass, "\">\n    <span class=\"icon ").concat(this._buttonName, "-icon\"></span>\n</button>\n");
-        }
-    }
-    AbstractViewerNavbarButton.prototype.interactionPredicate = function (event) {
-        var pointerDown = event.event;
-        if (pointerDown.button !== 0) {
-            return false;
-        }
-        var element = event.event.target;
-        if (!element) {
-            return false;
-        }
-        var elementClasses = element.classList;
-        for (var i = 0; i < elementClasses.length; ++i) {
-            var className = elementClasses[i];
-            if (className.indexOf(this._buttonClass) !== -1) {
-                return true;
-            }
-        }
-        return false;
-    };
-    AbstractViewerNavbarButton.prototype.addHTMLTemplate = function (template) {
-        var element = this._generateHTMLElement(template);
-        var container = template.parent.querySelector("div.default-control");
-        if (container) {
-            if (this._prepend) {
-                container.insertBefore(element, container.firstChild);
-            }
-            else {
-                container.appendChild(element);
-            }
-        }
-    };
-    AbstractViewerNavbarButton.prototype._generateHTMLElement = function (template) {
-        var compiledTemplate = Handlebars.compile(this._htmlTemplate, { noEscape: template.configuration.params && !!template.configuration.params.noEscape });
-        var config = template.configuration.params || {};
-        var rawHtml = compiledTemplate(config);
-        var fragment;
-        try {
-            fragment = document.createRange().createContextualFragment(rawHtml);
-        }
-        catch (e) {
-            var test_1 = document.createElement(this._buttonClass);
-            test_1.innerHTML = rawHtml;
-            fragment = test_1;
-        }
-        return fragment;
-    };
-    return AbstractViewerNavbarButton;
-}());
-export { AbstractViewerNavbarButton };
+import * as Handlebars from "handlebars";
+var AbstractViewerNavbarButton = /** @class */ (function () {
+    function AbstractViewerNavbarButton(buttonName, buttonClass, htmlTemplate) {
+        this.templateName = "navBar";
+        this.eventsToAttach = ["pointerdown"];
+        this._prepend = true;
+        this._buttonName = buttonName;
+        if (buttonClass) {
+            this._buttonClass = buttonClass;
+        }
+        else {
+            this._buttonClass = buttonName + "-button";
+        }
+        if (htmlTemplate) {
+            this._htmlTemplate = htmlTemplate;
+        }
+        else {
+            this._htmlTemplate = "\n<button class=\"".concat(this._buttonClass, "\">\n    <span class=\"icon ").concat(this._buttonName, "-icon\"></span>\n</button>\n");
+        }
+    }
+    AbstractViewerNavbarButton.prototype.interactionPredicate = function (event) {
+        var pointerDown = event.event;
+        if (pointerDown.button !== 0) {
+            return false;
+        }
+        var element = event.event.target;
+        if (!element) {
+            return false;
+        }
+        var elementClasses = element.classList;
+        for (var i = 0; i < elementClasses.length; ++i) {
+            var className = elementClasses[i];
+            if (className.indexOf(this._buttonClass) !== -1) {
+                return true;
+            }
+        }
+        return false;
+    };
+    AbstractViewerNavbarButton.prototype.addHTMLTemplate = function (template) {
+        var element = this._generateHTMLElement(template);
+        var container = template.parent.querySelector("div.default-control");
+        if (container) {
+            if (this._prepend) {
+                container.insertBefore(element, container.firstChild);
+            }
+            else {
+                container.appendChild(element);
+            }
+        }
+    };
+    AbstractViewerNavbarButton.prototype._generateHTMLElement = function (template) {
+        var compiledTemplate = Handlebars.compile(this._htmlTemplate, { noEscape: template.configuration.params && !!template.configuration.params.noEscape });
+        var config = template.configuration.params || {};
+        var rawHtml = compiledTemplate(config);
+        var fragment;
+        try {
+            fragment = document.createRange().createContextualFragment(rawHtml);
+        }
+        catch (e) {
+            var test_1 = document.createElement(this._buttonClass);
+            test_1.innerHTML = rawHtml;
+            fragment = test_1;
+        }
+        return fragment;
+    };
+    return AbstractViewerNavbarButton;
+}());
+export { AbstractViewerNavbarButton };
 //# sourceMappingURL=viewerTemplatePlugin.js.map

package/viewer/defaultViewer.d.ts

@@ -1,122 +1,122 @@
-import type { Template } from "../templating/templateManager";
-import { TemplateManager } from "../templating/templateManager";
-import { AbstractViewerWithTemplate } from "./viewerWithTemplate";
-import type { ViewerModel } from "../model/viewerModel";
-import type { IViewerTemplatePlugin } from "../templating/viewerTemplatePlugin";
-import type { ViewerConfiguration } from "../configuration/configuration";
-import type { IModelConfiguration } from "../configuration/interfaces/modelConfiguration";
-import "@babylonjs/core/Lights/Shadows/shadowGeneratorSceneComponent.js";
-/**
- * The Default viewer is the default implementation of the AbstractViewer.
- * It uses the templating system to render a new canvas and controls.
- */
-export declare class DefaultViewer extends AbstractViewerWithTemplate {
-    containerElement: Element;
-    /**
-     * The corresponsing template manager of this viewer.
-     */
-    templateManager: TemplateManager;
-    fullscreenElement?: Element;
-    /**
-     * Create a new default viewer
-     * @param containerElement the element in which the templates will be rendered
-     * @param initialConfiguration the initial configuration. Defaults to extending the default configuration
-     */
-    constructor(containerElement: Element, initialConfiguration?: ViewerConfiguration);
-    private _registeredPlugins;
-    registerTemplatePlugin(plugin: IViewerTemplatePlugin): void;
-    /**
-     * This will be executed when the templates initialize.
-     */
-    protected _onTemplatesLoaded(): Promise<import("./viewer").AbstractViewer>;
-    private _initNavbar;
-    private _animationList;
-    private _currentAnimation;
-    private _isAnimationPaused;
-    private _resumePlay;
-    private _handlePointerClick;
-    /**
-     * Plays or Pauses animation
-     * @param noUiUpdate
-     */
-    private _togglePlayPause;
-    private _oldIdleRotationValue;
-    /**
-     * Control progress bar position based on animation current frame
-     */
-    private _updateProgressBar;
-    /**
-     * Update Current Animation Speed
-     * @param speed
-     * @param paramsObject
-     */
-    private _updateAnimationSpeed;
-    /**
-     * Update Current Animation Type
-     * @param data
-     * @param data.label
-     * @param data.value
-     * @param paramsObject
-     */
-    private _updateAnimationType;
-    protected _initVR(): void;
-    /**
-     * Toggle fullscreen of the entire viewer
-     */
-    toggleFullscreen: () => void;
-    /**
-     * Preparing the container element to present the viewer
-     */
-    protected _prepareContainerElement(): void;
-    /**
-     * This function will configure the templates and update them after a model was loaded
-     * It is mainly responsible to changing the title and subtitle etc'.
-     * @param model the model to be used to configure the templates by
-     */
-    protected _configureTemplate(model?: ViewerModel): void;
-    /**
-     * This will load a new model to the default viewer
-     * overriding the AbstractViewer's loadModel.
-     * The scene will automatically be cleared of the old models, if exist.
-     * @param model the configuration object (or URL) to load.
-     */
-    loadModel(model?: string | File | IModelConfiguration): Promise<ViewerModel>;
-    private _onModelLoaded;
-    /**
-     * Show the overlay and the defined sub-screen.
-     * Mainly used for help and errors
-     * @param subScreen the name of the subScreen. Those can be defined in the configuration object
-     */
-    showOverlayScreen(subScreen: string): Promise<string> | Promise<Template>;
-    /**
-     * Hide the overlay screen.
-     */
-    hideOverlayScreen(): Promise<string> | Promise<Template>;
-    /**
-     * show the viewer (in case it was hidden)
-     *
-     * @param visibilityFunction an optional function to execute in order to show the container
-     */
-    show(visibilityFunction?: (template: Template) => Promise<Template>): Promise<Template>;
-    /**
-     * hide the viewer (in case it is visible)
-     *
-     * @param visibilityFunction an optional function to execute in order to hide the container
-     */
-    hide(visibilityFunction?: (template: Template) => Promise<Template>): Promise<Template>;
-    /**
-     * Show the loading screen.
-     * The loading screen can be configured using the configuration object
-     */
-    showLoadingScreen(): Promise<string> | Promise<Template>;
-    /**
-     * Hide the loading screen
-     */
-    hideLoadingScreen(): Promise<string> | Promise<Template>;
-    dispose(): void;
-    protected _onConfigurationLoaded(configuration: ViewerConfiguration): void;
-    /**
-     * An extension of the light configuration of the abstract viewer.
-     */
-    private _configureLights;
-}
+import type { Template } from "../templating/templateManager";
+import { TemplateManager } from "../templating/templateManager";
+import { AbstractViewerWithTemplate } from "./viewerWithTemplate";
+import type { ViewerModel } from "../model/viewerModel";
+import type { IViewerTemplatePlugin } from "../templating/viewerTemplatePlugin";
+import type { ViewerConfiguration } from "../configuration/configuration";
+import type { IModelConfiguration } from "../configuration/interfaces/modelConfiguration";
+import "@babylonjs/core/Lights/Shadows/shadowGeneratorSceneComponent.js";
+/**
+ * The Default viewer is the default implementation of the AbstractViewer.
+ * It uses the templating system to render a new canvas and controls.
+ */
+export declare class DefaultViewer extends AbstractViewerWithTemplate {
+    containerElement: Element;
+    /**
+     * The corresponsing template manager of this viewer.
+     */
+    templateManager: TemplateManager;
+    fullscreenElement?: Element;
+    /**
+     * Create a new default viewer
+     * @param containerElement the element in which the templates will be rendered
+     * @param initialConfiguration the initial configuration. Defaults to extending the default configuration
+     */
+    constructor(containerElement: Element, initialConfiguration?: ViewerConfiguration);
+    private _registeredPlugins;
+    registerTemplatePlugin(plugin: IViewerTemplatePlugin): void;
+    /**
+     * This will be executed when the templates initialize.
+     */
+    protected _onTemplatesLoaded(): Promise<import("./viewer").AbstractViewer>;
+    private _initNavbar;
+    private _animationList;
+    private _currentAnimation;
+    private _isAnimationPaused;
+    private _resumePlay;
+    private _handlePointerClick;
+    /**
+     * Plays or Pauses animation
+     * @param noUiUpdate
+     */
+    private _togglePlayPause;
+    private _oldIdleRotationValue;
+    /**
+     * Control progress bar position based on animation current frame
+     */
+    private _updateProgressBar;
+    /**
+     * Update Current Animation Speed
+     * @param speed
+     * @param paramsObject
+     */
+    private _updateAnimationSpeed;
+    /**
+     * Update Current Animation Type
+     * @param data
+     * @param data.label
+     * @param data.value
+     * @param paramsObject
+     */
+    private _updateAnimationType;
+    protected _initVR(): void;
+    /**
+     * Toggle fullscreen of the entire viewer
+     */
+    toggleFullscreen: () => void;
+    /**
+     * Preparing the container element to present the viewer
+     */
+    protected _prepareContainerElement(): void;
+    /**
+     * This function will configure the templates and update them after a model was loaded
+     * It is mainly responsible to changing the title and subtitle etc'.
+     * @param model the model to be used to configure the templates by
+     */
+    protected _configureTemplate(model?: ViewerModel): void;
+    /**
+     * This will load a new model to the default viewer
+     * overriding the AbstractViewer's loadModel.
+     * The scene will automatically be cleared of the old models, if exist.
+     * @param model the configuration object (or URL) to load.
+     */
+    loadModel(model?: string | File | IModelConfiguration): Promise<ViewerModel>;
+    private _onModelLoaded;
+    /**
+     * Show the overlay and the defined sub-screen.
+     * Mainly used for help and errors
+     * @param subScreen the name of the subScreen. Those can be defined in the configuration object
+     */
+    showOverlayScreen(subScreen: string): Promise<string> | Promise<Template>;
+    /**
+     * Hide the overlay screen.
+     */
+    hideOverlayScreen(): Promise<string> | Promise<Template>;
+    /**
+     * show the viewer (in case it was hidden)
+     *
+     * @param visibilityFunction an optional function to execute in order to show the container
+     */
+    show(visibilityFunction?: (template: Template) => Promise<Template>): Promise<Template>;
+    /**
+     * hide the viewer (in case it is visible)
+     *
+     * @param visibilityFunction an optional function to execute in order to hide the container
+     */
+    hide(visibilityFunction?: (template: Template) => Promise<Template>): Promise<Template>;
+    /**
+     * Show the loading screen.
+     * The loading screen can be configured using the configuration object
+     */
+    showLoadingScreen(): Promise<string> | Promise<Template>;
+    /**
+     * Hide the loading screen
+     */
+    hideLoadingScreen(): Promise<string> | Promise<Template>;
+    dispose(): void;
+    protected _onConfigurationLoaded(configuration: ViewerConfiguration): void;
+    /**
+     * An extension of the light configuration of the abstract viewer.
+     */
+    private _configureLights;
+}