MixedReality.Toolkit.UX Namespace

Classes

BaseDialogEventArgs

Every dialog event emits these parameters.

BasicPressableButtonVisuals

A simple visuals script to provide a visual layer on top of a PressableButton.

CanvasProxyInteractor

A simple proxy interactor which will select and hover things on MRTK's behalf, for canvas input.

CanvasSliderVisuals

A canvas-based visuals script to provide a visual layer on top of Slider.

Dialog

The Dialog script hydrates and controls the various sub-components of the dialog view.

DialogButtonEventArgs

Event arguments used when buttons in a IDialog are clicked or activated.

DialogDismissedEventArgs

Event arguments used a IDialog is dismissed or closed.

DialogPool

Spawns IDialog with the requested parameters and manages the lifecycle of the resulting IDialog component.

FontIconSelector

Allows the user to select a specific icon for display via a Unity text component.

FontIconSet

A Unity object for managing a set of character icons for use with MRTK UX via Unity text components.

InteractablePulse

A script to enable pulse effect on StatefulInteractable.

KeyboardAudio

Adds the chosen tap sound to the NonNativeKeyboard buttons

KeyboardPreview

Component to manage the visuals for a Mixed Reality Keyboard Preview window.

MRTKInputFieldManager

Static class recording the currently active input field in the scene.

MRTKTMPInputField

Component subclassed from TMP_InputField to account for XR interactions.

MRTKUGUIInputField

Component subclassed from InputField to account for XR interactions.

ObjectBar

Dynamic collection of objects positioned in a horizontal or vertical stack with an auto sized back plate.

ObjectBarAddRemoveItems

Adds and removes objects from a given Object Bar to demonstrate the back plate auto adjust behavior.

PressableButton

The core behavior logic for a button that can be pressed, following the StatefulInteractable pattern.

RectTransformColliderFitter

This script fits a Unity BoxCollider component onto a canvas element.

SeeItSayItLabelEnabler

When applied to a Unity game object along with a PressableButton, this component will enable a "see-it say-it" label if speech input is enabled within the application.

Slider

A slider that can be moved by grabbing / pinching a slider thumb

SliderEventData

Event data for when a slider's value changes

SliderSounds

Component that plays sounds to communicate the state of a pinch slider

SliderVisuals

A visuals script to provide a visual layer on top of a Slider component.

StatefulInteractableColliderToggle
StatefulInteractableSpriteToggleVisuals

A visuals script to provide a visual layer on top of a StatefulInteractable.

StatefulInteractableSwitchToggleVisuals

A visuals script to provide a visual layer on top of a StatefulInteractable.

StateVisualizer

A high-performance Playables API-powered interaction feedback system with extensible effects. Requires StatefulInteractable and an Animator.

TabSection

Represents a tab section, utilized in Tab View.

TabView

Enables and disables sub-objects based on the currently toggled index of a ToggleCollection.

ToggleCollection

ToggleCollection groups a list of StatefulInteractables and correlates their toggle states. When any one of the StatefulInteractables are toggled, all other interactables controlled by this script will be de-toggled. A custom list of interactables can be set; if none is set at edit-time, all direct StatefulInteractable children will be added.

ToggleSelectedEvent

A Unity event raised by ToggleCollection when any of the toggle buttons are selected. The event data is the index of the toggle button within the ToggleCollection.

UGUIInputAdapter

An input adapter that translates UnityUI input events into XRI-compatible interactions.

UGUIInputAdapterDraggable

An extension of the UGUIInputAdapter that allows the interception of drag events. Add to any XRI interactable you wish to receive drags, such as sliders, handles, or even ObjectManipulators.

UXBindingConfigurator

Automatically configures and adds DataConsumer components needed to manage all data bound and/or can customizable elements in a prefab

Interfaces

IAnimationMixableEffect

An IPlayableEffect that plugs into an AnimationLayerMixerPlayable.

IDialog

An IDialog hydrates and controls the various sub-components of the dialog view.

IEffect

An interface defining a state effect that StateVisualizer can use.

IPlayableEffect

An IEffect that is backed by a Playable.

Enums

CanvasSliderVisuals.Direction

Setting that indicates one of four directions.

DialogButtonType

The semantic action associated with a button on a dialog.

DialogPool.Policy

Specifies the DialogPool's behavior when opening a dialog while one is already active.

IAnimationMixableEffect.WeightType

How should this state's animation be blended and weighted?

ObjectBarFlowDirection

The flow direction for objects in an ObjectBar.

PressableButton.SpaceMode

An enumeration defining the coordinate space of plane distances.