VR4Medical/ICI/Library/PackageCache/com.unity.xr.interaction.toolkit@76258c00be3e/Documentation~/samples-world-space-ui.md

uid
xri-samples-world-space-ui

World Space UI

The World Space UI sample provides a demo scene and prefabs that are configured to provide world space UI support using both UI Toolkit and uGUI in conjunction with XR Interaction Toolkit.

For an overview of the world space UI Toolkit support, please view the XRI manual page.

Note

World-Space support for UI Toolkit is only available in Unity 6.2 and later. For more information, please see the Unity manual page.

This sample is installed into the default location for package samples, in the Assets\Samples\XR Interaction Toolkit\[version]\World Space UI folder. You can move these Assets to a different location.

Asset	Description
Editor\	Custom editor scripts and project validation scripts.
Materials\	Materials used for the prefabs.
Models\	Models used for the prefabs.
Prefabs\	uGUI and UI Toolkit configuration prefabs.
Scripts\	Contains scripts for the demo scene.
Styles\	Styles used for UI Toolkit documents.
UI Toolkit Documents\	UI Toolkit documents used in the demo scene and prefabs.
UI Toolkit Panel Settings\	UI Toolkit panel settings used in the demo scene and prefabs.
DemoScene	Scene that demonstrates world space UI using both UI Toolkit and uGUI. See Demo scene below.

Demo scene

The DemoScene contains a UI Toolkit station and a uGUI station which demonstrate world space UI configuration. Each station contains a single modal button, a scrollview, and a set of UI controls that consist of a slider, a dropdown, buttons, and toggles.

UI Toolkit Example

The UI Toolkit station contains prefabs for the UI Toolkit Scrollview, the UI Toolkit Grab UI, which contains the UI controls, and a UI Toolkit Button With Event. The UI documents, which layout each of these world space UI objects, can be found in the UI Toolkit Documents folder in the sample. There is a single style sheet called XRIStyleSheet which defines the XRI style to the UI documents that leverage it.

Additionally, the UI Toolkit Button With Event prefab contains the Button Event Sample script which demonstrates how to bind to a UI Toolkit button click event.

uGUI Example

The uGUI station is a duplicate of the UI Sample prefab that can be found in the XRI Starter Assets sample. The style and layout for uGUI is primarily done through the Hierarchy and Inspector in the Editor.

Prefabs

Prefab	Description
UGUI Grab UI	uGUI prefab which can be grabbed and repositioned.
UI Toolkit Button With Event	UI Toolkit prefab that contains a single modal button.
UI Toolkit Grab UI	UI Toolkit prefab which can be grabbed and repositioned.
UI Toolkit Scrollview	UI Toolkit prefab that contains a scrollview.

Scripts

The following script is included to support the prefabs and DemoScene.

Script	Description
ButtonEventSample	Sample script that demonstrates how to bind to a UI Toolkit button click event.

UI Toolkit Panel Settings

The UI Toolkit Panel Settings contain two panel settings assets which are used in the demo scene. The difference between these two panel settings is the way the UI Documents will handle collider creation. The WorldSpacePanel asset will expect a box collider on the UI document GameObject to use for UI Toolkit functionality, while the WorldSpacePanel_Auto settings will automatically generate a box collider for use based on the document size.

Note

Using WorldSpacePanel_Auto, which automatically generates the box collider for the UI Document, can potentially cause issues when using UI Toolkit world space support in conjunction with XRGrabInteractable from XR Interaction Toolkit. XRGrabInteractable looks for colliders on the GameObject (including child GameObjects) for grab interaction and can mistakenly use the UI Document box collider which could result in unwanted behavior.