Class XRUIInputModule
Inherited Members
Namespace: UnityEngine.XR.Interaction.Toolkit.UI
Syntax
public class XRUIInputModule : UIInputModuleProperties
maxRaycastDistance
Declaration
public float maxRaycastDistance { get; set; }Property Value
| Type | Description |
|---|---|
| Single |
Methods
Awake()
Declaration
protected override void Awake()DoProcess()
Declaration
protected override void DoProcess()Overrides
GetTrackedDeviceModel(IUIInteractable, out TrackedDeviceModel)
Retrieves the UI Model for a selected Interactable.
Declaration
public bool GetTrackedDeviceModel(IUIInteractable interactable, out TrackedDeviceModel model)Parameters
| Type | Name | Description |
|---|---|---|
| IUIInteractable | interactable | The Interactable you want the model for. |
| TrackedDeviceModel | model | The returned model that reflects the UI state of the interactable. |
Returns
| Type | Description |
|---|---|
| Boolean | True if the model was able to retrieved, false otherwise. |
OnEnable()
Declaration
protected override void OnEnable()RegisterInteractable(IUIInteractable)
Register an Interactable with the UI system. Calling this will enable it to start interacting with UI.
Declaration
public void RegisterInteractable(IUIInteractable interactable)Parameters
| Type | Name | Description |
|---|---|---|
| IUIInteractable | interactable | The IUIInteractable to use. |
UnregisterInteractable(IUIInteractable)
Unregisters an Interactable with the UI system. This cancels all UI Interaction and makes the IUIInteractable no longer able to affect UI.
Declaration
public void UnregisterInteractable(IUIInteractable interactable)Parameters
| Type | Name | Description |
|---|---|---|
| IUIInteractable | interactable | The IUIInteractable to stop using. |