babylonjs-gui 5.44.0 → 5.45.0

package/babylon.gui.d.ts

@@ -62,6 +62,8 @@ declare module BABYLON.GUI {
         static AllowGPUOptimizations: boolean;
         /** Snippet ID if the content was created from the snippet server */
         snippetId: string;
+        /** BABYLON.Observable that fires when the GUI is ready */
+        onGuiReadyObservable: BABYLON.Observable<AdvancedDynamicTexture>;
         private _isDirty;
         private _renderObserver;
         private _resizeObserver;
@@ -524,6 +526,11 @@ declare module BABYLON.GUI {
          * @param height the new height
          */
         scaleTo(width: number, height: number): void;
+        private _checkGuiIsReady;
+        /**
+         * Returns true if all the GUI components are ready to render
+         */
+        guiIsReady(): boolean;
     }
 
 
@@ -933,6 +940,7 @@ declare module BABYLON.GUI {
          * @internal
          */
         _parseFromContent(serializedObject: any, host: AdvancedDynamicTexture): void;
+        isReady(): boolean;
     }
 
 
@@ -1755,6 +1763,11 @@ declare module BABYLON.GUI {
          * @internal
          */
         protected static drawEllipse(x: number, y: number, width: number, height: number, context: BABYLON.ICanvasRenderingContext): void;
+        /**
+         * Returns true if the control is ready to be used
+         * @returns
+         */
+        isReady(): boolean;
     }
 
 
@@ -2259,6 +2272,7 @@ declare module BABYLON.GUI {
          * Gets a boolean indicating that the content is loaded
          */
         get isLoaded(): boolean;
+        isReady(): boolean;
         /**
          * Gets or sets a boolean indicating if pointers should only be validated on pixels with alpha > 0.
          * Beware using this as this will consume more memory as the image has to be stored twice

package/babylon.gui.js

@@ -501,6 +501,8 @@ var AdvancedDynamicTexture = /** @class */ (function (_super) {
         if (samplingMode === void 0) { samplingMode = core_Misc_observable__WEBPACK_IMPORTED_MODULE_1__.Texture.NEAREST_SAMPLINGMODE; }
         if (invertY === void 0) { invertY = true; }
         var _this = _super.call(this, name, { width: width, height: height }, scene, generateMipMaps, samplingMode, core_Misc_observable__WEBPACK_IMPORTED_MODULE_1__.Constants.TEXTUREFORMAT_RGBA, invertY) || this;
+        /** Observable that fires when the GUI is ready */
+        _this.onGuiReadyObservable = new core_Misc_observable__WEBPACK_IMPORTED_MODULE_1__.Observable();
         _this._isDirty = false;
         /** @internal */
         _this._rootContainer = new _controls_container__WEBPACK_IMPORTED_MODULE_2__.Container("root");
@@ -1103,6 +1105,7 @@ var AdvancedDynamicTexture = /** @class */ (function (_super) {
         this.onEndRenderObservable.clear();
         this.onBeginLayoutObservable.clear();
         this.onEndLayoutObservable.clear();
+        this.onGuiReadyObservable.clear();
         _super.prototype.dispose.call(this);
     };
     AdvancedDynamicTexture.prototype._onResize = function () {
@@ -1229,6 +1232,9 @@ var AdvancedDynamicTexture = /** @class */ (function (_super) {
         var context = this.getContext();
         context.font = "18px Arial";
         context.strokeStyle = "white";
+        if (this.onGuiReadyObservable.hasObservers()) {
+            this._checkGuiIsReady();
+        }
         /** We have to recheck the camera projection in the case the root control's children have changed  */
         if (this._rootChildrenHaveChanged) {
             var camera = (_a = this.getScene()) === null || _a === void 0 ? void 0 : _a.activeCamera;
@@ -1936,6 +1942,18 @@ var AdvancedDynamicTexture = /** @class */ (function (_super) {
         _super.prototype.scaleTo.call(this, width, height);
         this.markAsDirty();
     };
+    AdvancedDynamicTexture.prototype._checkGuiIsReady = function () {
+        if (this.guiIsReady()) {
+            this.onGuiReadyObservable.notifyObservers(this);
+            this.onGuiReadyObservable.clear();
+        }
+    };
+    /**
+     * Returns true if all the GUI components are ready to render
+     */
+    AdvancedDynamicTexture.prototype.guiIsReady = function () {
+        return this._rootContainer.isReady();
+    };
     /** Define the Uurl to load snippets */
     AdvancedDynamicTexture.SnippetUrl = core_Misc_observable__WEBPACK_IMPORTED_MODULE_1__.Constants.SnippetUrl;
     /** Indicates if some optimizations can be performed in GUI GPU management (the downside is additional memory/GPU texture memory used) */
@@ -4461,6 +4479,15 @@ var Container = /** @class */ (function (_super) {
             this.addControl(_control__WEBPACK_IMPORTED_MODULE_2__.Control.Parse(childData, host));
         }
     };
+    Container.prototype.isReady = function () {
+        for (var _i = 0, _a = this.children; _i < _a.length; _i++) {
+            var child = _a[_i];
+            if (!child.isReady()) {
+                return false;
+            }
+        }
+        return true;
+    };
     (0,tslib__WEBPACK_IMPORTED_MODULE_0__.__decorate)([
         (0,core_Misc_logger__WEBPACK_IMPORTED_MODULE_1__.serialize)()
     ], Container.prototype, "renderToIntermediateTexture", null);
@@ -6831,6 +6858,14 @@ var Control = /** @class */ (function () {
         context.scale(1 / width, 1 / height);
         context.translate(-x, -y);
     };
+    /**
+     * Returns true if the control is ready to be used
+     * @returns
+     */
+    Control.prototype.isReady = function () {
+        // Most controls are ready by default, so the default implementation is to return true
+        return true;
+    };
     /**
      * Gets or sets a boolean indicating if alpha must be an inherited value (false by default)
      */
@@ -8432,6 +8467,9 @@ var Image = /** @class */ (function (_super) {
         enumerable: false,
         configurable: true
     });
+    Image.prototype.isReady = function () {
+        return this.isLoaded;
+    };
     Object.defineProperty(Image.prototype, "detectPointerOnOpaqueOnly", {
         /**
          * Gets or sets a boolean indicating if pointers should only be validated on pixels with alpha > 0.