Class FluentButtonMaterialSince
Hierarchy (View Summary)
- WebXRSpatialLayerType
- FluentButtonMaterial
Index
Constructors
Properties
Methods
Constructors
constructor
-
Parameters
- name: string
Optionalscene: any
Returns FluentButtonMaterial
Properties
active Face Dir
Gets or sets the direction of the active face before the world transform is applied. This should almost always be set to -z.
active Face Up
Gets or sets the button's up direction before the world transform is applied. This should almost always be set to +y.
blob Fade Length
The distance over which the blob intensity fades from full to none (Default is 8cm).
blob Far Distance
The distance at which the pointer is considered far. See [left|right]BlobFarSize. (Default is 8cm).
blob Far Size
The size of the blob when the pointer is at the blobFarDistance (Default is 5cm).
blob Intensity
Gets or sets the intensity of the luminous blob (Ranges 0-1, default is 0.5).
blob Near Distance
The distance at which the pointer is considered near. See [left|right]BlobNearSize. (Default is 0cm).
edge Color
Gets or sets the color of the glowing edge.
edge Width
Gets or sets the width of the glowing edge, relative to the scale of the button. (Default is 4% of the height).
enable Fade
Gets or sets whether the edge fade effect is enabled.
fade Width
Gets or sets a value corresponding to the width of the edge fade effect (Default 1.5).
global Left Index Tip Position
Gets or sets the world-space position of the tip of the left index finger.
global Right Index Tip Position
Gets or sets the world-space position of the tip of the right index finger.
left Blob Enable
Gets or sets whether the blob corresponding to the left index finger is enabled.
left Blob Fade
Gets or sets the fade factor on the left blob.
left Blob Inner Fade
Gets or sets the inner fade on the left blob;
left Blob Near Size
Gets or sets the size of the left blob when the left pointer is considered near. See blobNearDistance. (Default is 2.5cm).
left Blob Pulse
Gets or sets the progress of the pulse animation on the left blob (Ranges 0-1).
proximity Anisotropy
Gets or sets the anisotropy of the proximity light.
proximity Far Distance
Gets or sets the maximum distance for the proximity light (Default is 16mm).
proximity Max Intensity
Gets or sets the maximum intensity of the proximity light.
proximity Near Radius
Gets or sets the radius of the proximity light when near to the surface.
right Blob Enable
Gets or sets whether the blob corresponding to the right index finger is enabled.
right Blob Fade
Gets or sets the fade factor on the right blob.
right Blob Inner Fade
Gets or sets the inner fade on the right blob;
right Blob Near Size
Gets or sets the size of the right blob when the right pointer is considered near. See blobNearDistance. (Default is 2.5cm).
right Blob Pulse
Gets or sets the progress of the pulse animation on the right blob (Ranges 0-1).
selected
Gets or sets an override value to display the button as selected.
selected Distance
Gets or sets the distance from the button the cursor should be for the button to appear selected (Default is 8cm).
selected Fade Length
Gets or sets the fall-off distance for the selection fade (Default is 8cm).
selection Fade
Gets or sets a value to manually fade the blob size.
selection Fade Size
Gets or sets a value to manually shrink the blob size as it fades (see selectionFade).
selection Fuzz
Gets or sets the amount of fuzzing in the selection focus.
show Frame
Gets or sets whether the frame of the fluent button model is visible. This is usually only enabled for debugging purposes.
smooth Active Face
Gets or sets whether the active face is smoothly interpolated.
use Blob Texture
Gets or sets whether the blob color texture is used for the proximity light effect. This is usually only disabled for debugging purposes.
StaticBLOB_ TEXTURE_ URL
URL pointing to the texture used to define the coloring for the fluent blob effect.
Methods
bind For Sub Mesh
-
Parameters
- world: Matrix
- mesh: Mesh
- subMesh: SubMesh
Returns void
clone
-
Parameters
- name: string
Returns FluentButtonMaterial
dispose
-
Disposes the material.
Parameters
OptionalforceDisposeEffect: booleanspecifies if effects should be forcefully disposed
Returns void
get Alpha Test Texture
-
Returns Nullable<BaseTexture>
get Animatables
-
Get the list of animatables in the material.
Returns IAnimatable[]
the list of animatables object used in the material
get Class Name
-
Returns string
is Ready For Sub Mesh
-
Parameters
- mesh: AbstractMesh
- subMesh: SubMesh
Returns boolean
need Alpha Blending
-
Returns boolean
need Alpha Testing
-
Returns boolean
serialize
-
Returns any
StaticParse
-
Creates a fluent button material from parsed material data.
Parameters
- source: any
defines the JSON representation of the material
- scene: Scene
defines the hosting scene
- rootUrl: string
defines the root URL to use to load textures and relative dependencies
Returns FluentButtonMaterial
a new fluent button material
- source: any
Class used to render square buttons with fluent design 5.0.0