API reference

FingerPinchGrabAPI Class

Methods

GetFingerGrabScore ( finger )
Retrieves a normalized score indicating how strongly a finger is grabbing.
Signature
float Oculus.Interaction.GrabAPI.FingerPinchGrabAPI.GetFingerGrabScore(HandFinger finger)
Parameters
finger: HandFinger  The HandFinger to evaluate.
Returns
float  A value between 0 and 1, where 0 indicates no grab and 1 indicates maximum grab strength.
GetFingerIsGrabbing ( finger )
Determines if a specific finger is currently in a grabbing state.
Signature
bool Oculus.Interaction.GrabAPI.FingerPinchGrabAPI.GetFingerIsGrabbing(HandFinger finger)
Parameters
finger: HandFinger  The HandFinger to check for grabbing state.
Returns
bool  True if the specified finger is grabbing, false otherwise.
GetFingerIsGrabbingChanged ( finger , targetPinchState )
Detects changes in a finger's grabbing state relative to a target state.
Signature
bool Oculus.Interaction.GrabAPI.FingerPinchGrabAPI.GetFingerIsGrabbingChanged(HandFinger finger, bool targetPinchState)
Parameters
finger: HandFinger  The HandFinger to check for state changes.
targetPinchState: bool  The target grab state to compare against.
Returns
bool  True if the finger's grab state has changed to match the target state.
GetFingerPinchDistance ( finger )
Signature
float Oculus.Interaction.GrabAPI.FingerPinchGrabAPI.GetFingerPinchDistance(HandFinger finger)
Parameters
finger: HandFinger
Returns
float
GetFingerPinchPercent ( finger )
Signature
float Oculus.Interaction.GrabAPI.FingerPinchGrabAPI.GetFingerPinchPercent(HandFinger finger)
Parameters
finger: HandFinger
Returns
float
GetPinchGrabParam ( paramId )
Signature
float Oculus.Interaction.GrabAPI.FingerPinchGrabAPI.GetPinchGrabParam(PinchGrabParam paramId)
Parameters
paramId: PinchGrabParam
Returns
float
GetWristOffsetLocal ()
Gets the local space offset from the wrist position for grab calculations.
Signature
Vector3 Oculus.Interaction.GrabAPI.FingerPinchGrabAPI.GetWristOffsetLocal()
Returns
Vector3  The offset vector in local space coordinates.
SetPinchGrabParam ( paramId , paramVal )
Signature
void Oculus.Interaction.GrabAPI.FingerPinchGrabAPI.SetPinchGrabParam(PinchGrabParam paramId, float paramVal)
Parameters
paramId: PinchGrabParam
paramVal: float
Returns
void
Update ( hand )
Updates the finger API with the latest hand tracking data.
Signature
void Oculus.Interaction.GrabAPI.FingerPinchGrabAPI.Update(IHand hand)
Parameters
hand: IHand  The IHand tracking data to process.
Returns
void