@babylonjs/gui 5.24.0 → 5.25.0

package/2D/controls/control.js

@@ -27,53 +27,53 @@ export class Control {
         this._alpha = 1;
         this._alphaSet = false;
         this._zIndex = 0;
-        /** @hidden */
+        /** @internal */
         this._currentMeasure = Measure.Empty();
-        /** @hidden */
+        /** @internal */
         this._tempPaddingMeasure = Measure.Empty();
         this._fontFamily = "Arial";
         this._fontStyle = "";
         this._fontWeight = "";
         this._fontSize = new ValueAndUnit(18, ValueAndUnit.UNITMODE_PIXEL, false);
-        /** @hidden */
+        /** @internal */
         this._width = new ValueAndUnit(1, ValueAndUnit.UNITMODE_PERCENTAGE, false);
-        /** @hidden */
+        /** @internal */
         this._height = new ValueAndUnit(1, ValueAndUnit.UNITMODE_PERCENTAGE, false);
         this._color = "";
         this._style = null;
-        /** @hidden */
+        /** @internal */
         this._horizontalAlignment = Control.HORIZONTAL_ALIGNMENT_CENTER;
-        /** @hidden */
+        /** @internal */
         this._verticalAlignment = Control.VERTICAL_ALIGNMENT_CENTER;
-        /** @hidden */
+        /** @internal */
         this._isDirty = true;
-        /** @hidden */
+        /** @internal */
         this._wasDirty = false;
-        /** @hidden */
+        /** @internal */
         this._tempParentMeasure = Measure.Empty();
-        /** @hidden */
+        /** @internal */
         this._prevCurrentMeasureTransformedIntoGlobalSpace = Measure.Empty();
-        /** @hidden */
+        /** @internal */
         this._cachedParentMeasure = Measure.Empty();
         this._descendantsOnlyPadding = false;
         this._paddingLeft = new ValueAndUnit(0);
         this._paddingRight = new ValueAndUnit(0);
         this._paddingTop = new ValueAndUnit(0);
         this._paddingBottom = new ValueAndUnit(0);
-        /** @hidden */
+        /** @internal */
         this._left = new ValueAndUnit(0);
-        /** @hidden */
+        /** @internal */
         this._top = new ValueAndUnit(0);
         this._scaleX = 1.0;
         this._scaleY = 1.0;
         this._rotation = 0;
         this._transformCenterX = 0.5;
         this._transformCenterY = 0.5;
-        /** @hidden */
+        /** @internal */
         this._transformMatrix = Matrix2D.Identity();
-        /** @hidden */
+        /** @internal */
         this._invertTransformMatrix = Matrix2D.Identity();
-        /** @hidden */
+        /** @internal */
         this._transformedPosition = Vector2.Zero();
         this._isMatrixDirty = true;
         this._isVisible = true;
@@ -92,13 +92,13 @@ export class Control {
         this._disabledColor = "#9a9a9a";
         this._disabledColorItem = "#6a6a6a";
         this._isReadOnly = false;
-        /** @hidden */
+        /** @internal */
         this._rebuildLayout = false;
-        /** @hidden */
+        /** @internal */
         this._customData = {};
-        /** @hidden */
+        /** @internal */
         this._isClipped = false;
-        /** @hidden */
+        /** @internal */
         this._automaticSize = false;
         /**
          * Gets or sets an object used to store user defined information for the node
@@ -137,9 +137,9 @@ export class Control {
         this._shadowColor = "black";
         /** Gets or sets the cursor to use when the control is hovered */
         this.hoverCursor = "";
-        /** @hidden */
+        /** @internal */
         this._linkOffsetX = new ValueAndUnit(0);
-        /** @hidden */
+        /** @internal */
         this._linkOffsetY = new ValueAndUnit(0);
         /**
          * An event triggered when pointer wheel is scrolled
@@ -545,7 +545,7 @@ export class Control {
         this._markAsDirty();
         this._resetFontCache();
     }
-    /** @hidden */
+    /** @internal */
     get _isFontSizeInPercentage() {
         return this._fontSize.isPercentage;
     }
@@ -671,7 +671,7 @@ export class Control {
         }
         this.paddingLeft = value + "px";
     }
-    /** @hidden */
+    /** @internal */
     get _paddingLeftInPixels() {
         if (this._descendantsOnlyPadding) {
             return 0;
@@ -703,7 +703,7 @@ export class Control {
         }
         this.paddingRight = value + "px";
     }
-    /** @hidden */
+    /** @internal */
     get _paddingRightInPixels() {
         if (this._descendantsOnlyPadding) {
             return 0;
@@ -735,7 +735,7 @@ export class Control {
         }
         this.paddingTop = value + "px";
     }
-    /** @hidden */
+    /** @internal */
     get _paddingTopInPixels() {
         if (this._descendantsOnlyPadding) {
             return 0;
@@ -767,7 +767,7 @@ export class Control {
         }
         this.paddingBottom = value + "px";
     }
-    /** @hidden */
+    /** @internal */
     get _paddingBottomInPixels() {
         if (this._descendantsOnlyPadding) {
             return 0;
@@ -931,7 +931,7 @@ export class Control {
         this._disabledColorItem = value;
         this._markAsDirty();
     }
-    /** @hidden */
+    /** @internal */
     _getTypeName() {
         return "Control";
     }
@@ -962,7 +962,7 @@ export class Control {
     markAllAsDirty() {
         this._markAllAsDirty();
     }
-    /** @hidden */
+    /** @internal */
     _resetFontCache() {
         this._fontSet = true;
         this._markAsDirty();
@@ -1119,8 +1119,7 @@ export class Control {
         this.paddingLeftInPixels = left;
     }
     /**
-     * @param projectedPosition
-     * @hidden
+     * @internal
      */
     _moveToProjectedPosition(projectedPosition) {
         const oldLeft = this._left.getValue(this._host);
@@ -1146,34 +1145,30 @@ export class Control {
         this._markAsDirty();
     }
     /**
-     * @param offset
-     * @hidden
+     * @internal
      */
     _offsetLeft(offset) {
         this._isDirty = true;
         this._currentMeasure.left += offset;
     }
     /**
-     * @param offset
-     * @hidden
+     * @internal
      */
     _offsetTop(offset) {
         this._isDirty = true;
         this._currentMeasure.top += offset;
     }
-    /** @hidden */
+    /** @internal */
     _markMatrixAsDirty() {
         this._isMatrixDirty = true;
         this._flagDescendantsAsMatrixDirty();
     }
-    /** @hidden */
+    /** @internal */
     _flagDescendantsAsMatrixDirty() {
         // No child
     }
     /**
-     * @param rect
-     * @param context
-     * @hidden
+     * @internal
      */
     _intersectsRect(rect, context) {
         // make sure we are transformed correctly before checking intersections. no-op if nothing is dirty.
@@ -1192,15 +1187,15 @@ export class Control {
         }
         return true;
     }
-    /** @hidden */
+    /** @internal */
     _computeAdditionnalOffsetX() {
         return 0;
     }
-    /** @hidden */
+    /** @internal */
     _computeAdditionnalOffsetY() {
         return 0;
     }
-    /** @hidden */
+    /** @internal */
     // eslint-disable-next-line @typescript-eslint/naming-convention
     invalidateRect() {
         this._transform();
@@ -1224,8 +1219,7 @@ export class Control {
         }
     }
     /**
-     * @param force
-     * @hidden
+     * @internal
      */
     _markAsDirty(force = false) {
         if (!this._isVisible && !force) {
@@ -1238,7 +1232,7 @@ export class Control {
             this._host.markAsDirty();
         }
     }
-    /** @hidden */
+    /** @internal */
     _markAllAsDirty() {
         this._markAsDirty();
         if (this._font) {
@@ -1246,8 +1240,7 @@ export class Control {
         }
     }
     /**
-     * @param host
-     * @hidden
+     * @internal
      */
     _link(host) {
         this._host = host;
@@ -1256,8 +1249,7 @@ export class Control {
         }
     }
     /**
-     * @param context
-     * @hidden
+     * @internal
      */
     _transform(context) {
         if (!this._isMatrixDirty && this._scaleX === 1 && this._scaleY === 1 && this._rotation === 0) {
@@ -1287,8 +1279,7 @@ export class Control {
         }
     }
     /**
-     * @param context
-     * @hidden
+     * @internal
      */
     _renderHighlight(context) {
         if (!this.isHighlighted) {
@@ -1301,15 +1292,13 @@ export class Control {
         context.restore();
     }
     /**
-     * @param context
-     * @hidden
+     * @internal
      */
     _renderHighlightSpecific(context) {
         context.strokeRect(this._currentMeasure.left, this._currentMeasure.top, this._currentMeasure.width, this._currentMeasure.height);
     }
     /**
-     * @param context
-     * @hidden
+     * @internal
      */
     _applyStates(context) {
         if (this._isFontSizeInPercentage) {
@@ -1336,9 +1325,7 @@ export class Control {
         }
     }
     /**
-     * @param parentMeasure
-     * @param context
-     * @hidden
+     * @internal
      */
     _layout(parentMeasure, context) {
         if (!this.isDirty && (!this.isVisible || this.notRenderable)) {
@@ -1367,9 +1354,7 @@ export class Control {
         return true;
     }
     /**
-     * @param parentMeasure
-     * @param context
-     * @hidden
+     * @internal
      */
     _processMeasures(parentMeasure, context) {
         this._tempPaddingMeasure.copyFrom(parentMeasure);
@@ -1422,7 +1407,7 @@ export class Control {
         }
         this._isClipped = false;
     }
-    /** @hidden */
+    /** @internal */
     _measure() {
         // Width / Height
         if (this._width.isPixel) {
@@ -1447,9 +1432,7 @@ export class Control {
         }
     }
     /**
-     * @param parentMeasure
-     * @param context
-     * @hidden
+     * @internal
      */
     _computeAlignment(parentMeasure, context) {
         const width = this._currentMeasure.width;
@@ -1527,24 +1510,19 @@ export class Control {
         this._currentMeasure.top += y;
     }
     /**
-     * @param parentMeasure
-     * @param context
-     * @hidden
+     * @internal
      */
     _preMeasure(parentMeasure, context) {
         // Do nothing
     }
     /**
-     * @param parentMeasure
-     * @param context
-     * @hidden
+     * @internal
      */
     _additionalProcessing(parentMeasure, context) {
         // Do nothing
     }
     /**
-     * @param context
-     * @hidden
+     * @internal
      */
     _clipForChildren(context) {
         // DO nothing
@@ -1579,9 +1557,7 @@ export class Control {
         context.clip();
     }
     /**
-     * @param context
-     * @param invalidatedRectangle
-     * @hidden
+     * @internal
      */
     _render(context, invalidatedRectangle) {
         if (!this.isVisible || this.notRenderable || this._isClipped) {
@@ -1617,9 +1593,7 @@ export class Control {
         return true;
     }
     /**
-     * @param context
-     * @param invalidatedRectangle
-     * @hidden
+     * @internal
      */
     _draw(context, invalidatedRectangle) {
         // Do nothing
@@ -1654,15 +1628,7 @@ export class Control {
         return true;
     }
     /**
-     * @param x
-     * @param y
-     * @param pi
-     * @param type
-     * @param pointerId
-     * @param buttonIndex
-     * @param deltaX
-     * @param deltaY
-     * @hidden
+     * @internal
      */
     _processPicking(x, y, pi, type, pointerId, buttonIndex, deltaX, deltaY) {
         if (!this._isEnabled) {
@@ -1678,11 +1644,7 @@ export class Control {
         return true;
     }
     /**
-     * @param target
-     * @param coordinates
-     * @param pointerId
-     * @param pi
-     * @hidden
+     * @internal
      */
     _onPointerMove(target, coordinates, pointerId, pi) {
         const canNotify = this.onPointerMoveObservable.notifyObservers(coordinates, -1, target, this, pi);
@@ -1691,9 +1653,7 @@ export class Control {
         }
     }
     /**
-     * @param target
-     * @param pi
-     * @hidden
+     * @internal
      */
     _onPointerEnter(target, pi) {
         if (!this._isEnabled) {
@@ -1714,10 +1674,7 @@ export class Control {
         return true;
     }
     /**
-     * @param target
-     * @param pi
-     * @param force
-     * @hidden
+     * @internal
      */
     _onPointerOut(target, pi, force = false) {
         if (!force && (!this._isEnabled || target === this)) {
@@ -1733,12 +1690,7 @@ export class Control {
         }
     }
     /**
-     * @param target
-     * @param coordinates
-     * @param pointerId
-     * @param buttonIndex
-     * @param pi
-     * @hidden
+     * @internal
      */
     _onPointerDown(target, coordinates, pointerId, buttonIndex, pi) {
         // Prevent pointerout to lose control context.
@@ -1759,13 +1711,7 @@ export class Control {
         return true;
     }
     /**
-     * @param target
-     * @param coordinates
-     * @param pointerId
-     * @param buttonIndex
-     * @param notifyClick
-     * @param pi
-     * @hidden
+     * @internal
      */
     _onPointerUp(target, coordinates, pointerId, buttonIndex, notifyClick, pi) {
         if (!this._isEnabled) {
@@ -1786,8 +1732,7 @@ export class Control {
         }
     }
     /**
-     * @param pointerId
-     * @hidden
+     * @internal
      */
     _forcePointerUp(pointerId = null) {
         if (pointerId !== null) {
@@ -1800,9 +1745,7 @@ export class Control {
         }
     }
     /**
-     * @param deltaX
-     * @param deltaY
-     * @hidden
+     * @internal
      */
     _onWheelScroll(deltaX, deltaY) {
         if (!this._isEnabled) {
@@ -1813,18 +1756,10 @@ export class Control {
             this.parent._onWheelScroll(deltaX, deltaY);
         }
     }
-    /** @hidden */
+    /** @internal */
     _onCanvasBlur() { }
     /**
-     * @param type
-     * @param x
-     * @param y
-     * @param pi
-     * @param pointerId
-     * @param buttonIndex
-     * @param deltaX
-     * @param deltaY
-     * @hidden
+     * @internal
      */
     _processObservables(type, x, y, pi, pointerId, buttonIndex, deltaX, deltaY) {
         if (!this._isEnabled) {
@@ -1894,9 +1829,7 @@ export class Control {
         }
     }
     /**
-     * @param serializedObject
-     * @param host
-     * @hidden
+     * @internal
      */
     _parseFromContent(serializedObject, host) {
         if (serializedObject.fontFamily) {
@@ -1967,8 +1900,7 @@ export class Control {
         return Control._VERTICAL_ALIGNMENT_CENTER;
     }
     /**
-     * @param font
-     * @hidden
+     * @internal
      */
     static _GetFontOffset(font) {
         if (Control._FontHeightSizes[font]) {
@@ -1996,12 +1928,7 @@ export class Control {
         return control;
     }
     /**
-     * @param x
-     * @param y
-     * @param width
-     * @param height
-     * @param context
-     * @hidden
+     * @internal
      */
     static drawEllipse(x, y, width, height, context) {
         context.translate(x, y);