@babylonjs/gui 5.0.0-rc.2 → 5.0.0-rc.5

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

@@ -1,16 +1,16 @@
-import { Nullable } from "@babylonjs/core/types";
-import { Observable } from "@babylonjs/core/Misc/observable";
-import { Vector2, Vector3 } from "@babylonjs/core/Maths/math.vector";
-import { PointerInfoBase } from "@babylonjs/core/Events/pointerEvents";
-import { TransformNode } from "@babylonjs/core/Meshes/transformNode";
-import { Scene } from "@babylonjs/core/scene";
+import { Nullable } from "@babylonjs/core/types.js";
+import { Observable } from "@babylonjs/core/Misc/observable.js";
+import { Vector2, Vector3 } from "@babylonjs/core/Maths/math.vector.js";
+import { PointerInfoBase } from "@babylonjs/core/Events/pointerEvents.js";
+import { TransformNode } from "@babylonjs/core/Meshes/transformNode.js";
+import { Scene } from "@babylonjs/core/scene.js";
 import { Container } from "./container";
 import { AdvancedDynamicTexture } from "../advancedDynamicTexture";
 import { ValueAndUnit } from "../valueAndUnit";
 import { Measure } from "../measure";
 import { Style } from "../style";
 import { Matrix2D, Vector2WithInfo } from "../math2D";
-import { ICanvasRenderingContext } from "@babylonjs/core/Engines/ICanvas";
+import { ICanvasRenderingContext } from "@babylonjs/core/Engines/ICanvas.js";
 /**
  * Root class used for all 2D controls
  * @see https://doc.babylonjs.com/how_to/gui#controls
@@ -525,7 +525,7 @@ export declare class Control {
      * Mark control element as dirty
      * @param force force non visible elements to be marked too
      */
-    markAsDirty(force: false): void;
+    markAsDirty(force?: boolean): void;
     /**
      * Mark the element and its children as dirty
      */
