babylonjs-gui 5.15.1 → 5.17.1

package/babylon.gui.module.d.ts

@@ -84,7 +84,7 @@ export class AdvancedDynamicTexture extends DynamicTexture {
     private _renderObserver;
     private _resizeObserver;
     private _preKeyboardObserver;
-    private _pointerMoveObserver;
+    private _prePointerObserver;
     private _sceneRenderObserver;
     private _pointerObserver;
     private _canvasPointerOutObserver;
@@ -432,21 +432,45 @@ export 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<void>;
+    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
+     */
+    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
@@ -1128,7 +1152,13 @@ export class Control {
     metadata: any;
     /** Gets or sets a boolean indicating if the control can be hit with pointer events */
     isHitTestVisible: boolean;
-    /** Gets or sets a boolean indicating if the control can block pointer events */
+    /** Gets or sets a boolean indicating if the control can block pointer events. False by default except on the following controls:
+     * * Button controls (Button, RadioButton, ToggleButton)
+     * * Checkbox
+     * * ColorPicker
+     * * InputText
+     * * Slider
+     */
     isPointerBlocker: boolean;
     /** Gets or sets a boolean indicating if the control can be focusable */
     isFocusInvisible: boolean;
@@ -5058,13 +5088,13 @@ import { Container3D } from "babylonjs-gui/3D/controls/container3D";
 export class Control3D implements IDisposable, IBehaviorAware<Control3D> {
     /** Defines the control name */
     name?: string | undefined;
-    /** @hidden */
-    _host: GUI3DManager;
     private _node;
     private _downCount;
     private _enterCount;
     private _downPointerIds;
-    private _isVisible;
+    protected _isVisible: boolean;
+    /** @hidden */
+    _host: GUI3DManager;
     /** @hidden */
     _isScaledByManager: boolean;
     /** Gets or sets the control position in world space */
@@ -5769,6 +5799,8 @@ export class Slider3D extends Control3D {
      * Gets the slider backplate material used by this control
      */
     get sliderBackplateMaterial(): MRDLBackplateMaterial;
+    /** Sets a boolean indicating if the control is visible */
+    set isVisible(value: boolean);
     protected _createNode(scene: Scene): TransformNode;
     protected _affectMaterial(mesh: AbstractMesh): void;
     private _createBehavior;
@@ -8038,7 +8070,7 @@ declare module BABYLON.GUI {
         private _renderObserver;
         private _resizeObserver;
         private _preKeyboardObserver;
-        private _pointerMoveObserver;
+        private _prePointerObserver;
         private _sceneRenderObserver;
         private _pointerObserver;
         private _canvasPointerOutObserver;
@@ -8386,21 +8418,45 @@ declare module BABYLON.GUI {
          * @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<void>;
+        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
+         */
+        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
@@ -9035,7 +9091,13 @@ declare module BABYLON.GUI {
         metadata: any;
         /** Gets or sets a boolean indicating if the control can be hit with pointer events */
         isHitTestVisible: boolean;
-        /** Gets or sets a boolean indicating if the control can block pointer events */
+        /** Gets or sets a boolean indicating if the control can block pointer events. False by default except on the following controls:
+         * * Button controls (Button, RadioButton, ToggleButton)
+         * * Checkbox
+         * * ColorPicker
+         * * InputText
+         * * Slider
+         */
         isPointerBlocker: boolean;
         /** Gets or sets a boolean indicating if the control can be focusable */
         isFocusInvisible: boolean;
@@ -12707,13 +12769,13 @@ declare module BABYLON.GUI {
     export class Control3D implements BABYLON.IDisposable, BABYLON.IBehaviorAware<Control3D> {
         /** Defines the control name */
         name?: string | undefined;
-        /** @hidden */
-        _host: GUI3DManager;
         private _node;
         private _downCount;
         private _enterCount;
         private _downPointerIds;
-        private _isVisible;
+        protected _isVisible: boolean;
+        /** @hidden */
+        _host: GUI3DManager;
         /** @hidden */
         _isScaledByManager: boolean;
         /** Gets or sets the control position in world space */
@@ -13327,6 +13389,8 @@ declare module BABYLON.GUI {
          * Gets the slider backplate material used by this control
          */
         get sliderBackplateMaterial(): MRDLBackplateMaterial;
+        /** Sets a boolean indicating if the control is visible */
+        set isVisible(value: boolean);
         protected _createNode(scene: BABYLON.Scene): BABYLON.TransformNode;
         protected _affectMaterial(mesh: BABYLON.AbstractMesh): void;
         private _createBehavior;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "babylonjs-gui",
-    "version": "5.15.1",
+    "version": "5.17.1",
     "main": "babylon.gui.js",
     "types": "babylon.gui.module.d.ts",
     "files": [
@@ -14,7 +14,7 @@
         "clean": "rimraf dist && rimraf babylon*.*"
     },
     "dependencies": {
-        "babylonjs": "^5.15.1"
+        "babylonjs": "^5.17.1"
     },
     "devDependencies": {
         "@dev/build-tools": "1.0.0",