Class Interactable

Controls from which directions a poke interaction can trigger this Interactable along the X-axis:

• Left: Finger must approach from -X direction.
• Right: Finger must approach from +X direction.
• All: Accepts both directions.
• None: Disables X-axis poke detection.

Controls from which directions a poke interaction can trigger this Interactable along the Y-axis:

• Top: Finger must approach from +Y direction
• Bottom: Finger must approach from -Y direction
• All: Accepts both directions
• None: Disables Y-axis poke detection

Controls from which directions a poke interaction can trigger this Interactable along the Z-axis:

• Front: Finger must approach from +Z direction.
• Back: Finger must approach from -Z direction.
• All: Accepts both directions.
• None: Disables Z-axis poke detection.

Determines whether this Interactable can be simultaneously controlled by multiple Interactors. When false, only one Interactor type (e.g., left hand or right hand) can interact with this Interactable at a time, and subsequent interaction attempts from different Interactors will be blocked. Set to true to enable interactions from multiple sources simultaneously, such as allowing both hands to manipulate the Interactable at once.

Provides all colliders associated with this Interactable.

Enable this to allow the Interactable to instantly be dragged on trigger rather than obeying the Interactor's drag threshold.

Enable Poke Directionality to help prevent accidental interactions when users approach from unwanted angles.

When enabled, this Interactable ignores any parent InteractionPlane and factors into the cursor's position and targetingVisual. Use when the Interactable is parented for organization but not spatially within that plane.

A flag that enables scroll interactions when this element is interacted with. When true, interactions with this element can scroll a parent ScrollView that has content extending beyond its visible bounds.

Defines the singular source of truth for feedback + UI + cursor components to poll to check if the Interactable should exhibit sticky behavior during trigger (cursor locks on Interactable, remains in active visual state even after de-hovering).

Called when an interactor was in a down event with this interactable and was dragging.

Called when an interactor is in a down event with this interactable and has moved a minimum drag distance.

Called when an interactor is in a down event with this interactable and is moving.

Called whenever the interactable enters the hovered state.

Called whenever the interactable is no longer hovered.

Called whenever an interactor remains hovering over this interactable.

Called whenever a new interactor hovers over this interactable.

Called whenever an interactor exits hovering this interactable.

Called whenever an interactor is no longer triggering the interactable while the interactor is hovering it.

Called whenever an interactor is no longer triggering the interactable while the interactor is not hovering it.

Called whenever an interactor triggers an interactable.

Called when an interactor was in a down event with this interactable and was dragging from another connection.

Called when an interactor is in a down event with this interactable and has moved a minimum drag distance from another connection.

Called when an interactor is in a down event with this interactable and is moving from another connection.

Called whenever the interactable enters the hovered state from another connection.

Called whenever the interactable is no longer hovered from another connection.

Called whenever an interactor remains hovering over this interactable from another connection.

Called whenever a new interactor hovers over this interactable from another connection.

Called whenever an interactor exits hovering this interactable from another connection.

Called whenever an interactor is no longer triggering the interactable while the interactor is hovering it from another connection.

Called whenever an interactor is no longer triggering the interactable while the interactor is not hovering it from another connection.

Called whenever an interactor triggers an interactable from another connection.

Called whenever an interactor is lost and was in a down event with this interactable from another connection.

Called whenever the interactable exits the triggered state while the interactor is hovering it from another connection.

Called whenever the interactable exits the triggered state while the interactor is not hovering it from another connection.

Called whenever the interactable enters the triggered state from another connection.

Called whenever an interactor continues to trigger an interactable from another connection.

Called whenever an interactor is lost and was in a down event with this interactable.

Called whenever the interactable exits the triggered state while the interactor is hovering it.

Called whenever the interactable exits the triggered state while the interactor is not hovering it.

Called whenever the interactable enters the triggered state.

Called whenever an interactor continues to trigger an interactable.

Defines how an interactor can interact with this interactable. Values are: 1: Direct: Only allows close pinch interactions where a hand directly touches the Interactable. 2: Indirect: Allows interactions from a distance with raycasting. 3: Direct/Indirect: Supports both direct and indirect interaction methods. 4: Poke: Enables finger poking interactions. 7: All: Supports all targeting modes (Direct, Indirect, and Poke).

Sets the preferred targeting visual. (Requires the V2 Cursor to be enabled on InteractorCursors).

• 0: Cursor (default)
• 1: Ray
• 2: None

Determines if the Interactable should listen to filtered pinch events when targeted by a HandInteractor. Filtered pinch events are more stable when the hand is quickly moving but may add latency in non-moving cases. Most interactions should use raw pinch events by default. Spatial interactions with large hand movement (such as dragging, scrolling) should use filtered pinch events. If an Interactable has a parent Interactable that uses filtered pinch events, the Interactable will also use filtered pinch events.