@@ -584,7 +584,7 @@ export declare class Control {
      */
     linkWithMesh(mesh: Nullable<TransformNode>): void;
     /**
-     * Shorthand funtion to set the top, right, bottom, and left padding values on the control.
+     * Shorthand function to set the top, right, bottom, and left padding values on the control.
      * @param { string | number} paddingTop - The value of the top padding.
      * @param { string | number} paddingRight - The value of the right padding. If omitted, top is used.
      * @param { string | number} paddingBottom - The value of the bottom padding. If omitted, top is used.
@@ -601,17 +601,30 @@ export declare class Control {
      * @see https://doc.babylonjs.com/how_to/gui#position-and-size
      */
     setPaddingInPixels(paddingTop: number, paddingRight?: number, paddingBottom?: number, paddingLeft?: number): void;
-    /** @hidden */
+    /**
+     * @param projectedPosition
+     * @hidden
+     */
     _moveToProjectedPosition(projectedPosition: Vector3): void;
-    /** @hidden */
+    /**
+     * @param offset
+     * @hidden
+     */
     _offsetLeft(offset: number): void;
-    /** @hidden */
+    /**
+     * @param offset
+     * @hidden
+     */
     _offsetTop(offset: number): void;
     /** @hidden */
     _markMatrixAsDirty(): void;
     /** @hidden */
     _flagDescendantsAsMatrixDirty(): void;
-    /** @hidden */
+    /**
+     * @param rect
+     * @param context
+     * @hidden
+     */
     _intersectsRect(rect: Measure, context?: ICanvasRenderingContext): boolean;
     /** @hidden */
     protected _computeAdditionnalOffsetX(): number;
@@ -619,41 +632,90 @@ export declare class Control {
     protected _computeAdditionnalOffsetY(): number;
     /** @hidden */
     protected invalidateRect(): void;
-    /** @hidden */
+    /**
+     * @param force
+     * @hidden
+     */
     _markAsDirty(force?: boolean): void;
     /** @hidden */
     _markAllAsDirty(): void;
-    /** @hidden */
+    /**
+     * @param host
+     * @hidden
+     */
     _link(host: AdvancedDynamicTexture): void;
-    /** @hidden */
+    /**
+     * @param context
+     * @hidden
+     */
     protected _transform(context?: ICanvasRenderingContext): void;
-    /** @hidden */
+    /**
+     * @param context
+     * @hidden
+     */
     _renderHighlight(context: ICanvasRenderingContext): void;
-    /** @hidden */
+    /**
+     * @param context
+     * @hidden
+     */
     _renderHighlightSpecific(context: ICanvasRenderingContext): void;
-    /** @hidden */
+    /**
+     * @param context
+     * @hidden
+     */
     protected _applyStates(context: ICanvasRenderingContext): void;
-    /** @hidden */
+    /**
+     * @param parentMeasure
+     * @param context
+     * @hidden
+     */
     _layout(parentMeasure: Measure, context: ICanvasRenderingContext): boolean;
-    /** @hidden */
+    /**
+     * @param parentMeasure
+     * @param context
+     * @hidden
+     */
     protected _processMeasures(parentMeasure: Measure, context: ICanvasRenderingContext): void;
     protected _evaluateClippingState(parentMeasure: Measure): void;
     /** @hidden */
     _measure(): void;
-    /** @hidden */
+    /**
+     * @param parentMeasure
+     * @param context
+     * @hidden
+     */
     protected _computeAlignment(parentMeasure: Measure, context: ICanvasRenderingContext): void;
-    /** @hidden */
+    /**
+     * @param parentMeasure
+     * @param context
+     * @hidden
+     */
     protected _preMeasure(parentMeasure: Measure, context: ICanvasRenderingContext): void;
-    /** @hidden */
+    /**
+     * @param parentMeasure
+     * @param context
+     * @hidden
+     */
     protected _additionalProcessing(parentMeasure: Measure, context: ICanvasRenderingContext): void;
-    /** @hidden */
+    /**
+     * @param context
+     * @hidden
+     */
     protected _clipForChildren(context: ICanvasRenderingContext): void;
     private static _ClipMeasure;
     private _tmpMeasureA;
     private _clip;
-    /** @hidden */
+    /**
+     * @param context
+     * @param invalidatedRectangle
+     * @hidden
+     */
     _render(context: ICanvasRenderingContext, invalidatedRectangle?: Nullable<Measure>): boolean;
-    /** @hidden */
+    /**
+     * @param context
+     * @param invalidatedRectangle
+     * @hidden
+     */
     _draw(context: ICanvasRenderingContext, invalidatedRectangle?: Nullable<Measure>): void;
     /**
      * Tests if a given coordinates belong to the current control
@@ -662,25 +724,82 @@ export declare class Control {
      * @returns true if the coordinates are inside the control
      */
     contains(x: number, y: number): boolean;
-    /** @hidden */
+    /**
+     * @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;
-    /** @hidden */
+    /**
+     * @param target
+     * @param coordinates
+     * @param pointerId
+     * @param pi
+     * @hidden
+     */
     _onPointerMove(target: Control, coordinates: Vector2, pointerId: number, pi: Nullable<PointerInfoBase>): void;
-    /** @hidden */
+    /**
+     * @param target
+     * @param pi
+     * @hidden
+     */
     _onPointerEnter(target: Control, pi: Nullable<PointerInfoBase>): boolean;
-    /** @hidden */
+    /**
+     * @param target
+     * @param pi
+     * @param force
+     * @hidden
+     */
     _onPointerOut(target: Control, pi: Nullable<PointerInfoBase>, force?: boolean): void;
-    /** @hidden */
+    /**
+     * @param target
+     * @param coordinates
+     * @param pointerId
+     * @param buttonIndex
+     * @param pi
+     * @hidden
+     */
     _onPointerDown(target: Control, coordinates: Vector2, pointerId: number, buttonIndex: number, pi: Nullable<PointerInfoBase>): boolean;
-    /** @hidden */
+    /**
+     * @param target
+     * @param coordinates
+     * @param pointerId
+     * @param buttonIndex
+     * @param notifyClick
+     * @param pi
+     * @hidden
+     */
     _onPointerUp(target: Control, coordinates: Vector2, pointerId: number, buttonIndex: number, notifyClick: boolean, pi?: Nullable<PointerInfoBase>): void;
-    /** @hidden */
+    /**
+     * @param pointerId
+     * @hidden
+     */
     _forcePointerUp(pointerId?: Nullable<number>): void;
-    /** @hidden */
+    /**
+     * @param deltaX
+     * @param deltaY
+     * @hidden
+     */
     _onWheelScroll(deltaX?: number, deltaY?: number): void;
     /** @hidden */
     _onCanvasBlur(): void;
-    /** @hidden */
+    /**
+     * @param type
+     * @param x
+     * @param y
+     * @param pi
+     * @param pointerId
+     * @param buttonIndex
+     * @param deltaX
+     * @param deltaY
+     * @hidden
+     */
     _processObservables(type: number, x: number, y: number, pi: Nullable<PointerInfoBase>, pointerId: number, buttonIndex: number, deltaX?: number, deltaY?: number): boolean;
     private _prepareFont;
     /**
@@ -688,7 +807,11 @@ export declare class Control {
      * @param serializationObject defined the JSON serialized object
      */
     serialize(serializationObject: any): void;
-    /** @hidden */
+    /**
+     * @param serializedObject
+     * @param host
+     * @hidden
+     */
     _parseFromContent(serializedObject: any, host: AdvancedDynamicTexture): void;
     /** Releases associated resources */
     dispose(): void;
@@ -711,7 +834,10 @@ export declare class Control {
     /** VERTICAL_ALIGNMENT_CENTER */
     static get VERTICAL_ALIGNMENT_CENTER(): number;
     private static _FontHeightSizes;
-    /** @hidden */
+    /**
+     * @param font
+     * @hidden
+     */
     static _GetFontOffset(font: string): {
         ascent: number;
         height: number;
@@ -724,20 +850,17 @@ export declare class Control {
      * @returns a new Control
      */
     static Parse(serializedObject: any, host: AdvancedDynamicTexture): Control;
-    /**
-     * Creates a stack panel that can be used to render headers
-     * @param control defines the control to associate with the header
-     * @param text defines the text of the header
-     * @param size defines the size of the header
-     * @param options defines options used to configure the header
-     * @returns a new StackPanel
-     * @ignore
-     * @hidden
-     */
     static AddHeader: (control: Control, text: string, size: string | number, options: {
         isHorizontal: boolean;
         controlFirst: boolean;
     }) => any;
-    /** @hidden */
+    /**
+     * @param x
+     * @param y
+     * @param width
+     * @param height
+     * @param context
+     * @hidden
+     */
     protected static drawEllipse(x: number, y: number, width: number, height: number, context: ICanvasRenderingContext): void;
 }