API reference
HandGrabPose Class
Extends MonoBehaviour
The HandGrabPose defines the local point in an object to which the grip point of a HandGrabInteractor should align.
It can also contain information about the final pose of the hand for perfect alignment as well as a surface that indicates the valid positions for the point.
Properties
IGrabSurface SnapSurface[Get]
The IGrabSurface containing information to help hand visuals pose themselves when grabbing.
This property is primarily used by internal HandGrabPose calculations and by Editor-based pose authoring tools.
HandPose HandPose[Get]
The HandGrab.HandPose a hand visual should adopt when grabbing an interactable equipped with this HandGrabPose.
float RelativeScale[Get]
Returns the current scale of the HandGrabPose relative to its reference transform.
This value is estimated based the RelativeTo transform's scale in its local X dimension; this estimate is not guaranteed to be accurate, particularly under arbitrary rotations and skewing scales.
Pose RelativePose[Get]
Pose of the HandGrabPose relative to its reference transform.
Pose LocalPose[Get]
Pose WorldPose[Get]
Fields
Transform RelativeTo[Get]
Reference transform of the HandGrabPose.
This is the transform relative to which many fundamental calculations are performed.
Protected Functions
virtual void Awake ( )
virtual void Reset ( )
Member Functions
bool UsesHandPose ( )
Checks whether this instance uses hand poses.
Returns
True if HandPose should return a valid HandGrab.HandPose, false otherwise
virtual bool CalculateBestPose
( Pose userPose,
Handedness handedness,
PoseMeasureParameters scoringModifier,
Transform relativeTo,
ref HandGrabResult result )
Obsolete implementation; use CalculateBestPose(in Pose, in Pose, Transform, Handedness, PoseMeasureParameters, ref HandGrabResult) instead.
Parameters
userPose
The current pose of the user
handedness
The handedness of the grab
scoringModifier
PoseMeasureParameters for score modification
relativeTo
The relative transform
result
Out parameter for the calculated pose
Returns
True always (this obsolete method always returns a valid result)
virtual void CalculateBestPose
( in Pose userPose,
in Pose offset,
Transform relativeTo,
Handedness handedness,
PoseMeasureParameters scoringModifier,
ref HandGrabResult result )
Finds the most similar pose to the provided pose.
If the HandGrabPose contains a surface it will defer the calculation to it.
Parameters
userPose
The current pose of the user
offset
The offset from the root, for accurate scoring
relativeTo
The relative transform
handedness
The handedness of the grab
scoringModifier
PoseMeasureParameters for score modification
result
Out parameter for the calculated pose
void InjectAllHandGrabPose
( Transform relativeTo )
Injects all required dependencies for a dynamically instantiated HandGrabPose; effectively wraps InjectRelativeTo(Transform).
This method exists to support Interaction SDK's dependency injection pattern and is not needed for typical Unity Editor-based usage.
void InjectRelativeTo
( Transform relativeTo )
Sets the RelativeTo transform for a dynamically instantiated HandGrabPose.
This method exists to support Interaction SDK's dependency injection pattern and is not needed for typical Unity Editor-based usage.
void InjectOptionalSurface
( IGrabSurface surface )
Sets the IGrabSurface for a dynamically instantiated HandGrabPose.
This method exists to support Interaction SDK's dependency injection pattern and is not needed for typical Unity Editor-based usage.
void InjectOptionalHandPose
( HandPose handPose )
Sets the HandPose for a dynamically instantiated HandGrabPose.
This method exists to support Interaction SDK's dependency injection pattern and is not needed for typical Unity Editor-based usage.
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