@babylonjs/gui 9.13.0 → 9.15.0

package/2D/controls/button.d.ts

@@ -1,109 +1,5 @@
-import { type Nullable } from "@babylonjs/core/types.js";
-import { type Vector2 } from "@babylonjs/core/Maths/math.vector.js";
-import { Rectangle } from "./rectangle.js";
-import { Control } from "./control.js";
-import { TextBlock } from "./textBlock.js";
-import { Image } from "./image.js";
-import { type PointerInfoBase } from "@babylonjs/core/Events/pointerEvents.js";
-import { type AdvancedDynamicTexture } from "../advancedDynamicTexture.js";
-import { type ICanvasRenderingContext } from "@babylonjs/core/Engines/ICanvas.js";
 /**
- * Class used to create 2D buttons
+ * Re-exports the pure implementation and applies the runtime registration side effect.
+ * Import "./button.pure" for tree-shakeable, side-effect-free usage.
  */
-export declare class Button extends Rectangle {
-    name?: string | undefined;
-    /**
-     * Function called to generate a pointer enter animation
-     */
-    pointerEnterAnimation: () => void;
-    /**
-     * Function called to generate a pointer out animation
-     */
-    pointerOutAnimation: () => void;
-    /**
-     * Function called to generate a pointer down animation
-     */
-    pointerDownAnimation: () => void;
-    /**
-     * Function called to generate a pointer up animation
-     */
-    pointerUpAnimation: () => void;
-    private _image;
-    /**
-     * Returns the image part of the button (if any)
-     */
-    get image(): Nullable<Image>;
-    private _textBlock;
-    /**
-     * Returns the TextBlock part of the button (if any)
-     */
-    get textBlock(): Nullable<TextBlock>;
-    /**
-     * Creates a new Button
-     * @param name defines the name of the button
-     */
-    constructor(name?: string | undefined);
-    protected _getTypeName(): string;
-    /**
-     * @internal
-     */
-    _processPicking(x: number, y: number, pi: PointerInfoBase, type: number, pointerId: number, buttonIndex: number, deltaX?: number, deltaY?: number): boolean;
-    /**
-     * @internal
-     */
-    _onPointerEnter(target: Control, pi: PointerInfoBase): boolean;
-    /**
-     * @internal
-     */
-    _onPointerOut(target: Control, pi: PointerInfoBase, force?: boolean): void;
-    /**
-     * @internal
-     */
-    _onPointerDown(target: Control, coordinates: Vector2, pointerId: number, buttonIndex: number, pi: PointerInfoBase): boolean;
-    protected _getRectangleFill(context: ICanvasRenderingContext): string | CanvasGradient;
-    /**
-     * @internal
-     */
-    _onPointerUp(target: Control, coordinates: Vector2, pointerId: number, buttonIndex: number, notifyClick: boolean, pi: PointerInfoBase): void;
-    /**
-     * Serializes the current button
-     * @param serializationObject defines the JSON serialized object
-     * @param force force serialization even if isSerializable === false
-     * @param allowCanvas defines if the control is allowed to use a Canvas2D object to serialize
-     */
-    serialize(serializationObject: any, force: boolean, allowCanvas: boolean): void;
-    /**
-     * @internal
-     */
-    _parseFromContent(serializedObject: any, host: AdvancedDynamicTexture): void;
-    /**
-     * Creates a new button made with an image and a text
-     * @param name defines the name of the button
-     * @param text defines the text of the button
-     * @param imageUrl defines the url of the image
-     * @returns a new Button
-     */
-    static CreateImageButton(name: string, text: string, imageUrl: string): Button;
-    /**
-     * Creates a new button made with an image
-     * @param name defines the name of the button
-     * @param imageUrl defines the url of the image
-     * @returns a new Button
-     */
-    static CreateImageOnlyButton(name: string, imageUrl: string): Button;
-    /**
-     * Creates a new button made with a text
-     * @param name defines the name of the button
-     * @param text defines the text of the button
-     * @returns a new Button
-     */
-    static CreateSimpleButton(name: string, text: string): Button;
-    /**
-     * Creates a new button made with an image and a centered text
-     * @param name defines the name of the button
-     * @param text defines the text of the button
-     * @param imageUrl defines the url of the image
-     * @returns a new Button
-     */
-    static CreateImageWithCenterTextButton(name: string, text: string, imageUrl: string): Button;
-}
+export * from "./button.pure.js";

package/2D/controls/button.js

@@ -1,246 +1,8 @@
-import { Rectangle } from "./rectangle.js";
-import { Control } from "./control.js";
-import { TextBlock } from "./textBlock.js";
-import { Image } from "./image.js";
-import { RegisterClass } from "@babylonjs/core/Misc/typeStore.js";
 /**
- * Class used to create 2D buttons
+ * Re-exports the pure implementation and applies the runtime registration side effect.
+ * Import "./button.pure" for tree-shakeable, side-effect-free usage.
  */
