API reference

HandGrabUseInteractor Class

Extends Oculus.Interaction.Interactor< HandGrabUseInteractor, HandGrabUseInteractable >
Implements Oculus.Interaction.HandGrab.IHandGrabState
This interactor allows sending use-strength values to an interactable to create use interactions.
e.g. Pressing a trigger, squeezing a ball, etc. In order to calculate the usage strength of a finger it uses a IFingerUseAPI. This class is also an IHandGrabState, so it can be attached to a SyntheticHand to drive the fingers rotations, it will lerp between the RelaxedHandGrabPose and TightHandGrabPose provided by the interactable depending on the progress of the action.

Fields

FingersStrength : float
Signature 
float Oculus.Interaction.HandGrab.HandGrabUseInteractor.FingersStrength
IsGrabbing : bool
Signature 
bool Oculus.Interaction.HandGrab.HandGrabUseInteractor.IsGrabbing
WristStrength : float
Signature 
float Oculus.Interaction.HandGrab.HandGrabUseInteractor.WristStrength
WristToGrabPoseOffset : Pose
Signature 
Pose Oculus.Interaction.HandGrab.HandGrabUseInteractor.WristToGrabPoseOffset

Properties

Hand : IHand
[Get]
Signature 
IHand Oculus.Interaction.HandGrab.HandGrabUseInteractor.Hand
HandGrabTarget : HandGrabTarget
[Get]
Signature 
HandGrabTarget Oculus.Interaction.HandGrab.HandGrabUseInteractor.HandGrabTarget
UseAPI : IFingerUseAPI
[Get]
Signature 
IFingerUseAPI Oculus.Interaction.HandGrab.HandGrabUseInteractor.UseAPI
WhenHandGrabEnded : Action< IHandGrabState >
[Get][Set]
Signature 
Action<IHandGrabState> Oculus.Interaction.HandGrab.HandGrabUseInteractor.WhenHandGrabEnded
WhenHandGrabStarted : Action< IHandGrabState >
[Get][Set]
Signature 
Action<IHandGrabState> Oculus.Interaction.HandGrab.HandGrabUseInteractor.WhenHandGrabStarted

Protected Methods

Awake ()
Signature 
override void Oculus.Interaction.HandGrab.HandGrabUseInteractor.Awake()
Returns
override void
ComputeCandidate ()
Signature 
override HandGrabUseInteractable Oculus.Interaction.HandGrab.HandGrabUseInteractor.ComputeCandidate()
Returns
override HandGrabUseInteractable
ComputeShouldSelect ()
Signature 
override bool Oculus.Interaction.HandGrab.HandGrabUseInteractor.ComputeShouldSelect()
Returns
override bool
ComputeShouldUnselect ()
Signature 
override bool Oculus.Interaction.HandGrab.HandGrabUseInteractor.ComputeShouldUnselect()
Returns
override bool
DoHoverUpdate ()
Signature 
override void Oculus.Interaction.HandGrab.HandGrabUseInteractor.DoHoverUpdate()
Returns
override void
DoSelectUpdate ()
Signature 
override void Oculus.Interaction.HandGrab.HandGrabUseInteractor.DoSelectUpdate()
Returns
override void
InteractableSelected ( interactable )
Signature 
override void Oculus.Interaction.HandGrab.HandGrabUseInteractor.InteractableSelected(HandGrabUseInteractable interactable)
Parameters
interactable: HandGrabUseInteractable
Returns
override void
InteractableUnselected ( interactable )
Signature 
override void Oculus.Interaction.HandGrab.HandGrabUseInteractor.InteractableUnselected(HandGrabUseInteractable interactable)
Parameters
interactable: HandGrabUseInteractable
Returns
override void
Start ()
Signature 
override void Oculus.Interaction.HandGrab.HandGrabUseInteractor.Start()
Returns
override void

Methods

GrabbingFingers ()
Returns the fingers that are currently grabbing.
Signature 
HandFingerFlags Oculus.Interaction.HandGrab.HandGrabUseInteractor.GrabbingFingers()
Returns
HandFingerFlags
InjectAllHandGrabUseInteractor ( useApi )
Adds all required scripts for a <cref="HandGrabUseInteractor" /> to a dynamically instantiated GameObject.
Signature 
void Oculus.Interaction.HandGrab.HandGrabUseInteractor.InjectAllHandGrabUseInteractor(IFingerUseAPI useApi)
Parameters
useApi: IFingerUseAPI
Returns
void
InjectOptionalHand ( hand )
Adds an <cref="IHand" /> to a dynamically instantiated GameObject.
Signature 
void Oculus.Interaction.HandGrab.HandGrabUseInteractor.InjectOptionalHand(IHand hand)
Parameters
hand: IHand
Returns
void
InjectUseApi ( useApi )
Adds an <cref="IFingerUseAPI" /> to a dynamically instantiated GameObject.
Signature 
void Oculus.Interaction.HandGrab.HandGrabUseInteractor.InjectUseApi(IFingerUseAPI useApi)
Parameters
useApi: IFingerUseAPI
Returns
void
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2026 Meta