docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class XRPokeFilter

    Filter component that allows for basic poke functionality and to define constraints for when the interactable will be selected.

    Inheritance
    object
    Object
    Component
    Behaviour
    MonoBehaviour
    XRPokeFilter
    Implements
    IXRPokeFilter
    IXRSelectFilter
    IXRInteractionStrengthFilter
    IPokeStateDataProvider
    Inherited Members
    MonoBehaviour.IsInvoking()
    MonoBehaviour.CancelInvoke()
    MonoBehaviour.Invoke(string, float)
    MonoBehaviour.InvokeRepeating(string, float, float)
    MonoBehaviour.CancelInvoke(string)
    MonoBehaviour.IsInvoking(string)
    MonoBehaviour.StartCoroutine(string)
    MonoBehaviour.StartCoroutine(string, object)
    MonoBehaviour.StartCoroutine(IEnumerator)
    MonoBehaviour.StopCoroutine(IEnumerator)
    MonoBehaviour.StopCoroutine(Coroutine)
    MonoBehaviour.StopCoroutine(string)
    MonoBehaviour.StopAllCoroutines()
    MonoBehaviour.print(object)
    MonoBehaviour.useGUILayout
    MonoBehaviour.runInEditMode
    Behaviour.enabled
    Behaviour.isActiveAndEnabled
    Component.GetComponent(Type)
    Component.GetComponent<T>()
    Component.TryGetComponent(Type, out Component)
    Component.TryGetComponent<T>(out T)
    Component.GetComponent(string)
    Component.GetComponentInChildren(Type, bool)
    Component.GetComponentInChildren(Type)
    Component.GetComponentInChildren<T>(bool)
    Component.GetComponentInChildren<T>()
    Component.GetComponentsInChildren(Type, bool)
    Component.GetComponentsInChildren(Type)
    Component.GetComponentsInChildren<T>(bool)
    Component.GetComponentsInChildren<T>(bool, List<T>)
    Component.GetComponentsInChildren<T>()
    Component.GetComponentsInChildren<T>(List<T>)
    Component.GetComponentInParent(Type, bool)
    Component.GetComponentInParent(Type)
    Component.GetComponentInParent<T>(bool)
    Component.GetComponentInParent<T>()
    Component.GetComponentsInParent(Type, bool)
    Component.GetComponentsInParent(Type)
    Component.GetComponentsInParent<T>(bool)
    Component.GetComponentsInParent<T>(bool, List<T>)
    Component.GetComponentsInParent<T>()
    Component.GetComponents(Type)
    Component.GetComponents(Type, List<Component>)
    Component.GetComponents<T>(List<T>)
    Component.GetComponents<T>()
    Component.CompareTag(string)
    Component.SendMessageUpwards(string, object, SendMessageOptions)
    Component.SendMessageUpwards(string, object)
    Component.SendMessageUpwards(string)
    Component.SendMessageUpwards(string, SendMessageOptions)
    Component.SendMessage(string, object)
    Component.SendMessage(string)
    Component.SendMessage(string, object, SendMessageOptions)
    Component.SendMessage(string, SendMessageOptions)
    Component.BroadcastMessage(string, object, SendMessageOptions)
    Component.BroadcastMessage(string, object)
    Component.BroadcastMessage(string)
    Component.BroadcastMessage(string, SendMessageOptions)
    Component.transform
    Component.gameObject
    Component.tag
    Object.GetInstanceID()
    Object.GetHashCode()
    Object.Equals(object)
    Object.Instantiate(Object, Vector3, Quaternion)
    Object.Instantiate(Object, Vector3, Quaternion, Transform)
    Object.Instantiate(Object)
    Object.Instantiate(Object, Transform)
    Object.Instantiate(Object, Transform, bool)
    Object.Instantiate<T>(T)
    Object.Instantiate<T>(T, Vector3, Quaternion)
    Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
    Object.Instantiate<T>(T, Transform)
    Object.Instantiate<T>(T, Transform, bool)
    Object.Destroy(Object, float)
    Object.Destroy(Object)
    Object.DestroyImmediate(Object, bool)
    Object.DestroyImmediate(Object)
    Object.FindObjectsOfType(Type)
    Object.FindObjectsOfType(Type, bool)
    Object.FindObjectsByType(Type, FindObjectsSortMode)
    Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)
    Object.DontDestroyOnLoad(Object)
    Object.FindObjectsOfType<T>()
    Object.FindObjectsByType<T>(FindObjectsSortMode)
    Object.FindObjectsOfType<T>(bool)
    Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)
    Object.FindObjectOfType<T>()
    Object.FindObjectOfType<T>(bool)
    Object.FindFirstObjectByType<T>()
    Object.FindAnyObjectByType<T>()
    Object.FindFirstObjectByType<T>(FindObjectsInactive)
    Object.FindAnyObjectByType<T>(FindObjectsInactive)
    Object.FindObjectOfType(Type)
    Object.FindFirstObjectByType(Type)
    Object.FindAnyObjectByType(Type)
    Object.FindObjectOfType(Type, bool)
    Object.FindFirstObjectByType(Type, FindObjectsInactive)
    Object.FindAnyObjectByType(Type, FindObjectsInactive)
    Object.ToString()
    Object.name
    Object.hideFlags
    object.Equals(object, object)
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    Namespace: UnityEngine.XR.Interaction.Toolkit.Filtering
    Assembly: Unity.XR.Interaction.Toolkit.dll
    Syntax
    [AddComponentMenu("XR/XR Poke Filter", 11)]
    [HelpURL("https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit@3.0/api/UnityEngine.XR.Interaction.Toolkit.Filtering.XRPokeFilter.html")]
    public class XRPokeFilter : MonoBehaviour, IXRPokeFilter, IXRSelectFilter, IXRInteractionStrengthFilter, IPokeStateDataProvider

    Properties

    canProcess

    Whether this poke filter can process interactions.

    Declaration
    public virtual bool canProcess { get; }
    Property Value
    Type Description
    bool
    See Also
    canProcess
    canProcess

    pokeCollider

    The Collider used to compute bounds of the poke interaction.

    Declaration
    public Collider pokeCollider { get; set; }
    Property Value
    Type Description
    Collider

    pokeConfiguration

    The settings used to fine tune the vector and offsets which dictate how the poke interaction will be evaluated.

    Declaration
    public PokeThresholdDatumProperty pokeConfiguration { get; set; }
    Property Value
    Type Description
    PokeThresholdDatumProperty

    pokeInteractable

    The XRBaseInteractable associated with this poke filter.

    Declaration
    public XRBaseInteractable pokeInteractable { get; set; }
    Property Value
    Type Description
    XRBaseInteractable

    pokeStateData

    Unity.XR.CoreUtils.Bindings.Variables.IReadOnlyBindableVariable<T> that updates whenever the poke logic state is evaluated.

    Declaration
    public IReadOnlyBindableVariable<PokeStateData> pokeStateData { get; }
    Property Value
    Type Description
    IReadOnlyBindableVariable<PokeStateData>
    See Also
    PokeStateData

    Methods

    Awake()

    See MonoBehaviour.

    Declaration
    protected void Awake()

    OnDestroy()

    See MonoBehaviour.

    Declaration
    protected void OnDestroy()

    OnDrawGizmosSelected()

    See MonoBehaviour.

    Declaration
    [Conditional("UNITY_EDITOR")]
    protected void OnDrawGizmosSelected()

    OnValidate()

    See MonoBehaviour.

    Declaration
    [Conditional("UNITY_EDITOR")]
    protected void OnValidate()

    Process(IXRInteractor, IXRInteractable, float)

    Called by the host object (XRBaseInteractable) to calculate the interaction strength between the given Interactor and Interactable.

    Declaration
    public float Process(IXRInteractor interactor, IXRInteractable interactable, float interactionStrength)
    Parameters
    Type Name Description
    IXRInteractor interactor

    The Interactor interacting.

    IXRInteractable interactable

    The Interactable interacting with the interactor.

    float interactionStrength

    The input interaction strength.

    Returns
    Type Description
    float

    Returns the modified interaction strength that is the result of passing the interaction strength through the filter.

    Process(IXRSelectInteractor, IXRSelectInteractable)

    Called by the host object (XRInteractionManager, XRBaseInteractor or XRBaseInteractable) to verify if the select interaction between the given Interactor and Interactable can be performed.

    Declaration
    public bool Process(IXRSelectInteractor interactor, IXRSelectInteractable interactable)
    Parameters
    Type Name Description
    IXRSelectInteractor interactor

    The Interactor to validate the select interaction.

    IXRSelectInteractable interactable

    The Interactable to validate the select interaction.

    Returns
    Type Description
    bool

    Returns true when the given Interactor can select the given Interactable. Otherwise, returns false.

    Reset()

    See MonoBehaviour.

    Declaration
    [Conditional("UNITY_EDITOR")]
    protected virtual void Reset()

    Start()

    See MonoBehaviour.

    Declaration
    protected void Start()

    Implements

    IXRPokeFilter
    IXRSelectFilter
    IXRInteractionStrengthFilter
    IPokeStateDataProvider
    In This Article
    Back to top
    Copyright © 2025 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)