@babylonjs/gui 5.15.1 → 5.17.1

package/2D/advancedDynamicTexture.d.ts

@@ -27,7 +27,7 @@ export declare class AdvancedDynamicTexture extends DynamicTexture {
     private _renderObserver;
     private _resizeObserver;
     private _preKeyboardObserver;
-    private _pointerMoveObserver;
+    private _prePointerObserver;
     private _sceneRenderObserver;
     private _pointerObserver;
     private _canvasPointerOutObserver;
@@ -375,21 +375,45 @@ export declare class AdvancedDynamicTexture extends DynamicTexture {
      * @param serializedObject define the JSON serialized object to restore from
      * @param scaleToSize defines whether to scale to texture to the saved size
      */
-    parseContent(serializedObject: any, scaleToSize?: boolean): void;
+    parseSerializedObject(serializedObject: any, scaleToSize?: boolean): void;
+    /**
+     * Recreate the content of the ADT from a JSON object
+     * @param serializedObject define the JSON serialized object to restore from
+     * @param scaleToSize defines whether to scale to texture to the saved size
+     * @deprecated Please use parseSerializedObject instead
+     */
+    parseContent: (serializedObject: any, scaleToSize?: boolean | undefined) => void;
     /**
      * Recreate the content of the ADT from a snippet saved by the GUI editor
      * @param snippetId defines the snippet to load
      * @param scaleToSize defines whether to scale to texture to the saved size
+     * @param appendToAdt if provided the snippet will be appended to the adt. Otherwise a fullscreen ADT will be created.
+     * @returns a promise that will resolve on success
+     */
+    static ParseFromSnippetAsync(snippetId: string, scaleToSize?: boolean, appendToAdt?: AdvancedDynamicTexture): Promise<AdvancedDynamicTexture>;
+    /**
+     * Recreate the content of the ADT from a snippet saved by the GUI editor
+     * @param snippetId defines the snippet to load
+     * @param scaleToSize defines whether to scale to texture to the saved size
+     * @returns a promise that will resolve on success
+     */
+    parseFromSnippetAsync(snippetId: string, scaleToSize?: boolean): Promise<AdvancedDynamicTexture>;
+    /**
+     * Recreate the content of the ADT from a url json
+     * @param url defines the url to load
+     * @param scaleToSize defines whether to scale to texture to the saved size
+     * @param appendToAdt if provided the snippet will be appended to the adt. Otherwise a fullscreen ADT will be created.
      * @returns a promise that will resolve on success
      */
-    parseFromSnippetAsync(snippetId: string, scaleToSize?: boolean): Promise<void>;
+    static ParseFromFileAsync(url: string, scaleToSize?: boolean, appendToAdt?: AdvancedDynamicTexture): Promise<AdvancedDynamicTexture>;
     /**
      * Recreate the content of the ADT from a url json
      * @param url defines the url to load
      * @param scaleToSize defines whether to scale to texture to the saved size
      * @returns a promise that will resolve on success
      */
-    parseFromURLAsync(url: string, scaleToSize?: boolean): Promise<void>;
+    parseFromURLAsync(url: string, scaleToSize?: boolean): Promise<AdvancedDynamicTexture>;
+    private static _LoadURLContentAsync;
     /**
      * Compares two rectangle based controls for pixel overlap
      * @param control1 The first control to compare

package/2D/advancedDynamicTexture.js

@@ -1,4 +1,4 @@
-import { __extends } from "tslib";
+import { __awaiter, __extends, __generator } from "tslib";
 import { Observable } from "@babylonjs/core/Misc/observable.js";
 import { Vector2, Vector3 } from "@babylonjs/core/Maths/math.vector.js";
 import { Tools } from "@babylonjs/core/Misc/tools.js";
@@ -144,6 +144,13 @@ var AdvancedDynamicTexture = /** @class */ (function (_super) {
             _this.onClipboardObservable.notifyObservers(ev);
             evt.preventDefault();
         };
+        /**
+         * Recreate the content of the ADT from a JSON object
+         * @param serializedObject define the JSON serialized object to restore from
+         * @param scaleToSize defines whether to scale to texture to the saved size
+         * @deprecated Please use parseSerializedObject instead
+         */
+        _this.parseContent = _this.parseSerializedObject;
         scene = _this.getScene();
         if (!scene || !_this._texture) {
             return _this;
@@ -589,8 +596,8 @@ var AdvancedDynamicTexture = /** @class */ (function (_super) {
         if (this._resizeObserver) {
             scene.getEngine().onResizeObservable.remove(this._resizeObserver);
         }
-        if (this._pointerMoveObserver) {
-            scene.onPrePointerObservable.remove(this._pointerMoveObserver);
+        if (this._prePointerObserver) {
+            scene.onPrePointerObservable.remove(this._prePointerObserver);
         }
         if (this._sceneRenderObserver) {
             scene.onBeforeRenderObservable.remove(this._sceneRenderObserver);
@@ -802,6 +809,9 @@ var AdvancedDynamicTexture = /** @class */ (function (_super) {
             y = y * (textureSize.height / (engine.getRenderHeight() * viewport.height));
         }
         if (this._capturingControl[pointerId]) {
+            if (this._capturingControl[pointerId].isPointerBlocker) {
+                this._shouldBlockPointer = true;
+            }
             this._capturingControl[pointerId]._processObservables(type, x, y, pi, pointerId, buttonIndex);
             return;
         }
@@ -909,18 +919,21 @@ var AdvancedDynamicTexture = /** @class */ (function (_super) {
             return;
         }
         var tempViewport = new Viewport(0, 0, 0, 0);
-        this._pointerMoveObserver = scene.onPrePointerObservable.add(function (pi) {
-            if (scene.isPointerCaptured(pi.event.pointerId)) {
-                return;
-            }
+        this._prePointerObserver = scene.onPrePointerObservable.add(function (pi) {
             if (pi.type !== PointerEventTypes.POINTERMOVE &&
                 pi.type !== PointerEventTypes.POINTERUP &&
                 pi.type !== PointerEventTypes.POINTERDOWN &&
                 pi.type !== PointerEventTypes.POINTERWHEEL) {
                 return;
             }
-            if (pi.type === PointerEventTypes.POINTERMOVE && pi.event.pointerId) {
-                _this._defaultMousePointerId = pi.event.pointerId; // This is required to make sure we have the correct pointer ID for wheel
+            if (pi.type === PointerEventTypes.POINTERMOVE) {
+                // Avoid pointerMove events firing while the pointer is captured by the scene
+                if (scene.isPointerCaptured(pi.event.pointerId)) {
+                    return;
+                }
+                if (pi.event.pointerId) {
+                    _this._defaultMousePointerId = pi.event.pointerId; // This is required to make sure we have the correct pointer ID for wheel
+                }
             }
             _this._translateToPicking(scene, tempViewport, pi);
         });
@@ -1109,7 +1122,7 @@ var AdvancedDynamicTexture = /** @class */ (function (_super) {
      * @param serializedObject define the JSON serialized object to restore from
      * @param scaleToSize defines whether to scale to texture to the saved size
      */
-    AdvancedDynamicTexture.prototype.parseContent = function (serializedObject, scaleToSize) {
+    AdvancedDynamicTexture.prototype.parseSerializedObject = function (serializedObject, scaleToSize) {
         this._rootContainer = Control.Parse(serializedObject.root, this);
         if (scaleToSize) {
             var width = serializedObject.width;
@@ -1123,6 +1136,32 @@ var AdvancedDynamicTexture = /** @class */ (function (_super) {
             }
         }
     };
+    /**
+     * Recreate the content of the ADT from a snippet saved by the GUI editor
+     * @param snippetId defines the snippet to load
+     * @param scaleToSize defines whether to scale to texture to the saved size
+     * @param appendToAdt if provided the snippet will be appended to the adt. Otherwise a fullscreen ADT will be created.
+     * @returns a promise that will resolve on success
+     */
+    AdvancedDynamicTexture.ParseFromSnippetAsync = function (snippetId, scaleToSize, appendToAdt) {
+        return __awaiter(this, void 0, void 0, function () {
+            var adt, serialized;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        adt = appendToAdt !== null && appendToAdt !== void 0 ? appendToAdt : AdvancedDynamicTexture.CreateFullscreenUI("ADT from snippet");
+                        if (snippetId === "_BLANK") {
+                            return [2 /*return*/, adt];
+                        }
+                        return [4 /*yield*/, AdvancedDynamicTexture._LoadURLContentAsync(AdvancedDynamicTexture.SnippetUrl + "/" + snippetId.replace(/#/g, "/"), true)];
+                    case 1:
+                        serialized = _a.sent();
+                        adt.parseSerializedObject(serialized, scaleToSize);
+                        return [2 /*return*/, adt];
+                }
+            });
+        });
+    };
     /**
      * Recreate the content of the ADT from a snippet saved by the GUI editor
      * @param snippetId defines the snippet to load
@@ -1130,28 +1169,29 @@ var AdvancedDynamicTexture = /** @class */ (function (_super) {
      * @returns a promise that will resolve on success
      */
     AdvancedDynamicTexture.prototype.parseFromSnippetAsync = function (snippetId, scaleToSize) {
-        var _this = this;
-        if (snippetId === "_BLANK") {
-            return Promise.resolve();
-        }
-        return new Promise(function (resolve, reject) {
-            var request = new WebRequest();
-            request.addEventListener("readystatechange", function () {
-                if (request.readyState == 4) {
-                    if (request.status == 200) {
-                        var snippet = JSON.parse(JSON.parse(request.responseText).jsonPayload);
-                        var serializationObject = JSON.parse(snippet.gui);
-                        _this.parseContent(serializationObject, scaleToSize);
-                        _this.snippetId = snippetId;
-                        resolve();
-                    }
-                    else {
-                        reject("Unable to load the snippet " + snippetId);
-                    }
+        return AdvancedDynamicTexture.ParseFromSnippetAsync(snippetId, scaleToSize, this);
+    };
+    /**
+     * Recreate the content of the ADT from a url json
+     * @param url defines the url to load
+     * @param scaleToSize defines whether to scale to texture to the saved size
+     * @param appendToAdt if provided the snippet will be appended to the adt. Otherwise a fullscreen ADT will be created.
+     * @returns a promise that will resolve on success
+     */
+    AdvancedDynamicTexture.ParseFromFileAsync = function (url, scaleToSize, appendToAdt) {
+        return __awaiter(this, void 0, void 0, function () {
+            var adt, serialized;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        adt = appendToAdt !== null && appendToAdt !== void 0 ? appendToAdt : AdvancedDynamicTexture.CreateFullscreenUI("ADT from URL");
+                        return [4 /*yield*/, AdvancedDynamicTexture._LoadURLContentAsync(url)];
+                    case 1:
+                        serialized = _a.sent();
+                        adt.parseSerializedObject(serialized, scaleToSize);
+                        return [2 /*return*/, adt];
                 }
             });
-            request.open("GET", AdvancedDynamicTexture.SnippetUrl + "/" + snippetId.replace(/#/g, "/"));
-            request.send();
         });
     };
     /**
@@ -1161,19 +1201,21 @@ var AdvancedDynamicTexture = /** @class */ (function (_super) {
      * @returns a promise that will resolve on success
      */
     AdvancedDynamicTexture.prototype.parseFromURLAsync = function (url, scaleToSize) {
-        var _this = this;
+        return AdvancedDynamicTexture.ParseFromFileAsync(url, scaleToSize, this);
+    };
+    AdvancedDynamicTexture._LoadURLContentAsync = function (url, snippet) {
+        if (snippet === void 0) { snippet = false; }
         if (url === "") {
-            return Promise.resolve();
+            return Promise.reject("No URL provided");
         }
         return new Promise(function (resolve, reject) {
             var request = new WebRequest();
             request.addEventListener("readystatechange", function () {
                 if (request.readyState == 4) {
                     if (request.status == 200) {
-                        var gui = request.responseText;
+                        var gui = snippet ? JSON.parse(JSON.parse(request.responseText).jsonPayload).gui : request.responseText;
                         var serializationObject = JSON.parse(gui);
-                        _this.parseContent(serializationObject, scaleToSize);
-                        resolve();
+                        resolve(serializationObject);
                     }
                     else {
                         reject("Unable to load");