Click or drag to resize

AllowControllerInput Class

If this component is on a unity ui element, it's parent canvas will ignore input raycasts
Inheritance Hierarchy
SystemObject
  UnityEngine.Object
    UnityEngine.Component
      UnityEngine.Behaviour
        UnityEngine.MonoBehaviour
          ImmerseSDKLoggingBehaviour
            ImmerseSDK.UIAllowControllerInput

Namespace:  ImmerseSDK.UI
Assembly:  ImmerseSDK.App (in ImmerseSDK.App.dll) Version: 3.5.0.0 (3.5.0.0)
Syntax
C#
[UnityEngine.RequireComponent(typeof(Canvas))]
public class AllowControllerInput : LoggingBehaviour

The AllowControllerInput type exposes the following members.

Constructors
  NameDescription
Private methodStatic memberAllowControllerInput
Public methodAllowControllerInput
Initializes a new instance of the AllowControllerInput class
Top
Properties
  NameDescription
Public propertyDistance
distance (in meters) at which to enable controller input
Public propertyIsDistanceCheckingEnabled
Set this to true if you want the input module to automatically be enabled when a controller comes within the specified distance. If set to false, then you have to enable input yourself at the correct times.
Public propertyIsInputEnabled
Indicates if Input has been enabled or not
Top
Methods
  NameDescription
Protected methodAwake
Unity Component Method
Protected methodEnableDistanceChecking
Enable or disable distance checking
Public methodEnableInput
Enable/Disable input for this canvas
Protected methodOnDisable
Unity Component Method
Protected methodOnDrawGizmosSelected
Unity Component Method
Protected methodOnEnable
Unity Component Method
Protected methodReset
Unity Component Method
Protected methodStart
Unity Component Method
Top
Fields
  NameDescription
Private field_distanceInMeters
distance (in meters) at which to enable controller input
Private field_isDistanceCheckingEnabled
Set this to true if you want the input module to automatically be activated when a controller comes within the specified distance. If set to false, then you have to activate input yourself at the correct times.
Public fieldStatic memberDefaultDistance
Default distance (in meters) at which to enable controller input
Top
Extension Methods
  NameDescription
Public Extension MethodGetCopyOf
Copies all properties of a component from source to target. Uses reflection to set properties.
(Defined by ComponentExtensions.)
Public Extension MethodWaitForT
Waits for a singleton on a coroutine
(Defined by SingletonManager.)
Top
See Also