Class XRPokeFilter
Filter component that allows for basic poke functionality and to define constraints for when the interactable will be selected.
Inherited Members
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
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 |
---|---|
Poke |
pokeInteractable
The XRBase
Declaration
public XRBaseInteractable pokeInteractable { get; set; }
Property Value
Type | Description |
---|---|
XRBase |
pokeStateData
Unity.
Declaration
public IReadOnlyBindableVariable<PokeStateData> pokeStateData { get; }
Property Value
Type | Description |
---|---|
IRead |
See Also
Methods
Awake()
See Mono
Declaration
protected void Awake()
OnDestroy()
See Mono
Declaration
protected void OnDestroy()
OnDrawGizmosSelected()
See Mono
Declaration
[Conditional("UNITY_EDITOR")]
protected void OnDrawGizmosSelected()
OnValidate()
See Mono
Declaration
[Conditional("UNITY_EDITOR")]
protected void OnValidate()
Process(IXRInteractor, IXRInteractable, float)
Called by the host object (XRBase
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 (XRInteraction
Declaration
public bool Process(IXRSelectInteractor interactor, IXRSelectInteractable interactable)
Parameters
Type | Name | Description |
---|---|---|
IXRSelect |
interactor | The Interactor to validate the select interaction. |
IXRSelect |
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 Mono
Declaration
[Conditional("UNITY_EDITOR")]
protected virtual void Reset()
Start()
See Mono
Declaration
protected void Start()