Class XRInteractionManager

The Interaction Manager acts as an intermediary between Interactors and Interactables. It is possible to have multiple Interaction Managers, each with their own valid set of Interactors and Interactables. Upon Awake both Interactors and Interactables register themselves with a valid Interaction Manager (if a specific one has not already been assigned in the inspector). The loaded scenes must have at least one Interaction Manager for Interactors and Interactables to be able to communicate.

Inheritance
Object
Object
Component
Behaviour
MonoBehaviour
XRInteractionManager
Inherited Members
Namespace: UnityEngine.XR.Interaction.Toolkit
Syntax
[AddComponentMenu("XR/XR Interaction Manager")]
[DisallowMultipleComponent]
[DefaultExecutionOrder(-100)]
public class XRInteractionManager : MonoBehaviour
Remarks

Many of the methods on this class are designed to be internal such that they can be called by the abstract base classes of the Interaction system (but are not called directly).

Methods

ClearInteractorHover(XRBaseInteractor, List<XRBaseInteractable>)

Declaration
public virtual void ClearInteractorHover(XRBaseInteractor interactor, List<XRBaseInteractable> validTargets)
Parameters
Type Name Description
XRBaseInteractor interactor
List<XRBaseInteractable> validTargets

ClearInteractorSelection(XRBaseInteractor)

Declaration
public virtual void ClearInteractorSelection(XRBaseInteractor interactor)
Parameters
Type Name Description
XRBaseInteractor interactor

FixedUpdate()

Declaration
protected virtual void FixedUpdate()

ForceSelect(XRBaseInteractor, XRBaseInteractable)

Declaration
public void ForceSelect(XRBaseInteractor interactor, XRBaseInteractable interactable)
Parameters
Type Name Description
XRBaseInteractor interactor
XRBaseInteractable interactable

GetColliderToInteractableMap(ref Dictionary<Collider, XRBaseInteractable>)

Declaration
public void GetColliderToInteractableMap(ref Dictionary<Collider, XRBaseInteractable> map)
Parameters
Type Name Description
Dictionary<Collider, XRBaseInteractable> map

GetValidTargets(XRBaseInteractor, List<XRBaseInteractable>)

Declaration
public List<XRBaseInteractable> GetValidTargets(XRBaseInteractor interactor, List<XRBaseInteractable> validTargets)
Parameters
Type Name Description
XRBaseInteractor interactor
List<XRBaseInteractable> validTargets
Returns
Type Description
List<XRBaseInteractable>

HoverEnter(XRBaseInteractor, XRBaseInteractable)

Declaration
public virtual void HoverEnter(XRBaseInteractor interactor, XRBaseInteractable interactable)
Parameters
Type Name Description
XRBaseInteractor interactor
XRBaseInteractable interactable

HoverExit(XRBaseInteractor, XRBaseInteractable)

Declaration
public virtual void HoverExit(XRBaseInteractor interactor, XRBaseInteractable interactable)
Parameters
Type Name Description
XRBaseInteractor interactor
XRBaseInteractable interactable

InteractorHoverValidTargets(XRBaseInteractor, List<XRBaseInteractable>)

Declaration
protected virtual void InteractorHoverValidTargets(XRBaseInteractor interactor, List<XRBaseInteractable> validTargets)
Parameters
Type Name Description
XRBaseInteractor interactor
List<XRBaseInteractable> validTargets

InteractorSelectValidTargets(XRBaseInteractor, List<XRBaseInteractable>)

Declaration
protected virtual void InteractorSelectValidTargets(XRBaseInteractor interactor, List<XRBaseInteractable> validTargets)
Parameters
Type Name Description
XRBaseInteractor interactor
List<XRBaseInteractable> validTargets

LateUpdate()

Declaration
protected virtual void LateUpdate()

OnBeforeRender()

Declaration
[BeforeRenderOrder(100)]
protected virtual void OnBeforeRender()

OnDisable()

Declaration
protected virtual void OnDisable()

OnEnable()

Declaration
protected virtual void OnEnable()

ProcessInteractables(XRInteractionUpdateOrder.UpdatePhase)

Declaration
protected virtual void ProcessInteractables(XRInteractionUpdateOrder.UpdatePhase updatePhase)
Parameters
Type Name Description
XRInteractionUpdateOrder.UpdatePhase updatePhase

ProcessInteractors(XRInteractionUpdateOrder.UpdatePhase)

Declaration
protected virtual void ProcessInteractors(XRInteractionUpdateOrder.UpdatePhase updatePhase)
Parameters
Type Name Description
XRInteractionUpdateOrder.UpdatePhase updatePhase

RegisterInteractable(XRBaseInteractable)

Declaration
public virtual void RegisterInteractable(XRBaseInteractable interactable)
Parameters
Type Name Description
XRBaseInteractable interactable

RegisterInteractor(XRBaseInteractor)

Declaration
public virtual void RegisterInteractor(XRBaseInteractor interactor)
Parameters
Type Name Description
XRBaseInteractor interactor

SelectCancel(XRBaseInteractor, XRBaseInteractable)

Declaration
public virtual void SelectCancel(XRBaseInteractor interactor, XRBaseInteractable interactable)
Parameters
Type Name Description
XRBaseInteractor interactor
XRBaseInteractable interactable

SelectEnter(XRBaseInteractor, XRBaseInteractable)

Declaration
public virtual void SelectEnter(XRBaseInteractor interactor, XRBaseInteractable interactable)
Parameters
Type Name Description
XRBaseInteractor interactor
XRBaseInteractable interactable

SelectExit(XRBaseInteractor, XRBaseInteractable)

Declaration
public virtual void SelectExit(XRBaseInteractor interactor, XRBaseInteractable interactable)
Parameters
Type Name Description
XRBaseInteractor interactor
XRBaseInteractable interactable

TryGetInteractableForCollider(Collider)

Declaration
public XRBaseInteractable TryGetInteractableForCollider(Collider interactableCollider)
Parameters
Type Name Description
Collider interactableCollider
Returns
Type Description
XRBaseInteractable

UnregisterInteractable(XRBaseInteractable)

Declaration
public virtual void UnregisterInteractable(XRBaseInteractable interactable)
Parameters
Type Name Description
XRBaseInteractable interactable

UnregisterInteractor(XRBaseInteractor)

Declaration
public virtual void UnregisterInteractor(XRBaseInteractor interactor)
Parameters
Type Name Description
XRBaseInteractor interactor

Update()

Declaration
protected virtual void Update()