babylonjs-gui 5.26.1 → 5.27.0

package/babylon.gui.d.ts

@@ -2309,7 +2309,7 @@ declare module BABYLON.GUI {
         /** Gets or sets the text displayed when the control is empty */
         get placeholderText(): string;
         set placeholderText(value: string);
-        /** Gets or sets the dead key flag */
+        /** Gets or sets the dead key. 0 to disable. */
         get deadKey(): boolean;
         set deadKey(flag: boolean);
         /** Gets or sets the highlight text */
@@ -5036,6 +5036,215 @@ declare module BABYLON.GUI {
     }
 
 
+    /**
+     * Class used to create the mrtkv3 button
+     */
+    export class TouchHolographicButton extends TouchButton3D {
+        /**
+         * Base Url for the frontplate model.
+         */
+        static MRTK_ASSET_BASE_URL: string;
+        /**
+         * File name for the frontplate model.
+         */
+        static FRONTPLATE_MODEL_FILENAME: string;
+        /**
+         * File name for the backplate model.
+         */
+        static BACKPLATE_MODEL_FILENAME: string;
+        /**
+         * File name for the backglow model.
+         */
+        static BACKGLOW_MODEL_FILENAME: string;
+        /**
+         * File name for the innerquad model.
+         */
+        static INNERQUAD_MODEL_FILENAME: string;
+        /**
+         * Gets or sets the horizontal scaling for the button.
+         */
+        width: number;
+        /**
+         * Gets or sets the vertical scaling for the button.
+         */
+        height: number;
+        /**
+         * Gets or sets the bevel radius for the button.
+         */
+        radius: number;
+        /**
+         * Gets or sets the font size of the button text in pixels.
+         * This is only adjustable for a button with width to height ratio greater than 1.
+         */
+        textSizeInPixels: number;
+        /**
+         * Gets or sets the size of the button image in pixels.
+         * This is only adjustable for a button with width to height ratio greater than 1.
+         */
+        imageSizeInPixels: number;
+        /**
+         * Gets or sets the color of the button plate.
+         */
+        plateMaterialColor: BABYLON.Color3;
+        /**
+         * Gets or sets the depth of the button's front plate.
+         * This variable determines the z scaling and z position for some of the button's meshes.
+         */
+        frontPlateDepth: number;
+        /**
+         * Gets or sets the depth of the button's back plate.
+         * This variable determines the z scaling and z position for some of the button's meshes.
+         */
+        backPlateDepth: number;
+        /**
+         * Gets or sets the offset value for button's back glow.
+         * This variable determines the x, y scaling of the button's meshes.
+         */
+        backGlowOffset: number;
+        /**
+         * Gets or sets the value that determines the z scaling and z position for the innerQuad and BackGlow meshes.
+         */
+        flatPlaneDepth: number;
+        /**
+         * Gets or sets the radius for FrontMaterial and innerQuadMaterial.
+         */
+        innerQuadRadius: number;
+        /**
+         * Gets or sets the color for innerQuadMaterial.
+         */
+        innerQuadColor: BABYLON.Color4;
+        /**
+         * Gets or sets the color for innerQuadMaterial for when it is toggled.
+         */
+        innerQuadToggledColor: BABYLON.Color4;
+        /**
+         * Gets or sets the color for innerQuadMaterial for when it is hovered.
+         */
+        innerQuadHoverColor: BABYLON.Color4;
+        /**
+         * Gets or sets the color for innerQuadMaterial for when it is toggled and hovered.
+         */
+        innerQuadToggledHoverColor: BABYLON.Color4;
+        private _backPlate;
+        private _textPlate;
+        private _frontPlate;
+        private _backGlow;
+        private _innerQuad;
+        private _collisionPlate;
+        private _frontPlateCollisionMesh;
+        private _isBackplateVisible;
+        private _text;
+        private _subtext;
+        private _imageUrl;
+        private _shareMaterials;
+        private _frontMaterial;
+        private _backMaterial;
+        private _backGlowMaterial;
+        private _innerQuadMaterial;
+        private _plateMaterial;
+        private _pickedPointObserver;
+        private _pointerClickObserver;
+        private _pointerEnterObserver;
+        private _pointerOutObserver;
+        private _toggleObserver;
+        private _tooltipFade;
+        private _tooltipTextBlock;
+        private _tooltipTexture;
+        private _tooltipMesh;
+        private _tooltipHoverObserver;
+        private _tooltipOutObserver;
+        private _disposeTooltip;
+        /**
+         * Rendering ground id of all the mesh in the button
+         */
+        set renderingGroupId(id: number);
+        get renderingGroupId(): number;
+        /**
+         * Gets the mesh used to render this control
+         */
+        get mesh(): BABYLON.Nullable<BABYLON.AbstractMesh>;
+        /**
+         * Text to be displayed on the tooltip shown when hovering on the button. When set to null tooltip is disabled. (Default: null)
+         * Set this property after adding the button to the GUI3DManager
+         */
+        set tooltipText(text: BABYLON.Nullable<string>);
+        get tooltipText(): BABYLON.Nullable<string>;
+        /**
+         * Gets or sets text for the button
+         */
+        get text(): string;
+        set text(value: string);
+        /**
+         * Gets or sets subtext for a button with larger width
+         */
+        get subtext(): string;
+        set subtext(value: string);
+        /**
+         * Gets or sets the image url for the button
+         */
+        get imageUrl(): string;
+        set imageUrl(value: string);
+        /**
+         * Gets the back material used by this button
+         */
+        get backMaterial(): MRDLBackplateMaterial;
+        /**
+         * Gets the front material used by this button
+         */
+        get frontMaterial(): MRDLFrontplateMaterial;
+        /**
+         * Gets the back glow material used by this button
+         */
+        get backGlowMaterial(): MRDLBackglowMaterial;
+        /**
+         * Gets the inner quad material used by this button
+         */
+        get innerQuadMaterial(): MRDLInnerquadMaterial;
+        /**
+         * Gets the plate material used by this button
+         */
+        get plateMaterial(): BABYLON.StandardMaterial;
+        /**
+         * Gets a boolean indicating if this button shares its material with other V3 Buttons
+         */
+        get shareMaterials(): boolean;
+        /**
+         * Sets whether the backplate is visible or hidden. Hiding the backplate is not recommended without some sort of replacement
+         */
+        set isBackplateVisible(isVisible: boolean);
+        /**
+         * Creates a new button
+         * @param name defines the control name
+         * @param shareMaterials
+         */
+        constructor(name?: string, shareMaterials?: boolean);
+        protected _getTypeName(): string;
+        private _rebuildContent;
+        private _getAspectRatio;
+        private _alignContentVertically;
+        private _alignContentHorizontally;
+        protected _createNode(scene: BABYLON.Scene): BABYLON.TransformNode;
+        private _createBackPlate;
+        private _createFrontPlate;
+        private _createInnerQuad;
+        private _createBackGlow;
+        protected _applyFacade(facadeTexture: AdvancedDynamicTexture): void;
+        private _performClickAnimation;
+        private _performEnterExitAnimation;
+        private _createBackMaterial;
+        private _createFrontMaterial;
+        private _createBackGlowMaterial;
+        private _createInnerQuadMaterial;
+        private _createPlateMaterial;
+        protected _onToggle(newState: boolean): void;
+        protected _affectMaterial(mesh: BABYLON.Mesh): void;
+        /**
+         * Releases all associated resources
+         */
+        dispose(): void;
+    }
+
+
     /**
      * NearMenu that displays buttons and follows the camera
      * @since 5.0.0
@@ -6302,6 +6511,83 @@ declare module BABYLON.GUI {
 
 
 
+    export class MRDLBackglowMaterial extends BABYLON.PushMaterial {
+        /**
+         * Gets or sets the bevel radius on the backglow. If this value is changed, update the lineWidth to match.
+         */
+        bevelRadius: number;
+        /**
+         * Gets or sets the line width of the backglow.
+         */
+        lineWidth: number;
+        /**
+         * Gets or sets whether to use absolute sizes when calculating effects on the backglow.
+         * Since desktop and VR/AR have different relative sizes, it's usually best to keep this false.
+         */
+        absoluteSizes: boolean;
+        /**
+         * Gets or sets the tuning motion of the backglow.
+         */
+        tuningMotion: number;
+        /**
+         * Gets or sets the motion of the backglow.
+         */
+        motion: number;
+        /**
+         * Gets or sets the maximum intensity of the backglow.
+         */
+        maxIntensity: number;
+        /**
+         * Gets or sets the fade-in exponent of the intensity of the backglow.
+         */
+        intensityFadeInExponent: number;
+        /**
+         * Gets or sets the start of the outer fuzz effect on the backglow.
+         */
+        outerFuzzStart: number;
+        /**
+         * Gets or sets the end of the outer fuzz effect on the backglow.
+         */
+        outerFuzzEnd: number;
+        /**
+         * Gets or sets the color of the backglow.
+         */
+        color: BABYLON.Color4;
+        /**
+         * Gets or sets the inner color of the backglow.
+         */
+        innerColor: BABYLON.Color4;
+        /**
+         * Gets or sets the blend exponent of the backglow.
+         */
+        blendExponent: number;
+        /**
+         * Gets or sets the falloff of the backglow.
+         */
+        falloff: number;
+        /**
+         * Gets or sets the bias of the backglow.
+         */
+        bias: number;
+        constructor(name: string, scene: BABYLON.Scene);
+        needAlphaBlending(): boolean;
+        needAlphaTesting(): boolean;
+        getAlphaTestTexture(): BABYLON.Nullable<BABYLON.BaseTexture>;
+        isReadyForSubMesh(mesh: BABYLON.AbstractMesh, subMesh: BABYLON.SubMesh): boolean;
+        bindForSubMesh(world: BABYLON.Matrix, mesh: BABYLON.Mesh, subMesh: BABYLON.SubMesh): void;
+        /**
+         * Get the list of animatables in the material.
+         * @returns the list of animatables object used in the material
+         */
+        getAnimatables(): BABYLON.IAnimatable[];
+        dispose(forceDisposeEffect?: boolean): void;
+        clone(name: string): MRDLBackglowMaterial;
+        serialize(): unknown;
+        getClassName(): string;
+        static Parse(source: any, scene: BABYLON.Scene, rootUrl: string): MRDLBackglowMaterial;
+    }
+
+
     /**
      * Class used to render backplate material with MRDL
      */
