babylonjs-gui 5.32.0 → 5.32.2

package/babylon.gui.d.ts

@@ -53,7 +53,7 @@ declare module BABYLON.GUI {
 
     /**
      * Class used to create texture to support 2D GUI elements
-     * @see https://doc.babylonjs.com/how_to/gui
+     * @see https://doc.babylonjs.com/features/featuresDeepDive/gui/gui
      */
     export class AdvancedDynamicTexture extends BABYLON.DynamicTexture {
         /** Define the Uurl to load snippets */
@@ -165,32 +165,32 @@ declare module BABYLON.GUI {
         /**
          * Gets or sets the ideal width used to design controls.
          * The GUI will then rescale everything accordingly
-         * @see https://doc.babylonjs.com/how_to/gui#adaptive-scaling
+         * @see https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#adaptive-scaling
          */
         get idealWidth(): number;
         set idealWidth(value: number);
         /**
          * Gets or sets the ideal height used to design controls.
          * The GUI will then rescale everything accordingly
-         * @see https://doc.babylonjs.com/how_to/gui#adaptive-scaling
+         * @see https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#adaptive-scaling
          */
         get idealHeight(): number;
         set idealHeight(value: number);
         /**
          * Gets or sets a boolean indicating if the smallest ideal value must be used if idealWidth and idealHeight are both set
-         * @see https://doc.babylonjs.com/how_to/gui#adaptive-scaling
+         * @see https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#adaptive-scaling
          */
         get useSmallestIdeal(): boolean;
         set useSmallestIdeal(value: boolean);
         /**
          * Gets or sets a boolean indicating if adaptive scaling must be used
-         * @see https://doc.babylonjs.com/how_to/gui#adaptive-scaling
+         * @see https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#adaptive-scaling
          */
         get renderAtIdealSize(): boolean;
         set renderAtIdealSize(value: boolean);
         /**
          * Gets the ratio used when in "ideal mode"
-         * @see https://doc.babylonjs.com/how_to/gui#adaptive-scaling
+         * @see https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#adaptive-scaling
          * */
         get idealRatio(): number;
         /**
@@ -293,7 +293,7 @@ declare module BABYLON.GUI {
         /**
          * Helper function used to create a new style
          * @returns a new style
-         * @see https://doc.babylonjs.com/how_to/gui#styles
+         * @see https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#styles
          */
         createStyle(): Style;
         /**
@@ -701,13 +701,13 @@ declare module BABYLON.GUI {
         set value(value: BABYLON.Color3);
         /**
          * 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(): string | number;
         set width(value: string | number);
         /**
          * 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(): string | number;
         /** Gets or sets control height */
@@ -773,7 +773,7 @@ declare module BABYLON.GUI {
 
     /**
      * Root class for 2D containers
-     * @see https://doc.babylonjs.com/how_to/gui#containers
+     * @see https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#containers
      */
     export class Container extends Control {
         name?: string | undefined;
@@ -928,7 +928,7 @@ declare module BABYLON.GUI {
 
     /**
      * 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 implements BABYLON.IAnimatable {
         /** defines the name of the control */
@@ -1196,39 +1196,39 @@ declare module BABYLON.GUI {
         get highlightColor(): string;
         set highlightColor(value: string);
         /** 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(): number;
         set scaleX(value: number);
         /** 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(): number;
         set scaleY(value: number);
         /** 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(): number;
         set rotation(value: number);
         /** 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(): number;
         set transformCenterY(value: number);
         /** 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(): number;
         set transformCenterX(value: number);
         /**
          * 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(): number;
         set horizontalAlignment(value: number);
         /**
          * 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(): number;
         set verticalAlignment(value: number);
@@ -1242,25 +1242,25 @@ declare module BABYLON.GUI {
         protected _fixedRatioMasterIsWidth: boolean;
         /**
          * 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(): string | number;
         set width(value: string | number);
         /**
          * 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(): number;
         set widthInPixels(value: number);
         /**
          * 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(): string | number;
         set height(value: string | number);
         /**
          * 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(): number;
         set heightInPixels(value: number);
@@ -1275,7 +1275,7 @@ declare module BABYLON.GUI {
         set fontWeight(value: string);
         /**
          * 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(): BABYLON.Nullable<Style>;
         set style(value: BABYLON.Nullable<Style>);
@@ -1313,13 +1313,13 @@ declare module BABYLON.GUI {
         set descendantsOnlyPadding(value: boolean);
         /**
          * 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(): string | number;
         set paddingLeft(value: string | number);
         /**
          * 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(): number;
         set paddingLeftInPixels(value: number);
@@ -1327,13 +1327,13 @@ declare module BABYLON.GUI {
         get _paddingLeftInPixels(): number;
         /**
          * 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(): string | number;
         set paddingRight(value: string | number);
         /**
          * 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(): number;
         set paddingRightInPixels(value: number);
@@ -1341,13 +1341,13 @@ declare module BABYLON.GUI {
         get _paddingRightInPixels(): number;
         /**
          * 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(): string | number;
         set paddingTop(value: string | number);
         /**
          * 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(): number;
         set paddingTopInPixels(value: number);
@@ -1355,13 +1355,13 @@ declare module BABYLON.GUI {
         get _paddingTopInPixels(): number;
         /**
          * 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(): string | number;
         set paddingBottom(value: string | number);
         /**
          * 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(): number;
         set paddingBottomInPixels(value: number);
@@ -1369,49 +1369,49 @@ declare module BABYLON.GUI {
         get _paddingBottomInPixels(): number;
         /**
          * 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(): string | number;
         set left(value: string | number);
         /**
          * 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(): number;
         set leftInPixels(value: number);
         /**
          * 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(): string | number;
         set top(value: string | number);
         /**
          * 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(): number;
         set topInPixels(value: number);
         /**
          * 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(): string | number;
         set linkOffsetX(value: string | number);
         /**
          * 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(): number;
         set linkOffsetXInPixels(value: number);
         /**
          * 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(): string | number;
         set linkOffsetY(value: string | number);
         /**
          * 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(): number;
         set linkOffsetYInPixels(value: number);
@@ -1432,7 +1432,7 @@ declare module BABYLON.GUI {
          * Gets/sets the overlap group of the control.
          * Controls with overlapGroup set to a number can be deoverlapped.
          * Controls with overlapGroup set to undefined are not deoverlapped.
-         * @see https://doc.babylonjs.com/how_to/gui#deoverlapping
+         * @see https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#deoverlapping
          */
         overlapGroup?: number;
         /**
@@ -1517,7 +1517,7 @@ declare module BABYLON.GUI {
         /**
          * 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: BABYLON.Nullable<BABYLON.TransformNode>): void;
         /**
@@ -1526,7 +1526,7 @@ declare module BABYLON.GUI {
          * @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: string | number, paddingRight?: string | number, paddingBottom?: string | number, paddingLeft?: string | number): void;
         /**
@@ -1535,7 +1535,7 @@ declare module BABYLON.GUI {
          * @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: number, paddingRight?: number, paddingBottom?: number, paddingLeft?: number): void;
         /**
@@ -2131,7 +2131,7 @@ declare module BABYLON.GUI {
         get svgAttributesComputationCompleted(): boolean;
         /**
          * Gets or sets a boolean indicating if the image can force its container to adapt its size
-         * @see https://doc.babylonjs.com/how_to/gui#image
+         * @see https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#image
          */
         get autoScale(): boolean;
         set autoScale(value: boolean);
@@ -2173,19 +2173,19 @@ declare module BABYLON.GUI {
         private _getSVGAttribs;
         /**
          * Gets or sets the cell width to use when animation sheet is enabled
-         * @see https://doc.babylonjs.com/how_to/gui#image
+         * @see https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#image
          */
         get cellWidth(): number;
         set cellWidth(value: number);
         /**
          * Gets or sets the cell height to use when animation sheet is enabled
-         * @see https://doc.babylonjs.com/how_to/gui#image
+         * @see https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#image
          */
         get cellHeight(): number;
         set cellHeight(value: number);
         /**
          * Gets or sets the cell id to use (this will turn on the animation sheet mode)
-         * @see https://doc.babylonjs.com/how_to/gui#image
+         * @see https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#image
          */
         get cellId(): number;
         set cellId(value: number);
@@ -3125,7 +3125,7 @@ declare module BABYLON.GUI {
         _setSelectorButtonBackground(selectorNb: number, color: string): void;
     }
     /** Class used to hold the controls for the checkboxes, radio buttons and sliders
-     * @see https://doc.babylonjs.com/how_to/selector
+     * @see https://doc.babylonjs.com/features/featuresDeepDive/gui/selector
      */
     export class SelectionPanel extends Rectangle {
         /** name of SelectionPanel */
@@ -3723,6 +3723,7 @@ declare module BABYLON.GUI {
          */
         _draw(context: BABYLON.ICanvasRenderingContext): void;
         protected _applyStates(context: BABYLON.ICanvasRenderingContext): void;
+        private _linesTemp;
         protected _breakLines(refWidth: number, refHeight: number, context: BABYLON.ICanvasRenderingContext): object[];
         protected _parseLine(line: string | undefined, context: BABYLON.ICanvasRenderingContext): object;
         private _getCharsToRemove;
@@ -4240,7 +4241,7 @@ declare module BABYLON.GUI {
         private _originalUnit;
         /**
          * Gets or sets a value indicating that this value will not scale accordingly with adaptive scaling property
-         * @see https://doc.babylonjs.com/how_to/gui#adaptive-scaling
+         * @see https://doc.babylonjs.com/features/featuresDeepDive/gui/gui#adaptive-scaling
          */
         ignoreAdaptiveScaling: boolean;
         /**
@@ -4646,19 +4647,19 @@ declare module BABYLON.GUI {
         private _behaviors;
         /**
          * Gets the list of attached behaviors
-         * @see https://doc.babylonjs.com/features/behaviour
+         * @see https://doc.babylonjs.com/features/featuresDeepDive/behaviors
          */
         get behaviors(): BABYLON.Behavior<Control3D>[];
         /**
          * Attach a behavior to the control
-         * @see https://doc.babylonjs.com/features/behaviour
+         * @see https://doc.babylonjs.com/features/featuresDeepDive/behaviors
          * @param behavior defines the behavior to attach
          * @returns the current control
          */
         addBehavior(behavior: BABYLON.Behavior<Control3D>): Control3D;
         /**
          * Remove an attached behavior
-         * @see https://doc.babylonjs.com/features/behaviour
+         * @see https://doc.babylonjs.com/features/featuresDeepDive/behaviors
          * @param behavior defines the behavior to attach
          * @returns the current control
          */
@@ -4666,7 +4667,7 @@ declare module BABYLON.GUI {
         /**
          * Gets an attached behavior by name
          * @param name defines the name of the behavior to look for
-         * @see https://doc.babylonjs.com/features/behaviour
+         * @see https://doc.babylonjs.com/features/featuresDeepDive/behaviors
          * @returns null if behavior was not found else the requested behavior
          */
         getBehaviorByName(name: string): BABYLON.Nullable<BABYLON.Behavior<Control3D>>;
@@ -5912,7 +5913,7 @@ declare module BABYLON.GUI {
 
     /**
      * Class used to manage 3D user interface
-     * @see https://doc.babylonjs.com/how_to/gui3d
+     * @see https://doc.babylonjs.com/features/featuresDeepDive/gui/gui3D
      */
     export class GUI3DManager implements BABYLON.IDisposable {
         private _scene;
@@ -6983,6 +6984,9 @@ declare module BABYLON.GUI {
          */
         static BLUE_GRADIENT_TEXTURE_URL: string;
         private _blueGradientTexture;
+        private _decalTexture;
+        private _reflectionMapTexture;
+        private _indirectEnvTexture;
         /**
          * Gets or sets the corner Radius on the slider bar.
          */
@@ -7305,6 +7309,9 @@ declare module BABYLON.GUI {
          */
         static BLUE_GRADIENT_TEXTURE_URL: string;
         private _blueGradientTexture;
+        private _decalTexture;
+        private _reflectionMapTexture;
+        private _indirectEnvTexture;
         /**
          * Gets or sets the corner Radius on the slider thumb.
          */