Class XRHoverFilterDelegate

A hover filter that forwards its processing to a delegate (delegateToProcess). Useful to create custom filters by code without needing to create new classes.

Inheritance
Object
XRHoverFilterDelegate
Inherited Members
Namespace: UnityEngine.XR.Interaction.Toolkit.Filtering
Syntax
public sealed class XRHoverFilterDelegate : IXRHoverFilter

Constructors

XRHoverFilterDelegate(Func<IXRHoverInteractor, IXRHoverInteractable, Boolean>)

Creates a new hover filter delegate.

Declaration
public XRHoverFilterDelegate(Func<IXRHoverInteractor, IXRHoverInteractable, bool> delegateToProcess)
Parameters
Type Name Description
Func<IXRHoverInteractor, IXRHoverInteractable, Boolean> delegateToProcess

The delegate to be invoked when processing this filter.

Properties

canProcess

Whether this hover filter can process interactions. Hover filters that can process interactions receive calls to Process(IXRHoverInteractor, IXRHoverInteractable), hover filters that cannot process do not.

Declaration
public bool canProcess { get; set; }
Property Value
Type Description
Boolean
Implements
Remarks

It's recommended to return isActiveAndEnabled when implementing this interface in a MonoBehaviour.

delegateToProcess

The delegate to be invoked when processing this filter.

Declaration
public Func<IXRHoverInteractor, IXRHoverInteractable, bool> delegateToProcess { get; set; }
Property Value
Type Description
Func<IXRHoverInteractor, IXRHoverInteractable, Boolean>

Methods

Process(IXRHoverInteractor, IXRHoverInteractable)

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

Declaration
public bool Process(IXRHoverInteractor interactor, IXRHoverInteractable interactable)
Parameters
Type Name Description
IXRHoverInteractor interactor

The Interactor to validate the hover interaction.
IXRHoverInteractable interactable

The Interactable to validate the hover interaction.
Returns
Type Description
Boolean

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

See Also