Class UIInputModule | XR Interaction Toolkit | 0.10.0-preview.7
docs.unity3d.com
    Show / Hide Table of Contents

    Class UIInputModule

    Base class for input modules that send UI input.

    Inheritance
    Object
    UIBehaviour
    BaseInputModule
    UIInputModule
    XRUIInputModule
    Inherited Members
    BaseInputModule.m_RaycastResultCache
    BaseInputModule.m_InputOverride
    BaseInputModule.OnEnable()
    BaseInputModule.OnDisable()
    BaseInputModule.FindFirstRaycast(List<RaycastResult>)
    BaseInputModule.DetermineMoveDirection(Single, Single)
    BaseInputModule.DetermineMoveDirection(Single, Single, Single)
    BaseInputModule.FindCommonRoot(GameObject, GameObject)
    BaseInputModule.HandlePointerExitAndEnter(PointerEventData, GameObject)
    BaseInputModule.GetAxisEventData(Single, Single, Single)
    BaseInputModule.GetBaseEventData()
    BaseInputModule.IsPointerOverGameObject(Int32)
    BaseInputModule.ShouldActivateModule()
    BaseInputModule.DeactivateModule()
    BaseInputModule.ActivateModule()
    BaseInputModule.UpdateModule()
    BaseInputModule.IsModuleSupported()
    BaseInputModule.input
    BaseInputModule.inputOverride
    BaseInputModule.eventSystem
    UIBehaviour.Awake()
    UIBehaviour.Start()
    UIBehaviour.OnDestroy()
    UIBehaviour.IsActive()
    UnityEngine.EventSystems.UIBehaviour.OnValidate()
    UnityEngine.EventSystems.UIBehaviour.Reset()
    UIBehaviour.OnRectTransformDimensionsChange()
    UIBehaviour.OnBeforeTransformParentChanged()
    UIBehaviour.OnTransformParentChanged()
    UIBehaviour.OnDidApplyAnimationProperties()
    UIBehaviour.OnCanvasGroupChanged()
    UIBehaviour.OnCanvasHierarchyChanged()
    UIBehaviour.IsDestroyed()
    Namespace: UnityEngine.XR.Interaction.Toolkit.UI
    Syntax
    public abstract class UIInputModule : BaseInputModule
    Remarks

    Multiple input modules may be placed on the same event system. In such a setup, the modules will synchronize with each other.

    Properties

    clickSpeed

    The maximum time (in seconds) between two mouse presses for it to be consecutive click.

    Declaration
    public float clickSpeed { get; set; }
    Property Value
    Type Description
    Single

    moveDeadzone

    The absolute value required by a move action on either axis required to trigger a move event.

    Declaration
    public float moveDeadzone { get; set; }
    Property Value
    Type Description
    Single

    repeatDelay

    The Initial delay (in seconds) between an initial move action and a repeated move action.

    Declaration
    public float repeatDelay { get; set; }
    Property Value
    Type Description
    Single

    repeatRate

    The speed (in seconds) that the move action repeats itself once repeating.

    Declaration
    public float repeatRate { get; set; }
    Property Value
    Type Description
    Single

    trackedDeviceDragThresholdMultiplier

    Scales the pixelDragThreshold, for tracked devices, to make selection easier.

    Declaration
    public float trackedDeviceDragThresholdMultiplier { get; set; }
    Property Value
    Type Description
    Single

    uiCamera

    The Camera that is used to perform 2D raycasts when determining the screen space location of a tracked device cursor.

    Declaration
    public Camera uiCamera { get; set; }
    Property Value
    Type Description
    Camera

    Methods

    DoProcess()

    Process the current tick for the module.

    Declaration
    protected abstract void DoProcess()
    Remarks

    Executed once per Update call.

    Process()

    Declaration
    public override void Process()
    Overrides
    BaseInputModule.Process()
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023