babylonjs-gui 6.38.1 → 6.40.0

package/babylon.gui.module.d.ts

@@ -554,7 +554,7 @@ export class AdvancedDynamicTexture extends DynamicTexture {
     scaleTo(width: number, height: number): void;
     private _checkGuiIsReady;
     /**
-     * Returns true if all the GUI components are ready to render
+     * @returns true if all the GUI components are ready to render
      */
     guiIsReady(): boolean;
 }
@@ -591,10 +591,6 @@ export class Button extends Rectangle {
      * Function called to generate a pointer up animation
      */
     pointerUpAnimation: () => void;
-    /**
-     * Gets or sets a boolean indicating that the button will let internal controls handle picking instead of doing it directly using its bounding info
-     */
-    delegatePickingToChildren: boolean;
     private _image;
     /**
      * Returns the image part of the button (if any)
@@ -635,8 +631,9 @@ export class Button extends Rectangle {
     /**
      * Serializes the current button
      * @param serializationObject defines the JSON serialized object
+     * @param force force serialization even if isSerializable === false
      */
-    serialize(serializationObject: any): void;
+    serialize(serializationObject: any, force: boolean): void;
     /**
      * @internal
      */
@@ -866,6 +863,10 @@ export class Container extends Control {
     protected _renderToIntermediateTexture: boolean;
     /** @internal */
     protected _intermediateTexture: Nullable<DynamicTexture>;
+    /**
+     * Gets or sets a boolean indicating that the container will let internal controls handle picking instead of doing it directly using its bounding info
+     */
+    delegatePickingToChildren: boolean;
     /** Gets or sets boolean indicating if children should be rendered to an intermediate texture rather than directly to host, useful for alpha blending */
     get renderToIntermediateTexture(): boolean;
     set renderToIntermediateTexture(value: boolean);
@@ -998,8 +999,9 @@ export class Container extends Control {
     /**
      * Serializes the current control
      * @param serializationObject defined the JSON serialized object
+     * @param force force serialization even if isSerializable === false
      */
-    serialize(serializationObject: any): void;
+    serialize(serializationObject: any, force?: boolean): void;
     /** Releases associated resources */
     dispose(): void;
     /**
@@ -1224,6 +1226,9 @@ export class Control implements IAnimatable {
     set accessibilityTag(value: Nullable<IAccessibilityTag>);
     get accessibilityTag(): Nullable<IAccessibilityTag>;
     protected _accessibilityTag: Nullable<IAccessibilityTag>;
+    /**
+     * Observable that fires whenever the accessibility event of the control has changed
+     */
     onAccessibilityTagChangedObservable: Observable<Nullable<IAccessibilityTag>>;
     /**
      * An event triggered when pointer wheel is scrolled
@@ -1301,6 +1306,10 @@ export class Control implements IAnimatable {
      */
     get isHighlighted(): boolean;
     set isHighlighted(value: boolean);
+    /**
+     * Indicates if the control should be serialized. Defaults to true.
+     */
+    isSerializable: boolean;
     /**
      * Gets or sets a string defining the color to use for highlighting this control
      */
@@ -1831,8 +1840,9 @@ export class Control implements IAnimatable {
     /**
      * Serializes the current control
      * @param serializationObject defined the JSON serialized object
+     * @param force if the control should be serialized even if the isSerializable flag is set to false (default false)
      */
-    serialize(serializationObject: any): void;
+    serialize(serializationObject: any, force?: boolean): void;
     /**
      * @internal
      */
@@ -2022,7 +2032,7 @@ export class FocusableButton extends Button implements IFocusableControl {
      */
     _onPointerDown(target: Control, coordinates: Vector2, pointerId: number, buttonIndex: number, pi: PointerInfoBase): boolean;
     /** @internal */
-    displose(): void;
+    dispose(): void;
 }
 
 }
@@ -2095,7 +2105,9 @@ export abstract class BaseGradient {
     /**
      * If there are any changes or the context changed, regenerate the canvas gradient object. Else,
      * reuse the existing gradient.
-     **/
+     * @param context the context to create the gradient from
+     * @returns the canvas gradient
+     */
     getCanvasGradient(context: ICanvasRenderingContext): CanvasGradient;
     /**
      * Adds a new color stop to the gradient.
@@ -2112,13 +2124,23 @@ export abstract class BaseGradient {
      * Removes all color stops from the gradient
      */
     clearColorStops(): void;
-    /** Color stops of the gradient */
+    /**
+     * Color stops of the gradient
+     */
     get colorStops(): GradientColorStop[];
-    /** Type of the gradient */
+    /**
+     * @returns Type of the gradient
+     */
     getClassName(): string;
-    /** Serialize into a json object */
+    /**
+     * Serialize into a json object
+     * @param serializationObject object to serialize into
+     */
     serialize(serializationObject: any): void;
-    /** Parse from json object */
+    /**
+     * Parse from json object
+     * @param serializationObject object to parse from
+     */
     parse(serializationObject: any): void;
 }
 
@@ -2370,8 +2392,9 @@ export class Grid extends Container {
     /**
      * Serializes the current control
      * @param serializationObject defined the JSON serialized object
+     * @param force force serialization even if isSerializable === false
      */
-    serialize(serializationObject: any): void;
+    serialize(serializationObject: any, force: boolean): void;
     /**
      * @internal
      */
@@ -2545,7 +2568,8 @@ export class Image extends Control {
     set source(value: Nullable<string>);
     /**
      * Checks for svg document with icon id present
-     * @param value
+     * @param value the source svg
+     * @returns the svg
      */
     private _svgCheck;
     /**
@@ -4112,8 +4136,9 @@ export class StackPanel extends Container {
     /**
      * Serializes the current control
      * @param serializationObject defined the JSON serialized object
+     * @param force force serialization even if isSerializable === false
      */
-    serialize(serializationObject: any): void;
+    serialize(serializationObject: any, force: boolean): void;
     /**
      * @internal
      */
@@ -5168,6 +5193,7 @@ export class Button3D extends AbstractButton3D {
     /**
      * Creates a new button
      * @param name defines the control name
+     * @param options defines the options used to create the button
      */
     constructor(name?: string, options?: IButton3DCreationOptions);
     /**
@@ -5425,7 +5451,7 @@ export class Control3D implements IDisposable, IBehaviorAware<Control3D> {
      */
     linkToTransformNode(node: Nullable<TransformNode>): Control3D;
     /**
-     * @internal*
+     * @internal
      */
     _prepareNode(scene: Scene): void;
     protected _injectGUI3DReservedDataStore(node: TransformNode): any;
@@ -5787,7 +5813,7 @@ export class HolographicSlate extends ContentDisplay3D {
     private _attachContentPlateBehavior;
     protected _affectMaterial(mesh: AbstractMesh): void;
     /**
-     * @internal*
+     * @internal
      */
     _prepareNode(scene: Scene): void;
     /**
@@ -6531,8 +6557,8 @@ export class TouchHolographicMenu extends VolumeBasedPanel {
     /**
      * This method should not be used directly. It is inherited from `Container3D`.
      * Please use `addButton` instead.
-     * @param _control
-     * @returns
+     * @param _control the control to add
+     * @returns the current container
      */
     addControl(_control: Control3D): Container3D;
     /**
@@ -9355,7 +9381,7 @@ declare module BABYLON.GUI {
         scaleTo(width: number, height: number): void;
         private _checkGuiIsReady;
         /**
-         * Returns true if all the GUI components are ready to render
+         * @returns true if all the GUI components are ready to render
          */
         guiIsReady(): boolean;
     }
@@ -9382,10 +9408,6 @@ declare module BABYLON.GUI {
          * Function called to generate a pointer up animation
          */
         pointerUpAnimation: () => void;
-        /**
-         * Gets or sets a boolean indicating that the button will let internal controls handle picking instead of doing it directly using its bounding info
-         */
-        delegatePickingToChildren: boolean;
         private _image;
         /**
          * Returns the image part of the button (if any)
@@ -9426,8 +9448,9 @@ declare module BABYLON.GUI {
         /**
          * Serializes the current button
          * @param serializationObject defines the JSON serialized object
+         * @param force force serialization even if isSerializable === false
          */
-        serialize(serializationObject: any): void;
+        serialize(serializationObject: any, force: boolean): void;
         /**
          * @internal
          */
@@ -9631,6 +9654,10 @@ declare module BABYLON.GUI {
         protected _renderToIntermediateTexture: boolean;
         /** @internal */
         protected _intermediateTexture: BABYLON.Nullable<BABYLON.DynamicTexture>;
+        /**
+         * Gets or sets a boolean indicating that the container will let internal controls handle picking instead of doing it directly using its bounding info
+         */
+        delegatePickingToChildren: boolean;
         /** Gets or sets boolean indicating if children should be rendered to an intermediate texture rather than directly to host, useful for alpha blending */
         get renderToIntermediateTexture(): boolean;
         set renderToIntermediateTexture(value: boolean);
@@ -9763,8 +9790,9 @@ declare module BABYLON.GUI {
         /**
          * Serializes the current control
          * @param serializationObject defined the JSON serialized object
+         * @param force force serialization even if isSerializable === false
          */
-        serialize(serializationObject: any): void;
+        serialize(serializationObject: any, force?: boolean): void;
         /** Releases associated resources */
         dispose(): void;
         /**
@@ -9971,6 +9999,9 @@ declare module BABYLON.GUI {
         set accessibilityTag(value: BABYLON.Nullable<BABYLON.IAccessibilityTag>);
         get accessibilityTag(): BABYLON.Nullable<BABYLON.IAccessibilityTag>;
         protected _accessibilityTag: BABYLON.Nullable<BABYLON.IAccessibilityTag>;
+        /**
+         * BABYLON.Observable that fires whenever the accessibility event of the control has changed
+         */
         onAccessibilityTagChangedObservable: BABYLON.Observable<BABYLON.Nullable<BABYLON.IAccessibilityTag>>;
         /**
          * An event triggered when pointer wheel is scrolled
@@ -10048,6 +10079,10 @@ declare module BABYLON.GUI {
          */
         get isHighlighted(): boolean;
         set isHighlighted(value: boolean);
+        /**
+         * Indicates if the control should be serialized. Defaults to true.
+         */
+        isSerializable: boolean;
         /**
          * Gets or sets a string defining the color to use for highlighting this control
          */
@@ -10578,8 +10613,9 @@ declare module BABYLON.GUI {
         /**
          * Serializes the current control
          * @param serializationObject defined the JSON serialized object
+         * @param force if the control should be serialized even if the isSerializable flag is set to false (default false)
          */
-        serialize(serializationObject: any): void;
+        serialize(serializationObject: any, force?: boolean): void;
         /**
          * @internal
          */
@@ -10753,7 +10789,7 @@ declare module BABYLON.GUI {
          */
         _onPointerDown(target: Control, coordinates: BABYLON.Vector2, pointerId: number, buttonIndex: number, pi: BABYLON.PointerInfoBase): boolean;
         /** @internal */
-        displose(): void;
+        dispose(): void;
     }
 
 
@@ -10820,7 +10856,9 @@ declare module BABYLON.GUI {
         /**
          * If there are any changes or the context changed, regenerate the canvas gradient object. Else,
          * reuse the existing gradient.
-         **/
+         * @param context the context to create the gradient from
+         * @returns the canvas gradient
+         */
         getCanvasGradient(context: BABYLON.ICanvasRenderingContext): CanvasGradient;
         /**
          * Adds a new color stop to the gradient.
@@ -10837,13 +10875,23 @@ declare module BABYLON.GUI {
          * Removes all color stops from the gradient
          */
         clearColorStops(): void;
-        /** Color stops of the gradient */
+        /**
+         * Color stops of the gradient
+         */
         get colorStops(): GradientColorStop[];
-        /** Type of the gradient */
+        /**
+         * @returns Type of the gradient
+         */
         getClassName(): string;
-        /** Serialize into a json object */
+        /**
+         * Serialize into a json object
+         * @param serializationObject object to serialize into
+         */
         serialize(serializationObject: any): void;
-        /** Parse from json object */
+        /**
+         * Parse from json object
+         * @param serializationObject object to parse from
+         */
         parse(serializationObject: any): void;
     }
 
@@ -11081,8 +11129,9 @@ declare module BABYLON.GUI {
         /**
          * Serializes the current control
          * @param serializationObject defined the JSON serialized object
+         * @param force force serialization even if isSerializable === false
          */
-        serialize(serializationObject: any): void;
+        serialize(serializationObject: any, force: boolean): void;
         /**
          * @internal
          */
@@ -11250,7 +11299,8 @@ declare module BABYLON.GUI {
         set source(value: BABYLON.Nullable<string>);
         /**
          * Checks for svg document with icon id present
-         * @param value
+         * @param value the source svg
+         * @returns the svg
          */
         private _svgCheck;
         /**
@@ -12675,8 +12725,9 @@ declare module BABYLON.GUI {
         /**
          * Serializes the current control
          * @param serializationObject defined the JSON serialized object
+         * @param force force serialization even if isSerializable === false
          */
-        serialize(serializationObject: any): void;
+        serialize(serializationObject: any, force: boolean): void;
         /**
          * @internal
          */
@@ -13657,6 +13708,7 @@ declare module BABYLON.GUI {
         /**
          * Creates a new button
          * @param name defines the control name
+         * @param options defines the options used to create the button
          */
         constructor(name?: string, options?: IButton3DCreationOptions);
         /**
@@ -13894,7 +13946,7 @@ declare module BABYLON.GUI {
          */
         linkToTransformNode(node: BABYLON.Nullable<BABYLON.TransformNode>): Control3D;
         /**
-         * @internal*
+         * @internal
          */
         _prepareNode(scene: BABYLON.Scene): void;
         protected _injectGUI3DReservedDataStore(node: BABYLON.TransformNode): any;
@@ -14218,7 +14270,7 @@ declare module BABYLON.GUI {
         private _attachContentPlateBehavior;
         protected _affectMaterial(mesh: BABYLON.AbstractMesh): void;
         /**
-         * @internal*
+         * @internal
          */
         _prepareNode(scene: BABYLON.Scene): void;
         /**
@@ -14858,8 +14910,8 @@ declare module BABYLON.GUI {
         /**
          * This method should not be used directly. It is inherited from `Container3D`.
          * Please use `addButton` instead.
-         * @param _control
-         * @returns
+         * @param _control the control to add
+         * @returns the current container
          */
         addControl(_control: Control3D): Container3D;
         /**

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "babylonjs-gui",
-    "version": "6.38.1",
+    "version": "6.40.0",
     "main": "babylon.gui.js",
     "types": "babylon.gui.module.d.ts",
     "files": [
@@ -15,7 +15,7 @@
         "test:escheck": "es-check es6 ./babylon.gui.js"
     },
     "dependencies": {
-        "babylonjs": "^6.38.1"
+        "babylonjs": "^6.40.0"
     },
     "devDependencies": {
         "@dev/build-tools": "1.0.0",