mrtk_developmentreleases/2.0.0releases/2.1.0releases/2.2.0

    Show / Hide Table of Contents

    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.

    Dockable

    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.

    HandInteractionHint

    This class provides wrapper functionality for triggering animations and fades for the hand rig.

    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 HoloLens 2.

    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).

    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

    MixedRealityKeyboardPreview

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

    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)

    ScrollingObjectCollection

    A set of child objects organized in a series of Rows/Columns that can scroll in either the X or Y direction.

    ScrollingObjectCollection.ScrollEvent

    The UnityEvent type the ScrollingObjectCollection sends. GameObject is the object the fired the scroll.

    ScrollingObjectCollectionNode

    A ObjectCollectionNode specific for ScrollingObjectCollection.

    SliderInputField

    This is an input field that overrides getting deselected

    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 TMP_InputField to make them work with Windows Mixed Reality's system keyboard

    UI_KeyboardInputField

    A component that can be added to InputField to make them work with Windows Mixed Reality's system keyboard

    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.

    Enums

    AxisSlider.EAxis

    AxisSlider.EAxis

    DockingState

    The possible states of a Dockable object.

    KeyboardKeyFunc.Function

    Possible functionality for a button.

    KeyboardKeyFunc.Function

    Possible functionality for a button.

    NonNativeKeyboard.LayoutType

    Layout type enum for the type of keyboard layout to use.
    This is used when spawning to enable the correct keys based on layout type.

    NonNativeKeyboard.LayoutType

    Layout type enum for the type of keyboard layout to use.
    This is used when spawning to enable the correct keys based on layout type.

    ScrollingObjectCollection.ScrollDirectionType

    The direction in which a ScrollingObjectCollection can scroll.

    ScrollingObjectCollection.ScrollDirectionType

    The direction in which a ScrollingObjectCollection can scroll.

    ScrollingObjectCollection.VelocityType

    How velocity is applied to a ScrollingObjectCollection when a scroll is released.

    ScrollingObjectCollection.VelocityType

    How velocity is applied to a ScrollingObjectCollection when a scroll is released.

    In This Article
    • Classes
    • Enums
    Back to top Generated by DocFX