API reference

FingerPalmGrabAPI Class

This IFingerAPI uses the curl value of the fingers to detect if they are grabbing.
The implementation details of this grab 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

FingerPalmGrabAPI ()
Signature
Oculus.Interaction.GrabAPI.FingerPalmGrabAPI.FingerPalmGrabAPI()

Methods

GetConfigParamFloat ( paramId )
Gets the current value of paramId .
Signature
float Oculus.Interaction.GrabAPI.FingerPalmGrabAPI.GetConfigParamFloat(PalmGrabParamID paramId)
Parameters
paramId: PalmGrabParamID  The PalmGrabParamID to get the value of
Returns
float  The current value of paramId
GetConfigParamVec3 ( paramId )
Gets the current value of paramId .
Signature
Vector3 Oculus.Interaction.GrabAPI.FingerPalmGrabAPI.GetConfigParamVec3(PalmGrabParamID paramId)
Parameters
paramId: PalmGrabParamID  The PalmGrabParamID to get the value of
Returns
Vector3  The current value of paramId
GetFingerGrabScore ( finger )
Implementation of IFingerAPI.GetFingerGrabScore(HandFinger); for details, please refer to the related documentation provided for that property.
Signature
float Oculus.Interaction.GrabAPI.FingerPalmGrabAPI.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.FingerPalmGrabAPI.GetFingerIsGrabbing(HandFinger finger)
Parameters
finger: HandFinger
Returns
bool
GetFingerIsGrabbingChanged ( finger , targetGrabState )
Implementation of IFingerAPI.GetFingerIsGrabbingChanged(HandFinger, bool); for details, please refer to the related documentation provided for that property.
Signature
bool Oculus.Interaction.GrabAPI.FingerPalmGrabAPI.GetFingerIsGrabbingChanged(HandFinger finger, bool targetGrabState)
Parameters
finger: HandFinger
targetGrabState: bool
Returns
bool
GetWristOffsetLocal ()
Gets the offset between the wrist and the pinch point.
Signature
Vector3 Oculus.Interaction.GrabAPI.FingerPalmGrabAPI.GetWristOffsetLocal()
Returns
Vector3  The offset between the wrist and the pinch point
SetConfigParamFloat ( paramId , paramVal )
Sets the value of a floating point configuration.
Signature
void Oculus.Interaction.GrabAPI.FingerPalmGrabAPI.SetConfigParamFloat(PalmGrabParamID paramId, float paramVal)
Parameters
paramId: PalmGrabParamID  The PalmGrabParamID of the configuration value to set
paramVal: float  The new value paramId should be set to
Returns
void
SetConfigParamVec3 ( paramId , paramVal )
Sets the value of a Vector3 configuration.
Signature
void Oculus.Interaction.GrabAPI.FingerPalmGrabAPI.SetConfigParamVec3(PalmGrabParamID paramId, Vector3 paramVal)
Parameters
paramId: PalmGrabParamID  The PalmGrabParamID of the configuration value to set
paramVal: Vector3  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.FingerPalmGrabAPI.Update(IHand hand)
Parameters
hand: IHand
Returns
void