babylonjs-gui 5.9.1 → 5.12.0

package/babylon.gui.d.ts

@@ -1233,7 +1233,7 @@ declare module BABYLON.GUI {
          * second dimension is computed as first dimension * fixedRatio
          */
         fixedRatio: number;
-        private _fixedRatioMasterIsWidth;
+        protected _fixedRatioMasterIsWidth: boolean;
         /**
          * Gets or sets control width
          * @see https://doc.babylonjs.com/how_to/gui#position-and-size
@@ -2123,6 +2123,11 @@ declare module BABYLON.GUI {
          * BABYLON.Observable notified when _sourceLeft, _sourceTop, _sourceWidth and _sourceHeight are computed
          */
         onSVGAttributesComputedObservable: BABYLON.Observable<Image>;
+        /**
+         * Gets or sets the referrer policy to apply on the img element load request.
+         * You should set referrerPolicy before set the source of the image if you want to ensure the header will be present on the xhr loading request
+         */
+        referrerPolicy: BABYLON.Nullable<ReferrerPolicy>;
         /**
          * Gets a boolean indicating that the content is loaded
          */
@@ -2303,39 +2308,39 @@ declare module BABYLON.GUI {
      */
     export class InputText extends Control implements IFocusableControl {
         name?: string | undefined;
-        private _textWrapper;
-        private _placeholderText;
-        private _background;
-        private _focusedBackground;
-        private _focusedColor;
-        private _placeholderColor;
-        private _thickness;
-        private _margin;
-        private _autoStretchWidth;
-        private _maxWidth;
-        private _isFocused;
+        protected _textWrapper: TextWrapper;
+        protected _placeholderText: string;
+        protected _background: string;
+        protected _focusedBackground: string;
+        protected _focusedColor: string;
+        protected _placeholderColor: string;
+        protected _thickness: number;
+        protected _margin: ValueAndUnit;
+        protected _autoStretchWidth: boolean;
+        protected _maxWidth: ValueAndUnit;
+        protected _isFocused: boolean;
         /** the type of device that most recently focused the input: "mouse", "touch" or "pen" */
-        private _focusedBy;
-        private _blinkTimeout;
-        private _blinkIsEven;
+        protected _focusedBy: string;
+        protected _blinkTimeout: number;
+        protected _blinkIsEven: boolean;
         private _cursorOffset;
-        private _scrollLeft;
-        private _textWidth;
-        private _clickedCoordinate;
-        private _deadKey;
-        private _addKey;
-        private _currentKey;
-        private _isTextHighlightOn;
-        private _textHighlightColor;
-        private _highligherOpacity;
-        private _highlightedText;
+        protected _scrollLeft: BABYLON.Nullable<number>;
+        protected _textWidth: number;
+        protected _clickedCoordinate: BABYLON.Nullable<number>;
+        protected _deadKey: boolean;
+        protected _addKey: boolean;
+        protected _currentKey: string;
+        protected _isTextHighlightOn: boolean;
+        protected _textHighlightColor: string;
+        protected _highligherOpacity: number;
+        protected _highlightedText: string;
         private _startHighlightIndex;
         private _endHighlightIndex;
         private _cursorIndex;
-        private _onFocusSelectAll;
-        private _isPointerDown;
-        private _onClipboardObserver;
-        private _onPointerDblTapObserver;
+        protected _onFocusSelectAll: boolean;
+        protected _isPointerDown: boolean;
+        protected _onClipboardObserver: BABYLON.Nullable<BABYLON.Observer<BABYLON.ClipboardInfo>>;
+        protected _onPointerDblTapObserver: BABYLON.Nullable<BABYLON.Observer<BABYLON.PointerInfo>>;
         /** @hidden */
         _connectedVirtualKeyboard: BABYLON.Nullable<VirtualKeyboard>;
         /** Gets or sets a string representing the message displayed on mobile when the control gets the focus */
@@ -2415,7 +2420,7 @@ declare module BABYLON.GUI {
         /** Gets or sets the text displayed in the control */
         get text(): string;
         set text(value: string);
-        private _textHasChanged;
+        protected _textHasChanged(): void;
         /** Gets or sets control width */
         get width(): string | number;
         set width(value: string | number);
@@ -2454,14 +2459,14 @@ declare module BABYLON.GUI {
          * @param offset
          * @hidden
          */
-        private _updateValueFromCursorIndex;
+        protected _updateValueFromCursorIndex(offset: number): void;
         /**
          * @param evt
          * @hidden
          */
-        private _processDblClick;
+        protected _processDblClick(evt: BABYLON.PointerInfo): void;
         /** @hidden */
-        private _selectAllText;
+        protected _selectAllText(): void;
         /**
          * Handles the keyboard event
          * @param evt Defines the KeyboardEvent
@@ -2471,17 +2476,17 @@ declare module BABYLON.GUI {
          * @param ev
          * @hidden
          */
-        private _onCopyText;
+        protected _onCopyText(ev: ClipboardEvent): void;
         /**
          * @param ev
          * @hidden
          */
-        private _onCutText;
+        protected _onCutText(ev: ClipboardEvent): void;
         /**
          * @param ev
          * @hidden
          */
-        private _onPasteText;
+        protected _onPasteText(ev: ClipboardEvent): void;
         _draw(context: BABYLON.ICanvasRenderingContext): void;
         _onPointerDown(target: Control, coordinates: BABYLON.Vector2, pointerId: number, buttonIndex: number, pi: BABYLON.PointerInfoBase): boolean;
         _onPointerMove(target: Control, coordinates: BABYLON.Vector2, pointerId: number, pi: BABYLON.PointerInfoBase): void;
@@ -2491,6 +2496,158 @@ declare module BABYLON.GUI {
     }
 
 
+    /**
+     * Class used to create input text control
+     */
+    export class InputTextArea extends InputText {
+        name?: string | undefined;
+        private _textHorizontalAlignment;
+        private _textVerticalAlignment;
+        private _lines;
+        private _lineSpacing;
+        private _outlineWidth;
+        private _outlineColor;
+        private _maxHeight;
+        private _clipTextTop;
+        private _clipTextLeft;
+        private _cursorInfo;
+        private _highlightCursorInfo;
+        /**
+         * An event triggered after the text was broken up into lines
+         */
+        onLinesReadyObservable: BABYLON.Observable<InputTextArea>;
+        /** @hidden */
+        _connectedVirtualKeyboard: BABYLON.Nullable<VirtualKeyboard>;
+        private _contextForBreakLines;
+        private _clickedCoordinateX;
+        private _clickedCoordinateY;
+        private _availableWidth;
+        private _availableHeight;
+        private _scrollTop;
+        private _autoStretchHeight;
+        /**
+         * Gets or sets outlineWidth of the text to display
+         */
+        get outlineWidth(): number;
+        /**
+         * Gets or sets outlineWidth of the text to display
+         */
+        set outlineWidth(value: number);
+        /**
+         * Gets or sets outlineColor of the text to display
+         */
+        get outlineColor(): string;
+        /**
+         * Gets or sets outlineColor of the text to display
+         */
+        set outlineColor(value: string);
+        /** Gets or sets a boolean indicating if the control can auto stretch its height to adapt to the text */
+        get autoStretchHeight(): boolean;
+        set autoStretchHeight(value: boolean);
+        set height(value: string | number);
+        get maxHeight(): string | number;
+        /** Gets the maximum width allowed by the control in pixels */
+        get maxHeightInPixels(): number;
+        set maxHeight(value: string | number);
+        /**
+         * Creates a new InputTextArea
+         * @param name defines the control name
+         * @param text defines the text of the control
+         */
+        constructor(name?: string | undefined, text?: string);
+        protected _getTypeName(): string;
+        /**
+         * Handles the keyboard event
+         * @param evt Defines the KeyboardEvent
+         */
+        processKeyboard(evt: BABYLON.IKeyboardEvent): void;
+        /**
+         * Process the last keyboard input
+         *
+         * @param code The ascii input number
+         * @param key The key string representation
+         * @param evt The keyboard event emits with input
+         * @hidden
+         */
+        alternativeProcessKey(code: string, key?: string, evt?: BABYLON.IKeyboardEvent): void;
+        protected _parseLineWordWrap(line: string | undefined, width: number, context: BABYLON.ICanvasRenderingContext): {
+            text: string;
+            width: number;
+            lineEnding: string;
+        }[];
+        protected _breakLines(refWidth: number, context: BABYLON.ICanvasRenderingContext): object[];
+        protected _parseLine(line: string | undefined, context: BABYLON.ICanvasRenderingContext): {
+            text: string;
+            width: number;
+            lineEnding: string;
+        };
+        /**
+         * Processing of child right before the parent measurement update
+         *
+         * @param parentMeasure The parent measure
+         * @param context The rendering canvas
+         * @hidden
+         */
+        protected _preMeasure(parentMeasure: Measure, context: BABYLON.ICanvasRenderingContext): void;
+        /**
+         * Processing of child after the parent measurement update
+         *
+         * @param parentMeasure The parent measure
+         * @param context The rendering canvas
+         * @hidden
+         */
+        protected _additionalProcessing(parentMeasure: Measure, context: BABYLON.ICanvasRenderingContext): void;
+        private _drawText;
+        /**
+         * Copy the text in the clipboard
+         *
+         * @param ev The clipboard event
+         * @hidden
+         */
+        protected _onCopyText(ev: ClipboardEvent): void;
+        /**
+         * Cut the text and copy it in the clipboard
+         *
+         * @param ev The clipboard event
+         * @hidden
+         */
+        protected _onCutText(ev: ClipboardEvent): void;
+        /**
+         * Paste the copied text from the clipboard
+         *
+         * @param ev The clipboard event
+         * @hidden
+         */
+        protected _onPasteText(ev: ClipboardEvent): void;
+        _draw(context: BABYLON.ICanvasRenderingContext): void;
+        private _resetBlinking;
+        protected _applyStates(context: BABYLON.ICanvasRenderingContext): void;
+        _onPointerDown(target: Control, coordinates: BABYLON.Vector2, pointerId: number, buttonIndex: number, pi: BABYLON.PointerInfoBase): boolean;
+        _onPointerMove(target: Control, coordinates: BABYLON.Vector2, pointerId: number, pi: BABYLON.PointerInfoBase): void;
+        /**
+         * Apply the correct position of cursor according to current modification
+         */
+        private _updateCursorPosition;
+        /**
+         * Update all values of cursor information based on cursorIndex value
+         *
+         * @param offset The index to take care of
+         * @hidden
+         */
+        protected _updateValueFromCursorIndex(offset: number): void;
+        /**
+         * Select the word immediatly under the cursor on double click
+         *
+         * @param _evt Pointer informations of double click
+         * @hidden
+         */
+        protected _processDblClick(_evt: BABYLON.PointerInfo): void;
+        /** @hidden */
+        protected _selectAllText(): void;
+        dipose(): void;
+    }
+
+
     /** Class used to render 2D lines */
     export class Line extends Control {
         name?: string | undefined;