Meta Developers

GrabInteractor Class

Extends PointerInteractor< GrabInteractor, GrabInteractable >, IRigidbodyRef

The GrabInteractor class facilitates interaction with objects that have a GrabInteractable component.

It supports interaction via both controllers and hands, though the HandGrabInteractor is recommended for hand interactions. This class provides advanced control over grab interactions, including forced selection and release, and dynamic component injection.

Properties

Rigidbody Rigidbody[Get]

The Unity Rigidbody most relevant to the current instance.

The role this Rigidbody plays varies according to the implementing type; for example, an HandGrab.HandGrabInteractor may use a Rigidbody for collision detection when grabbing.

IThrowVelocityCalculator VelocityCalculator[Get]

Protected Functions

override void Awake ( )

override void Start ( )

override void DoPreprocess ( )

override GrabInteractable ComputeCandidate ( )

override void InteractableSelected

( GrabInteractable interactable )

override void InteractableUnselected

( GrabInteractable interactable )

virtual override void HandlePointerEventRaised

( PointerEvent evt )

virtual override Pose ComputePointerPose ( )

override void DoSelectUpdate ( )

override bool ComputeShouldUnselect ( )

Member Functions

void ForceSelect

( GrabInteractable interactable )

Forces the controller to select a specific GrabInteractable even if it is not the closest available option.

This method overrides the default selection process, allowing for programmatic control over which interactable is selected.

void ForceRelease ( )

Forces the controller to unselect the currently selected GrabInteractable.

This method clears any overrides set by ForceSelect and reverts to the default selection behavior.

override void Unselect ( )

This method unselects the currently selected interactable, and in addition reverts any selection overrides if necessary.

void InjectAllGrabInteractor

( ISelector selector,

Rigidbody rigidbody )

Injects both a ISelector and a Rigidbody into a dynamically instantiated GameObject.

Parameters

selector

The selector component to be added.

rigidbody

The Rigidbody component to be added.

void InjectSelector

( ISelector selector )

Adds a ISelector to a dynamically instantiated GameObject.

Parameters

selector

The external selector component to be added.

void InjectRigidbody

( Rigidbody rigidbody )

Adds a Rigidbody to a dynamically instantiated GameObject, enhancing the physical interaction capabilities by providing an external Rigidbody component.

void InjectOptionalGrabCenter

( Transform grabCenter )

Optionally adds a grab center to a dynamically instantiated GameObject, allowing for precise control over the center of grabbing operations by providing an external grab center transform.

void InjectOptionalGrabTarget

( Transform grabTarget )

Optionally adds a grab target to a dynamically instantiated GameObject, enabling targeted grabbing operations by providing an external grab target transform.

void InjectOptionalVelocityCalculator

( IThrowVelocityCalculator velocityCalculator )

Adds a velocity calculator to a dynamically instantiated GameObject.

Did you find this page helpful?