API reference
HandGrabAPI Class
Extends MonoBehaviour
The HandGrabAPI wraps under the hood several IFingerAPIs to detect if the fingers are grabbing or not.
It differentiates between pinch and palm grabs but via Inject it is possible to modify the detectors.
Properties
Protected Functions
virtual void Awake ( )
virtual void Start ( )
Member Functions
HandFingerFlags HandPinchGrabbingFingers ( )
HandFingerFlags HandPalmGrabbingFingers ( )
bool IsHandPinchGrabbing
( in GrabbingRule fingers )
bool IsHandPalmGrabbing
( in GrabbingRule fingers )
bool IsSustainingGrab
( in GrabbingRule fingers,
HandFingerFlags grabbingFingers )
bool IsHandSelectPinchFingersChanged
( in GrabbingRule fingers )
Determine whether the state of any of the finger pinches have changed this frame to the target pinching state (on/off).
Parameters
fingers
Finger rules to check.
bool IsHandSelectPalmFingersChanged
( in GrabbingRule fingers )
Determine whether the state of any of the finger grabs have changed this frame to the target grabbing state (on/off).
Parameters
fingers
Finger rules to check.
bool IsHandUnselectPinchFingersChanged
( in GrabbingRule fingers )
bool IsHandUnselectPalmFingersChanged
( in GrabbingRule fingers )
Vector3 GetPinchCenter ( )
Vector3 GetPalmCenter ( )
float GetHandPinchScore
( in GrabbingRule fingers,
bool includePinching )
float GetHandPalmScore
( in GrabbingRule fingers,
bool includeGrabbing )
float GetFingerPinchStrength
( HandFinger finger )
float GetFingerPinchPercent
( HandFinger finger )
float GetFingerPinchDistance
( HandFinger finger )
float GetFingerPalmStrength
( HandFinger finger )
void SetPinchGrabParam
( PinchGrabParam paramId,
float paramVal )
float GetPinchGrabParam
( PinchGrabParam paramId )
bool GetFingerIsGrabbing
( HandFinger finger )
bool GetFingerIsPalmGrabbing
( HandFinger finger )
void InjectAllHandGrabAPI
( IHand hand )
void InjectHand
( IHand hand )
void InjectOptionalHmd
( IHmd hmd )
void InjectOptionalFingerPinchAPI
( IFingerAPI fingerPinchAPI )
void InjectOptionalFingerGrabAPI
( IFingerAPI fingerGrabAPI )
Did you find this page helpful?
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
English (US)
© 2026 Meta