@babylonjs/gui 5.0.0-rc.6 → 5.0.0

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

@@ -1,175 +1,175 @@
-import { Nullable } from "@babylonjs/core/types.js";
-import { Control } from "./control";
-import { Measure } from "../measure";
-import { AdvancedDynamicTexture } from "../advancedDynamicTexture";
-import { PointerInfoBase } from "@babylonjs/core/Events/pointerEvents.js";
-import { ICanvasRenderingContext } from "@babylonjs/core/Engines/ICanvas.js";
-import { DynamicTexture } from "@babylonjs/core/Materials/Textures/dynamicTexture.js";
-/**
- * Root class for 2D containers
- * @see https://doc.babylonjs.com/how_to/gui#containers
- */
-export declare class Container extends Control {
-    name?: string | undefined;
-    /** @hidden */
-    _children: Control[];
-    /** @hidden */
-    protected _measureForChildren: Measure;
-    /** @hidden */
-    protected _background: string;
-    /** @hidden */
-    protected _adaptWidthToChildren: boolean;
-    /** @hidden */
-    protected _adaptHeightToChildren: boolean;
-    /** @hidden */
-    protected _renderToIntermediateTexture: boolean;
-    /** @hidden */
-    protected _intermediateTexture: Nullable<DynamicTexture>;
-    /** Gets or sets boolean indicating if children should be rendered to an intermediate texture rather than directly to host, useful for alpha blending */
-    get renderToIntermediateTexture(): boolean;
-    set renderToIntermediateTexture(value: boolean);
-    /**
-     * Gets or sets a boolean indicating that layout cycle errors should be displayed on the console
-     */
-    logLayoutCycleErrors: boolean;
-    /**
-     * Gets or sets the number of layout cycles (a change involved by a control while evaluating the layout) allowed
-     */
-    maxLayoutCycle: number;
-    /** Gets or sets a boolean indicating if the container should try to adapt to its children height */
-    get adaptHeightToChildren(): boolean;
-    set adaptHeightToChildren(value: boolean);
-    /** Gets or sets a boolean indicating if the container should try to adapt to its children width */
-    get adaptWidthToChildren(): boolean;
-    set adaptWidthToChildren(value: boolean);
-    /** Gets or sets background color */
-    get background(): string;
-    set background(value: string);
-    /** Gets the list of children */
-    get children(): Control[];
-    get isReadOnly(): boolean;
-    set isReadOnly(value: boolean);
-    /**
-     * Creates a new Container
-     * @param name defines the name of the container
-     */
-    constructor(name?: string | undefined);
-    protected _getTypeName(): string;
-    _flagDescendantsAsMatrixDirty(): void;
-    /**
-     * Gets a child using its name
-     * @param name defines the child name to look for
-     * @returns the child control if found
-     */
-    getChildByName(name: string): Nullable<Control>;
-    /**
-     * Gets a child using its type and its name
-     * @param name defines the child name to look for
-     * @param type defines the child type to look for
-     * @returns the child control if found
-     */
-    getChildByType(name: string, type: string): Nullable<Control>;
-    /**
-     * Search for a specific control in children
-     * @param control defines the control to look for
-     * @returns true if the control is in child list
-     */
-    containsControl(control: Control): boolean;
-    /**
-     * Adds a new control to the current container
-     * @param control defines the control to add
-     * @returns the current container
-     */
-    addControl(control: Nullable<Control>): Container;
-    /**
-     * Removes all controls from the current container
-     * @returns the current container
-     */
-    clearControls(): Container;
-    /**
-     * Removes a control from the current container
-     * @param control defines the control to remove
-     * @returns the current container
-     */
-    removeControl(control: Control): Container;
-    /**
-     * @param control
-     * @hidden
-     */
-    _reOrderControl(control: Control): void;
-    /**
-     * @param offset
-     * @hidden
-     */
-    _offsetLeft(offset: number): void;
-    /**
-     * @param offset
-     * @hidden
-     */
-    _offsetTop(offset: number): void;
-    /** @hidden */
-    _markAllAsDirty(): void;
-    /**
-     * @param context
-     * @hidden
-     */
-    protected _localDraw(context: ICanvasRenderingContext): void;
-    /**
-     * @param host
-     * @hidden
-     */
-    _link(host: AdvancedDynamicTexture): void;
-    /** @hidden */
-    protected _beforeLayout(): void;
-    /**
-     * @param parentMeasure
-     * @param context
-     * @hidden
-     */
-    protected _processMeasures(parentMeasure: Measure, context: ICanvasRenderingContext): void;
-    /**
-     * @param parentMeasure
-     * @param context
-     * @hidden
-     */
-    _layout(parentMeasure: Measure, context: ICanvasRenderingContext): boolean;
-    protected _postMeasure(): void;
-    /**
-     * @param context
-     * @param invalidatedRectangle
-     * @hidden
-     */
-    _draw(context: ICanvasRenderingContext, invalidatedRectangle?: Measure): void;
-    getDescendantsToRef(results: Control[], directDescendantsOnly?: boolean, predicate?: (control: Control) => boolean): void;
-    /**
-     * @param x
-     * @param y
-     * @param pi
-     * @param type
-     * @param pointerId
-     * @param buttonIndex
-     * @param deltaX
-     * @param deltaY
-     * @hidden
-     */
-    _processPicking(x: number, y: number, pi: Nullable<PointerInfoBase>, type: number, pointerId: number, buttonIndex: number, deltaX?: number, deltaY?: number): boolean;
-    /**
-     * @param parentMeasure
-     * @param context
-     * @hidden
-     */
-    protected _additionalProcessing(parentMeasure: Measure, context: ICanvasRenderingContext): void;
-    /**
-     * Serializes the current control
-     * @param serializationObject defined the JSON serialized object
-     */
-    serialize(serializationObject: any): void;
-    /** Releases associated resources */
-    dispose(): void;
-    /**
-     * @param serializedObject
-     * @param host
-     * @hidden
-     */
-    _parseFromContent(serializedObject: any, host: AdvancedDynamicTexture): void;
-}
+import type { Nullable } from "@babylonjs/core/types.js";
+import { Control } from "./control";
+import { Measure } from "../measure";
+import type { AdvancedDynamicTexture } from "../advancedDynamicTexture";
+import type { PointerInfoBase } from "@babylonjs/core/Events/pointerEvents.js";
+import type { ICanvasRenderingContext } from "@babylonjs/core/Engines/ICanvas.js";
+import { DynamicTexture } from "@babylonjs/core/Materials/Textures/dynamicTexture.js";
+/**
+ * Root class for 2D containers
+ * @see https://doc.babylonjs.com/how_to/gui#containers
+ */
+export declare class Container extends Control {
+    name?: string | undefined;
+    /** @hidden */
+    _children: Control[];
+    /** @hidden */
+    protected _measureForChildren: Measure;
+    /** @hidden */
+    protected _background: string;
+    /** @hidden */
+    protected _adaptWidthToChildren: boolean;
+    /** @hidden */
+    protected _adaptHeightToChildren: boolean;
+    /** @hidden */
+    protected _renderToIntermediateTexture: boolean;
+    /** @hidden */
+    protected _intermediateTexture: Nullable<DynamicTexture>;
+    /** Gets or sets boolean indicating if children should be rendered to an intermediate texture rather than directly to host, useful for alpha blending */
+    get renderToIntermediateTexture(): boolean;
+    set renderToIntermediateTexture(value: boolean);
+    /**
+     * Gets or sets a boolean indicating that layout cycle errors should be displayed on the console
+     */
+    logLayoutCycleErrors: boolean;
+    /**
+     * Gets or sets the number of layout cycles (a change involved by a control while evaluating the layout) allowed
+     */
+    maxLayoutCycle: number;
+    /** Gets or sets a boolean indicating if the container should try to adapt to its children height */
+    get adaptHeightToChildren(): boolean;
+    set adaptHeightToChildren(value: boolean);
+    /** Gets or sets a boolean indicating if the container should try to adapt to its children width */
+    get adaptWidthToChildren(): boolean;
+    set adaptWidthToChildren(value: boolean);
+    /** Gets or sets background color */
+    get background(): string;
+    set background(value: string);
+    /** Gets the list of children */
+    get children(): Control[];
+    get isReadOnly(): boolean;
+    set isReadOnly(value: boolean);
+    /**
+     * Creates a new Container
+     * @param name defines the name of the container
+     */
+    constructor(name?: string | undefined);
+    protected _getTypeName(): string;
+    _flagDescendantsAsMatrixDirty(): void;
+    /**
+     * Gets a child using its name
+     * @param name defines the child name to look for
+     * @returns the child control if found
+     */
+    getChildByName(name: string): Nullable<Control>;
+    /**
+     * Gets a child using its type and its name
+     * @param name defines the child name to look for
+     * @param type defines the child type to look for
+     * @returns the child control if found
+     */
+    getChildByType(name: string, type: string): Nullable<Control>;
+    /**
+     * Search for a specific control in children
+     * @param control defines the control to look for
+     * @returns true if the control is in child list
+     */
+    containsControl(control: Control): boolean;
+    /**
+     * Adds a new control to the current container
+     * @param control defines the control to add
+     * @returns the current container
+     */
+    addControl(control: Nullable<Control>): Container;
+    /**
+     * Removes all controls from the current container
+     * @returns the current container
+     */
+    clearControls(): Container;
+    /**
+     * Removes a control from the current container
+     * @param control defines the control to remove
+     * @returns the current container
+     */
+    removeControl(control: Control): Container;
+    /**
+     * @param control
+     * @hidden
+     */
+    _reOrderControl(control: Control): void;
+    /**
+     * @param offset
+     * @hidden
+     */
+    _offsetLeft(offset: number): void;
+    /**
+     * @param offset
+     * @hidden
+     */
+    _offsetTop(offset: number): void;
+    /** @hidden */
+    _markAllAsDirty(): void;
+    /**
+     * @param context
+     * @hidden
+     */
+    protected _localDraw(context: ICanvasRenderingContext): void;
+    /**
+     * @param host
+     * @hidden
+     */
+    _link(host: AdvancedDynamicTexture): void;
+    /** @hidden */
+    protected _beforeLayout(): void;
+    /**
+     * @param parentMeasure
+     * @param context
+     * @hidden
+     */
+    protected _processMeasures(parentMeasure: Measure, context: ICanvasRenderingContext): void;
+    /**
+     * @param parentMeasure
+     * @param context
+     * @hidden
+     */
+    _layout(parentMeasure: Measure, context: ICanvasRenderingContext): boolean;
+    protected _postMeasure(): void;
+    /**
+     * @param context
+     * @param invalidatedRectangle
+     * @hidden
+     */
+    _draw(context: ICanvasRenderingContext, invalidatedRectangle?: Measure): void;
+    getDescendantsToRef(results: Control[], directDescendantsOnly?: boolean, predicate?: (control: Control) => boolean): void;
+    /**
+     * @param x
+     * @param y
+     * @param pi
+     * @param type
+     * @param pointerId
+     * @param buttonIndex
+     * @param deltaX
+     * @param deltaY
+     * @hidden
+     */
+    _processPicking(x: number, y: number, pi: Nullable<PointerInfoBase>, type: number, pointerId: number, buttonIndex: number, deltaX?: number, deltaY?: number): boolean;
+    /**
+     * @param parentMeasure
+     * @param context
+     * @hidden
+     */
+    protected _additionalProcessing(parentMeasure: Measure, context: ICanvasRenderingContext): void;
+    /**
+     * Serializes the current control
+     * @param serializationObject defined the JSON serialized object
+     */
+    serialize(serializationObject: any): void;
+    /** Releases associated resources */
+    dispose(): void;
+    /**
+     * @param serializedObject
+     * @param host
+     * @hidden
+     */
+    _parseFromContent(serializedObject: any, host: AdvancedDynamicTexture): void;
+}