babylonjs-gui 5.43.1 → 5.44.0

package/babylon.gui.d.ts

@@ -584,6 +584,7 @@ declare module BABYLON.GUI {
          * @internal
          */
         _onPointerDown(target: Control, coordinates: BABYLON.Vector2, pointerId: number, buttonIndex: number, pi: BABYLON.PointerInfoBase): boolean;
+        protected _getRectangleFill(context: BABYLON.ICanvasRenderingContext): string | import("core/Engines/ICanvas").ICanvasGradient;
         /**
          * @internal
          */
@@ -787,6 +788,8 @@ declare module BABYLON.GUI {
         /** @internal */
         protected _background: string;
         /** @internal */
+        protected _backgroundGradient: BABYLON.Nullable<BaseGradient>;
+        /** @internal */
         protected _adaptWidthToChildren: boolean;
         /** @internal */
         protected _adaptHeightToChildren: boolean;
@@ -814,6 +817,9 @@ declare module BABYLON.GUI {
         /** Gets or sets background color */
         get background(): string;
         set background(value: string);
+        /** Gets or sets background gradient color. Takes precedence over background */
+        get backgroundGradient(): BABYLON.Nullable<BaseGradient>;
+        set backgroundGradient(value: BABYLON.Nullable<BaseGradient>);
         /** Gets the list of children */
         get children(): Control[];
         get isReadOnly(): boolean;
@@ -883,6 +889,7 @@ declare module BABYLON.GUI {
         _offsetTop(offset: number): void;
         /** @internal */
         _markAllAsDirty(): void;
+        protected _getBackgroundColor(context: BABYLON.ICanvasRenderingContext): string | BABYLON.ICanvasGradient;
         /**
          * @internal
          */
@@ -1024,6 +1031,7 @@ declare module BABYLON.GUI {
         protected _disabledColor: string;
         protected _disabledColorItem: string;
         protected _isReadOnly: boolean;
+        private _gradient;
         /** @internal */
         protected _rebuildLayout: boolean;
         /** @internal */
@@ -1293,6 +1301,9 @@ declare module BABYLON.GUI {
         /** Gets or sets foreground color */
         get color(): string;
         set color(value: string);
+        /** Gets or sets gradient. Setting a gradient will override the color */
+        get gradient(): BABYLON.Nullable<BaseGradient>;
+        set gradient(value: BABYLON.Nullable<BaseGradient>);
         /** Gets or sets z index which is used to reorder controls on the z axis */
         get zIndex(): number;
         set zIndex(value: number);
@@ -1589,6 +1600,7 @@ declare module BABYLON.GUI {
          * @internal
          */
         _renderHighlightSpecific(context: BABYLON.ICanvasRenderingContext): void;
+        protected _getColor(context: BABYLON.ICanvasRenderingContext): string | BABYLON.ICanvasGradient;
         /**
          * @internal
          */
@@ -1900,6 +1912,162 @@ declare module BABYLON.GUI {
     }
 
 
+    /**
+     * Type that represents a single stop on the gradient.
+     */
+    export type GradientColorStop = {
+        /**
+         * Offset from the start where the color will be applied.
+         */
+        offset: number;
+        /**
+         * Color to be applied.
+         */
+        color: string;
+    };
+    /**
+     * Class that serves as a base for all the gradients created from context.
+     */
+    export abstract class BaseGradient {
+        private _colorStops;
+        private _canvasGradient;
+        private _context;
+        private _gradientDirty;
+        /**
+         * Overwritten by child classes to create the canvas gradient.
+         * @param context
+         */
+        protected abstract _createCanvasGradient(context: BABYLON.ICanvasRenderingContext): BABYLON.ICanvasGradient;
+        private _addColorStopsToCanvasGradient;
+        /**
+         * If there are any changes or the context changed, regenerate the canvas gradient object. Else,
+         * reuse the existing gradient.
+         **/
+        getCanvasGradient(context: BABYLON.ICanvasRenderingContext): CanvasGradient;
+        /**
+         * Adds a new color stop to the gradient.
+         * @param offset the offset of the stop on the gradient. Should be between 0 and 1
+         * @param color the color of the stop
+         */
+        addColorStop(offset: number, color: string): void;
+        /**
+         * Removes an existing color stop with the specified offset from the gradient
+         * @param offset the offset of the stop to be removed
+         */
+        removeColorStop(offset: number): void;
+        /**
+         * Removes all color stops from the gradient
+         */
+        clearColorStops(): void;
+        /** Color stops of the gradient */
+        get colorStops(): GradientColorStop[];
+        /** Type of the gradient */
+        getClassName(): string;
+        /** Serialize into a json object */
+        serialize(serializationObject: any): void;
+        /** Parse from json object */
+        parse(serializationObject: any): void;
+    }
+
+
+    /**
+     * Gradient along a line that connects two coordinates.
+     * These coordinates are relative to the canvas' space, not to any control's space.
+     * @see https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/createLinearGradient
+     */
+    export class LinearGradient extends BaseGradient {
+        private _x0;
+        private _y0;
+        private _x1;
+        private _y1;
+        /**
+         * Creates a new linear gradient
+         * @param x0
+         * @param y0
+         * @param x1
+         * @param y1
+         */
+        constructor(x0?: number, y0?: number, x1?: number, y1?: number);
+        protected _createCanvasGradient(context: BABYLON.ICanvasRenderingContext): BABYLON.ICanvasGradient;
+        /** X axis coordinate of the starting point in the line */
+        get x0(): number;
+        /** X axis coordinate of the ending point in the line */
+        get x1(): number;
+        /** Y axis coordinate of the starting point in the line */
+        get y0(): number;
+        /** Y axis coordinate of the ending point in the line */
+        get y1(): number;
+        /**
+         * Class name of the gradient
+         * @returns the class name of the gradient
+         */
+        getClassName(): string;
+        /**
+         * Serializes this gradient
+         * @param serializationObject the object to serialize to
+         */
+        serialize(serializationObject: any): void;
+        /**
+         * Parses a gradient from a serialization object
+         * @param serializationObject the object to parse from
+         */
+        parse(serializationObject: any): void;
+    }
+
+
+    /**
+     * Gradient formed from two circles with their own centers and radius.
+     * The coordinates of the circles centers are relative to the canvas' space, not to any control's space.
+     * @see https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/createRadialGradient
+     */
+    export class RadialGradient extends BaseGradient {
+        private _x0;
+        private _y0;
+        private _r0;
+        private _x1;
+        private _y1;
+        private _r1;
+        /**
+         * Creates a new radial gradient
+         * @param x0 x coordinate of the first circle's center
+         * @param y0 y coordinate of the first circle's center
+         * @param r0 radius of the first circle
+         * @param x1 x coordinate of the second circle's center
+         * @param y1 y coordinate of the second circle's center
+         * @param r1 radius of the second circle
+         */
+        constructor(x0?: number, y0?: number, r0?: number, x1?: number, y1?: number, r1?: number);
+        protected _createCanvasGradient(context: BABYLON.ICanvasRenderingContext): BABYLON.ICanvasGradient;
+        /** x coordinate of the first circle's center */
+        get x0(): number;
+        /** x coordinate of the second circle's center */
+        get x1(): number;
+        /** y coordinate of the first circle's center */
+        get y0(): number;
+        /** y coordinate of the second circle's center */
+        get y1(): number;
+        /** radius of the first circle */
+        get r0(): number;
+        /** radius of the second circle */
+        get r1(): number;
+        /**
+         * Class name of the gradient
+         * @returns the class name of the gradient
+         */
+        getClassName(): string;
+        /**
+         * Serializes this gradient
+         * @param serializationObject the object to serialize to
+         */
+        serialize(serializationObject: any): void;
+        /**
+         * Parses a gradient from a serialization object
+         * @param serializationObject the object to parse from
+         */
+        parse(serializationObject: any): void;
+    }
+
+
     /**
      * Class used to create a 2D grid container
      */
@@ -2813,6 +2981,7 @@ declare module BABYLON.GUI {
         protected _computeAdditionnalOffsetX(): 1 | 0;
         /** @internal */
         protected _computeAdditionnalOffsetY(): 1 | 0;
+        protected _getRectangleFill(context: BABYLON.ICanvasRenderingContext): string | BABYLON.ICanvasGradient;
         protected _localDraw(context: BABYLON.ICanvasRenderingContext): void;
         protected _additionalProcessing(parentMeasure: Measure, context: BABYLON.ICanvasRenderingContext): void;
         private _drawRoundedRect;
@@ -3471,12 +3640,16 @@ declare module BABYLON.GUI {
         private _borderColor;
         private _tempMeasure;
         private _invertScrollDirection;
+        private _backgroundGradient;
         /** Gets or sets border color */
         get borderColor(): string;
         set borderColor(value: string);
         /** Gets or sets background color */
         get background(): string;
         set background(value: string);
+        /** Gets or sets background gradient. Takes precedence over gradient. */
+        get backgroundGradient(): BABYLON.Nullable<BaseGradient>;
+        set backgroundGradient(value: BABYLON.Nullable<BaseGradient>);
         /** Inverts the scrolling direction (default: false) */
         get invertScrollDirection(): boolean;
         set invertScrollDirection(invert: boolean);
@@ -3487,6 +3660,7 @@ declare module BABYLON.GUI {
         constructor(name?: string | undefined);
         protected _getTypeName(): string;
         protected _getThumbThickness(): number;
+        private _getBackgroundColor;
         _draw(context: BABYLON.ICanvasRenderingContext): void;
         private _first;
         private _originX;
@@ -3496,6 +3670,8 @@ declare module BABYLON.GUI {
          */
         protected _updateValueFromPointer(x: number, y: number): void;
         _onPointerDown(target: Control, coordinates: BABYLON.Vector2, pointerId: number, buttonIndex: number, pi: BABYLON.PointerInfoBase): boolean;
+        serialize(serializationObject: any): void;
+        _parseFromContent(serializationObject: any, host: AdvancedDynamicTexture): void;
     }
 
 
@@ -3509,6 +3685,7 @@ declare module BABYLON.GUI {
         private _thumbColor;
         private _isThumbCircle;
         protected _displayValueBar: boolean;
+        private _backgroundGradient;
         /** Gets or sets a boolean indicating if the value bar must be rendered */
         get displayValueBar(): boolean;
         set displayValueBar(value: boolean);
@@ -3518,6 +3695,9 @@ declare module BABYLON.GUI {
         /** Gets or sets background color */
         get background(): string;
         set background(value: string);
+        /** Gets or sets background gradient */
+        get backgroundGradient(): BABYLON.Nullable<BaseGradient>;
+        set backgroundGradient(value: BABYLON.Nullable<BaseGradient>);
         /** Gets or sets thumb's color */
         get thumbColor(): string;
         set thumbColor(value: string);
@@ -3530,7 +3710,11 @@ declare module BABYLON.GUI {
          */
         constructor(name?: string | undefined);
         protected _getTypeName(): string;
+        protected _getBackgroundColor(context: BABYLON.ICanvasRenderingContext): string | CanvasGradient;
         _draw(context: BABYLON.ICanvasRenderingContext): void;
+        serialize(serializationObject: any): void;
+        /** @internal */
+        _parseFromContent(serializedObject: any, host: AdvancedDynamicTexture): void;
     }
 
 
@@ -3640,6 +3824,7 @@ declare module BABYLON.GUI {
         private _underline;
         private _lineThrough;
         private _wordDivider;
+        private _forceResizeWidth;
         /**
          * An event triggered after the text is changed
          */
@@ -3744,6 +3929,13 @@ declare module BABYLON.GUI {
          * Gets or sets word divider
          */
         set wordDivider(value: string);
+        /**
+         * By default, if a text block has text wrapping other than Clip, its width
+         * is not resized even if resizeToFit = true. This parameter forces the width
+         * to be resized.
+         */
+        get forceResizeWidth(): boolean;
+        set forceResizeWidth(value: boolean);
         /**
          * Creates a new TextBlock object
          * @param name defines the name of the control