ui

ExPresSXR.UI Namespace

Summary

Classes for XR focussed UI elements.

Classes

Name	Description
AutoScrollRect	Manages a set of MapPoints controlling the behavior of MapPoints during TP-Mode.

For controlling what is shown when the player is present and what not, use a PlayerDetector on the MapPoints themselves.

Attention: Make sure that you correctly set the the height of your "Content"-GameObject so that it can fit everyting inside. If you don't do that, the scrolling will not work!
You can check it by disabling the "Mask"-Component of the Viewport-GameObject.| |CircularTimerUi|Visualizes an ExPresSXR Timer as a filling circle with an optional display of time and text.

The visuals can be customized in various ways such as counting up or down as well as smooth or tick movement based on time or steps. To further control the timing of the visuals both text and progress can be rounded independently. It is recommended to use the same RoundType if both use the CountType is the same. With FillDirection being set to Down these values are recommended based on RoundType:

• Smooth: Ceil (Text), None (Fill)
• TickNum: Ceil (Both)
• TickTime: Floor (Both)| |ConsoleToUI|This component that can be added to a TMP_Text to display the console log inside the application. The first element of the Stack Trace will be logged too.

Please note that you can connect your device to your your computer and select it as "Connected Player" in the editor. Use this component instead if this is not possible.
A discussion and credits to bboysil on this topic: https://answers.unity.com/questions/125049/is-there-any-way-to-view-the-console-in-a-build.html| |FadeRect|A HUD Canvas item that can be faded between a certain color (default: black) and transparency. These fades can either be done over a certain time or instantaneous.

It is set to be rendered in layer UI Always on Top, meaning it can be used as a full screen fade.

When used in the context of an XR Rig, the rig provides convenience functions to fade in and out.| |HeadGazeReticle|A visual indicator that is to hint interactions without controllers of the Head Gaze XR Rig. The indicator is a circle with another lighter colored circle on top that fills up. It get's disabled when no interaction opportunity was found.| |ScreenCollisionIndicator|A visual indicator for on screen collision that fades the screen corners.A visual indicator for on screen collision that fades the screen corners.A visual indicator for on screen collision that fades the screen corners.| |TimerUi|Visualizes an ExPresSXR Timer as a filling circle.| |UiAudio|Class for playing common UI Audios triggered by various UI elements.

Provides automatic setup utility via the context menu.| |WorldSpaceKeyboard|A world space UI element representing keyboard with an input field for XR. It can be configured to match any set of characters or even longer string sequences. Keyboards of the German and English key layouts, and a numpad can be created directly from the GameObject-Menu.

The keyboard can have a Caps-key which is interpreted determined by capsMode.
It can either be:

• Toggle: Pressing Caps will change between upper to lower and keep it until pressed again.
• OneCharUpper: Pressing Caps will change the next character to upper, then go back to lower
• AlwaysUpper: The caps does not have an effect. All characters are in upper case.
• AlwaysLower: The caps does not have an effect. All characters are in lower case.

To make a new custom Keyboard create a Canvas Object and add a WorldSpaceKeyboards-Component. Then place all Buttons and connect the Buttons with their OnPressed-Event with the WorldSpaceKeyboard.appendToText()-function passing the text of the button as parameter. For the deletion of the last character, clearing or confirming the text simply connect their respective functions instead. If the current text should be shown, add a TMP_InputField and drag it into the property of the WorldSpaceKeyboards.|

Enums

Name	Description
CapsMode	Defines possible behaviors for toggle behaviors.

Namespaces

Name	Description
ExPresSXR.UI.Menu	Classes for creating a start menu.