Namespace Microsoft.MixedReality.Toolkit.Experimental.UI

Classes

AxisSlider

Axis slider is a script to lock a bar across a specific axis.

CapsLockHighlight

This class toggles the Caps Lock image based on the NonNativeKeyboard's IsCapsLocked state

Dock

This control enables moving objects in and out of predetermined positions, to create palettes, shelves and navigation bars.

Add a Dockable component to any object that has a Dockable and an ObjectManipulator or ManipulationHandler to make it dockable in Docks. That allows this object to be used as part of a palette, shelf or navigation bar together with other objects.

DockPosition

Represents a position where a Dockable object can be docked. This component also adds a Collider and a Rigidbody, if they're not already present.

KeyboardInputFieldBase<T>

Base class explicitly launching Windows Mixed Reality's system keyboard for InputField and TMP_InputField To be attached to the same GameObject with either of the components.

KeyboardKeyFunc

Represents a key on the keyboard that has a function.

KeyboardTest

This component links the NonNativeKeyboard to a TMP_InputField Put it on the TMP_InputField and assign the NonNativeKeyboard.prefab

KeyboardValueKey

Represents a key on the keyboard that has a string value for input.

MixedRealityKeyboard

Class that can launch and hide a system keyboard specifically for Windows Mixed Reality devices (HoloLens 2, Windows Mixed Reality).

Implements a workaround for UWP TouchScreenKeyboard bug which prevents UWP keyboard from showing up again after it is closed. Unity bug tracking the issue https://fogbugz.unity3d.com/default.asp?1137074_rttdnt8t1lccmtd3

MixedRealityKeyboardBase

Base class for objects that wish to launch and hide a system keyboard specifically for Windows Mixed Reality devices (HoloLens 2, Windows Mixed Reality).

MixedRealityKeyboardPreview

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

MRTKTMPInputField

A derived class of TMP's InputField to workaround with some issues of typing on HoloLens 2 No longer used in Unity 2019.3 and later versions.

MRTKUGUIInputField

A derived class of UGUI's InputField to workaround with some issues of typing on HoloLens 2

NonNativeKeyboard

A simple general use keyboard that is ideal for AR/VR applications that do not provide a native keyboard.

NonNativeKeyboardTouchAssistant

Adds touch events to the NonNativeKeyboard buttons (and a tap sound)

SliderInputField

This is an input field that overrides getting deselected

StepSlider

A slider with a fixed number of step values that can be moved by grabbing / pinching a slider thumb Number of steps defaults to 0, if number isn't set then slider behaves just like a regular PinchSlider

SymbolDisableHighlight

Updates the visual state of the text based on the buttons state

SymbolKeyboard

This class switches back and forth between two symbol boards that otherwise do not fit on the keyboard entirely

TMP_KeyboardInputField

A component that can be added to InputField to make it work with Windows Mixed Reality's system keyboard. Required when using Unity 2018.4. No longer used in Unity 2019.3 and later versions (becomes an empty MonoBehaviour and is only around for compatibility) and you can safely remove it if you wish

UI_KeyboardInputField

A component that can be added to InputField to make it work with Windows Mixed Reality's system keyboard. Will no longer be necessary in Unity 2019.3 and later versions after a Unity/UGUI bug is fixed (see disableUGUIWorkaround).

UICollection

This component represents and ordered collection of UI elements. You can add to the UICollection by either dropping UI elements in the UI element this component is attached to in the Editor or by calling the AddItem(RectTransform) method. UI elements that are added to this collection via the Editor will be automatically arranged when this component executes. To use this component attach it to a UI element (a GameObject with a RectTransform component) such as an Image or Panel.

We've moved!