@babylonjs/gui 5.32.0 → 5.32.2

package/2D/controls/control.js

@@ -12,7 +12,7 @@ import { SerializationHelper, serialize } from "@babylonjs/core/Misc/decorators.
 import { EngineStore } from "@babylonjs/core/Engines/engineStore.js";
 /**
  * Root class used for all 2D controls
- * @see https://doc.babylonjs.com/how_to/gui#controls
+ * @see https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#controls
  */
 export class Control {
     // Functions
@@ -354,7 +354,7 @@ export class Control {
         this._markAsDirty();
     }
     /** Gets or sets a value indicating the scale factor on X axis (1 by default)
-     * @see https://doc.babylonjs.com/how_to/gui#rotation-and-scaling
+     * @see https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#rotation-and-scaling
      */
     get scaleX() {
         return this._scaleX;
@@ -368,7 +368,7 @@ export class Control {
         this._markMatrixAsDirty();
     }
     /** Gets or sets a value indicating the scale factor on Y axis (1 by default)
-     * @see https://doc.babylonjs.com/how_to/gui#rotation-and-scaling
+     * @see https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#rotation-and-scaling
      */
     get scaleY() {
         return this._scaleY;
@@ -382,7 +382,7 @@ export class Control {
         this._markMatrixAsDirty();
     }
     /** Gets or sets the rotation angle (0 by default)
-     * @see https://doc.babylonjs.com/how_to/gui#rotation-and-scaling
+     * @see https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#rotation-and-scaling
      */
     get rotation() {
         return this._rotation;
@@ -396,7 +396,7 @@ export class Control {
         this._markMatrixAsDirty();
     }
     /** Gets or sets the transformation center on Y axis (0 by default)
-     * @see https://doc.babylonjs.com/how_to/gui#rotation-and-scaling
+     * @see https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#rotation-and-scaling
      */
     get transformCenterY() {
         return this._transformCenterY;
@@ -410,7 +410,7 @@ export class Control {
         this._markMatrixAsDirty();
     }
     /** Gets or sets the transformation center on X axis (0 by default)
-     * @see https://doc.babylonjs.com/how_to/gui#rotation-and-scaling
+     * @see https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#rotation-and-scaling
      */
     get transformCenterX() {
         return this._transformCenterX;
@@ -425,7 +425,7 @@ export class Control {
     }
     /**
      * Gets or sets the horizontal alignment
-     * @see https://doc.babylonjs.com/how_to/gui#alignments
+     * @see https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#alignments
      */
     get horizontalAlignment() {
         return this._horizontalAlignment;
@@ -439,7 +439,7 @@ export class Control {
     }
     /**
      * Gets or sets the vertical alignment
-     * @see https://doc.babylonjs.com/how_to/gui#alignments
+     * @see https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#alignments
      */
     get verticalAlignment() {
         return this._verticalAlignment;
@@ -453,7 +453,7 @@ export class Control {
     }
     /**
      * Gets or sets control width
-     * @see https://doc.babylonjs.com/how_to/gui#position-and-size
+     * @see https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#position-and-size
      */
     get width() {
         return this._width.toString(this._host);
@@ -469,7 +469,7 @@ export class Control {
     }
     /**
      * Gets or sets the control width in pixel
-     * @see https://doc.babylonjs.com/how_to/gui#position-and-size
+     * @see https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#position-and-size
      */
     get widthInPixels() {
         return this._width.getValueInPixel(this._host, this._cachedParentMeasure.width);
@@ -483,7 +483,7 @@ export class Control {
     }
     /**
      * Gets or sets control height
-     * @see https://doc.babylonjs.com/how_to/gui#position-and-size
+     * @see https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#position-and-size
      */
     get height() {
         return this._height.toString(this._host);
@@ -499,7 +499,7 @@ export class Control {
     }
     /**
      * Gets or sets control height in pixel
-     * @see https://doc.babylonjs.com/how_to/gui#position-and-size
+     * @see https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#position-and-size
      */
     get heightInPixels() {
         return this._height.getValueInPixel(this._host, this._cachedParentMeasure.height);
@@ -546,7 +546,7 @@ export class Control {
     }
     /**
      * Gets or sets style
-     * @see https://doc.babylonjs.com/how_to/gui#styles
+     * @see https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#styles
      */
     get style() {
         return this._style;
@@ -670,7 +670,7 @@ export class Control {
     }
     /**
      * Gets or sets a value indicating the padding to use on the left of the control
-     * @see https://doc.babylonjs.com/how_to/gui#position-and-size
+     * @see https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#position-and-size
      */
     get paddingLeft() {
         return this._paddingLeft.toString(this._host);
@@ -682,7 +682,7 @@ export class Control {
     }
     /**
      * Gets or sets a value indicating the padding in pixels to use on the left of the control
-     * @see https://doc.babylonjs.com/how_to/gui#position-and-size
+     * @see https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#position-and-size
      */
     get paddingLeftInPixels() {
         return this._paddingLeft.getValueInPixel(this._host, this._cachedParentMeasure.width);
@@ -702,7 +702,7 @@ export class Control {
     }
     /**
      * Gets or sets a value indicating the padding to use on the right of the control
-     * @see https://doc.babylonjs.com/how_to/gui#position-and-size
+     * @see https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#position-and-size
      */
     get paddingRight() {
         return this._paddingRight.toString(this._host);
@@ -714,7 +714,7 @@ export class Control {
     }
     /**
      * Gets or sets a value indicating the padding in pixels to use on the right of the control
-     * @see https://doc.babylonjs.com/how_to/gui#position-and-size
+     * @see https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#position-and-size
      */
     get paddingRightInPixels() {
         return this._paddingRight.getValueInPixel(this._host, this._cachedParentMeasure.width);
@@ -734,7 +734,7 @@ export class Control {
     }
     /**
      * Gets or sets a value indicating the padding to use on the top of the control
-     * @see https://doc.babylonjs.com/how_to/gui#position-and-size
+     * @see https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#position-and-size
      */
     get paddingTop() {
         return this._paddingTop.toString(this._host);
@@ -746,7 +746,7 @@ export class Control {
     }
     /**
      * Gets or sets a value indicating the padding in pixels to use on the top of the control
-     * @see https://doc.babylonjs.com/how_to/gui#position-and-size
+     * @see https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#position-and-size
      */
     get paddingTopInPixels() {
         return this._paddingTop.getValueInPixel(this._host, this._cachedParentMeasure.height);
@@ -766,7 +766,7 @@ export class Control {
     }
     /**
      * Gets or sets a value indicating the padding to use on the bottom of the control
-     * @see https://doc.babylonjs.com/how_to/gui#position-and-size
+     * @see https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#position-and-size
      */
     get paddingBottom() {
         return this._paddingBottom.toString(this._host);
@@ -778,7 +778,7 @@ export class Control {
     }
     /**
      * Gets or sets a value indicating the padding in pixels to use on the bottom of the control
-     * @see https://doc.babylonjs.com/how_to/gui#position-and-size
+     * @see https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#position-and-size
      */
     get paddingBottomInPixels() {
         return this._paddingBottom.getValueInPixel(this._host, this._cachedParentMeasure.height);
@@ -798,7 +798,7 @@ export class Control {
     }
     /**
      * Gets or sets a value indicating the left coordinate of the control
-     * @see https://doc.babylonjs.com/how_to/gui#position-and-size
+     * @see https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#position-and-size
      */
     get left() {
         return this._left.toString(this._host);
@@ -810,7 +810,7 @@ export class Control {
     }
     /**
      * Gets or sets a value indicating the left coordinate in pixels of the control
-     * @see https://doc.babylonjs.com/how_to/gui#position-and-size
+     * @see https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#position-and-size
      */
     get leftInPixels() {
         return this._left.getValueInPixel(this._host, this._cachedParentMeasure.width);
@@ -823,7 +823,7 @@ export class Control {
     }
     /**
      * Gets or sets a value indicating the top coordinate of the control
-     * @see https://doc.babylonjs.com/how_to/gui#position-and-size
+     * @see https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#position-and-size
      */
     get top() {
         return this._top.toString(this._host);
@@ -835,7 +835,7 @@ export class Control {
     }
     /**
      * Gets or sets a value indicating the top coordinate in pixels of the control
-     * @see https://doc.babylonjs.com/how_to/gui#position-and-size
+     * @see https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#position-and-size
      */
     get topInPixels() {
         return this._top.getValueInPixel(this._host, this._cachedParentMeasure.height);
@@ -848,7 +848,7 @@ export class Control {
     }
     /**
      * Gets or sets a value indicating the offset on X axis to the linked mesh
-     * @see https://doc.babylonjs.com/how_to/gui#tracking-positions
+     * @see https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#tracking-positions
      */
     get linkOffsetX() {
         return this._linkOffsetX.toString(this._host);
@@ -860,7 +860,7 @@ export class Control {
     }
     /**
      * Gets or sets a value indicating the offset in pixels on X axis to the linked mesh
-     * @see https://doc.babylonjs.com/how_to/gui#tracking-positions
+     * @see https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#tracking-positions
      */
     get linkOffsetXInPixels() {
         return this._linkOffsetX.getValueInPixel(this._host, this._cachedParentMeasure.width);
@@ -873,7 +873,7 @@ export class Control {
     }
     /**
      * Gets or sets a value indicating the offset on Y axis to the linked mesh
-     * @see https://doc.babylonjs.com/how_to/gui#tracking-positions
+     * @see https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#tracking-positions
      */
     get linkOffsetY() {
         return this._linkOffsetY.toString(this._host);
@@ -885,7 +885,7 @@ export class Control {
     }
     /**
      * Gets or sets a value indicating the offset in pixels on Y axis to the linked mesh
-     * @see https://doc.babylonjs.com/how_to/gui#tracking-positions
+     * @see https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#tracking-positions
      */
     get linkOffsetYInPixels() {
         return this._linkOffsetY.getValueInPixel(this._host, this._cachedParentMeasure.height);
@@ -1079,7 +1079,7 @@ export class Control {
     /**
      * Link current control with a target mesh
      * @param mesh defines the mesh to link with
-     * @see https://doc.babylonjs.com/how_to/gui#tracking-positions
+     * @see https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#tracking-positions
      */
     linkWithMesh(mesh) {
         if (!this._host || (this.parent && this.parent !== this._host._rootContainer)) {
@@ -1110,7 +1110,7 @@ export class Control {
      * @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.
      * @param { string | number} paddingLeft - The value of the left padding. If omitted, right is used.
-     * @see https://doc.babylonjs.com/how_to/gui#position-and-size
+     * @see https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#position-and-size
      */
     setPadding(paddingTop, paddingRight, paddingBottom, paddingLeft) {
         const top = paddingTop;
@@ -1128,7 +1128,7 @@ export class Control {
      * @param { number} paddingRight - The value in pixels of the right padding. If omitted, top is used.
      * @param { number} paddingBottom - The value in pixels of the bottom padding. If omitted, top is used.
      * @param { number} paddingLeft - The value in pixels of the left padding. If omitted, right is used.
-     * @see https://doc.babylonjs.com/how_to/gui#position-and-size
+     * @see https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#position-and-size
      */
     setPaddingInPixels(paddingTop, paddingRight, paddingBottom, paddingLeft) {
         const top = paddingTop;