API reference
HandRef Class
Extends MonoBehaviour, IHand, IActiveState
HandRef is a utility component that delegates all of its IHand implementation to the provided Hand object.
HandRef can be thought of as a "redirect," which is useful for making Unity Component configurations flexible with limited setup. For example, if making a prefab containing multiple hand-referencing components which should be usable with either hand, it is more convenient to have a single HandRef at the root of the prefab (to which all the other Components connect) and connect only that to the desired hand versus having to connect every Component individually for every instance of the prefab.
Properties
Action WhenHandUpdated
Retrieves the IHand.WhenHandUpdated event of the underlying Hand.
This is a pure shim property equivalent to accessing the same property on the Hand.
Fields
Handedness Handedness[Get]
Retrieves the IHand.Handedness of the underlying Hand.
This is a pure shim property equivalent to accessing the same property on the Hand.
bool IsConnected[Get]
Retrieves the IHand.IsConnected value of the underlying Hand.
This is a pure shim property equivalent to accessing the same property on the Hand.
bool IsHighConfidence[Get]
Retrieves the IHand.IsHighConfidence value of the underlying Hand.
This is a pure shim property equivalent to accessing the same property on the Hand.
bool IsDominantHand[Get]
Retrieves the IHand.IsDominantHand value of the underlying Hand.
This is a pure shim property equivalent to accessing the same property on the Hand.
float Scale[Get]
Retrieves the IHand.Scale value of the underlying Hand.
This is a pure shim property equivalent to accessing the same property on the Hand.
bool IsPointerPoseValid[Get]
Retrieves the IHand.IsPointerPoseValid value of the underlying Hand.
This is a pure shim property equivalent to accessing the same property on the Hand.
bool IsTrackedDataValid[Get]
Retrieves the IHand.IsTrackedDataValid value of the underlying Hand.
This is a pure shim property equivalent to accessing the same property on the Hand.
int CurrentDataVersion[Get]
Retrieves the IHand.CurrentDataVersion value of the underlying Hand.
This is a pure shim property equivalent to accessing the same property on the Hand.
bool Active[Get]
Implements IActiveState.Active, in this case indicating whether the underlying Hand is connected.
This is a remapping method which makes the IsConnected value available to consumers treating the HandRef as an IActiveState.
Protected Functions
virtual void Awake ( )
virtual void Start ( )
Member Functions
bool GetFingerIsPinching
( HandFinger finger )
Invokes IHand.GetFingerIsPinching(HandFinger) on the underlying Hand.
This is a pure shim method equivalent to invoking the same method on the Hand.
bool GetIndexFingerIsPinching ( )
Invokes IHand.GetIndexFingerIsPinching() on the underlying Hand.
This is a pure shim method equivalent to invoking the same method on the Hand.
bool GetPointerPose
( out Pose pose )
Invokes IHand.GetPointerPose(out Pose) on the underlying Hand.
This is a pure shim method equivalent to invoking the same method on the Hand.
bool GetJointPose
( HandJointId handJointId,
out Pose pose )
Invokes IHand.GetJointPose(HandJointId, out Pose) on the underlying Hand.
This is a pure shim method equivalent to invoking the same method on the Hand.
bool GetJointPoseLocal
( HandJointId handJointId,
out Pose pose )
Invokes IHand.GetJointPoseLocal(HandJointId, out Pose) on the underlying Hand.
This is a pure shim method equivalent to invoking the same method on the Hand.
bool GetJointPosesLocal
( out ReadOnlyHandJointPoses jointPosesLocal )
Invokes IHand.GetJointPosesLocal(out ReadOnlyHandJointPoses) on the underlying Hand.
This is a pure shim method equivalent to invoking the same method on the Hand.
bool GetJointPoseFromWrist
( HandJointId handJointId,
out Pose pose )
Invokes IHand.GetJointPoseFromWrist(HandJointId, out Pose) on the underlying Hand.
This is a pure shim method equivalent to invoking the same method on the Hand.
bool GetJointPosesFromWrist
( out ReadOnlyHandJointPoses jointPosesFromWrist )
Invokes IHand.GetJointPosesFromWrist(out ReadOnlyHandJointPoses) on the underlying Hand.
This is a pure shim method equivalent to invoking the same method on the Hand.
bool GetPalmPoseLocal
( out Pose pose )
Invokes IHand.GetPalmPoseLocal(out Pose) on the underlying Hand.
This is a pure shim method equivalent to invoking the same method on the Hand.
bool GetFingerIsHighConfidence
( HandFinger finger )
Invokes IHand
This is a pure shim method equivalent to invoking the same method on the Hand.
float GetFingerPinchStrength
( HandFinger finger )
Invokes IHand.GetFingerPinchStrength(HandFinger) on the underlying Hand.
This is a pure shim method equivalent to invoking the same method on the Hand.
bool GetRootPose
( out Pose pose )
Invokes IHand.GetRootPose(out Pose) on the underlying Hand.
This is a pure shim method equivalent to invoking the same method on the Hand.
void InjectAllHandRef
( IHand hand )
Sets all required dependencies for a dynamically instantiated HandRef.
This is a convenience method wrapping InjectHand(IHand). 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