Namespace UnityEngine.XR.Interaction.Toolkit.UI
Classes
CanvasOptimizer
Keeps track of canvases in a scene and optimizes them by removing unnecessary components in nested canvases and canvases out of view.
CanvasTracker
Helper object for the CanvasOptimizer. Monitors for hierarchy changes to ensure that only a top-level canvas is in place.
LazyFollow
Makes the GameObject this component is attached to follow a target with a delay and some other layout options.
TrackedDeviceEventData
A custom UI event for devices that exist within 3D Unity space, separate from the camera's position.
TrackedDeviceGraphicRaycaster
Custom implementation of GraphicRaycaster for XR Interaction Toolkit. This behavior is used to ray cast against a Canvas. The Raycaster looks at all Graphics on the canvas and determines if any of them have been hit by a ray from a tracked device.
TrackedDevicePhysicsRaycaster
Physics-based UI Raycaster for Tracked Devices (e.g. XR Controllers). Detects UI elements with physics colliders attached to their GameObjects.
UIHoverEnterEvent
UnityEvent that Unity invokes when an Interactor initiates hovering over a new UI element.
UIHoverEventArgs
Arguments passed to the UnityEvent that Unity invokes when an Interactor is hovering over a UI element.
UIHoverExitEvent
UnityEvent that Unity invokes when an Interactor ends hovering over a UI element.
UIInputModule
Base class for input modules that send UI input.
XRUIInputModule
Custom class for input modules that send UI input in XR.
XRUIToolkitManager
This component controls whether UI Toolkit support is enabled for compatible IXRInteractor components in the scene.
Structs
MouseButtonModel
Represents the state of a single mouse button within the uGUI (Unity UI) system. Keeps track of various book-keeping regarding clicks, drags, and presses. Can be converted to and from PointerEventData for sending into uGUI (Unity UI).
TrackedDeviceModel
Models a tracked device.
Interfaces
IUIHoverInteractor
Matches the UI Model to the state of the Interactor with support for hover events.
IUIInteractor
Matches the UI Model to the state of the Interactor.
IUIModelUpdater
Defines an interface for updating a UI data model.
Enums
ButtonDeltaState
A series of flags to determine if a button has been pressed or released since the last time checked. Useful for identifying press/release events that occur in a single frame or sample.
LazyFollow.PositionFollowMode
Defines the possible position follow modes for the lazy follow object.
LazyFollow.RotationFollowMode
Defines the possible rotation follow modes for the lazy follow object.
QueryUIDocumentInteraction
Sets whether physics queries hit Trigger colliders and include or ignore UI Toolkit UI Document trigger colliders.
UIInteractionType
Defines the type of interaction expected from the interactor when interacting with UI.
XRUIInputModule.ActiveInputMode
Represents which Active Input Mode will be used in the situation where the Active Input Handling project setting is set to Both.