@babylonjs/gui 5.23.0 → 5.25.0

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

@@ -25,24 +25,24 @@ export declare class Control {
     private _alpha;
     private _alphaSet;
     private _zIndex;
-    /** @hidden */
+    /** @internal */
     _host: AdvancedDynamicTexture;
     /** Gets or sets the control parent */
     parent: Nullable<Container>;
-    /** @hidden */
+    /** @internal */
     _currentMeasure: Measure;
-    /** @hidden */
+    /** @internal */
     _tempPaddingMeasure: Measure;
     private _fontFamily;
     private _fontStyle;
     private _fontWeight;
     private _fontSize;
     private _font;
-    /** @hidden */
+    /** @internal */
     _width: ValueAndUnit;
-    /** @hidden */
+    /** @internal */
     _height: ValueAndUnit;
-    /** @hidden */
+    /** @internal */
     protected _fontOffset: {
         ascent: number;
         height: number;
@@ -51,39 +51,39 @@ export declare class Control {
     private _color;
     private _style;
     private _styleObserver;
-    /** @hidden */
+    /** @internal */
     protected _horizontalAlignment: number;
-    /** @hidden */
+    /** @internal */
     protected _verticalAlignment: number;
-    /** @hidden */
+    /** @internal */
     protected _isDirty: boolean;
-    /** @hidden */
+    /** @internal */
     protected _wasDirty: boolean;
-    /** @hidden */
+    /** @internal */
     _tempParentMeasure: Measure;
-    /** @hidden */
+    /** @internal */
     _prevCurrentMeasureTransformedIntoGlobalSpace: Measure;
-    /** @hidden */
+    /** @internal */
     protected _cachedParentMeasure: Measure;
     private _descendantsOnlyPadding;
     private _paddingLeft;
     private _paddingRight;
     private _paddingTop;
     private _paddingBottom;
-    /** @hidden */
+    /** @internal */
     _left: ValueAndUnit;
-    /** @hidden */
+    /** @internal */
     _top: ValueAndUnit;
     private _scaleX;
     private _scaleY;
     private _rotation;
     private _transformCenterX;
     private _transformCenterY;
-    /** @hidden */
+    /** @internal */
     _transformMatrix: Matrix2D;
-    /** @hidden */
+    /** @internal */
     protected _invertTransformMatrix: Matrix2D;
-    /** @hidden */
+    /** @internal */
     protected _transformedPosition: Vector2;
     private _isMatrixDirty;
     private _cachedOffsetX;
@@ -92,7 +92,7 @@ export declare class Control {
     private _isHighlighted;
     private _highlightColor;
     protected _highlightLineWidth: number;
-    /** @hidden */
+    /** @internal */
     _linkedMesh: Nullable<TransformNode>;
     private _fontSet;
     private _dummyVector2;
@@ -106,15 +106,15 @@ export declare class Control {
     protected _disabledColor: string;
     protected _disabledColorItem: string;
     protected _isReadOnly: boolean;
-    /** @hidden */
+    /** @internal */
     protected _rebuildLayout: boolean;
-    /** @hidden */
+    /** @internal */
     _customData: any;
-    /** @hidden */
+    /** @internal */
     _isClipped: boolean;
-    /** @hidden */
+    /** @internal */
     _automaticSize: boolean;
-    /** @hidden */
+    /** @internal */
     _tag: any;
     /**
      * Gets or sets the unique id of the node. Please note that this number will be updated when the control is added to a container
@@ -180,9 +180,9 @@ export declare class Control {
     set shadowColor(value: string);
     /** Gets or sets the cursor to use when the control is hovered */
     hoverCursor: string;
-    /** @hidden */
+    /** @internal */
     protected _linkOffsetX: ValueAndUnit;
-    /** @hidden */
+    /** @internal */
     protected _linkOffsetY: ValueAndUnit;
     /** Gets the control type name */
     get typeName(): string;
@@ -352,7 +352,7 @@ export declare class Control {
      */
     get style(): Nullable<Style>;
     set style(value: Nullable<Style>);
-    /** @hidden */
+    /** @internal */
     get _isFontSizeInPercentage(): boolean;
     /** Gets or sets font size in pixels */
     get fontSizeInPixels(): number;
@@ -396,7 +396,7 @@ export declare class Control {
      */
     get paddingLeftInPixels(): number;
     set paddingLeftInPixels(value: number);
-    /** @hidden */
+    /** @internal */
     get _paddingLeftInPixels(): number;
     /**
      * Gets or sets a value indicating the padding to use on the right of the control
@@ -410,7 +410,7 @@ export declare class Control {
      */
     get paddingRightInPixels(): number;
     set paddingRightInPixels(value: number);
-    /** @hidden */
+    /** @internal */
     get _paddingRightInPixels(): number;
     /**
      * Gets or sets a value indicating the padding to use on the top of the control
@@ -424,7 +424,7 @@ export declare class Control {
      */
     get paddingTopInPixels(): number;
     set paddingTopInPixels(value: number);
-    /** @hidden */
+    /** @internal */
     get _paddingTopInPixels(): number;
     /**
      * Gets or sets a value indicating the padding to use on the bottom of the control
@@ -438,7 +438,7 @@ export declare class Control {
      */
     get paddingBottomInPixels(): number;
     set paddingBottomInPixels(value: number);
-    /** @hidden */
+    /** @internal */
     get _paddingBottomInPixels(): number;
     /**
      * Gets or sets a value indicating the left coordinate of the control
@@ -519,7 +519,7 @@ export declare class Control {
     constructor(
     /** defines the name of the control */
     name?: string | undefined);
-    /** @hidden */
+    /** @internal */
     protected _getTypeName(): string;
     /**
      * Gets the first ascendant in the hierarchy of the given type
@@ -536,7 +536,7 @@ export declare class Control {
      * Mark the element and its children as dirty
      */
     markAllAsDirty(): void;
-    /** @hidden */
+    /** @internal */
     _resetFontCache(): void;
     /**
      * Determines if a container is an ascendant of the current control
@@ -580,7 +580,7 @@ export declare class Control {
      * Will return all controls that have this control as ascendant
      * @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
+     * @returns all child controls
      */
     getDescendants(directDescendantsOnly?: boolean, predicate?: (control: Control) => boolean): Control[];
     /**
@@ -608,119 +608,93 @@ export declare class Control {
      */
     setPaddingInPixels(paddingTop: number, paddingRight?: number, paddingBottom?: number, paddingLeft?: number): void;
     /**
-     * @param projectedPosition
-     * @hidden
+     * @internal
      */
     _moveToProjectedPosition(projectedPosition: Vector3): void;
     /**
-     * @param offset
-     * @hidden
+     * @internal
      */
     _offsetLeft(offset: number): void;
     /**
-     * @param offset
-     * @hidden
+     * @internal
      */
     _offsetTop(offset: number): void;
-    /** @hidden */
+    /** @internal */
     _markMatrixAsDirty(): void;
-    /** @hidden */
+    /** @internal */
     _flagDescendantsAsMatrixDirty(): void;
     /**
-     * @param rect
-     * @param context
-     * @hidden
+     * @internal
      */
     _intersectsRect(rect: Measure, context?: ICanvasRenderingContext): boolean;
-    /** @hidden */
+    /** @internal */
     protected _computeAdditionnalOffsetX(): number;
-    /** @hidden */
+    /** @internal */
     protected _computeAdditionnalOffsetY(): number;
-    /** @hidden */
+    /** @internal */
     protected invalidateRect(): void;
     /**
-     * @param force
-     * @hidden
+     * @internal
      */
     _markAsDirty(force?: boolean): void;
-    /** @hidden */
+    /** @internal */
     _markAllAsDirty(): void;
     /**
-     * @param host
-     * @hidden
+     * @internal
      */
     _link(host: AdvancedDynamicTexture): void;
     /**
-     * @param context
-     * @hidden
+     * @internal
      */
     protected _transform(context?: ICanvasRenderingContext): void;
     /**
-     * @param context
-     * @hidden
+     * @internal
      */
     _renderHighlight(context: ICanvasRenderingContext): void;
     /**
-     * @param context
-     * @hidden
+     * @internal
      */
     _renderHighlightSpecific(context: ICanvasRenderingContext): void;
     /**
-     * @param context
-     * @hidden
+     * @internal
      */
     protected _applyStates(context: ICanvasRenderingContext): void;
     /**
-     * @param parentMeasure
-     * @param context
-     * @hidden
+     * @internal
      */
     _layout(parentMeasure: Measure, context: ICanvasRenderingContext): boolean;
     /**
-     * @param parentMeasure
-     * @param context
-     * @hidden
+     * @internal
      */
     protected _processMeasures(parentMeasure: Measure, context: ICanvasRenderingContext): void;
     protected _evaluateClippingState(parentMeasure: Measure): void;
-    /** @hidden */
+    /** @internal */
     _measure(): void;
     /**
-     * @param parentMeasure
-     * @param context
-     * @hidden
+     * @internal
      */
     protected _computeAlignment(parentMeasure: Measure, context: ICanvasRenderingContext): void;
     /**
-     * @param parentMeasure
-     * @param context
-     * @hidden
+     * @internal
      */
     protected _preMeasure(parentMeasure: Measure, context: ICanvasRenderingContext): void;
     /**
-     * @param parentMeasure
-     * @param context
-     * @hidden
+     * @internal
      */
     protected _additionalProcessing(parentMeasure: Measure, context: ICanvasRenderingContext): void;
     /**
-     * @param context
-     * @hidden
+     * @internal
      */
     protected _clipForChildren(context: ICanvasRenderingContext): void;
     private static _ClipMeasure;
     private _tmpMeasureA;
     private _clip;
     /**
-     * @param context
-     * @param invalidatedRectangle
-     * @hidden
+     * @internal
      */
     _render(context: ICanvasRenderingContext, invalidatedRectangle?: Nullable<Measure>): boolean;
     /**
-     * @param context
-     * @param invalidatedRectangle
-     * @hidden
+     * @internal
      */
     _draw(context: ICanvasRenderingContext, invalidatedRectangle?: Nullable<Measure>): void;
     /**
@@ -731,80 +705,41 @@ export declare class Control {
      */
     contains(x: number, y: number): boolean;
     /**
-     * @param x
-     * @param y
-     * @param pi
-     * @param type
-     * @param pointerId
-     * @param buttonIndex
-     * @param deltaX
-     * @param deltaY
-     * @hidden
+     * @internal
      */
     _processPicking(x: number, y: number, pi: Nullable<PointerInfoBase>, type: number, pointerId: number, buttonIndex: number, deltaX?: number, deltaY?: number): boolean;
     /**
-     * @param target
-     * @param coordinates
-     * @param pointerId
-     * @param pi
-     * @hidden
+     * @internal
      */
     _onPointerMove(target: Control, coordinates: Vector2, pointerId: number, pi: Nullable<PointerInfoBase>): void;
     /**
-     * @param target
-     * @param pi
-     * @hidden
+     * @internal
      */
     _onPointerEnter(target: Control, pi: Nullable<PointerInfoBase>): boolean;
     /**
-     * @param target
-     * @param pi
-     * @param force
-     * @hidden
+     * @internal
      */
     _onPointerOut(target: Control, pi: Nullable<PointerInfoBase>, force?: boolean): void;
     /**
-     * @param target
-     * @param coordinates
-     * @param pointerId
-     * @param buttonIndex
-     * @param pi
-     * @hidden
+     * @internal
      */
     _onPointerDown(target: Control, coordinates: Vector2, pointerId: number, buttonIndex: number, pi: Nullable<PointerInfoBase>): boolean;
     /**
-     * @param target
-     * @param coordinates
-     * @param pointerId
-     * @param buttonIndex
-     * @param notifyClick
-     * @param pi
-     * @hidden
+     * @internal
      */
     _onPointerUp(target: Control, coordinates: Vector2, pointerId: number, buttonIndex: number, notifyClick: boolean, pi?: Nullable<PointerInfoBase>): void;
     /**
-     * @param pointerId
-     * @hidden
+     * @internal
      */
     _forcePointerUp(pointerId?: Nullable<number>): void;
     /**
-     * @param deltaX
-     * @param deltaY
-     * @hidden
+     * @internal
      */
     _onWheelScroll(deltaX?: number, deltaY?: number): void;
-    /** @hidden */
+    /** @internal */
     _onCanvasBlur(): void;
     /**
-     * @param type
-     * @param x
-     * @param y
-     * @param pi
-     * @param pointerId
-     * @param buttonIndex
-     * @param deltaX
-     * @param deltaY
-     * @hidden
+     * @internal
      */
     _processObservables(type: number, x: number, y: number, pi: Nullable<PointerInfoBase>, pointerId: number, buttonIndex: number, deltaX?: number, deltaY?: number): boolean;
     private _prepareFont;
@@ -814,9 +749,7 @@ export declare class Control {
      */
     serialize(serializationObject: any): void;
     /**
-     * @param serializedObject
-     * @param host
-     * @hidden
+     * @internal
      */
     _parseFromContent(serializedObject: any, host: AdvancedDynamicTexture): void;
     /** Releases associated resources */
@@ -841,8 +774,7 @@ export declare class Control {
     static get VERTICAL_ALIGNMENT_CENTER(): number;
     private static _FontHeightSizes;
     /**
-     * @param font
-     * @hidden
+     * @internal
      */
     static _GetFontOffset(font: string): {
         ascent: number;
@@ -861,12 +793,7 @@ export declare class Control {
         controlFirst: boolean;
     }) => any;
     /**
-     * @param x
-     * @param y
-     * @param width
-     * @param height
-     * @param context
-     * @hidden
+     * @internal
      */
     protected static drawEllipse(x: number, y: number, width: number, height: number, context: ICanvasRenderingContext): void;
 }