-export class Button extends Rectangle {
-    /**
-     * Returns the image part of the button (if any)
-     */
-    get image() {
-        return this._image;
-    }
-    /**
-     * Returns the TextBlock part of the button (if any)
-     */
-    get textBlock() {
-        return this._textBlock;
-    }
-    /**
-     * Creates a new Button
-     * @param name defines the name of the button
-     */
-    constructor(name) {
-        super(name);
-        this.name = name;
-        this.thickness = 1;
-        this.isPointerBlocker = true;
-        let alphaStore = null;
-        this.pointerEnterAnimation = () => {
-            alphaStore = this.alpha;
-            this.alpha -= 0.1;
-        };
-        this.pointerOutAnimation = () => {
-            if (alphaStore !== null) {
-                this.alpha = alphaStore;
-            }
-        };
-        this.pointerDownAnimation = () => {
-            this.scaleX -= 0.05;
-            this.scaleY -= 0.05;
-        };
-        this.pointerUpAnimation = () => {
-            this.scaleX += 0.05;
-            this.scaleY += 0.05;
-        };
-    }
-    _getTypeName() {
-        return "Button";
-    }
-    // While being a container, the button behaves like a control.
-    /**
-     * @internal
-     */
-    _processPicking(x, y, pi, type, pointerId, buttonIndex, deltaX, deltaY) {
-        if (!this._isEnabled || !this.isHitTestVisible || !this.isVisible || this.notRenderable) {
-            return false;
-        }
-        if (!super.contains(x, y)) {
-            return false;
-        }
-        if (this.delegatePickingToChildren) {
-            let contains = false;
-            for (let index = this._children.length - 1; index >= 0; index--) {
-                const child = this._children[index];
-                if (child.isEnabled && child.isHitTestVisible && child.isVisible && !child.notRenderable && child.contains(x, y)) {
-                    contains = true;
-                    break;
-                }
-            }
-            if (!contains) {
-                return false;
-            }
-        }
-        this._processObservables(type, x, y, pi, pointerId, buttonIndex, deltaX, deltaY);
-        return true;
-    }
-    /**
-     * @internal
-     */
-    _onPointerEnter(target, pi) {
-        if (!super._onPointerEnter(target, pi)) {
-            return false;
-        }
-        if (!this.isReadOnly && this.pointerEnterAnimation) {
-            this.pointerEnterAnimation();
-        }
-        return true;
-    }
-    /**
-     * @internal
-     */
-    _onPointerOut(target, pi, force = false) {
-        if (!this.isReadOnly && this.pointerOutAnimation) {
-            this.pointerOutAnimation();
-        }
-        super._onPointerOut(target, pi, force);
-    }
-    /**
-     * @internal
-     */
-    _onPointerDown(target, coordinates, pointerId, buttonIndex, pi) {
-        if (!super._onPointerDown(target, coordinates, pointerId, buttonIndex, pi)) {
-            return false;
-        }
-        if (!this.isReadOnly && this.pointerDownAnimation) {
-            this.pointerDownAnimation();
-        }
-        return true;
-    }
-    _getRectangleFill(context) {
-        if (this.isEnabled) {
-            return this._getBackgroundColor(context);
-        }
-        else {
-            return this._disabledColor;
-        }
-    }
-    /**
-     * @internal
-     */
-    _onPointerUp(target, coordinates, pointerId, buttonIndex, notifyClick, pi) {
-        if (!this.isReadOnly && this.pointerUpAnimation) {
-            this.pointerUpAnimation();
-        }
-        super._onPointerUp(target, coordinates, pointerId, buttonIndex, notifyClick, pi);
-    }
-    /**
-     * Serializes the current button
-     * @param serializationObject defines the JSON serialized object
-     * @param force force serialization even if isSerializable === false
-     * @param allowCanvas defines if the control is allowed to use a Canvas2D object to serialize
-     */
-    serialize(serializationObject, force, allowCanvas) {
-        super.serialize(serializationObject, force, allowCanvas);
-        if (!this.isSerializable && !force) {
-            return;
-        }
-        if (this._textBlock) {
-            serializationObject.textBlockName = this._textBlock.name;
-        }
-        if (this._image) {
-            serializationObject.imageName = this._image.name;
-        }
-    }
-    /**
-     * @internal
-     */
-    _parseFromContent(serializedObject, host) {
-        super._parseFromContent(serializedObject, host);
-        if (serializedObject.textBlockName) {
-            this._textBlock = this.getChildByName(serializedObject.textBlockName);
-        }
-        if (serializedObject.imageName) {
-            this._image = this.getChildByName(serializedObject.imageName);
-        }
-    }
-    // Statics
-    /**
-     * Creates a new button made with an image and a text
-     * @param name defines the name of the button
-     * @param text defines the text of the button
-     * @param imageUrl defines the url of the image
-     * @returns a new Button
-     */
-    static CreateImageButton(name, text, imageUrl) {
-        const result = new this(name);
-        // Adding text
-        const textBlock = new TextBlock(name + "_button", text);
-        textBlock.textWrapping = true;
-        textBlock.textHorizontalAlignment = Control.HORIZONTAL_ALIGNMENT_CENTER;
-        textBlock.paddingLeft = "20%";
-        result.addControl(textBlock);
-        // Adding image
-        const iconImage = new Image(name + "_icon", imageUrl);
-        iconImage.width = "20%";
-        iconImage.stretch = Image.STRETCH_UNIFORM;
-        iconImage.horizontalAlignment = Control.HORIZONTAL_ALIGNMENT_LEFT;
-        result.addControl(iconImage);
-        // Store
-        result._image = iconImage;
-        result._textBlock = textBlock;
-        return result;
-    }
-    /**
-     * Creates a new button made with an image
-     * @param name defines the name of the button
-     * @param imageUrl defines the url of the image
-     * @returns a new Button
-     */
-    static CreateImageOnlyButton(name, imageUrl) {
-        const result = new this(name);
-        // Adding image
-        const iconImage = new Image(name + "_icon", imageUrl);
-        iconImage.stretch = Image.STRETCH_FILL;
-        iconImage.horizontalAlignment = Control.HORIZONTAL_ALIGNMENT_LEFT;
-        result.addControl(iconImage);
-        // Store
-        result._image = iconImage;
-        return result;
-    }
-    /**
-     * Creates a new button made with a text
-     * @param name defines the name of the button
-     * @param text defines the text of the button
-     * @returns a new Button
-     */
-    static CreateSimpleButton(name, text) {
-        const result = new this(name);
-        // Adding text
-        const textBlock = new TextBlock(name + "_button", text);
-        textBlock.textWrapping = true;
-        textBlock.textHorizontalAlignment = Control.HORIZONTAL_ALIGNMENT_CENTER;
-        result.addControl(textBlock);
-        // Store
-        result._textBlock = textBlock;
-        return result;
-    }
-    /**
-     * Creates a new button made with an image and a centered text
-     * @param name defines the name of the button
-     * @param text defines the text of the button
-     * @param imageUrl defines the url of the image
-     * @returns a new Button
-     */
-    static CreateImageWithCenterTextButton(name, text, imageUrl) {
-        const result = new this(name);
-        // Adding image
-        const iconImage = new Image(name + "_icon", imageUrl);
-        iconImage.stretch = Image.STRETCH_FILL;
-        result.addControl(iconImage);
-        // Adding text
-        const textBlock = new TextBlock(name + "_button", text);
-        textBlock.textWrapping = true;
-        textBlock.textHorizontalAlignment = Control.HORIZONTAL_ALIGNMENT_CENTER;
-        result.addControl(textBlock);
-        // Store
-        result._image = iconImage;
-        result._textBlock = textBlock;
-        return result;
-    }
-}
-RegisterClass("BABYLON.GUI.Button", Button);
+export * from "./button.pure.js";
+import { RegisterButton } from "./button.pure.js";
+RegisterButton();
 //# sourceMappingURL=button.js.map

