Class XRInteractionStrengthFilterDelegate
An interaction strength filter that forwards its processing to a delegate (delegateToProcess). Useful to create custom filters by code without needing to create new classes.
Implements
Inherited Members
Namespace: UnityEngine.XR.Interaction.Toolkit.Filtering
Assembly: Unity.XR.Interaction.Toolkit.dll
Syntax
public sealed class XRInteractionStrengthFilterDelegate : IXRInteractionStrengthFilterConstructors
XRInteractionStrengthFilterDelegate(Func<IXRInteractor, IXRInteractable, float, float>)
Creates a new interaction strength filter delegate.
Declaration
public XRInteractionStrengthFilterDelegate(Func<IXRInteractor, IXRInteractable, float, float> delegateToProcess)Parameters
| Type | Name | Description |
|---|---|---|
| Func<IXRInteractor, IXRInteractable, float, float> | delegateToProcess | The delegate to be invoked when processing this filter. |
See Also
Properties
canProcess
Whether this interaction strength filter can process. Interaction strength filters that can process receive calls to Process(IXRInteractor, IXRInteractable, float), interaction strength filters that cannot process do not.
Declaration
public bool canProcess { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
Remarks
It's recommended to return isActiveAndEnabled when implementing this interface in a MonoBehaviour.
See Also
delegateToProcess
The delegate to be invoked when processing this filter.
Declaration
public Func<IXRInteractor, IXRInteractable, float, float> delegateToProcess { get; set; }Property Value
| Type | Description |
|---|---|
| Func<IXRInteractor, IXRInteractable, float, float> |
See Also
Methods
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. |