HandPosing.Interaction.IGrabNotifier Interface Reference

Layer for communicating between the Grabber and the Snapper code. You must implement this interface if you want your grabber to be able to snap to objects. More...

Inheritance diagram for HandPosing.Interaction.IGrabNotifier:

Public Member Functions
float	CurrentFlex ()
	Current normalised value of the grabbing gesture. 1 for a fully realised gesture, 0 for no gesture detected. More...
Snappable	FindClosestSnappable ()
	The snappable with the best score that can be reached at the current pose. Typically all grabbable objects will also have snappables, and the Grabber would already implement a metho to find the nearest grabbable,this could be very similar. More...

Properties
Action< GameObject >	OnGrabStarted [get, set]
	Event triggered when a Grab is started at a GameObject. More...
Action< GameObject, float >	OnGrabAttemp [get, set]
	Event triggered when a Grab is attempted at a GameObject. More...
Action< GameObject >	OnGrabAttemptFail [get, set]
	Event triggered when a grabbed GameObjec if user tried to make a grab attempt sometime in the past More...
Action< GameObject >	OnGrabEnded [get, set]
	Event triggered when a grabbed GameObject is released. More...
Vector2	GrabFlexThreshold [get]
	Min - Max value for the grab thresold. X indicates the release point, Y the grab point. Typically [0.33,0.9] or even [0,1] More...

Detailed Description

Layer for communicating between the Grabber and the Snapper code. You must implement this interface if you want your grabber to be able to snap to objects.

Member Function Documentation

CurrentFlex()

float HandPosing.Interaction.IGrabNotifier.CurrentFlex

(

)

Current normalised value of the grabbing gesture. 1 for a fully realised gesture, 0 for no gesture detected.

Returns

Normalised value for the grab gesture detection.

Implemented in HandPosing.OVRIntegration.GrabberHybridOVR, and HandPosing.Interaction.BaseGrabber.

FindClosestSnappable()

Snappable HandPosing.Interaction.IGrabNotifier.FindClosestSnappable

(

)

The snappable with the best score that can be reached at the current pose. Typically all grabbable objects will also have snappables, and the Grabber would already implement a metho to find the nearest grabbable,this could be very similar.

Returns

If found, the best object that the hand can snap to.

Implemented in HandPosing.Interaction.BaseGrabber.

Property Documentation

GrabFlexThreshold

Vector2 HandPosing.Interaction.IGrabNotifier.GrabFlexThreshold

get

Min - Max value for the grab thresold. X indicates the release point, Y the grab point. Typically [0.33,0.9] or even [0,1]

OnGrabAttemp

Action<GameObject, float> HandPosing.Interaction.IGrabNotifier.OnGrabAttemp

getset

Event triggered when a Grab is attempted at a GameObject.

Parameters

GameObject	The object about to be grabbed.
float	The normalised value indicating how close to grab the user is. e.g. if the user grabs with a pinch 0.5 would indicate the pinch gesture is half-way in.

OnGrabAttemptFail

Action<GameObject> HandPosing.Interaction.IGrabNotifier.OnGrabAttemptFail

getset

Event triggered when a grabbed GameObjec if user tried to make a grab attempt sometime in the past

Parameters

GameObject

The object that failed to be grabbed.

OnGrabEnded

Action<GameObject> HandPosing.Interaction.IGrabNotifier.OnGrabEnded

getset

Event triggered when a grabbed GameObject is released.

Parameters

GameObject

The ungrabbed object.

OnGrabStarted

Action<GameObject> HandPosing.Interaction.IGrabNotifier.OnGrabStarted

getset

Event triggered when a Grab is started at a GameObject.

Parameters

GameObject

The grabbed object.

---

The documentation for this interface was generated from the following file:

• Runtime/Interaction/IGrabNotifier.cs