Namespace UnityEngine.XR.Interaction.Toolkit.Interactables

Classes

XRBaseInteractable

Abstract base class from which all interactable behaviors derive. This class hooks into the interaction system (via XRInteractionManager) and provides base virtual methods for handling hover, selection, and focus.

XRFocusInteractableExtensions

Extension methods for IXRFocusInteractable.

XRGrabInteractable

Interactable component that allows for basic grab functionality. When this behavior is selected (grabbed) by an Interactor, this behavior will follow it around and inherit velocity when released.

XRHoverInteractableExtensions

Extension methods for IXRHoverInteractable.

XRInteractableSnapVolume

Utility component for supporting interactors snapping to and selecting interactables. Add this component to a child GameObject of the interactable.

XRSelectInteractableExtensions

Extension methods for IXRSelectInteractable.

XRSimpleInteractable

The simplest Interactable object which provides events for interaction states like hover and select.

Structs

DistanceInfo

Struct used to get information back from a distance calculation between an object and a location.

Interfaces

IXRActivateInteractable

An interface that represents an Interactable component which Interactor components can activate. Not to be confused with the active state of a GameObject, an activate event in this context refers to a contextual command action, such as toggling a flashlight on and off.

IXRFocusInteractable

An interface that represents an Interactable component which an Interactor component can persistently select.

IXRHoverInteractable

An interface that represents an Interactable component which Interactor components can hover over.

IXRInteractable

An interface that represents an Interactable component that controls how a GameObject interacts with an Interactor component. An example is a Grab Interactable which can be picked up and moved by an Interactor.

IXRInteractionStrengthInteractable

An interface that represents an Interactable component which can express an interaction strength amount, which is a normalized value [0.0, 1.0] that describes the strength of selection.

IXRSelectInteractable

An interface that represents an Interactable component which an Interactor component can select.

Enums

InteractableFocusMode

Options for the focus policy of an Interactable.

InteractableSelectMode

Options for the selection policy of an Interactable.

XRBaseInteractable.DistanceCalculationMode

Options for how to calculate an Interactable distance to a location in world space.

XRBaseInteractable.MovementType

Options for how to process and perform movement of an Interactable.