package/2D/controls/button.js.map

@@ -1 +1 @@
-{"version":3,"file":"button.js","sourceRoot":"","sources":["../../../../../dev/gui/src/2D/controls/button.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAKpD;;GAEG;AACH,MAAM,OAAO,MAAO,SAAQ,SAAS;IAmBjC;;OAEG;IACH,IAAW,KAAK;QACZ,OAAO,IAAI,CAAC,MAAM,CAAC;IACvB,CAAC;IAGD;;OAEG;IACH,IAAW,SAAS;QAChB,OAAO,IAAI,CAAC,UAAU,CAAC;IAC3B,CAAC;IAED;;;OAGG;IACH,YAA4B,IAAa;QACrC,KAAK,CAAC,IAAI,CAAC,CAAC;QADY,SAAI,GAAJ,IAAI,CAAS;QAGrC,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC;QACnB,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC;QAE7B,IAAI,UAAU,GAAqB,IAAI,CAAC;QAExC,IAAI,CAAC,qBAAqB,GAAG,GAAG,EAAE;YAC9B,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC;YACxB,IAAI,CAAC,KAAK,IAAI,GAAG,CAAC;QACtB,CAAC,CAAC;QAEF,IAAI,CAAC,mBAAmB,GAAG,GAAG,EAAE;YAC5B,IAAI,UAAU,KAAK,IAAI,EAAE,CAAC;gBACtB,IAAI,CAAC,KAAK,GAAG,UAAU,CAAC;YAC5B,CAAC;QACL,CAAC,CAAC;QAEF,IAAI,CAAC,oBAAoB,GAAG,GAAG,EAAE;YAC7B,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC;YACpB,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC;QACxB,CAAC,CAAC;QAEF,IAAI,CAAC,kBAAkB,GAAG,GAAG,EAAE;YAC3B,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC;YACpB,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC;QACxB,CAAC,CAAC;IACN,CAAC;IAEkB,YAAY;QAC3B,OAAO,QAAQ,CAAC;IACpB,CAAC;IAED,8DAA8D;IAC9D;;OAEG;IACa,eAAe,CAAC,CAAS,EAAE,CAAS,EAAE,EAAmB,EAAE,IAAY,EAAE,SAAiB,EAAE,WAAmB,EAAE,MAAe,EAAE,MAAe;QAC7J,IAAI,CAAC,IAAI,CAAC,UAAU,IAAI,CAAC,IAAI,CAAC,gBAAgB,IAAI,CAAC,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YACtF,OAAO,KAAK,CAAC;QACjB,CAAC;QAED,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;YACxB,OAAO,KAAK,CAAC;QACjB,CAAC;QAED,IAAI,IAAI,CAAC,yBAAyB,EAAE,CAAC;YACjC,IAAI,QAAQ,GAAG,KAAK,CAAC;YACrB,KAAK,IAAI,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,KAAK,IAAI,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC;gBAC9D,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;gBACpC,IAAI,KAAK,CAAC,SAAS,IAAI,KAAK,CAAC,gBAAgB,IAAI,KAAK,CAAC,SAAS,IAAI,CAAC,KAAK,CAAC,aAAa,IAAI,KAAK,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;oBAC/G,QAAQ,GAAG,IAAI,CAAC;oBAChB,MAAM;gBACV,CAAC;YACL,CAAC;YAED,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACZ,OAAO,KAAK,CAAC;YACjB,CAAC;QACL,CAAC;QAED,IAAI,CAAC,mBAAmB,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;QAEjF,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;OAEG;IACa,eAAe,CAAC,MAAe,EAAE,EAAmB;QAChE,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;YACrC,OAAO,KAAK,CAAC;QACjB,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,qBAAqB,EAAE,CAAC;YACjD,IAAI,CAAC,qBAAqB,EAAE,CAAC;QACjC,CAAC;QAED,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;OAEG;IACa,aAAa,CAAC,MAAe,EAAE,EAAmB,EAAE,KAAK,GAAG,KAAK;QAC7E,IAAI,CAAC,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,mBAAmB,EAAE,CAAC;YAC/C,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAC/B,CAAC;QAED,KAAK,CAAC,aAAa,CAAC,MAAM,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;IAC3C,CAAC;IAED;;OAEG;IACa,cAAc,CAAC,MAAe,EAAE,WAAoB,EAAE,SAAiB,EAAE,WAAmB,EAAE,EAAmB;QAC7H,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,MAAM,EAAE,WAAW,EAAE,SAAS,EAAE,WAAW,EAAE,EAAE,CAAC,EAAE,CAAC;YACzE,OAAO,KAAK,CAAC;QACjB,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAChD,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAChC,CAAC;QAED,OAAO,IAAI,CAAC;IAChB,CAAC;IAEkB,iBAAiB,CAAC,OAAgC;QACjE,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACjB,OAAO,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;QAC7C,CAAC;aAAM,CAAC;YACJ,OAAO,IAAI,CAAC,cAAc,CAAC;QAC/B,CAAC;IACL,CAAC;IAED;;OAEG;IACa,YAAY,CAAC,MAAe,EAAE,WAAoB,EAAE,SAAiB,EAAE,WAAmB,EAAE,WAAoB,EAAE,EAAmB;QACjJ,IAAI,CAAC,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC;YAC9C,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAC9B,CAAC;QAED,KAAK,CAAC,YAAY,CAAC,MAAM,EAAE,WAAW,EAAE,SAAS,EAAE,WAAW,EAAE,WAAW,EAAE,EAAE,CAAC,CAAC;IACrF,CAAC;IAED;;;;;OAKG;IACa,SAAS,CAAC,mBAAwB,EAAE,KAAc,EAAE,WAAoB;QACpF,KAAK,CAAC,SAAS,CAAC,mBAAmB,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC;QACzD,IAAI,CAAC,IAAI,CAAC,cAAc,IAAI,CAAC,KAAK,EAAE,CAAC;YACjC,OAAO;QACX,CAAC;QAED,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YAClB,mBAAmB,CAAC,aAAa,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;QAC7D,CAAC;QACD,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YACd,mBAAmB,CAAC,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;QACrD,CAAC;IACL,CAAC;IAED;;OAEG;IACa,iBAAiB,CAAC,gBAAqB,EAAE,IAA4B;QACjF,KAAK,CAAC,iBAAiB,CAAC,gBAAgB,EAAE,IAAI,CAAC,CAAC;QAEhD,IAAI,gBAAgB,CAAC,aAAa,EAAE,CAAC;YACjC,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,cAAc,CAAC,gBAAgB,CAAC,aAAa,CAAwB,CAAC;QACjG,CAAC;QAED,IAAI,gBAAgB,CAAC,SAAS,EAAE,CAAC;YAC7B,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,cAAc,CAAC,gBAAgB,CAAC,SAAS,CAAoB,CAAC;QACrF,CAAC;IACL,CAAC;IAED,UAAU;IACV;;;;;;OAMG;IACI,MAAM,CAAC,iBAAiB,CAAC,IAAY,EAAE,IAAY,EAAE,QAAgB;QACxE,MAAM,MAAM,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC;QAE9B,cAAc;QACd,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,IAAI,GAAG,SAAS,EAAE,IAAI,CAAC,CAAC;QACxD,SAAS,CAAC,YAAY,GAAG,IAAI,CAAC;QAC9B,SAAS,CAAC,uBAAuB,GAAG,OAAO,CAAC,2BAA2B,CAAC;QACxE,SAAS,CAAC,WAAW,GAAG,KAAK,CAAC;QAC9B,MAAM,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;QAE7B,eAAe;QACf,MAAM,SAAS,GAAG,IAAI,KAAK,CAAC,IAAI,GAAG,OAAO,EAAE,QAAQ,CAAC,CAAC;QACtD,SAAS,CAAC,KAAK,GAAG,KAAK,CAAC;QACxB,SAAS,CAAC,OAAO,GAAG,KAAK,CAAC,eAAe,CAAC;QAC1C,SAAS,CAAC,mBAAmB,GAAG,OAAO,CAAC,yBAAyB,CAAC;QAClE,MAAM,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;QAE7B,QAAQ;QACR,MAAM,CAAC,MAAM,GAAG,SAAS,CAAC;QAC1B,MAAM,CAAC,UAAU,GAAG,SAAS,CAAC;QAE9B,OAAO,MAAM,CAAC;IAClB,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,qBAAqB,CAAC,IAAY,EAAE,QAAgB;QAC9D,MAAM,MAAM,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC;QAE9B,eAAe;QACf,MAAM,SAAS,GAAG,IAAI,KAAK,CAAC,IAAI,GAAG,OAAO,EAAE,QAAQ,CAAC,CAAC;QACtD,SAAS,CAAC,OAAO,GAAG,KAAK,CAAC,YAAY,CAAC;QACvC,SAAS,CAAC,mBAAmB,GAAG,OAAO,CAAC,yBAAyB,CAAC;QAClE,MAAM,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;QAE7B,QAAQ;QACR,MAAM,CAAC,MAAM,GAAG,SAAS,CAAC;QAE1B,OAAO,MAAM,CAAC;IAClB,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,kBAAkB,CAAC,IAAY,EAAE,IAAY;QACvD,MAAM,MAAM,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC;QAE9B,cAAc;QACd,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,IAAI,GAAG,SAAS,EAAE,IAAI,CAAC,CAAC;QACxD,SAAS,CAAC,YAAY,GAAG,IAAI,CAAC;QAC9B,SAAS,CAAC,uBAAuB,GAAG,OAAO,CAAC,2BAA2B,CAAC;QACxE,MAAM,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;QAE7B,QAAQ;QACR,MAAM,CAAC,UAAU,GAAG,SAAS,CAAC;QAE9B,OAAO,MAAM,CAAC;IAClB,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,+BAA+B,CAAC,IAAY,EAAE,IAAY,EAAE,QAAgB;QACtF,MAAM,MAAM,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC;QAE9B,eAAe;QACf,MAAM,SAAS,GAAG,IAAI,KAAK,CAAC,IAAI,GAAG,OAAO,EAAE,QAAQ,CAAC,CAAC;QACtD,SAAS,CAAC,OAAO,GAAG,KAAK,CAAC,YAAY,CAAC;QACvC,MAAM,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;QAE7B,cAAc;QACd,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,IAAI,GAAG,SAAS,EAAE,IAAI,CAAC,CAAC;QACxD,SAAS,CAAC,YAAY,GAAG,IAAI,CAAC;QAC9B,SAAS,CAAC,uBAAuB,GAAG,OAAO,CAAC,2BAA2B,CAAC;QACxE,MAAM,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;QAE7B,QAAQ;QACR,MAAM,CAAC,MAAM,GAAG,SAAS,CAAC;QAC1B,MAAM,CAAC,UAAU,GAAG,SAAS,CAAC;QAE9B,OAAO,MAAM,CAAC;IAClB,CAAC;CACJ;AACD,aAAa,CAAC,oBAAoB,EAAE,MAAM,CAAC,CAAC","sourcesContent":["import { type Nullable } from \"core/types\";\r\nimport { type Vector2 } from \"core/Maths/math.vector\";\r\n\r\nimport { Rectangle } from \"./rectangle\";\r\nimport { Control } from \"./control\";\r\nimport { TextBlock } from \"./textBlock\";\r\nimport { Image } from \"./image\";\r\nimport { RegisterClass } from \"core/Misc/typeStore\";\r\nimport { type PointerInfoBase } from \"core/Events/pointerEvents\";\r\nimport { type AdvancedDynamicTexture } from \"../advancedDynamicTexture\";\r\nimport { type ICanvasRenderingContext } from \"core/Engines/ICanvas\";\r\n\r\n/**\r\n * Class used to create 2D buttons\r\n */\r\nexport class Button extends Rectangle {\r\n    /**\r\n     * Function called to generate a pointer enter animation\r\n     */\r\n    public pointerEnterAnimation: () => void;\r\n    /**\r\n     * Function called to generate a pointer out animation\r\n     */\r\n    public pointerOutAnimation: () => void;\r\n    /**\r\n     * Function called to generate a pointer down animation\r\n     */\r\n    public pointerDownAnimation: () => void;\r\n    /**\r\n     * Function called to generate a pointer up animation\r\n     */\r\n    public pointerUpAnimation: () => void;\r\n\r\n    private _image: Nullable<Image>;\r\n    /**\r\n     * Returns the image part of the button (if any)\r\n     */\r\n    public get image(): Nullable<Image> {\r\n        return this._image;\r\n    }\r\n\r\n    private _textBlock: Nullable<TextBlock>;\r\n    /**\r\n     * Returns the TextBlock part of the button (if any)\r\n     */\r\n    public get textBlock(): Nullable<TextBlock> {\r\n        return this._textBlock;\r\n    }\r\n\r\n    /**\r\n     * Creates a new Button\r\n     * @param name defines the name of the button\r\n     */\r\n    constructor(public override name?: string) {\r\n        super(name);\r\n\r\n        this.thickness = 1;\r\n        this.isPointerBlocker = true;\r\n\r\n        let alphaStore: Nullable<number> = null;\r\n\r\n        this.pointerEnterAnimation = () => {\r\n            alphaStore = this.alpha;\r\n            this.alpha -= 0.1;\r\n        };\r\n\r\n        this.pointerOutAnimation = () => {\r\n            if (alphaStore !== null) {\r\n                this.alpha = alphaStore;\r\n            }\r\n        };\r\n\r\n        this.pointerDownAnimation = () => {\r\n            this.scaleX -= 0.05;\r\n            this.scaleY -= 0.05;\r\n        };\r\n\r\n        this.pointerUpAnimation = () => {\r\n            this.scaleX += 0.05;\r\n            this.scaleY += 0.05;\r\n        };\r\n    }\r\n\r\n    protected override _getTypeName(): string {\r\n        return \"Button\";\r\n    }\r\n\r\n    // While being a container, the button behaves like a control.\r\n    /**\r\n     * @internal\r\n     */\r\n    public override _processPicking(x: number, y: number, pi: PointerInfoBase, type: number, pointerId: number, buttonIndex: number, deltaX?: number, deltaY?: number): boolean {\r\n        if (!this._isEnabled || !this.isHitTestVisible || !this.isVisible || this.notRenderable) {\r\n            return false;\r\n        }\r\n\r\n        if (!super.contains(x, y)) {\r\n            return false;\r\n        }\r\n\r\n        if (this.delegatePickingToChildren) {\r\n            let contains = false;\r\n            for (let index = this._children.length - 1; index >= 0; index--) {\r\n                const child = this._children[index];\r\n                if (child.isEnabled && child.isHitTestVisible && child.isVisible && !child.notRenderable && child.contains(x, y)) {\r\n                    contains = true;\r\n                    break;\r\n                }\r\n            }\r\n\r\n            if (!contains) {\r\n                return false;\r\n            }\r\n        }\r\n\r\n        this._processObservables(type, x, y, pi, pointerId, buttonIndex, deltaX, deltaY);\r\n\r\n        return true;\r\n    }\r\n\r\n    /**\r\n     * @internal\r\n     */\r\n    public override _onPointerEnter(target: Control, pi: PointerInfoBase): boolean {\r\n        if (!super._onPointerEnter(target, pi)) {\r\n            return false;\r\n        }\r\n\r\n        if (!this.isReadOnly && this.pointerEnterAnimation) {\r\n            this.pointerEnterAnimation();\r\n        }\r\n\r\n        return true;\r\n    }\r\n\r\n    /**\r\n     * @internal\r\n     */\r\n    public override _onPointerOut(target: Control, pi: PointerInfoBase, force = false): void {\r\n        if (!this.isReadOnly && this.pointerOutAnimation) {\r\n            this.pointerOutAnimation();\r\n        }\r\n\r\n        super._onPointerOut(target, pi, force);\r\n    }\r\n\r\n    /**\r\n     * @internal\r\n     */\r\n    public override _onPointerDown(target: Control, coordinates: Vector2, pointerId: number, buttonIndex: number, pi: PointerInfoBase): boolean {\r\n        if (!super._onPointerDown(target, coordinates, pointerId, buttonIndex, pi)) {\r\n            return false;\r\n        }\r\n\r\n        if (!this.isReadOnly && this.pointerDownAnimation) {\r\n            this.pointerDownAnimation();\r\n        }\r\n\r\n        return true;\r\n    }\r\n\r\n    protected override _getRectangleFill(context: ICanvasRenderingContext) {\r\n        if (this.isEnabled) {\r\n            return this._getBackgroundColor(context);\r\n        } else {\r\n            return this._disabledColor;\r\n        }\r\n    }\r\n\r\n    /**\r\n     * @internal\r\n     */\r\n    public override _onPointerUp(target: Control, coordinates: Vector2, pointerId: number, buttonIndex: number, notifyClick: boolean, pi: PointerInfoBase): void {\r\n        if (!this.isReadOnly && this.pointerUpAnimation) {\r\n            this.pointerUpAnimation();\r\n        }\r\n\r\n        super._onPointerUp(target, coordinates, pointerId, buttonIndex, notifyClick, pi);\r\n    }\r\n\r\n    /**\r\n     * Serializes the current button\r\n     * @param serializationObject defines the JSON serialized object\r\n     * @param force force serialization even if isSerializable === false\r\n     * @param allowCanvas defines if the control is allowed to use a Canvas2D object to serialize\r\n     */\r\n    public override serialize(serializationObject: any, force: boolean, allowCanvas: boolean) {\r\n        super.serialize(serializationObject, force, allowCanvas);\r\n        if (!this.isSerializable && !force) {\r\n            return;\r\n        }\r\n\r\n        if (this._textBlock) {\r\n            serializationObject.textBlockName = this._textBlock.name;\r\n        }\r\n        if (this._image) {\r\n            serializationObject.imageName = this._image.name;\r\n        }\r\n    }\r\n\r\n    /**\r\n     * @internal\r\n     */\r\n    public override _parseFromContent(serializedObject: any, host: AdvancedDynamicTexture) {\r\n        super._parseFromContent(serializedObject, host);\r\n\r\n        if (serializedObject.textBlockName) {\r\n            this._textBlock = this.getChildByName(serializedObject.textBlockName) as Nullable<TextBlock>;\r\n        }\r\n\r\n        if (serializedObject.imageName) {\r\n            this._image = this.getChildByName(serializedObject.imageName) as Nullable<Image>;\r\n        }\r\n    }\r\n\r\n    // Statics\r\n    /**\r\n     * Creates a new button made with an image and a text\r\n     * @param name defines the name of the button\r\n     * @param text defines the text of the button\r\n     * @param imageUrl defines the url of the image\r\n     * @returns a new Button\r\n     */\r\n    public static CreateImageButton(name: string, text: string, imageUrl: string): Button {\r\n        const result = new this(name);\r\n\r\n        // Adding text\r\n        const textBlock = new TextBlock(name + \"_button\", text);\r\n        textBlock.textWrapping = true;\r\n        textBlock.textHorizontalAlignment = Control.HORIZONTAL_ALIGNMENT_CENTER;\r\n        textBlock.paddingLeft = \"20%\";\r\n        result.addControl(textBlock);\r\n\r\n        // Adding image\r\n        const iconImage = new Image(name + \"_icon\", imageUrl);\r\n        iconImage.width = \"20%\";\r\n        iconImage.stretch = Image.STRETCH_UNIFORM;\r\n        iconImage.horizontalAlignment = Control.HORIZONTAL_ALIGNMENT_LEFT;\r\n        result.addControl(iconImage);\r\n\r\n        // Store\r\n        result._image = iconImage;\r\n        result._textBlock = textBlock;\r\n\r\n        return result;\r\n    }\r\n\r\n    /**\r\n     * Creates a new button made with an image\r\n     * @param name defines the name of the button\r\n     * @param imageUrl defines the url of the image\r\n     * @returns a new Button\r\n     */\r\n    public static CreateImageOnlyButton(name: string, imageUrl: string): Button {\r\n        const result = new this(name);\r\n\r\n        // Adding image\r\n        const iconImage = new Image(name + \"_icon\", imageUrl);\r\n        iconImage.stretch = Image.STRETCH_FILL;\r\n        iconImage.horizontalAlignment = Control.HORIZONTAL_ALIGNMENT_LEFT;\r\n        result.addControl(iconImage);\r\n\r\n        // Store\r\n        result._image = iconImage;\r\n\r\n        return result;\r\n    }\r\n\r\n    /**\r\n     * Creates a new button made with a text\r\n     * @param name defines the name of the button\r\n     * @param text defines the text of the button\r\n     * @returns a new Button\r\n     */\r\n    public static CreateSimpleButton(name: string, text: string): Button {\r\n        const result = new this(name);\r\n\r\n        // Adding text\r\n        const textBlock = new TextBlock(name + \"_button\", text);\r\n        textBlock.textWrapping = true;\r\n        textBlock.textHorizontalAlignment = Control.HORIZONTAL_ALIGNMENT_CENTER;\r\n        result.addControl(textBlock);\r\n\r\n        // Store\r\n        result._textBlock = textBlock;\r\n\r\n        return result;\r\n    }\r\n\r\n    /**\r\n     * Creates a new button made with an image and a centered text\r\n     * @param name defines the name of the button\r\n     * @param text defines the text of the button\r\n     * @param imageUrl defines the url of the image\r\n     * @returns a new Button\r\n     */\r\n    public static CreateImageWithCenterTextButton(name: string, text: string, imageUrl: string): Button {\r\n        const result = new this(name);\r\n\r\n        // Adding image\r\n        const iconImage = new Image(name + \"_icon\", imageUrl);\r\n        iconImage.stretch = Image.STRETCH_FILL;\r\n        result.addControl(iconImage);\r\n\r\n        // Adding text\r\n        const textBlock = new TextBlock(name + \"_button\", text);\r\n        textBlock.textWrapping = true;\r\n        textBlock.textHorizontalAlignment = Control.HORIZONTAL_ALIGNMENT_CENTER;\r\n        result.addControl(textBlock);\r\n\r\n        // Store\r\n        result._image = iconImage;\r\n        result._textBlock = textBlock;\r\n\r\n        return result;\r\n    }\r\n}\r\nRegisterClass(\"BABYLON.GUI.Button\", Button);\r\n"]}
+{"version":3,"file":"button.js","sourceRoot":"","sources":["../../../../../dev/gui/src/2D/controls/button.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,cAAc,eAAe,CAAC;AAE9B,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAC/C,cAAc,EAAE,CAAC","sourcesContent":["/**\r\n * Re-exports the pure implementation and applies the runtime registration side effect.\r\n * Import \"./button.pure\" for tree-shakeable, side-effect-free usage.\r\n */\r\nexport * from \"./button.pure\";\r\n\r\nimport { RegisterButton } from \"./button.pure\";\r\nRegisterButton();\r\n"]}

package/2D/controls/button.pure.d.ts

@@ -0,0 +1,114 @@
+import { type Nullable } from "@babylonjs/core/types.js";
+import { type Vector2 } from "@babylonjs/core/Maths/math.vector.pure.js";
+import { Rectangle } from "./rectangle.pure.js";
+import { Control } from "./control.pure.js";
+import { TextBlock } from "./textBlock.pure.js";
+import { Image } from "./image.pure.js";
+import { type PointerInfoBase } from "@babylonjs/core/Events/pointerEvents.js";
+import { type AdvancedDynamicTexture } from "../advancedDynamicTexture.js";
+import { type ICanvasRenderingContext } from "@babylonjs/core/Engines/ICanvas.js";
+/**
+ * Class used to create 2D buttons
+ */
+export declare class Button extends Rectangle {
+    name?: string | undefined;
+    /**
+     * Function called to generate a pointer enter animation
+     */
+    pointerEnterAnimation: () => void;
+    /**
+     * Function called to generate a pointer out animation
+     */
+    pointerOutAnimation: () => void;
+    /**
+     * Function called to generate a pointer down animation
+     */
+    pointerDownAnimation: () => void;
+    /**
+     * Function called to generate a pointer up animation
+     */
+    pointerUpAnimation: () => void;
+    private _image;
+    /**
+     * Returns the image part of the button (if any)
+     */
+    get image(): Nullable<Image>;
+    private _textBlock;
+    /**
+     * Returns the TextBlock part of the button (if any)
+     */
+    get textBlock(): Nullable<TextBlock>;
+    /**
+     * Creates a new Button
+     * @param name defines the name of the button
+     */
+    constructor(name?: string | undefined);
+    protected _getTypeName(): string;
+    /**
+     * @internal
+     */
+    _processPicking(x: number, y: number, pi: PointerInfoBase, type: number, pointerId: number, buttonIndex: number, deltaX?: number, deltaY?: number): boolean;
+    /**
+     * @internal
+     */
+    _onPointerEnter(target: Control, pi: PointerInfoBase): boolean;
+    /**
+     * @internal
+     */
+    _onPointerOut(target: Control, pi: PointerInfoBase, force?: boolean): void;
+    /**
+     * @internal
+     */
+    _onPointerDown(target: Control, coordinates: Vector2, pointerId: number, buttonIndex: number, pi: PointerInfoBase): boolean;
+    protected _getRectangleFill(context: ICanvasRenderingContext): string | CanvasGradient;
+    /**
+     * @internal
+     */
+    _onPointerUp(target: Control, coordinates: Vector2, pointerId: number, buttonIndex: number, notifyClick: boolean, pi: PointerInfoBase): void;
+    /**
+     * Serializes the current button
+     * @param serializationObject defines the JSON serialized object
+     * @param force force serialization even if isSerializable === false
+     * @param allowCanvas defines if the control is allowed to use a Canvas2D object to serialize
+     */
+    serialize(serializationObject: any, force: boolean, allowCanvas: boolean): void;
+    /**
+     * @internal
+     */
+    _parseFromContent(serializedObject: any, host: AdvancedDynamicTexture): void;
+    /**
+     * Creates a new button made with an image and a text
+     * @param name defines the name of the button
+     * @param text defines the text of the button
+     * @param imageUrl defines the url of the image
+     * @returns a new Button
+     */
+    static CreateImageButton(name: string, text: string, imageUrl: string): Button;
+    /**
+     * Creates a new button made with an image
+     * @param name defines the name of the button
+     * @param imageUrl defines the url of the image
+     * @returns a new Button
+     */
+    static CreateImageOnlyButton(name: string, imageUrl: string): Button;
+    /**
+     * Creates a new button made with a text
+     * @param name defines the name of the button
+     * @param text defines the text of the button
+     * @returns a new Button
+     */
+    static CreateSimpleButton(name: string, text: string): Button;
+    /**
+     * Creates a new button made with an image and a centered text
+     * @param name defines the name of the button
+     * @param text defines the text of the button
+     * @param imageUrl defines the url of the image
+     * @returns a new Button
+     */
+    static CreateImageWithCenterTextButton(name: string, text: string, imageUrl: string): Button;
+}
+/**
+ * Registers the Button class with the type store for serialization support.
+ * Safe to call multiple times; only the first call has an effect.
+ */
+export declare function RegisterButton(): void;