 | AllowControllerInput Class |
If this component is on a unity ui element, it's parent canvas will ignore input raycasts
Inheritance HierarchySystemObject
UnityEngine.Object
UnityEngine.Component
UnityEngine.Behaviour
UnityEngine.MonoBehaviour
ImmerseSDKLoggingBehaviour
ImmerseSDK.UIAllowControllerInput
UnityEngine.Object
UnityEngine.Component
UnityEngine.Behaviour
UnityEngine.MonoBehaviour
ImmerseSDKLoggingBehaviour
ImmerseSDK.UIAllowControllerInput
Namespace: ImmerseSDK.UI
Assembly: ImmerseSDK.App (in ImmerseSDK.App.dll) Version: 3.9.0.0 (3.9.0.0)
SyntaxC#
[UnityEngine.RequireComponent(typeof(Canvas))] public class AllowControllerInput : LoggingBehaviour
The AllowControllerInput type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
  | AllowControllerInput | |
 | AllowControllerInput | Initializes a new instance of the AllowControllerInput class |
Properties| Name | Description | |
|---|---|---|
 | Distance |
Distance (in meters) at which to enable controller input
|
| EnableDuringPlaybackSessions |
Indicates whether session reviewer VR users can interact with the attached canvas during a playback session.
If any input on this canvas results in a network-synchronised state change, then it is strongly advised that you leave this set to false.
|
| IsInputEnabled |
Indicates if Input has been enabled or not
|
| IsOverrideForInput |
Make sure this dialogue is the only one allowed for input
|
Methods| Name | Description | |
|---|---|---|
 | Awake | |
| DisableInput | |
| EnableInput | |
| HasPermissionToInteract | |
| IsControllerInsideCollider | |
| OnDisable | |
| OnDrawGizmosSelected | |
| OnEnable | |
| OnTriggerExit | |
| Reset | |
| Start |
Fields| Name | Description | |
|---|---|---|
 | _canvasInteractionScaleAmount |
Scale when menu is being interacted with
|
| _distanceInMeters |
Distance (in meters) at which to enable controller input
|
| _dotOnlyMode |
Use dot rather than a laser with a dot
|
| _enableDuringPlaybackSessions |
Indicates whether session reviewer VR users can interact with this canvas during a playback session.
If user input on this canvas can modify any synchronised state, then it is strongly advised that this is set to false, to avoid breaking the playback of a recording.
|
| _interactionTrigger | |
 | DefaultDistance |
Default distance (in meters) at which to enable controller input
|
Extension Methods| Name | Description | |
|---|---|---|
 | GetCopyOf |
Copies all properties of a component from source to target. Uses reflection to set properties.
(Defined by ComponentExtensions.) |
| WaitForT |
Waits for a singleton on a coroutine
(Defined by SingletonManager.) |
See Also