API

Class FluentButtonMaterialSince

Class used to render square buttons with fluent design 5.0.0

Hierarchy (View Summary)

Index
activeFaceDir: any = ...

Gets or sets the direction of the active face before the world transform is applied. This should almost always be set to -z.

activeFaceUp: any = ...

Gets or sets the button's up direction before the world transform is applied. This should almost always be set to +y.

blobFadeLength: number = 0.08

The distance over which the blob intensity fades from full to none (Default is 8cm).

blobFarDistance: number = 0.08

The distance at which the pointer is considered far. See [left|right]BlobFarSize. (Default is 8cm).

blobFarSize: number = 0.05

The size of the blob when the pointer is at the blobFarDistance (Default is 5cm).

blobIntensity: number = 0.5

Gets or sets the intensity of the luminous blob (Ranges 0-1, default is 0.5).

blobNearDistance: number = 0

The distance at which the pointer is considered near. See [left|right]BlobNearSize. (Default is 0cm).

edgeColor: any = ...

Gets or sets the color of the glowing edge.

edgeWidth: number = 0.04

Gets or sets the width of the glowing edge, relative to the scale of the button. (Default is 4% of the height).

enableFade: boolean = true

Gets or sets whether the edge fade effect is enabled.

fadeWidth: number = 1.5

Gets or sets a value corresponding to the width of the edge fade effect (Default 1.5).

globalLeftIndexTipPosition: any = ...

Gets or sets the world-space position of the tip of the left index finger.

globalRightIndexTipPosition: any = ...

Gets or sets the world-space position of the tip of the right index finger.

leftBlobEnable: boolean = true

Gets or sets whether the blob corresponding to the left index finger is enabled.

leftBlobFade: number = 1

Gets or sets the fade factor on the left blob.

leftBlobInnerFade: number = 0.01

Gets or sets the inner fade on the left blob;

leftBlobNearSize: number = 0.025

Gets or sets the size of the left blob when the left pointer is considered near. See blobNearDistance. (Default is 2.5cm).

leftBlobPulse: number = 0

Gets or sets the progress of the pulse animation on the left blob (Ranges 0-1).

proximityAnisotropy: number = 1

Gets or sets the anisotropy of the proximity light.

proximityFarDistance: number = 0.16

Gets or sets the maximum distance for the proximity light (Default is 16mm).

proximityMaxIntensity: number = 0.45

Gets or sets the maximum intensity of the proximity light.

proximityNearRadius: number = 1.5

Gets or sets the radius of the proximity light when near to the surface.

rightBlobEnable: boolean = true

Gets or sets whether the blob corresponding to the right index finger is enabled.

rightBlobFade: number = 1

Gets or sets the fade factor on the right blob.

rightBlobInnerFade: number = 0.01

Gets or sets the inner fade on the right blob;

rightBlobNearSize: number = 0.025

Gets or sets the size of the right blob when the right pointer is considered near. See blobNearDistance. (Default is 2.5cm).

rightBlobPulse: number = 0

Gets or sets the progress of the pulse animation on the right blob (Ranges 0-1).

selected: number = 0

Gets or sets an override value to display the button as selected.

selectedDistance: number = 0.08

Gets or sets the distance from the button the cursor should be for the button to appear selected (Default is 8cm).

selectedFadeLength: number = 0.08

Gets or sets the fall-off distance for the selection fade (Default is 8cm).

selectionFade: number = 0

Gets or sets a value to manually fade the blob size.

selectionFadeSize: number = 0.3

Gets or sets a value to manually shrink the blob size as it fades (see selectionFade).

selectionFuzz: number = 0.5

Gets or sets the amount of fuzzing in the selection focus.

showFrame: boolean = false

Gets or sets whether the frame of the fluent button model is visible. This is usually only enabled for debugging purposes.

smoothActiveFace: boolean = true

Gets or sets whether the active face is smoothly interpolated.

useBlobTexture: boolean = true

Gets or sets whether the blob color texture is used for the proximity light effect. This is usually only disabled for debugging purposes.

BLOB_TEXTURE_URL: string = "https://assets.babylonjs.com/core/MRTK/mrtk-fluent-button-blob.png"

URL pointing to the texture used to define the coloring for the fluent blob effect.