@@ -6439,6 +6725,227 @@ declare module BABYLON.GUI {
     }
 
 
+    export class MRDLFrontplateMaterial extends BABYLON.PushMaterial {
+        /**
+         * Gets or sets the corner radius on the frontplate. If this value is changed, update the lineWidth to match.
+         */
+        radius: number;
+        /**
+         * Gets or sets the line width of the frontplate.
+         */
+        lineWidth: number;
+        /**
+         * Gets or sets whether the scale is relative to the frontplate height.
+         */
+        relativeToHeight: boolean;
+        /** @hidden */
+        _filterWidth: number;
+        /**
+         * Gets or sets the edge color of the frontplate.
+         */
+        edgeColor: BABYLON.Color4;
+        /**
+         * Gets or sets whether to enable blob effects on the frontplate.
+         */
+        blobEnable: boolean;
+        /**
+         * Gets or sets the blob position on the frontplate.
+         */
+        blobPosition: BABYLON.Vector3;
+        /**
+         * Gets or sets the blob intensity of the frontplate.
+         */
+        blobIntensity: number;
+        /**
+         * Gets or sets the blob near size of the frontplate.
+         */
+        blobNearSize: number;
+        /**
+         * Gets or sets the blob far size of the frontplate.
+         */
+        blobFarSize: number;
+        /**
+         * Gets or sets the blob near distance of the frontplate.
+         */
+        blobNearDistance: number;
+        /**
+         * Gets or sets the blob far distance of the frontplate.
+         */
+        blobFarDistance: number;
+        /**
+         * Gets or sets the blob fade length of the frontplate.
+         */
+        blobFadeLength: number;
+        /**
+         * Gets or sets the blob inner fade of the frontplate.
+         */
+        blobInnerFade: number;
+        /**
+         * Gets or sets the blob pulse of the frontplate.
+         */
+        blobPulse: number;
+        /**
+         * Gets or sets the blob fade effect on the frontplate.
+         */
+        blobFade: number;
+        /**
+         * Gets or sets the maximum size of the blob pulse on the frontplate.
+         */
+        blobPulseMaxSize: number;
+        /**
+         * Gets or sets whether to enable extra blob effects of the frontplate.
+         */
+        blobEnable2: boolean;
+        /**
+         * Gets or sets blob2 position of the frontplate.
+         */
+        blobPosition2: BABYLON.Vector3;
+        /**
+         * Gets or sets the blob2 near size of the frontplate.
+         */
+        blobNearSize2: number;
+        /**
+         * Gets or sets the blob2 inner fade of the frontplate.
+         */
+        blobInnerFade2: number;
+        /**
+         * Gets or sets the blob2 pulse of the frontplate.
+         */
+        blobPulse2: number;
+        /**
+         * Gets or sets the blob2 fade effect on the frontplate.
+         */
+        blobFade2: number;
+        /**
+         * Gets or sets the gaze intensity of the frontplate.
+         */
+        gazeIntensity: number;
+        /**
+         * Gets or sets the gaze focus of the frontplate.
+         */
+        gazeFocus: number;
+        /**
+         * Gets or sets the selection fuzz of the frontplate.
+         */
+        selectionFuzz: number;
+        /**
+         * Gets or sets the fade intensity of the frontplate.
+         */
+        selected: number;
+        /**
+         * Gets or sets the selection fade intensity of the frontplate.
+         */
+        selectionFade: number;
+        /**
+         * Gets or sets the selection fade size of the frontplate.
+         */
+        selectionFadeSize: number;
+        /**
+         * Gets or sets the selected distance of the frontplate.
+         */
+        selectedDistance: number;
+        /**
+         * Gets or sets the selected fade length of the frontplate.
+         */
+        selectedFadeLength: number;
+        /**
+         * Gets or sets the proximity maximum intensity of the frontplate.
+         */
+        proximityMaxIntensity: number;
+        /**
+         * Gets or sets the proximity far distance of the frontplate.
+         */
+        proximityFarDistance: number;
+        /**
+         * Gets or sets the proximity near radius of the frontplate.
+         */
+        proximityNearRadius: number;
+        /**
+         * Gets or sets the proximity anisotropy of the frontplate.
+         */
+        proximityAnisotropy: number;
+        /**
+         * Gets or sets whether to use global left index on the frontplate.
+         */
+        useGlobalLeftIndex: boolean;
+        /**
+         * Gets or sets  whether to use global right index of the frontplate.
+         */
+        useGlobalRightIndex: boolean;
+        /**
+         * URL pointing to the texture used to define the coloring for the BLOB.
+         */
+        static BLOB_TEXTURE_URL: string;
+        /**
+         * Gets or sets the opacity of the frontplate (0.0 - 1.0).
+         */
+        fadeOut: number;
+        private _blobTexture;
+        constructor(name: string, scene: BABYLON.Scene);
+        needAlphaBlending(): boolean;
+        needAlphaTesting(): boolean;
+        getAlphaTestTexture(): BABYLON.Nullable<BABYLON.BaseTexture>;
+        isReadyForSubMesh(mesh: BABYLON.AbstractMesh, subMesh: BABYLON.SubMesh): boolean;
+        bindForSubMesh(world: BABYLON.Matrix, mesh: BABYLON.Mesh, subMesh: BABYLON.SubMesh): void;
+        /**
+         * Get the list of animatables in the material.
+         * @returns the list of animatables object used in the material
+         */
+        getAnimatables(): BABYLON.IAnimatable[];
+        dispose(forceDisposeEffect?: boolean): void;
+        clone(name: string): MRDLFrontplateMaterial;
+        serialize(): unknown;
+        getClassName(): string;
+        static Parse(source: any, scene: BABYLON.Scene, rootUrl: string): MRDLFrontplateMaterial;
+    }
+
+
+    export class MRDLInnerquadMaterial extends BABYLON.PushMaterial {
+        /**
+         * Gets or sets the color of the innerquad.
+         */
+        color: BABYLON.Color4;
+        /**
+         * Gets or sets the corner radius on the innerquad. If this value is changed, update the lineWidth to match.
+         */
+        radius: number;
+        /**
+         * Gets or sets whether the radius of the innerquad should be fixed.
+         */
+        fixedRadius: boolean;
+        /** @hidden */
+        _filterWidth: number;
+        /**
+         * Gets or sets the glow fraction of the innerquad.
+         */
+        glowFraction: number;
+        /**
+         * Gets or sets the maximum glow intensity of the innerquad.
+         */
+        glowMax: number;
+        /**
+         * Gets or sets the glow falloff effect of the innerquad.
+         */
+        glowFalloff: number;
+        constructor(name: string, scene: BABYLON.Scene);
+        needAlphaBlending(): boolean;
+        needAlphaTesting(): boolean;
+        getAlphaTestTexture(): BABYLON.Nullable<BABYLON.BaseTexture>;
+        isReadyForSubMesh(mesh: BABYLON.AbstractMesh, subMesh: BABYLON.SubMesh): boolean;
+        bindForSubMesh(world: BABYLON.Matrix, mesh: BABYLON.Mesh, subMesh: BABYLON.SubMesh): void;
+        /**
+         * Get the list of animatables in the material.
+         * @returns the list of animatables object used in the material
+         */
+        getAnimatables(): BABYLON.IAnimatable[];
+        dispose(forceDisposeEffect?: boolean): void;
+        clone(name: string): MRDLInnerquadMaterial;
+        serialize(): unknown;
+        getClassName(): string;
+        static Parse(source: any, scene: BABYLON.Scene, rootUrl: string): MRDLInnerquadMaterial;
+    }
+
+
     /**
      * Class used to render Slider Bar material with MRDL
      */
@@ -7083,6 +7590,20 @@ declare module BABYLON.GUI {
     }
 
 
+    /** @internal */
+    export var mrdlBackglowPixelShader: {
+        name: string;
+        shader: string;
+    };
+
+
+    /** @internal */
+    export var mrdlBackglowVertexShader: {
+        name: string;
+        shader: string;
+    };
+
+
     /** @internal */
     export var mrdlBackplatePixelShader: {
         name: string;
@@ -7097,6 +7618,34 @@ declare module BABYLON.GUI {
     };
 
 
+    /** @internal */
+    export var mrdlFrontplatePixelShader: {
+        name: string;
+        shader: string;
+    };
+
+
+    /** @internal */
+    export var mrdlFrontplateVertexShader: {
+        name: string;
+        shader: string;
+    };
+
+
+    /** @internal */
+    export var mrdlInnerquadPixelShader: {
+        name: string;
+        shader: string;
+    };
+
+
+    /** @internal */
+    export var mrdlInnerquadVertexShader: {
+        name: string;
+        shader: string;
+    };
+
+
     /** @internal */
     export var mrdlSliderBarPixelShader: {
         name: string;