API reference
GrabbingRule Struct
This struct indicates which fingers should be taken in count for performing an interaction (for example, in HandGrab.HandGrabInteractor).
All required fingers must be in use in order to start the interaction while any of the optional fingers is needed. For finishing the action it supports either releasing all fingers or any of them.
Fields
FingerUnselectMode UnselectMode[Get]
Returns the FingerUnselectMode for this instance, which dictates whether the grab defined by this rule ends when any of its required fingers release, or when all of them do.
Properties
bool SelectsWithOptionals[Get]
This property checks whether this grab can be performed using only fingers marked FingerRequirement.Optional.
The property is true only if no fingers are marked as FingerRequirement.Required, false otherwise.
FingerRequirement this[HandFinger fingerID][Get]
Indexer for retrieving and setting FingerRequirements by their HandFinger type.
Parameters
fingerID
The HandFinger of the FingerRequirement to be accessed
Returns
Access to the FingerRequirement requested
static GrabbingRule DefaultPalmRule[Get]
Standard definition for "palm grab": requires the middle three fingers to begin a grab, allowing that grab to persist as long as any finger continues grabbing.
static GrabbingRule DefaultPinchRule[Get]
Standard definition for "pinch grab": allows grabbing to begin when any of the first three fingers (thumb, index, middle) grabs, persisting the grab as long as any of those three is grabbing, and ignoring the last two fingers.
static GrabbingRule FullGrab[Get]
Standard definition for "full grab": requires all five fingers to begin a grab, allowing that grab to persist as long as any finger continues grabbing.
Member Functions
void StripIrrelevant
( ref HandFingerFlags fingerFlags )
In-place modifies a HandFingerFlags bit mask representing the grabbing state of the various fingers, suppressing any detected grabs by fingers marked FingerRequirement.Ignored in this rule.
Parameters
fingerFlags
GrabbingRule
( HandFingerFlags mask,
in GrabbingRule otherRule )
Projecting constructor which creates a new GrabbingRule as a subset of another.
Copies the otherRule 's requirements for fingers included in the mask bit mask, setting FingerRequirement.Ignored rules for all other fingers.
Parameters
mask
Bit mask specifying which requirements from otherRule to copy
otherRule
Original rule from which requirements should be copied
Did you find this page helpful?
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
English (US)
© 2025 Meta