@babylonjs/gui 5.0.0-rc.1 → 5.0.0-rc.12

package/2D/valueAndUnit.d.ts

@@ -1,89 +1,89 @@
-import { Observable } from "@babylonjs/core/Misc/observable";
-import { AdvancedDynamicTexture } from "./advancedDynamicTexture";
-/**
- * Class used to specific a value and its associated unit
- */
-export declare class ValueAndUnit {
-    /** defines a boolean indicating if the value can be negative */
-    negativeValueAllowed: boolean;
-    private _value;
-    private _unit;
-    private _originalUnit;
-    /**
-     * Gets or sets a value indicating that this value will not scale accordingly with adaptive scaling property
-     * @see https://doc.babylonjs.com/how_to/gui#adaptive-scaling
-     */
-    ignoreAdaptiveScaling: boolean;
-    /**
-     * Observable event triggered each time the value or unit changes
-     */
-    onChangedObservable: Observable<void>;
-    /**
-     * Creates a new ValueAndUnit
-     * @param value defines the value to store
-     * @param unit defines the unit to store - defaults to ValueAndUnit.UNITMODE_PIXEL
-     * @param negativeValueAllowed defines a boolean indicating if the value can be negative
-     */
-    constructor(value: number, 
-    /** defines the unit to store */
-    unit?: number, 
-    /** defines a boolean indicating if the value can be negative */
-    negativeValueAllowed?: boolean);
-    /** Gets a boolean indicating if the value is a percentage */
-    get isPercentage(): boolean;
-    /** Gets a boolean indicating if the value is store as pixel */
-    get isPixel(): boolean;
-    /**
-     * Gets value (without units)
-     * @deprecated use value property instead
-     */
-    get internalValue(): number;
-    /** Gets value (without units) */
-    get value(): number;
-    /** Sets value (without units) */
-    set value(value: number);
-    /** Gets units (without value) */
-    get unit(): number;
-    /** Sets units (without value) */
-    set unit(value: number);
-    /**
-     * Gets value as pixel
-     * @param host defines the root host
-     * @param refValue defines the reference value for percentages
-     * @returns the value as pixel
-     */
-    getValueInPixel(host: AdvancedDynamicTexture, refValue: number): number;
-    /**
-     * Update the current value and unit.
-     * @param value defines the value to store
-     * @param unit defines the unit to store
-     * @returns the current ValueAndUnit
-     */
-    updateInPlace(value: number, unit?: number): ValueAndUnit;
-    /**
-     * Gets the value accordingly to its unit
-     * @param host  defines the root host
-     * @returns the value
-     */
-    getValue(host: AdvancedDynamicTexture): number;
-    /**
-     * Gets a string representation of the value
-     * @param host defines the root host
-     * @param decimals defines an optional number of decimals to display
-     * @returns a string
-     */
-    toString(host: AdvancedDynamicTexture, decimals?: number): string;
-    /**
-     * Store a value parsed from a string
-     * @param source defines the source string
-     * @returns true if the value was successfully parsed and updated
-     */
-    fromString(source: string | number): boolean;
-    private static _Regex;
-    private static _UNITMODE_PERCENTAGE;
-    private static _UNITMODE_PIXEL;
-    /** UNITMODE_PERCENTAGE */
-    static get UNITMODE_PERCENTAGE(): number;
-    /** UNITMODE_PIXEL */
-    static get UNITMODE_PIXEL(): number;
-}
+import { Observable } from "@babylonjs/core/Misc/observable.js";
+import type { AdvancedDynamicTexture } from "./advancedDynamicTexture";
+/**
+ * Class used to specific a value and its associated unit
+ */
+export declare class ValueAndUnit {
+    /** defines a boolean indicating if the value can be negative */
+    negativeValueAllowed: boolean;
+    private _value;
+    private _unit;
+    private _originalUnit;
+    /**
+     * Gets or sets a value indicating that this value will not scale accordingly with adaptive scaling property
+     * @see https://doc.babylonjs.com/how_to/gui#adaptive-scaling
+     */
+    ignoreAdaptiveScaling: boolean;
+    /**
+     * Observable event triggered each time the value or unit changes
+     */
+    onChangedObservable: Observable<void>;
+    /**
+     * Creates a new ValueAndUnit
+     * @param value defines the value to store
+     * @param unit defines the unit to store - defaults to ValueAndUnit.UNITMODE_PIXEL
+     * @param negativeValueAllowed defines a boolean indicating if the value can be negative
+     */
+    constructor(value: number, 
+    /** defines the unit to store */
+    unit?: number, 
+    /** defines a boolean indicating if the value can be negative */
+    negativeValueAllowed?: boolean);
+    /** Gets a boolean indicating if the value is a percentage */
+    get isPercentage(): boolean;
+    /** Gets a boolean indicating if the value is store as pixel */
+    get isPixel(): boolean;
+    /**
+     * Gets value (without units)
+     * @deprecated use value property instead
+     */
+    get internalValue(): number;
+    /** Gets value (without units) */
+    get value(): number;
+    /** Sets value (without units) */
+    set value(value: number);
+    /** Gets units (without value) */
+    get unit(): number;
+    /** Sets units (without value) */
+    set unit(value: number);
+    /**
+     * Gets value as pixel
+     * @param host defines the root host
+     * @param refValue defines the reference value for percentages
+     * @returns the value as pixel
+     */
+    getValueInPixel(host: AdvancedDynamicTexture, refValue: number): number;
+    /**
+     * Update the current value and unit.
+     * @param value defines the value to store
+     * @param unit defines the unit to store
+     * @returns the current ValueAndUnit
+     */
+    updateInPlace(value: number, unit?: number): ValueAndUnit;
+    /**
+     * Gets the value accordingly to its unit
+     * @param host  defines the root host
+     * @returns the value
+     */
+    getValue(host: AdvancedDynamicTexture): number;
+    /**
+     * Gets a string representation of the value
+     * @param host defines the root host
+     * @param decimals defines an optional number of decimals to display
+     * @returns a string
+     */
+    toString(host: AdvancedDynamicTexture, decimals?: number): string;
+    /**
+     * Store a value parsed from a string
+     * @param source defines the source string
+     * @returns true if the value was successfully parsed and updated
+     */
+    fromString(source: string | number): boolean;
+    private static _Regex;
+    private static _UNITMODE_PERCENTAGE;
+    private static _UNITMODE_PIXEL;
+    /** UNITMODE_PERCENTAGE */
+    static get UNITMODE_PERCENTAGE(): number;
+    /** UNITMODE_PIXEL */
+    static get UNITMODE_PIXEL(): number;
+}

