MRTKBaseInteractable Class

Definition

Namespace:

MixedReality.Toolkit

Assembly:

MixedReality.Toolkit.Core.dll

Extended version of XRBaseInteractable to enable multi-hand interactions.

C#

[UnityEngine.AddComponentMenu("MRTK/Core/MRTK Base Interactable")]
public class MRTKBaseInteractable : UnityEngine.XR.Interaction.Toolkit.XRBaseInteractable

Inheritance

UnityEngine.XR.Interaction.Toolkit.XRBaseInteractable

MRTKBaseInteractable

Derived

MixedReality.Toolkit.StatefulInteractable

MixedReality.Toolkit.UX.Experimental.Scrollable

Attributes

UnityEngine.AddComponentMenuAttribute

Constructors

MRTKBaseInteractable()

Properties

HoveringGazeInteractors	(Read Only) The list of IGazeInteractor components currently gazing this object.
HoveringGazePinchInteractors	(Read Only) The list of IGazePinchInteractor components currently hovering this object.
HoveringGrabInteractors	(Read Only) The list of IGrabInteractor components currently hovering this object.
HoveringPokeInteractors	(Read Only) The list of IPokeInteractor components currently hovering this object.
HoveringRayInteractors	(Read Only) The list of IRayInteractor components currently hovering this object.
IsActiveHovered	Is this object hovered by any interactor other than passive targeting interactors?
IsGazeHovered	Is this object hovered by any gaze interactor?
IsGazePinchHovered	Is this object hovered by a gaze-pinch interactor?
IsGazePinchSelected	Is this object selected by a gaze-pinch interactor?
IsGrabHovered	Is this object hovered by a grab interactor?
IsGrabSelected	Is this object selected by a grab interactor?
IsPokeHovered	Is this object hovered by a near touch/poke interactor?
IsPokeSelected	Is this object selected by a poke interactor?
IsRayHovered	Is this object hovered by a non-gaze ray interactor?
IsRaySelected	Is this object selected by a non-gaze ray interactor?
SelectingGazePinchInteractors	(Read Only) The list of IGazePinchInteractor components currently selecting this object.
SelectingGrabInteractors	(Read Only) The list of IGrabInteractor components currently selecting this object.

Methods

DisableInteractorType(SystemInterfaceType)	Adds the specified type to the set of interactors which cannot select this interactable
EnableInteractorType(SystemInterfaceType)	Removes the specified type to the set of interactors which cannot select this interactable
IsHoverableBy(IXRHoverInteractor)	UnityEngine.XR.Interaction.Toolkit.XRBaseInteractable.IsHoverableBy(UnityEngine.XR.Interaction.Toolkit.IXRHoverInteractor)
IsInteractorTypeValid(IXRInteractor)	Is the given type of interactor permitted to interact with this interactable?
IsSelectableBy(IXRSelectInteractor)	UnityEngine.XR.Interaction.Toolkit.XRBaseInteractable.IsSelectableBy(UnityEngine.XR.Interaction.Toolkit.IXRSelectInteractor)
OnHoverEntering(HoverEnterEventArgs)	UnityEngine.XR.Interaction.Toolkit.XRBaseInteractable.OnHoverEntering(UnityEngine.XR.Interaction.Toolkit.HoverEnterEventArgs)
OnHoverExiting(HoverExitEventArgs)	UnityEngine.XR.Interaction.Toolkit.XRBaseInteractable.OnHoverExiting(UnityEngine.XR.Interaction.Toolkit.HoverExitEventArgs)
OnSelectEntering(SelectEnterEventArgs)	UnityEngine.XR.Interaction.Toolkit.XRBaseInteractable.OnSelectEntering(UnityEngine.XR.Interaction.Toolkit.SelectEnterEventArgs)
OnSelectExiting(SelectExitEventArgs)	UnityEngine.XR.Interaction.Toolkit.XRBaseInteractable.OnSelectExiting(UnityEngine.XR.Interaction.Toolkit.SelectExitEventArgs)

Applies to