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

Hand : IHand [Get]	Signature IHand Oculus.Interaction.GrabAPI.HandGrabAPI.Hand
Hmd : IHmd [Get]	Signature IHmd Oculus.Interaction.GrabAPI.HandGrabAPI.Hmd

Protected Methods

Awake ()	Signature virtual void Oculus.Interaction.GrabAPI.HandGrabAPI.Awake() Returns `void`
Start ()	Signature virtual void Oculus.Interaction.GrabAPI.HandGrabAPI.Start() Returns `void`

Methods

GetFingerIsGrabbing ( finger )	Signature bool Oculus.Interaction.GrabAPI.HandGrabAPI.GetFingerIsGrabbing(HandFinger finger) Parameters `finger: HandFinger` Returns `bool`
GetFingerIsPalmGrabbing ( finger )	Signature bool Oculus.Interaction.GrabAPI.HandGrabAPI.GetFingerIsPalmGrabbing(HandFinger finger) Parameters `finger: HandFinger` Returns `bool`
GetFingerPalmStrength ( finger )	Signature float Oculus.Interaction.GrabAPI.HandGrabAPI.GetFingerPalmStrength(HandFinger finger) Parameters `finger: HandFinger` Returns `float`
GetFingerPinchDistance ( finger )	Signature float Oculus.Interaction.GrabAPI.HandGrabAPI.GetFingerPinchDistance(HandFinger finger) Parameters `finger: HandFinger` Returns `float`
GetFingerPinchPercent ( finger )	Signature float Oculus.Interaction.GrabAPI.HandGrabAPI.GetFingerPinchPercent(HandFinger finger) Parameters `finger: HandFinger` Returns `float`
GetFingerPinchStrength ( finger )	Signature float Oculus.Interaction.GrabAPI.HandGrabAPI.GetFingerPinchStrength(HandFinger finger) Parameters `finger: HandFinger` Returns `float`
GetHandPalmScore ( fingers , includeGrabbing )	Signature float Oculus.Interaction.GrabAPI.HandGrabAPI.GetHandPalmScore(in GrabbingRule fingers, bool includeGrabbing=true) Parameters `fingers: in GrabbingRule` `includeGrabbing: bool` Returns `float`
GetHandPinchScore ( fingers , includePinching )	Signature float Oculus.Interaction.GrabAPI.HandGrabAPI.GetHandPinchScore(in GrabbingRule fingers, bool includePinching=true) Parameters `fingers: in GrabbingRule` `includePinching: bool` Returns `float`
GetPalmCenter ()	Signature Vector3 Oculus.Interaction.GrabAPI.HandGrabAPI.GetPalmCenter() Returns `Vector3`
GetPinchCenter ()	Signature Vector3 Oculus.Interaction.GrabAPI.HandGrabAPI.GetPinchCenter() Returns `Vector3`
GetPinchGrabParam ( paramId )	Signature float Oculus.Interaction.GrabAPI.HandGrabAPI.GetPinchGrabParam(PinchGrabParam paramId) Parameters `paramId: PinchGrabParam` Returns `float`
HandPalmGrabbingFingers ()	Signature HandFingerFlags Oculus.Interaction.GrabAPI.HandGrabAPI.HandPalmGrabbingFingers() Returns `HandFingerFlags`
HandPinchGrabbingFingers ()	Signature HandFingerFlags Oculus.Interaction.GrabAPI.HandGrabAPI.HandPinchGrabbingFingers() Returns `HandFingerFlags`
InjectAllHandGrabAPI ( hand )	Signature void Oculus.Interaction.GrabAPI.HandGrabAPI.InjectAllHandGrabAPI(IHand hand) Parameters `hand: IHand` Returns `void`
InjectHand ( hand )	Signature void Oculus.Interaction.GrabAPI.HandGrabAPI.InjectHand(IHand hand) Parameters `hand: IHand` Returns `void`
InjectOptionalFingerGrabAPI ( fingerGrabAPI )	Signature void Oculus.Interaction.GrabAPI.HandGrabAPI.InjectOptionalFingerGrabAPI(IFingerAPI fingerGrabAPI) Parameters `fingerGrabAPI: IFingerAPI` Returns `void`
InjectOptionalFingerPinchAPI ( fingerPinchAPI )	Signature void Oculus.Interaction.GrabAPI.HandGrabAPI.InjectOptionalFingerPinchAPI(IFingerAPI fingerPinchAPI) Parameters `fingerPinchAPI: IFingerAPI` Returns `void`
InjectOptionalHmd ( hmd )	Signature void Oculus.Interaction.GrabAPI.HandGrabAPI.InjectOptionalHmd(IHmd hmd) Parameters `hmd: IHmd` Returns `void`
IsHandPalmGrabbing ( fingers )	Signature bool Oculus.Interaction.GrabAPI.HandGrabAPI.IsHandPalmGrabbing(in GrabbingRule fingers) Parameters `fingers: in GrabbingRule` Returns `bool`
IsHandPinchGrabbing ( fingers )	Signature bool Oculus.Interaction.GrabAPI.HandGrabAPI.IsHandPinchGrabbing(in GrabbingRule fingers) Parameters `fingers: in GrabbingRule` Returns `bool`
IsHandSelectPalmFingersChanged ( fingers )	Determine whether the state of any of the finger grabs have changed this frame to the target grabbing state (on/off). Signature bool Oculus.Interaction.GrabAPI.HandGrabAPI.IsHandSelectPalmFingersChanged(in GrabbingRule fingers) Parameters `fingers: in GrabbingRule` Finger rules to check. Returns `bool`
IsHandSelectPinchFingersChanged ( fingers )	Determine whether the state of any of the finger pinches have changed this frame to the target pinching state (on/off). Signature bool Oculus.Interaction.GrabAPI.HandGrabAPI.IsHandSelectPinchFingersChanged(in GrabbingRule fingers) Parameters `fingers: in GrabbingRule` Finger rules to check. Returns `bool`
IsHandUnselectPalmFingersChanged ( fingers )	Signature bool Oculus.Interaction.GrabAPI.HandGrabAPI.IsHandUnselectPalmFingersChanged(in GrabbingRule fingers) Parameters `fingers: in GrabbingRule` Returns `bool`
IsHandUnselectPinchFingersChanged ( fingers )	Signature bool Oculus.Interaction.GrabAPI.HandGrabAPI.IsHandUnselectPinchFingersChanged(in GrabbingRule fingers) Parameters `fingers: in GrabbingRule` Returns `bool`
IsSustainingGrab ( fingers , grabbingFingers )	Signature bool Oculus.Interaction.GrabAPI.HandGrabAPI.IsSustainingGrab(in GrabbingRule fingers, HandFingerFlags grabbingFingers) Parameters `fingers: in GrabbingRule` `grabbingFingers: HandFingerFlags` Returns `bool`
SetPinchGrabParam ( paramId , paramVal )	Signature void Oculus.Interaction.GrabAPI.HandGrabAPI.SetPinchGrabParam(PinchGrabParam paramId, float paramVal) Parameters `paramId: PinchGrabParam` `paramVal: float` Returns `void`