package/2D/valueAndUnit.js

@@ -1,223 +1,227 @@
-import { Observable } from "@babylonjs/core/Misc/observable.js";
-/**
- * Class used to specific a value and its associated unit
- */
-var ValueAndUnit = /** @class */ (function () {
-    /**
-     * Creates a new ValueAndUnit
-     * @param value defines the value to store
-     * @param unit defines the unit to store - defaults to ValueAndUnit.UNITMODE_PIXEL
-     * @param negativeValueAllowed defines a boolean indicating if the value can be negative
-     */
-    function ValueAndUnit(value, 
-    /** defines the unit to store */
-    unit, 
-    /** defines a boolean indicating if the value can be negative */
-    negativeValueAllowed) {
-        if (unit === void 0) { unit = ValueAndUnit.UNITMODE_PIXEL; }
-        if (negativeValueAllowed === void 0) { negativeValueAllowed = true; }
-        this.negativeValueAllowed = negativeValueAllowed;
-        this._value = 1;
-        this._unit = ValueAndUnit.UNITMODE_PIXEL;
-        /**
-         * Gets or sets a value indicating that this value will not scale accordingly with adaptive scaling property
-         * @see https://doc.babylonjs.com/how_to/gui#adaptive-scaling
-         */
-        this.ignoreAdaptiveScaling = false;
-        /**
-         * Observable event triggered each time the value or unit changes
-         */
-        this.onChangedObservable = new Observable();
-        this._value = value;
-        this._unit = unit;
-        this._originalUnit = unit;
-    }
-    Object.defineProperty(ValueAndUnit.prototype, "isPercentage", {
-        /** Gets a boolean indicating if the value is a percentage */
-        get: function () {
-            return this._unit === ValueAndUnit.UNITMODE_PERCENTAGE;
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(ValueAndUnit.prototype, "isPixel", {
-        /** Gets a boolean indicating if the value is store as pixel */
-        get: function () {
-            return this._unit === ValueAndUnit.UNITMODE_PIXEL;
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(ValueAndUnit.prototype, "internalValue", {
-        /**
-         * Gets value (without units)
-         * @deprecated use value property instead
-         */
-        get: function () {
-            return this._value;
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(ValueAndUnit.prototype, "value", {
-        /** Gets value (without units) */
-        get: function () {
-            return this._value;
-        },
-        /** Sets value (without units) */
-        set: function (value) {
-            if (value !== this._value) {
-                this._value = value;
-                this.onChangedObservable.notifyObservers();
-            }
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(ValueAndUnit.prototype, "unit", {
-        /** Gets units (without value) */
-        get: function () {
-            return this._unit;
-        },
-        /** Sets units (without value) */
-        set: function (value) {
-            if (value !== this._unit) {
-                this._unit = value;
-                this.onChangedObservable.notifyObservers();
-            }
-        },
-        enumerable: false,
-        configurable: true
-    });
-    /**
-     * Gets value as pixel
-     * @param host defines the root host
-     * @param refValue defines the reference value for percentages
-     * @returns the value as pixel
-     */
-    ValueAndUnit.prototype.getValueInPixel = function (host, refValue) {
-        if (this.isPixel) {
-            return this.getValue(host);
-        }
-        return this.getValue(host) * refValue;
-    };
-    /**
-     * Update the current value and unit.
-     * @param value defines the value to store
-     * @param unit defines the unit to store
-     * @returns the current ValueAndUnit
-     */
-    ValueAndUnit.prototype.updateInPlace = function (value, unit) {
-        if (unit === void 0) { unit = ValueAndUnit.UNITMODE_PIXEL; }
-        if (this.value !== value || this.unit !== unit) {
-            // set member variables to notify only once
-            this._value = value;
-            this._unit = unit;
-            this.onChangedObservable.notifyObservers();
-        }
-        return this;
-    };
-    /**
-     * Gets the value accordingly to its unit
-     * @param host  defines the root host
-     * @returns the value
-     */
-    ValueAndUnit.prototype.getValue = function (host) {
-        if (host && !this.ignoreAdaptiveScaling && this.unit !== ValueAndUnit.UNITMODE_PERCENTAGE) {
-            var width = 0;
-            var height = 0;
-            if (host.idealWidth) {
-                width = (this._value * host.getSize().width) / host.idealWidth;
-            }
-            if (host.idealHeight) {
-                height = (this._value * host.getSize().height) / host.idealHeight;
-            }
-            if (host.useSmallestIdeal && host.idealWidth && host.idealHeight) {
-                return window.innerWidth < window.innerHeight ? width : height;
-            }
-            if (host.idealWidth) { // horizontal
-                return width;
-            }
-            if (host.idealHeight) { // vertical
-                return height;
-            }
-        }
-        return this._value;
-    };
-    /**
-     * Gets a string representation of the value
-     * @param host defines the root host
-     * @param decimals defines an optional number of decimals to display
-     * @returns a string
-     */
-    ValueAndUnit.prototype.toString = function (host, decimals) {
-        switch (this._unit) {
-            case ValueAndUnit.UNITMODE_PERCENTAGE:
-                var percentage = this.getValue(host) * 100;
-                return (decimals ? percentage.toFixed(decimals) : percentage) + "%";
-            case ValueAndUnit.UNITMODE_PIXEL:
-                var pixels = this.getValue(host);
-                return (decimals ? pixels.toFixed(decimals) : pixels) + "px";
-        }
-        return this._unit.toString();
-    };
-    /**
-     * Store a value parsed from a string
-     * @param source defines the source string
-     * @returns true if the value was successfully parsed and updated
-     */
-    ValueAndUnit.prototype.fromString = function (source) {
-        var match = ValueAndUnit._Regex.exec(source.toString());
-        if (!match || match.length === 0) {
-            return false;
-        }
-        var sourceValue = parseFloat(match[1]);
-        var sourceUnit = this._originalUnit;
-        if (!this.negativeValueAllowed) {
-            if (sourceValue < 0) {
-                sourceValue = 0;
-            }
-        }
-        if (match.length === 4) {
-            switch (match[3]) {
-                case "px":
-                    sourceUnit = ValueAndUnit.UNITMODE_PIXEL;
-                    break;
-                case "%":
-                    sourceUnit = ValueAndUnit.UNITMODE_PERCENTAGE;
-                    sourceValue /= 100.0;
-                    break;
-            }
-        }
-        if (sourceValue === this._value && sourceUnit === this._unit) {
-            return false;
-        }
-        this._value = sourceValue;
-        this._unit = sourceUnit;
-        this.onChangedObservable.notifyObservers();
-        return true;
-    };
-    Object.defineProperty(ValueAndUnit, "UNITMODE_PERCENTAGE", {
-        /** UNITMODE_PERCENTAGE */
-        get: function () {
-            return ValueAndUnit._UNITMODE_PERCENTAGE;
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(ValueAndUnit, "UNITMODE_PIXEL", {
-        /** UNITMODE_PIXEL */
-        get: function () {
-            return ValueAndUnit._UNITMODE_PIXEL;
-        },
-        enumerable: false,
-        configurable: true
-    });
-    // Static
-    ValueAndUnit._Regex = /(^-?\d*(\.\d+)?)(%|px)?/;
-    ValueAndUnit._UNITMODE_PERCENTAGE = 0;
-    ValueAndUnit._UNITMODE_PIXEL = 1;
-    return ValueAndUnit;
-}());
-export { ValueAndUnit };
+import { Observable } from "@babylonjs/core/Misc/observable.js";
+/**
+ * Class used to specific a value and its associated unit
+ */
+var ValueAndUnit = /** @class */ (function () {
+    /**
+     * Creates a new ValueAndUnit
+     * @param value defines the value to store
+     * @param unit defines the unit to store - defaults to ValueAndUnit.UNITMODE_PIXEL
+     * @param negativeValueAllowed defines a boolean indicating if the value can be negative
+     */
+    function ValueAndUnit(value, 
+    /** defines the unit to store */
+    unit, 
+    /** defines a boolean indicating if the value can be negative */
+    negativeValueAllowed) {
+        if (unit === void 0) { unit = ValueAndUnit.UNITMODE_PIXEL; }
+        if (negativeValueAllowed === void 0) { negativeValueAllowed = true; }
+        this.negativeValueAllowed = negativeValueAllowed;
+        this._value = 1;
+        this._unit = ValueAndUnit.UNITMODE_PIXEL;
+        /**
+         * Gets or sets a value indicating that this value will not scale accordingly with adaptive scaling property
+         * @see https://doc.babylonjs.com/how_to/gui#adaptive-scaling
+         */
+        this.ignoreAdaptiveScaling = false;
+        /**
+         * Observable event triggered each time the value or unit changes
+         */
+        this.onChangedObservable = new Observable();
+        this._value = value;
+        this._unit = unit;
+        this._originalUnit = unit;
+    }
+    Object.defineProperty(ValueAndUnit.prototype, "isPercentage", {
+        /** Gets a boolean indicating if the value is a percentage */
+        get: function () {
+            return this._unit === ValueAndUnit.UNITMODE_PERCENTAGE;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(ValueAndUnit.prototype, "isPixel", {
+        /** Gets a boolean indicating if the value is store as pixel */
+        get: function () {
+            return this._unit === ValueAndUnit.UNITMODE_PIXEL;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(ValueAndUnit.prototype, "internalValue", {
+        /**
+         * Gets value (without units)
+         * @deprecated use value property instead
+         */
+        get: function () {
+            return this._value;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(ValueAndUnit.prototype, "value", {
+        /** Gets value (without units) */
+        get: function () {
+            return this._value;
+        },
+        /** Sets value (without units) */
+        set: function (value) {
+            if (value !== this._value) {
+                this._value = value;
+                this.onChangedObservable.notifyObservers();
+            }
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(ValueAndUnit.prototype, "unit", {
+        /** Gets units (without value) */
+        get: function () {
+            return this._unit;
+        },
+        /** Sets units (without value) */
+        set: function (value) {
+            if (value !== this._unit) {
+                this._unit = value;
+                this.onChangedObservable.notifyObservers();
+            }
+        },
+        enumerable: false,
+        configurable: true
+    });
+    /**
+     * Gets value as pixel
+     * @param host defines the root host
+     * @param refValue defines the reference value for percentages
+     * @returns the value as pixel
+     */
+    ValueAndUnit.prototype.getValueInPixel = function (host, refValue) {
+        if (this.isPixel) {
+            return this.getValue(host);
+        }
+        return this.getValue(host) * refValue;
+    };
+    /**
+     * Update the current value and unit.
+     * @param value defines the value to store
+     * @param unit defines the unit to store
+     * @returns the current ValueAndUnit
+     */
+    ValueAndUnit.prototype.updateInPlace = function (value, unit) {
+        if (unit === void 0) { unit = ValueAndUnit.UNITMODE_PIXEL; }
+        if (this.value !== value || this.unit !== unit) {
+            // set member variables to notify only once
+            this._value = value;
+            this._unit = unit;
+            this.onChangedObservable.notifyObservers();
+        }
+        return this;
+    };
+    /**
+     * Gets the value accordingly to its unit
+     * @param host  defines the root host
+     * @returns the value
+     */
+    ValueAndUnit.prototype.getValue = function (host) {
+        if (host && !this.ignoreAdaptiveScaling && this.unit !== ValueAndUnit.UNITMODE_PERCENTAGE) {
+            var width = 0;
+            var height = 0;
+            if (host.idealWidth) {
+                width = (this._value * host.getSize().width) / host.idealWidth;
+            }
+            if (host.idealHeight) {
+                height = (this._value * host.getSize().height) / host.idealHeight;
+            }
+            if (host.useSmallestIdeal && host.idealWidth && host.idealHeight) {
+                return window.innerWidth < window.innerHeight ? width : height;
+            }
+            if (host.idealWidth) {
+                // horizontal
+                return width;
+            }
+            if (host.idealHeight) {
+                // vertical
+                return height;
+            }
+        }
+        return this._value;
+    };
+    /**
+     * Gets a string representation of the value
+     * @param host defines the root host
+     * @param decimals defines an optional number of decimals to display
+     * @returns a string
+     */
+    ValueAndUnit.prototype.toString = function (host, decimals) {
+        switch (this._unit) {
+            case ValueAndUnit.UNITMODE_PERCENTAGE: {
+                var percentage = this.getValue(host) * 100;
+                return (decimals ? percentage.toFixed(decimals) : percentage) + "%";
+            }
+            case ValueAndUnit.UNITMODE_PIXEL: {
+                var pixels = this.getValue(host);
+                return (decimals ? pixels.toFixed(decimals) : pixels) + "px";
+            }
+        }
+        return this._unit.toString();
+    };
+    /**
+     * Store a value parsed from a string
+     * @param source defines the source string
+     * @returns true if the value was successfully parsed and updated
+     */
+    ValueAndUnit.prototype.fromString = function (source) {
+        var match = ValueAndUnit._Regex.exec(source.toString());
+        if (!match || match.length === 0) {
+            return false;
+        }
+        var sourceValue = parseFloat(match[1]);
+        var sourceUnit = this._originalUnit;
+        if (!this.negativeValueAllowed) {
+            if (sourceValue < 0) {
+                sourceValue = 0;
+            }
+        }
+        if (match.length === 4) {
+            switch (match[3]) {
+                case "px":
+                    sourceUnit = ValueAndUnit.UNITMODE_PIXEL;
+                    break;
+                case "%":
+                    sourceUnit = ValueAndUnit.UNITMODE_PERCENTAGE;
+                    sourceValue /= 100.0;
+                    break;
+            }
+        }
+        if (sourceValue === this._value && sourceUnit === this._unit) {
+            return false;
+        }
+        this._value = sourceValue;
+        this._unit = sourceUnit;
+        this.onChangedObservable.notifyObservers();
+        return true;
+    };
+    Object.defineProperty(ValueAndUnit, "UNITMODE_PERCENTAGE", {
+        /** UNITMODE_PERCENTAGE */
+        get: function () {
+            return ValueAndUnit._UNITMODE_PERCENTAGE;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(ValueAndUnit, "UNITMODE_PIXEL", {
+        /** UNITMODE_PIXEL */
+        get: function () {
+            return ValueAndUnit._UNITMODE_PIXEL;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    // Static
+    ValueAndUnit._Regex = /(^-?\d*(\.\d+)?)(%|px)?/;
+    ValueAndUnit._UNITMODE_PERCENTAGE = 0;
+    ValueAndUnit._UNITMODE_PIXEL = 1;
+    return ValueAndUnit;
+}());
+export { ValueAndUnit };
 //# sourceMappingURL=valueAndUnit.js.map