@babylonjs/gui 5.0.0-rc.6 → 5.0.0

package/2D/advancedDynamicTexture.d.ts

@@ -1,448 +1,449 @@
-import { Nullable } from "@babylonjs/core/types.js";
-import { Observable } from "@babylonjs/core/Misc/observable.js";
-import { Vector2, Vector3, Matrix } from "@babylonjs/core/Maths/math.vector.js";
-import { ClipboardInfo } from "@babylonjs/core/Events/clipboardEvents.js";
-import { DynamicTexture } from "@babylonjs/core/Materials/Textures/dynamicTexture.js";
-import { AbstractMesh } from "@babylonjs/core/Meshes/abstractMesh.js";
-import { Layer } from "@babylonjs/core/Layers/layer.js";
-import { Scene } from "@babylonjs/core/scene.js";
-import { Container } from "./controls/container";
-import { Control } from "./controls/control";
-import { IFocusableControl } from "./controls/focusableControl";
-import { Style } from "./style";
-import { Viewport } from "@babylonjs/core/Maths/math.viewport.js";
-/**
- * Class used to create texture to support 2D GUI elements
- * @see https://doc.babylonjs.com/how_to/gui
- */
-export declare class AdvancedDynamicTexture extends DynamicTexture {
-    /** Define the Uurl to load snippets */
-    static SnippetUrl: string;
-    /** Indicates if some optimizations can be performed in GUI GPU management (the downside is additional memory/GPU texture memory used) */
-    static AllowGPUOptimizations: boolean;
-    /** Snippet ID if the content was created from the snippet server */
-    snippetId: string;
-    private _isDirty;
-    private _renderObserver;
-    private _resizeObserver;
-    private _preKeyboardObserver;
-    private _pointerMoveObserver;
-    private _sceneRenderObserver;
-    private _pointerObserver;
-    private _canvasPointerOutObserver;
-    private _canvasBlurObserver;
-    private _background;
-    /** @hidden */
-    _rootContainer: Container;
-    /** @hidden */
-    _lastPickedControl: Control;
-    /** @hidden */
-    _lastControlOver: {
-        [pointerId: number]: Control;
-    };
-    /** @hidden */
-    _lastControlDown: {
-        [pointerId: number]: Control;
-    };
-    /** @hidden */
-    _capturingControl: {
-        [pointerId: number]: Control;
-    };
-    /** @hidden */
-    _shouldBlockPointer: boolean;
-    /** @hidden */
-    _layerToDispose: Nullable<Layer>;
-    /** @hidden */
-    _linkedControls: Control[];
-    private _isFullscreen;
-    private _fullscreenViewport;
-    private _idealWidth;
-    private _idealHeight;
-    private _useSmallestIdeal;
-    private _renderAtIdealSize;
-    private _focusedControl;
-    private _blockNextFocusCheck;
-    private _renderScale;
-    private _rootElement;
-    private _cursorChanged;
-    private _defaultMousePointerId;
-    /** @hidden */
-    _numLayoutCalls: number;
-    /** Gets the number of layout calls made the last time the ADT has been rendered */
-    get numLayoutCalls(): number;
-    /** @hidden */
-    _numRenderCalls: number;
-    /** Gets the number of render calls made the last time the ADT has been rendered */
-    get numRenderCalls(): number;
-    /**
-     * Define type to string to ensure compatibility across browsers
-     * Safari doesn't support DataTransfer constructor
-     */
-    private _clipboardData;
-    /**
-     * Observable event triggered each time an clipboard event is received from the rendering canvas
-     */
-    onClipboardObservable: Observable<ClipboardInfo>;
-    /**
-     * Observable event triggered each time a pointer down is intercepted by a control
-     */
-    onControlPickedObservable: Observable<Control>;
-    /**
-     * Observable event triggered before layout is evaluated
-     */
-    onBeginLayoutObservable: Observable<AdvancedDynamicTexture>;
-    /**
-     * Observable event triggered after the layout was evaluated
-     */
-    onEndLayoutObservable: Observable<AdvancedDynamicTexture>;
-    /**
-     * Observable event triggered before the texture is rendered
-     */
-    onBeginRenderObservable: Observable<AdvancedDynamicTexture>;
-    /**
-     * Observable event triggered after the texture was rendered
-     */
-    onEndRenderObservable: Observable<AdvancedDynamicTexture>;
-    /**
-     * Gets or sets a boolean defining if alpha is stored as premultiplied
-     */
-    premulAlpha: boolean;
-    /**
-     * Gets or sets a boolean indicating that the canvas must be reverted on Y when updating the texture
-     */
-    applyYInversionOnUpdate: boolean;
-    /**
-     * Gets or sets a number used to scale rendering size (2 means that the texture will be twice bigger).
-     * Useful when you want more antialiasing
-     */
-    get renderScale(): number;
-    set renderScale(value: number);
-    /** Gets or sets the background color */
-    get background(): string;
-    set background(value: string);
-    /**
-     * Gets or sets the ideal width used to design controls.
-     * The GUI will then rescale everything accordingly
-     * @see https://doc.babylonjs.com/how_to/gui#adaptive-scaling
-     */
-    get idealWidth(): number;
-    set idealWidth(value: number);
-    /**
-     * Gets or sets the ideal height used to design controls.
-     * The GUI will then rescale everything accordingly
-     * @see https://doc.babylonjs.com/how_to/gui#adaptive-scaling
-     */
-    get idealHeight(): number;
-    set idealHeight(value: number);
-    /**
-     * Gets or sets a boolean indicating if the smallest ideal value must be used if idealWidth and idealHeight are both set
-     * @see https://doc.babylonjs.com/how_to/gui#adaptive-scaling
-     */
-    get useSmallestIdeal(): boolean;
-    set useSmallestIdeal(value: boolean);
-    /**
-     * Gets or sets a boolean indicating if adaptive scaling must be used
-     * @see https://doc.babylonjs.com/how_to/gui#adaptive-scaling
-     */
-    get renderAtIdealSize(): boolean;
-    set renderAtIdealSize(value: boolean);
-    /**
-     * Gets the ratio used when in "ideal mode"
-     * @see https://doc.babylonjs.com/how_to/gui#adaptive-scaling
-     * */
-    get idealRatio(): number;
-    /**
-     * Gets the underlying layer used to render the texture when in fullscreen mode
-     */
-    get layer(): Nullable<Layer>;
-    /**
-     * Gets the root container control
-     */
-    get rootContainer(): Container;
-    /**
-     * Returns an array containing the root container.
-     * This is mostly used to let the Inspector introspects the ADT
-     * @returns an array containing the rootContainer
-     */
-    getChildren(): Array<Container>;
-    /**
-     * Will return all controls that are inside this texture
-     * @param directDescendantsOnly defines if true only direct descendants of 'this' will be considered, if false direct and also indirect (children of children, an so on in a recursive manner) descendants of 'this' will be considered
-     * @param predicate defines an optional predicate that will be called on every evaluated child, the predicate must return true for a given child to be part of the result, otherwise it will be ignored
-     * @return all child controls
-     */
-    getDescendants(directDescendantsOnly?: boolean, predicate?: (control: Control) => boolean): Control[];
-    /**
-     * Will return all controls with the given type name
-     * @param typeName defines the type name to search for
-     * @returns an array of all controls found
-     */
-    getControlsByType(typeName: string): Control[];
-    /**
-     * Will return the first control with the given name
-     * @param name defines the name to search for
-     * @return the first control found or null
-     */
-    getControlByName(name: string): Nullable<Control>;
-    private _getControlByKey;
-    /**
-     * Gets or sets the current focused control
-     */
-    get focusedControl(): Nullable<IFocusableControl>;
-    set focusedControl(control: Nullable<IFocusableControl>);
-    /**
-     * Gets or sets a boolean indicating if the texture must be rendered in background or foreground when in fullscreen mode
-     */
-    get isForeground(): boolean;
-    set isForeground(value: boolean);
-    /**
-     * Gets or set information about clipboardData
-     */
-    get clipboardData(): string;
-    set clipboardData(value: string);
-    /**
-     * If set to true, every scene render will trigger a pointer event for the GUI
-     * if it is linked to a mesh or has controls linked to a mesh. This will allow
-     * you to catch the pointer moving around the GUI due to camera or mesh movements,
-     * but it has a performance cost.
-     */
-    checkPointerEveryFrame: boolean;
-    /**
-     * Creates a new AdvancedDynamicTexture
-     * @param name defines the name of the texture
-     * @param width defines the width of the texture
-     * @param height defines the height of the texture
-     * @param scene defines the hosting scene
-     * @param generateMipMaps defines a boolean indicating if mipmaps must be generated (false by default)
-     * @param samplingMode defines the texture sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
-     * @param invertY defines if the texture needs to be inverted on the y axis during loading (true by default)
-     */
-    constructor(name: string, width?: number, height?: number, scene?: Nullable<Scene>, generateMipMaps?: boolean, samplingMode?: number, invertY?: boolean);
-    /**
-     * Get the current class name of the texture useful for serialization or dynamic coding.
-     * @returns "AdvancedDynamicTexture"
-     */
-    getClassName(): string;
-    /**
-     * Function used to execute a function on all controls
-     * @param func defines the function to execute
-     * @param container defines the container where controls belong. If null the root container will be used
-     */
-    executeOnAllControls(func: (control: Control) => void, container?: Container): void;
-    private _useInvalidateRectOptimization;
-    /**
-     * Gets or sets a boolean indicating if the InvalidateRect optimization should be turned on
-     */
-    get useInvalidateRectOptimization(): boolean;
-    set useInvalidateRectOptimization(value: boolean);
-    private _invalidatedRectangle;
-    /**
-     * Invalidates a rectangle area on the gui texture
-     * @param invalidMinX left most position of the rectangle to invalidate in the texture
-     * @param invalidMinY top most position of the rectangle to invalidate in the texture
-     * @param invalidMaxX right most position of the rectangle to invalidate in the texture
-     * @param invalidMaxY bottom most position of the rectangle to invalidate in the texture
-     */
-    invalidateRect(invalidMinX: number, invalidMinY: number, invalidMaxX: number, invalidMaxY: number): void;
-    /**
-     * Marks the texture as dirty forcing a complete update
-     */
-    markAsDirty(): void;
-    /**
-     * Helper function used to create a new style
-     * @returns a new style
-     * @see https://doc.babylonjs.com/how_to/gui#styles
-     */
-    createStyle(): Style;
-    /**
-     * Adds a new control to the root container
-     * @param control defines the control to add
-     * @returns the current texture
-     */
-    addControl(control: Control): AdvancedDynamicTexture;
-    /**
-     * Removes a control from the root container
-     * @param control defines the control to remove
-     * @returns the current texture
-     */
-    removeControl(control: Control): AdvancedDynamicTexture;
-    /**
-     * Moves overlapped controls towards a position where it is not overlapping anymore.
-     * Please note that this method alters linkOffsetXInPixels and linkOffsetYInPixels.
-     * @param overlapGroup the overlap group which will be processed or undefined to process all overlap groups
-     * @param deltaStep the step size (speed) to reach the target non overlapping position (default 0.1)
-     * @param repelFactor how much is the control repelled by other controls
-     */
-    moveToNonOverlappedPosition(overlapGroup?: number | Control[], deltaStep?: number, repelFactor?: number): void;
-    /**
-     * Release all resources
-     */
-    dispose(): void;
-    private _onResize;
-    /** @hidden */
-    _getGlobalViewport(): Viewport;
-    /**
-     * Get screen coordinates for a vector3
-     * @param position defines the position to project
-     * @param worldMatrix defines the world matrix to use
-     * @returns the projected position
-     */
-    getProjectedPosition(position: Vector3, worldMatrix: Matrix): Vector2;
-    /**
-     * Get screen coordinates for a vector3
-     * @param position defines the position to project
-     * @param worldMatrix defines the world matrix to use
-     * @returns the projected position with Z
-     */
-    getProjectedPositionWithZ(position: Vector3, worldMatrix: Matrix): Vector3;
-    private _checkUpdate;
-    private _clearMeasure;
-    private _render;
-    /**
-     * @param cursor
-     * @hidden
-     */
-    _changeCursor(cursor: string): void;
-    /**
-     * @param control
-     * @param pointerId
-     * @hidden
-     */
-    _registerLastControlDown(control: Control, pointerId: number): void;
-    private _doPicking;
-    /**
-     * @param list
-     * @param control
-     * @hidden
-     */
-    _cleanControlAfterRemovalFromList(list: {
-        [pointerId: number]: Control;
-    }, control: Control): void;
-    /**
-     * @param control
-     * @hidden
-     */
-    _cleanControlAfterRemoval(control: Control): void;
-    private _translateToPicking;
-    /** Attach to all scene events required to support pointer events */
-    attach(): void;
-    /**
-     * @param rawEvt
-     * @hidden
-     */
-    private _onClipboardCopy;
-    /**
-     * @param rawEvt
-     * @hidden
-     */
-    private _onClipboardCut;
-    /**
-     * @param rawEvt
-     * @hidden
-     */
-    private _onClipboardPaste;
-    /**
-     * Register the clipboard Events onto the canvas
-     */
-    registerClipboardEvents(): void;
-    /**
-     * Unregister the clipboard Events from the canvas
-     */
-    unRegisterClipboardEvents(): void;
-    /**
-     * Connect the texture to a hosting mesh to enable interactions
-     * @param mesh defines the mesh to attach to
-     * @param supportPointerMove defines a boolean indicating if pointer move events must be catched as well
-     */
-    attachToMesh(mesh: AbstractMesh, supportPointerMove?: boolean): void;
-    /**
-     * Move the focus to a specific control
-     * @param control defines the control which will receive the focus
-     */
-    moveFocusToControl(control: IFocusableControl): void;
-    private _manageFocus;
-    private _attachPickingToSceneRender;
-    private _attachToOnPointerOut;
-    private _attachToOnBlur;
-    /**
-     * Serializes the entire GUI system
-     * @returns an object with the JSON serialized data
-     */
-    serializeContent(): any;
-    /**
-     * Recreate the content of the ADT from a JSON object
-     * @param serializedObject define the JSON serialized object to restore from
-     * @param scaleToSize defines whether to scale to texture to the saved size
-     */
-    parseContent(serializedObject: any, scaleToSize?: boolean): void;
-    /**
-     * Recreate the content of the ADT from a snippet saved by the GUI editor
-     * @param snippetId defines the snippet to load
-     * @param scaleToSize defines whether to scale to texture to the saved size
-     * @returns a promise that will resolve on success
-     */
-    parseFromSnippetAsync(snippetId: string, scaleToSize?: boolean): Promise<void>;
-    /**
-     * Recreate the content of the ADT from a url json
-     * @param url defines the url to load
-     * @param scaleToSize defines whether to scale to texture to the saved size
-     * @returns a promise that will resolve on success
-     */
-    parseFromURLAsync(url: string, scaleToSize?: boolean): Promise<void>;
-    /**
-     * Compares two rectangle based controls for pixel overlap
-     * @param control1 The first control to compare
-     * @param control2 The second control to compare
-     * @returns true if overlaps, otherwise false
-     */
-    private static _Overlaps;
-    /**
-     * Creates a new AdvancedDynamicTexture in projected mode (ie. attached to a mesh)
-     * @param mesh defines the mesh which will receive the texture
-     * @param width defines the texture width (1024 by default)
-     * @param height defines the texture height (1024 by default)
-     * @param supportPointerMove defines a boolean indicating if the texture must capture move events (true by default)
-     * @param onlyAlphaTesting defines a boolean indicating that alpha blending will not be used (only alpha testing) (false by default)
-     * @param invertY defines if the texture needs to be inverted on the y axis during loading (true by default)
-     * @param materialSetupCallback defines a custom way of creating and setting up the material on the mesh
-     * @returns a new AdvancedDynamicTexture
-     */
-    static CreateForMesh(mesh: AbstractMesh, width?: number, height?: number, supportPointerMove?: boolean, onlyAlphaTesting?: boolean, invertY?: boolean, materialSetupCallback?: (mesh: AbstractMesh, uniqueId: string, texture: AdvancedDynamicTexture, onlyAlphaTesting: boolean) => void): AdvancedDynamicTexture;
-    private static _CreateMaterial;
-    /**
-     * Creates a new AdvancedDynamicTexture in projected mode (ie. attached to a mesh) BUT do not create a new material for the mesh. You will be responsible for connecting the texture
-     * @param mesh defines the mesh which will receive the texture
-     * @param width defines the texture width (1024 by default)
-     * @param height defines the texture height (1024 by default)
-     * @param supportPointerMove defines a boolean indicating if the texture must capture move events (true by default)
-     * @param invertY defines if the texture needs to be inverted on the y axis during loading (true by default)
-     * @returns a new AdvancedDynamicTexture
-     */
-    static CreateForMeshTexture(mesh: AbstractMesh, width?: number, height?: number, supportPointerMove?: boolean, invertY?: boolean): AdvancedDynamicTexture;
-    /**
-     * Creates a new AdvancedDynamicTexture in fullscreen mode.
-     * In this mode the texture will rely on a layer for its rendering.
-     * This allows it to be treated like any other layer.
-     * As such, if you have a multi camera setup, you can set the layerMask on the GUI as well.
-     * LayerMask is set through advancedTexture.layer.layerMask
-     * @param name defines name for the texture
-     * @param foreground defines a boolean indicating if the texture must be rendered in foreground (default is true)
-     * @param scene defines the hosting scene
-     * @param sampling defines the texture sampling mode (Texture.BILINEAR_SAMPLINGMODE by default)
-     * @param adaptiveScaling defines whether to automatically scale root to match hardwarescaling (false by default)
-     * @returns a new AdvancedDynamicTexture
-     */
-    static CreateFullscreenUI(name: string, foreground?: boolean, scene?: Nullable<Scene>, sampling?: number, adaptiveScaling?: boolean): AdvancedDynamicTexture;
-    /**
-     * Scales the texture
-     * @param ratio the scale factor to apply to both width and height
-     */
-    scale(ratio: number): void;
-    /**
-     * Resizes the texture
-     * @param width the new width
-     * @param height the new height
-     */
-    scaleTo(width: number, height: number): void;
-}
-export { IFocusableControl };
+import type { Nullable } from "@babylonjs/core/types.js";
+import { Observable } from "@babylonjs/core/Misc/observable.js";
+import type { Matrix } from "@babylonjs/core/Maths/math.vector.js";
+import { Vector2, Vector3 } from "@babylonjs/core/Maths/math.vector.js";
+import { ClipboardInfo } from "@babylonjs/core/Events/clipboardEvents.js";
+import { DynamicTexture } from "@babylonjs/core/Materials/Textures/dynamicTexture.js";
+import type { AbstractMesh } from "@babylonjs/core/Meshes/abstractMesh.js";
+import { Layer } from "@babylonjs/core/Layers/layer.js";
+import type { Scene } from "@babylonjs/core/scene.js";
+import { Container } from "./controls/container";
+import { Control } from "./controls/control";
+import { IFocusableControl } from "./controls/focusableControl";
+import { Style } from "./style";
+import { Viewport } from "@babylonjs/core/Maths/math.viewport.js";
+/**
+ * Class used to create texture to support 2D GUI elements
+ * @see https://doc.babylonjs.com/how_to/gui
+ */
+export declare class AdvancedDynamicTexture extends DynamicTexture {
+    /** Define the Uurl to load snippets */
+    static SnippetUrl: string;
+    /** Indicates if some optimizations can be performed in GUI GPU management (the downside is additional memory/GPU texture memory used) */
+    static AllowGPUOptimizations: boolean;
+    /** Snippet ID if the content was created from the snippet server */
+    snippetId: string;
+    private _isDirty;
+    private _renderObserver;
+    private _resizeObserver;
+    private _preKeyboardObserver;
+    private _pointerMoveObserver;
+    private _sceneRenderObserver;
+    private _pointerObserver;
+    private _canvasPointerOutObserver;
+    private _canvasBlurObserver;
+    private _background;
+    /** @hidden */
+    _rootContainer: Container;
+    /** @hidden */
+    _lastPickedControl: Control;
+    /** @hidden */
+    _lastControlOver: {
+        [pointerId: number]: Control;
+    };
+    /** @hidden */
+    _lastControlDown: {
+        [pointerId: number]: Control;
+    };
+    /** @hidden */
+    _capturingControl: {
+        [pointerId: number]: Control;
+    };
+    /** @hidden */
+    _shouldBlockPointer: boolean;
+    /** @hidden */
+    _layerToDispose: Nullable<Layer>;
+    /** @hidden */
+    _linkedControls: Control[];
+    private _isFullscreen;
+    private _fullscreenViewport;
+    private _idealWidth;
+    private _idealHeight;
+    private _useSmallestIdeal;
+    private _renderAtIdealSize;
+    private _focusedControl;
+    private _blockNextFocusCheck;
+    private _renderScale;
+    private _rootElement;
+    private _cursorChanged;
+    private _defaultMousePointerId;
+    /** @hidden */
+    _numLayoutCalls: number;
+    /** Gets the number of layout calls made the last time the ADT has been rendered */
+    get numLayoutCalls(): number;
+    /** @hidden */
+    _numRenderCalls: number;
+    /** Gets the number of render calls made the last time the ADT has been rendered */
+    get numRenderCalls(): number;
+    /**
+     * Define type to string to ensure compatibility across browsers
+     * Safari doesn't support DataTransfer constructor
+     */
+    private _clipboardData;
+    /**
+     * Observable event triggered each time an clipboard event is received from the rendering canvas
+     */
+    onClipboardObservable: Observable<ClipboardInfo>;
+    /**
+     * Observable event triggered each time a pointer down is intercepted by a control
+     */
+    onControlPickedObservable: Observable<Control>;
+    /**
+     * Observable event triggered before layout is evaluated
+     */
+    onBeginLayoutObservable: Observable<AdvancedDynamicTexture>;
+    /**
+     * Observable event triggered after the layout was evaluated
+     */
+    onEndLayoutObservable: Observable<AdvancedDynamicTexture>;
+    /**
+     * Observable event triggered before the texture is rendered
+     */
+    onBeginRenderObservable: Observable<AdvancedDynamicTexture>;
+    /**
+     * Observable event triggered after the texture was rendered
+     */
+    onEndRenderObservable: Observable<AdvancedDynamicTexture>;
+    /**
+     * Gets or sets a boolean defining if alpha is stored as premultiplied
+     */
+    premulAlpha: boolean;
+    /**
+     * Gets or sets a boolean indicating that the canvas must be reverted on Y when updating the texture
+     */
+    applyYInversionOnUpdate: boolean;
+    /**
+     * Gets or sets a number used to scale rendering size (2 means that the texture will be twice bigger).
+     * Useful when you want more antialiasing
+     */
+    get renderScale(): number;
+    set renderScale(value: number);
+    /** Gets or sets the background color */
+    get background(): string;
+    set background(value: string);
+    /**
+     * Gets or sets the ideal width used to design controls.
+     * The GUI will then rescale everything accordingly
+     * @see https://doc.babylonjs.com/how_to/gui#adaptive-scaling
+     */
+    get idealWidth(): number;
+    set idealWidth(value: number);
+    /**
+     * Gets or sets the ideal height used to design controls.
+     * The GUI will then rescale everything accordingly
+     * @see https://doc.babylonjs.com/how_to/gui#adaptive-scaling
+     */
+    get idealHeight(): number;
+    set idealHeight(value: number);
+    /**
+     * Gets or sets a boolean indicating if the smallest ideal value must be used if idealWidth and idealHeight are both set
+     * @see https://doc.babylonjs.com/how_to/gui#adaptive-scaling
+     */
+    get useSmallestIdeal(): boolean;
+    set useSmallestIdeal(value: boolean);
+    /**
+     * Gets or sets a boolean indicating if adaptive scaling must be used
+     * @see https://doc.babylonjs.com/how_to/gui#adaptive-scaling
+     */
+    get renderAtIdealSize(): boolean;
+    set renderAtIdealSize(value: boolean);
+    /**
+     * Gets the ratio used when in "ideal mode"
+     * @see https://doc.babylonjs.com/how_to/gui#adaptive-scaling
+     * */
+    get idealRatio(): number;
+    /**
+     * Gets the underlying layer used to render the texture when in fullscreen mode
+     */
+    get layer(): Nullable<Layer>;
+    /**
+     * Gets the root container control
+     */
+    get rootContainer(): Container;
+    /**
+     * Returns an array containing the root container.
+     * This is mostly used to let the Inspector introspects the ADT
+     * @returns an array containing the rootContainer
+     */
+    getChildren(): Array<Container>;
+    /**
+     * Will return all controls that are inside this texture
+     * @param directDescendantsOnly defines if true only direct descendants of 'this' will be considered, if false direct and also indirect (children of children, an so on in a recursive manner) descendants of 'this' will be considered
+     * @param predicate defines an optional predicate that will be called on every evaluated child, the predicate must return true for a given child to be part of the result, otherwise it will be ignored
+     * @return all child controls
+     */
+    getDescendants(directDescendantsOnly?: boolean, predicate?: (control: Control) => boolean): Control[];
+    /**
+     * Will return all controls with the given type name
+     * @param typeName defines the type name to search for
+     * @returns an array of all controls found
+     */
+    getControlsByType(typeName: string): Control[];
+    /**
+     * Will return the first control with the given name
+     * @param name defines the name to search for
+     * @return the first control found or null
+     */
+    getControlByName(name: string): Nullable<Control>;
+    private _getControlByKey;
+    /**
+     * Gets or sets the current focused control
+     */
+    get focusedControl(): Nullable<IFocusableControl>;
+    set focusedControl(control: Nullable<IFocusableControl>);
+    /**
+     * Gets or sets a boolean indicating if the texture must be rendered in background or foreground when in fullscreen mode
+     */
+    get isForeground(): boolean;
+    set isForeground(value: boolean);
+    /**
+     * Gets or set information about clipboardData
+     */
+    get clipboardData(): string;
+    set clipboardData(value: string);
+    /**
+     * If set to true, every scene render will trigger a pointer event for the GUI
+     * if it is linked to a mesh or has controls linked to a mesh. This will allow
+     * you to catch the pointer moving around the GUI due to camera or mesh movements,
+     * but it has a performance cost.
+     */
+    checkPointerEveryFrame: boolean;
+    /**
+     * Creates a new AdvancedDynamicTexture
+     * @param name defines the name of the texture
+     * @param width defines the width of the texture
+     * @param height defines the height of the texture
+     * @param scene defines the hosting scene
+     * @param generateMipMaps defines a boolean indicating if mipmaps must be generated (false by default)
+     * @param samplingMode defines the texture sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
+     * @param invertY defines if the texture needs to be inverted on the y axis during loading (true by default)
+     */
+    constructor(name: string, width?: number, height?: number, scene?: Nullable<Scene>, generateMipMaps?: boolean, samplingMode?: number, invertY?: boolean);
+    /**
+     * Get the current class name of the texture useful for serialization or dynamic coding.
+     * @returns "AdvancedDynamicTexture"
+     */
+    getClassName(): string;
+    /**
+     * Function used to execute a function on all controls
+     * @param func defines the function to execute
+     * @param container defines the container where controls belong. If null the root container will be used
+     */
+    executeOnAllControls(func: (control: Control) => void, container?: Container): void;
+    private _useInvalidateRectOptimization;
+    /**
+     * Gets or sets a boolean indicating if the InvalidateRect optimization should be turned on
+     */
+    get useInvalidateRectOptimization(): boolean;
+    set useInvalidateRectOptimization(value: boolean);
+    private _invalidatedRectangle;
+    /**
+     * Invalidates a rectangle area on the gui texture
+     * @param invalidMinX left most position of the rectangle to invalidate in the texture
+     * @param invalidMinY top most position of the rectangle to invalidate in the texture
+     * @param invalidMaxX right most position of the rectangle to invalidate in the texture
+     * @param invalidMaxY bottom most position of the rectangle to invalidate in the texture
+     */
+    invalidateRect(invalidMinX: number, invalidMinY: number, invalidMaxX: number, invalidMaxY: number): void;
+    /**
+     * Marks the texture as dirty forcing a complete update
+     */
+    markAsDirty(): void;
+    /**
+     * Helper function used to create a new style
+     * @returns a new style
+     * @see https://doc.babylonjs.com/how_to/gui#styles
+     */
+    createStyle(): Style;
+    /**
+     * Adds a new control to the root container
+     * @param control defines the control to add
+     * @returns the current texture
+     */
+    addControl(control: Control): AdvancedDynamicTexture;
+    /**
+     * Removes a control from the root container
+     * @param control defines the control to remove
+     * @returns the current texture
+     */
+    removeControl(control: Control): AdvancedDynamicTexture;
+    /**
+     * Moves overlapped controls towards a position where it is not overlapping anymore.
+     * Please note that this method alters linkOffsetXInPixels and linkOffsetYInPixels.
+     * @param overlapGroup the overlap group which will be processed or undefined to process all overlap groups
+     * @param deltaStep the step size (speed) to reach the target non overlapping position (default 0.1)
+     * @param repelFactor how much is the control repelled by other controls
+     */
+    moveToNonOverlappedPosition(overlapGroup?: number | Control[], deltaStep?: number, repelFactor?: number): void;
+    /**
+     * Release all resources
+     */
+    dispose(): void;
+    private _onResize;
+    /** @hidden */
+    _getGlobalViewport(): Viewport;
+    /**
+     * Get screen coordinates for a vector3
+     * @param position defines the position to project
+     * @param worldMatrix defines the world matrix to use
+     * @returns the projected position
+     */
+    getProjectedPosition(position: Vector3, worldMatrix: Matrix): Vector2;
+    /**
+     * Get screen coordinates for a vector3
+     * @param position defines the position to project
+     * @param worldMatrix defines the world matrix to use
+     * @returns the projected position with Z
+     */
+    getProjectedPositionWithZ(position: Vector3, worldMatrix: Matrix): Vector3;
+    private _checkUpdate;
+    private _clearMeasure;
+    private _render;
+    /**
+     * @param cursor
+     * @hidden
+     */
+    _changeCursor(cursor: string): void;
+    /**
+     * @param control
+     * @param pointerId
+     * @hidden
+     */
+    _registerLastControlDown(control: Control, pointerId: number): void;
+    private _doPicking;
+    /**
+     * @param list
+     * @param control
+     * @hidden
+     */
+    _cleanControlAfterRemovalFromList(list: {
+        [pointerId: number]: Control;
+    }, control: Control): void;
+    /**
+     * @param control
+     * @hidden
+     */
+    _cleanControlAfterRemoval(control: Control): void;
+    private _translateToPicking;
+    /** Attach to all scene events required to support pointer events */
+    attach(): void;
+    /**
+     * @param rawEvt
+     * @hidden
+     */
+    private _onClipboardCopy;
+    /**
+     * @param rawEvt
+     * @hidden
+     */
+    private _onClipboardCut;
+    /**
+     * @param rawEvt
+     * @hidden
+     */
+    private _onClipboardPaste;
+    /**
+     * Register the clipboard Events onto the canvas
+     */
+    registerClipboardEvents(): void;
+    /**
+     * Unregister the clipboard Events from the canvas
+     */
+    unRegisterClipboardEvents(): void;
+    /**
+     * Connect the texture to a hosting mesh to enable interactions
+     * @param mesh defines the mesh to attach to
+     * @param supportPointerMove defines a boolean indicating if pointer move events must be catched as well
+     */
+    attachToMesh(mesh: AbstractMesh, supportPointerMove?: boolean): void;
+    /**
+     * Move the focus to a specific control
+     * @param control defines the control which will receive the focus
+     */
+    moveFocusToControl(control: IFocusableControl): void;
+    private _manageFocus;
+    private _attachPickingToSceneRender;
+    private _attachToOnPointerOut;
+    private _attachToOnBlur;
+    /**
+     * Serializes the entire GUI system
+     * @returns an object with the JSON serialized data
+     */
+    serializeContent(): any;
+    /**
+     * Recreate the content of the ADT from a JSON object
+     * @param serializedObject define the JSON serialized object to restore from
+     * @param scaleToSize defines whether to scale to texture to the saved size
+     */
+    parseContent(serializedObject: any, scaleToSize?: boolean): void;
+    /**
+     * Recreate the content of the ADT from a snippet saved by the GUI editor
+     * @param snippetId defines the snippet to load
+     * @param scaleToSize defines whether to scale to texture to the saved size
+     * @returns a promise that will resolve on success
+     */
+    parseFromSnippetAsync(snippetId: string, scaleToSize?: boolean): Promise<void>;
+    /**
+     * Recreate the content of the ADT from a url json
+     * @param url defines the url to load
+     * @param scaleToSize defines whether to scale to texture to the saved size
+     * @returns a promise that will resolve on success
+     */
+    parseFromURLAsync(url: string, scaleToSize?: boolean): Promise<void>;
+    /**
+     * Compares two rectangle based controls for pixel overlap
+     * @param control1 The first control to compare
+     * @param control2 The second control to compare
+     * @returns true if overlaps, otherwise false
+     */
+    private static _Overlaps;
+    /**
+     * Creates a new AdvancedDynamicTexture in projected mode (ie. attached to a mesh)
+     * @param mesh defines the mesh which will receive the texture
+     * @param width defines the texture width (1024 by default)
+     * @param height defines the texture height (1024 by default)
+     * @param supportPointerMove defines a boolean indicating if the texture must capture move events (true by default)
+     * @param onlyAlphaTesting defines a boolean indicating that alpha blending will not be used (only alpha testing) (false by default)
+     * @param invertY defines if the texture needs to be inverted on the y axis during loading (true by default)
+     * @param materialSetupCallback defines a custom way of creating and setting up the material on the mesh
+     * @returns a new AdvancedDynamicTexture
+     */
+    static CreateForMesh(mesh: AbstractMesh, width?: number, height?: number, supportPointerMove?: boolean, onlyAlphaTesting?: boolean, invertY?: boolean, materialSetupCallback?: (mesh: AbstractMesh, uniqueId: string, texture: AdvancedDynamicTexture, onlyAlphaTesting: boolean) => void): AdvancedDynamicTexture;
+    private static _CreateMaterial;
+    /**
+     * Creates a new AdvancedDynamicTexture in projected mode (ie. attached to a mesh) BUT do not create a new material for the mesh. You will be responsible for connecting the texture
+     * @param mesh defines the mesh which will receive the texture
+     * @param width defines the texture width (1024 by default)
+     * @param height defines the texture height (1024 by default)
+     * @param supportPointerMove defines a boolean indicating if the texture must capture move events (true by default)
+     * @param invertY defines if the texture needs to be inverted on the y axis during loading (true by default)
+     * @returns a new AdvancedDynamicTexture
+     */
+    static CreateForMeshTexture(mesh: AbstractMesh, width?: number, height?: number, supportPointerMove?: boolean, invertY?: boolean): AdvancedDynamicTexture;
+    /**
+     * Creates a new AdvancedDynamicTexture in fullscreen mode.
+     * In this mode the texture will rely on a layer for its rendering.
+     * This allows it to be treated like any other layer.
+     * As such, if you have a multi camera setup, you can set the layerMask on the GUI as well.
+     * LayerMask is set through advancedTexture.layer.layerMask
+     * @param name defines name for the texture
+     * @param foreground defines a boolean indicating if the texture must be rendered in foreground (default is true)
+     * @param scene defines the hosting scene
+     * @param sampling defines the texture sampling mode (Texture.BILINEAR_SAMPLINGMODE by default)
+     * @param adaptiveScaling defines whether to automatically scale root to match hardwarescaling (false by default)
+     * @returns a new AdvancedDynamicTexture
+     */
+    static CreateFullscreenUI(name: string, foreground?: boolean, scene?: Nullable<Scene>, sampling?: number, adaptiveScaling?: boolean): AdvancedDynamicTexture;
+    /**
+     * Scales the texture
+     * @param ratio the scale factor to apply to both width and height
+     */
+    scale(ratio: number): void;
+    /**
+     * Resizes the texture
+     * @param width the new width
+     * @param height the new height
+     */
+    scaleTo(width: number, height: number): void;
+}
+export { IFocusableControl };