babylonjs-gui 6.38.1 → 6.40.0

package/babylon.gui.d.ts

@@ -535,7 +535,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;
     }
@@ -562,10 +562,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)
@@ -606,8 +602,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
          */
@@ -811,6 +808,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);
@@ -943,8 +944,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;
         /**
@@ -1151,6 +1153,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
@@ -1228,6 +1233,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
          */
@@ -1758,8 +1767,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
          */
@@ -1933,7 +1943,7 @@ declare module BABYLON.GUI {
          */
         _onPointerDown(target: Control, coordinates: BABYLON.Vector2, pointerId: number, buttonIndex: number, pi: BABYLON.PointerInfoBase): boolean;
         /** @internal */
-        displose(): void;
+        dispose(): void;
     }
 
 
@@ -2000,7 +2010,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.
@@ -2017,13 +2029,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;
     }
 
@@ -2261,8 +2283,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
          */
@@ -2430,7 +2453,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;
         /**
@@ -3855,8 +3879,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
          */
@@ -4837,6 +4862,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);
         /**
@@ -5074,7 +5100,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;
@@ -5398,7 +5424,7 @@ declare module BABYLON.GUI {
         private _attachContentPlateBehavior;
         protected _affectMaterial(mesh: BABYLON.AbstractMesh): void;
         /**
-         * @internal*
+         * @internal
          */
         _prepareNode(scene: BABYLON.Scene): void;
         /**
@@ -6038,8 +6064,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;
         /**