@babylonjs/gui 5.0.0-rc.3 → 5.0.0-rc.6

package/2D/controls/control.js

@@ -1202,6 +1202,7 @@ var Control = /** @class */ (function () {
      * @param force force non visible elements to be marked too
      */
     Control.prototype.markAsDirty = function (force) {
+        if (force === void 0) { force = false; }
         this._markAsDirty(force);
     };
     /**
@@ -1332,7 +1333,7 @@ var Control = /** @class */ (function () {
         this._host._linkedControls.push(this);
     };
     /**
-     * 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.
@@ -1367,7 +1368,10 @@ var Control = /** @class */ (function () {
         this.paddingBottomInPixels = bottom;
         this.paddingLeftInPixels = left;
     };
-    /** @hidden */
+    /**
+     * @param projectedPosition
+     * @hidden
+     */
     Control.prototype._moveToProjectedPosition = function (projectedPosition) {
         var _a;
         var oldLeft = this._left.getValue(this._host);
@@ -1392,12 +1396,18 @@ var Control = /** @class */ (function () {
         this._top.ignoreAdaptiveScaling = true;
         this._markAsDirty();
     };
-    /** @hidden */
+    /**
+     * @param offset
+     * @hidden
+     */
     Control.prototype._offsetLeft = function (offset) {
         this._isDirty = true;
         this._currentMeasure.left += offset;
     };
-    /** @hidden */
+    /**
+     * @param offset
+     * @hidden
+     */
     Control.prototype._offsetTop = function (offset) {
         this._isDirty = true;
         this._currentMeasure.top += offset;
@@ -1411,7 +1421,11 @@ var Control = /** @class */ (function () {
     Control.prototype._flagDescendantsAsMatrixDirty = function () {
         // No child
     };
-    /** @hidden */
+    /**
+     * @param rect
+     * @param context
+     * @hidden
+     */
     Control.prototype._intersectsRect = function (rect, context) {
         // make sure we are transformed correctly before checking intersections. no-op if nothing is dirty.
         this._transform(context);
@@ -1438,6 +1452,7 @@ var Control = /** @class */ (function () {
         return 0;
     };
     /** @hidden */
+    // eslint-disable-next-line @typescript-eslint/naming-convention
     Control.prototype.invalidateRect = function () {
         this._transform();
         if (this.host && this.host.useInvalidateRectOptimization) {
@@ -1459,7 +1474,10 @@ var Control = /** @class */ (function () {
             this.host.invalidateRect(Math.floor(this._tmpMeasureA.left + leftShadowOffset - offsetX), Math.floor(this._tmpMeasureA.top + topShadowOffset - offsetY), Math.ceil(this._tmpMeasureA.left + this._tmpMeasureA.width + rightShadowOffset + offsetX), Math.ceil(this._tmpMeasureA.top + this._tmpMeasureA.height + bottomShadowOffset + offsetY));
         }
     };
-    /** @hidden */
+    /**
+     * @param force
+     * @hidden
+     */
     Control.prototype._markAsDirty = function (force) {
         if (force === void 0) { force = false; }
         if (!this._isVisible && !force) {
@@ -1479,14 +1497,20 @@ var Control = /** @class */ (function () {
             this._prepareFont();
         }
     };
-    /** @hidden */
+    /**
+     * @param host
+     * @hidden
+     */
     Control.prototype._link = function (host) {
         this._host = host;
         if (this._host) {
             this.uniqueId = this._host.getScene().getUniqueId();
         }
     };
-    /** @hidden */
+    /**
+     * @param context
+     * @hidden
+     */
     Control.prototype._transform = function (context) {
         if (!this._isMatrixDirty && this._scaleX === 1 && this._scaleY === 1 && this._rotation === 0) {
             return;
@@ -1514,7 +1538,10 @@ var Control = /** @class */ (function () {
             this._currentMeasure.transformToRef(this._transformMatrix, this._evaluatedMeasure);
         }
     };
-    /** @hidden */
+    /**
+     * @param context
+     * @hidden
+     */
     Control.prototype._renderHighlight = function (context) {
         if (!this.isHighlighted) {
             return;
@@ -1525,11 +1552,17 @@ var Control = /** @class */ (function () {
         this._renderHighlightSpecific(context);
         context.restore();
     };
-    /** @hidden */
+    /**
+     * @param context
+     * @hidden
+     */
     Control.prototype._renderHighlightSpecific = function (context) {
         context.strokeRect(this._currentMeasure.left, this._currentMeasure.top, this._currentMeasure.width, this._currentMeasure.height);
     };
-    /** @hidden */
+    /**
+     * @param context
+     * @hidden
+     */
     Control.prototype._applyStates = function (context) {
         if (this._isFontSizeInPercentage) {
             this._fontSet = true;
@@ -1554,7 +1587,11 @@ var Control = /** @class */ (function () {
             context.globalAlpha = this.parent && !this.parent.renderToIntermediateTexture ? this.parent.alpha * this._alpha : this._alpha;
         }
     };
-    /** @hidden */
+    /**
+     * @param parentMeasure
+     * @param context
+     * @hidden
+     */
     Control.prototype._layout = function (parentMeasure, context) {
         if (!this.isDirty && (!this.isVisible || this.notRenderable)) {
             return false;
@@ -1581,7 +1618,11 @@ var Control = /** @class */ (function () {
         this._isDirty = false;
         return true;
     };
-    /** @hidden */
+    /**
+     * @param parentMeasure
+     * @param context
+     * @hidden
+     */
     Control.prototype._processMeasures = function (parentMeasure, context) {
         this._tempPaddingMeasure.copyFrom(parentMeasure);
         // Apply padding if in correct mode
@@ -1657,7 +1698,11 @@ var Control = /** @class */ (function () {
             }
         }
     };
-    /** @hidden */
+    /**
+     * @param parentMeasure
+     * @param context
+     * @hidden
+     */
     Control.prototype._computeAlignment = function (parentMeasure, context) {
         var width = this._currentMeasure.width;
         var height = this._currentMeasure.height;
@@ -1733,15 +1778,26 @@ var Control = /** @class */ (function () {
         this._currentMeasure.left += x;
         this._currentMeasure.top += y;
     };
-    /** @hidden */
+    /**
+     * @param parentMeasure
+     * @param context
+     * @hidden
+     */
     Control.prototype._preMeasure = function (parentMeasure, context) {
         // Do nothing
     };
-    /** @hidden */
+    /**
+     * @param parentMeasure
+     * @param context
+     * @hidden
+     */
     Control.prototype._additionalProcessing = function (parentMeasure, context) {
         // Do nothing
     };
-    /** @hidden */
+    /**
+     * @param context
+     * @hidden
+     */
     Control.prototype._clipForChildren = function (context) {
         // DO nothing
     };
@@ -1774,7 +1830,11 @@ var Control = /** @class */ (function () {
         }
         context.clip();
     };
-    /** @hidden */
+    /**
+     * @param context
+     * @param invalidatedRectangle
+     * @hidden
+     */
     Control.prototype._render = function (context, invalidatedRectangle) {
         if (!this.isVisible || this.notRenderable || this._isClipped) {
             this._isDirty = false;
@@ -1808,7 +1868,11 @@ var Control = /** @class */ (function () {
         context.restore();
         return true;
     };
-    /** @hidden */
+    /**
+     * @param context
+     * @param invalidatedRectangle
+     * @hidden
+     */
     Control.prototype._draw = function (context, invalidatedRectangle) {
         // Do nothing
     };
@@ -1841,7 +1905,17 @@ var Control = /** @class */ (function () {
         }
         return true;
     };
-    /** @hidden */
+    /**
+     * @param x
+     * @param y
+     * @param pi
+     * @param type
+     * @param pointerId
+     * @param buttonIndex
+     * @param deltaX
+     * @param deltaY
+     * @hidden
+     */
     Control.prototype._processPicking = function (x, y, pi, type, pointerId, buttonIndex, deltaX, deltaY) {
         if (!this._isEnabled) {
             return false;
@@ -1855,14 +1929,24 @@ var Control = /** @class */ (function () {
         this._processObservables(type, x, y, pi, pointerId, buttonIndex, deltaX, deltaY);
         return true;
     };
-    /** @hidden */
+    /**
+     * @param target
+     * @param coordinates
+     * @param pointerId
+     * @param pi
+     * @hidden
+     */
     Control.prototype._onPointerMove = function (target, coordinates, pointerId, pi) {
         var canNotify = this.onPointerMoveObservable.notifyObservers(coordinates, -1, target, this, pi);
         if (canNotify && this.parent != null) {
             this.parent._onPointerMove(target, coordinates, pointerId, pi);
         }
     };
-    /** @hidden */
+    /**
+     * @param target
+     * @param pi
+     * @hidden
+     */
     Control.prototype._onPointerEnter = function (target, pi) {
         if (!this._isEnabled) {
             return false;
@@ -1881,7 +1965,12 @@ var Control = /** @class */ (function () {
         }
         return true;
     };
-    /** @hidden */
+    /**
+     * @param target
+     * @param pi
+     * @param force
+     * @hidden
+     */
     Control.prototype._onPointerOut = function (target, pi, force) {
         if (force === void 0) { force = false; }
         if (!force && (!this._isEnabled || target === this)) {
@@ -1896,7 +1985,14 @@ var Control = /** @class */ (function () {
             this.parent._onPointerOut(target, pi, force);
         }
     };
-    /** @hidden */
+    /**
+     * @param target
+     * @param coordinates
+     * @param pointerId
+     * @param buttonIndex
+     * @param pi
+     * @hidden
+     */
     Control.prototype._onPointerDown = function (target, coordinates, pointerId, buttonIndex, pi) {
         // Prevent pointerout to lose control context.
         // Event redundancy is checked inside the function.
@@ -1912,7 +2008,15 @@ var Control = /** @class */ (function () {
         }
         return true;
     };
-    /** @hidden */
+    /**
+     * @param target
+     * @param coordinates
+     * @param pointerId
+     * @param buttonIndex
+     * @param notifyClick
+     * @param pi
+     * @hidden
+     */
     Control.prototype._onPointerUp = function (target, coordinates, pointerId, buttonIndex, notifyClick, pi) {
         if (!this._isEnabled) {
             return;
@@ -1928,7 +2032,10 @@ var Control = /** @class */ (function () {
             this.parent._onPointerUp(target, coordinates, pointerId, buttonIndex, canNotifyClick, pi);
         }
     };
-    /** @hidden */
+    /**
+     * @param pointerId
+     * @hidden
+     */
     Control.prototype._forcePointerUp = function (pointerId) {
         if (pointerId === void 0) { pointerId = null; }
         if (pointerId !== null) {
@@ -1940,7 +2047,11 @@ var Control = /** @class */ (function () {
             }
         }
     };
-    /** @hidden */
+    /**
+     * @param deltaX
+     * @param deltaY
+     * @hidden
+     */
     Control.prototype._onWheelScroll = function (deltaX, deltaY) {
         if (!this._isEnabled) {
             return;
@@ -1952,7 +2063,17 @@ var Control = /** @class */ (function () {
     };
     /** @hidden */
     Control.prototype._onCanvasBlur = function () { };
-    /** @hidden */
+    /**
+     * @param type
+     * @param x
+     * @param y
+     * @param pi
+     * @param pointerId
+     * @param buttonIndex
+     * @param deltaX
+     * @param deltaY
+     * @hidden
+     */
     Control.prototype._processObservables = function (type, x, y, pi, pointerId, buttonIndex, deltaX, deltaY) {
         if (!this._isEnabled) {
             return false;
@@ -2020,7 +2141,11 @@ var Control = /** @class */ (function () {
             serializationObject.fontStyle = this.fontStyle;
         }
     };
-    /** @hidden */
+    /**
+     * @param serializedObject
+     * @param host
+     * @hidden
+     */
     Control.prototype._parseFromContent = function (serializedObject, host) {
         if (serializedObject.fontFamily) {
             this.fontFamily = serializedObject.fontFamily;
@@ -2113,7 +2238,10 @@ var Control = /** @class */ (function () {
         enumerable: false,
         configurable: true
     });
-    /** @hidden */
+    /**
+     * @param font
+     * @hidden
+     */
     Control._GetFontOffset = function (font) {
         if (Control._FontHeightSizes[font]) {
             return Control._FontHeightSizes[font];
@@ -2139,7 +2267,14 @@ var Control = /** @class */ (function () {
         control._parseFromContent(serializedObject, host);
         return control;
     };
-    /** @hidden */
+    /**
+     * @param x
+     * @param y
+     * @param width
+     * @param height
+     * @param context
+     * @hidden
+     */
     Control.drawEllipse = function (x, y, width, height, context) {
         context.translate(x, y);
         context.scale(width, height);
@@ -2162,16 +2297,6 @@ var Control = /** @class */ (function () {
     Control._VERTICAL_ALIGNMENT_BOTTOM = 1;
     Control._VERTICAL_ALIGNMENT_CENTER = 2;
     Control._FontHeightSizes = {};
-    /**
-     * 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
-     */
     Control.AddHeader = function () { };
     __decorate([
         serialize()