API reference

FingerPinchGrabAPI Class

This IFingerAPI uses an advanced calculation for the pinch value of the fingers to detect if they are grabbing.
The implementation details of this pinch calculation are more low-level than Unity and are thus encapsulated below the managed-native boundary. This type merely provides an API surface through which to invoke the native functionality.

Constructors

FingerPinchGrabAPI ( hmd )
Signature
Oculus.Interaction.GrabAPI.FingerPinchGrabAPI.FingerPinchGrabAPI(IHmd hmd=null)
Parameters
hmd: IHmd

Methods

GetFingerGrabScore ( finger )
Implementation of IFingerAPI.GetFingerGrabScore(HandFinger); for details, please refer to the related documentation provided for that property.
Signature
float Oculus.Interaction.GrabAPI.FingerPinchGrabAPI.GetFingerGrabScore(HandFinger finger)
Parameters
finger: HandFinger
Returns
float
GetFingerIsGrabbing ( finger )
Implementation of IFingerAPI.GetFingerIsGrabbing(HandFinger); for details, please refer to the related documentation provided for that property.
Signature
bool Oculus.Interaction.GrabAPI.FingerPinchGrabAPI.GetFingerIsGrabbing(HandFinger finger)
Parameters
finger: HandFinger
Returns
bool
GetFingerIsGrabbingChanged ( finger , targetPinchState )
Implementation of IFingerAPI.GetFingerIsGrabbingChanged(HandFinger, bool); for details, please refer to the related documentation provided for that property.
Signature
bool Oculus.Interaction.GrabAPI.FingerPinchGrabAPI.GetFingerIsGrabbingChanged(HandFinger finger, bool targetPinchState)
Parameters
finger: HandFinger
targetPinchState: bool
Returns
bool
GetFingerPinchDistance ( finger )
Gets the finger pinch distance for the requested finger.
Signature
float Oculus.Interaction.GrabAPI.FingerPinchGrabAPI.GetFingerPinchDistance(HandFinger finger)
Parameters
finger: HandFinger  The HandFinger for which to check the pinch distance
Returns
float
GetFingerPinchPercent ( finger )
Determines the degree to which a particular finger is pinching.
Signature
float Oculus.Interaction.GrabAPI.FingerPinchGrabAPI.GetFingerPinchPercent(HandFinger finger)
Parameters
finger: HandFinger  The HandFinger to check
Returns
float  A percentage representation of how pinched finger is
GetIsPinchVisibilityGood ()
Checks whether hand tracking has good visibility on a pinch.
Signature
bool Oculus.Interaction.GrabAPI.FingerPinchGrabAPI.GetIsPinchVisibilityGood()
Returns
bool  True if the hand tracking system believes it can see pinching well, false otherwise
GetPinchGrabParam ( paramId )
Retrieves the current value of paramId .
Signature
float Oculus.Interaction.GrabAPI.FingerPinchGrabAPI.GetPinchGrabParam(PinchGrabParam paramId)
Parameters
paramId: PinchGrabParam  The PinchGrabParam for which to retrieve the value
Returns
float  The current value of paramId
GetWristOffsetLocal ()
Gets the offset between the wrist and the pinch point.
Signature
Vector3 Oculus.Interaction.GrabAPI.FingerPinchGrabAPI.GetWristOffsetLocal()
Returns
Vector3  The offset between the wrist and the pinch point
SetPinchGrabParam ( paramId , paramVal )
Sets the current value of paramId .
Signature
void Oculus.Interaction.GrabAPI.FingerPinchGrabAPI.SetPinchGrabParam(PinchGrabParam paramId, float paramVal)
Parameters
paramId: PinchGrabParam  The PinchGrabParam for which to set the value
paramVal: float  The new value paramId should be set to
Returns
void
Update ( hand )
Implementation of IFingerAPI.Update(IHand); for details, please refer to the related documentation provided for that property.
Signature
void Oculus.Interaction.GrabAPI.FingerPinchGrabAPI.Update(IHand hand)
Parameters
hand: IHand
Returns
void