API reference
API reference
Select your platform
No SDKs available
No versions available

HandRootOffset Class

Extends MonoBehaviour
This component positions its transform relative to the root (wrist) joint of an IHand.
Offset and mirroring capabilities are provided, otherwise the transform pose will match that of the hand wrist root.

Protected Fields

_started : bool
Signature 
bool Oculus.Interaction.HandRootOffset._started

Properties

FreezeRotationX : bool
[Get][Set]
When set, rotation about the X axis will be ignored.
Signature 
bool Oculus.Interaction.HandRootOffset.FreezeRotationX
FreezeRotationY : bool
[Get][Set]
When set, rotation about the Y axis will be ignored.
Signature 
bool Oculus.Interaction.HandRootOffset.FreezeRotationY
FreezeRotationZ : bool
[Get][Set]
When set, rotation about the Z axis will be ignored.
Signature 
bool Oculus.Interaction.HandRootOffset.FreezeRotationZ
Hand : IHand
[Get]
The IHand that provides the wrist joint used by this component.
Signature 
IHand Oculus.Interaction.HandRootOffset.Hand
MirrorLeftRotation : bool
[Get][Set]
Signature 
bool Oculus.Interaction.HandRootOffset.MirrorLeftRotation
MirrorOffsetsForLeftHand : bool
[Get][Set]
When the attached hand's IHand.Handedness is set to Handedness.Left, this property will mirror the offsets.
This allows for offset values to be set in Right hand coordinates for both Left and Right hands.
Signature 
bool Oculus.Interaction.HandRootOffset.MirrorOffsetsForLeftHand
Offset : Vector3
[Get][Set]
The driven transform will be offset by this positional value relative to the Hand's wrist
Signature 
Vector3 Oculus.Interaction.HandRootOffset.Offset
Rotation : Quaternion
[Get][Set]
The driven transform will be offset by this rotational value relative to the Hand's wrist
Signature 
Quaternion Oculus.Interaction.HandRootOffset.Rotation

Protected Methods

Awake ()
Signature 
virtual void Oculus.Interaction.HandRootOffset.Awake()
Returns
void
OnDisable ()
Signature 
virtual void Oculus.Interaction.HandRootOffset.OnDisable()
Returns
void
OnEnable ()
Signature 
virtual void Oculus.Interaction.HandRootOffset.OnEnable()
Returns
void
Start ()
Signature 
virtual void Oculus.Interaction.HandRootOffset.Start()
Returns
void

Methods

GetOffset ( pose )
Applies the position offset Offset and the rotation offset Rotation to the provided Pose
Signature 
void Oculus.Interaction.HandRootOffset.GetOffset(ref Pose pose)
Parameters
pose: ref Pose
Returns
void
GetOffset ( pose , handedness , scale )
Applies the position offset Offset and the rotation offset Rotation to the provided Pose for a given Handedness and hand scale factor.
Signature 
void Oculus.Interaction.HandRootOffset.GetOffset(ref Pose pose, Handedness handedness, float scale)
Parameters
pose: ref Pose
handedness: Handedness
scale: float
Returns
void
GetWorldPose ( pose )
Retrieve the world space Pose of this transform.
Signature 
void Oculus.Interaction.HandRootOffset.GetWorldPose(ref Pose pose)
Parameters
pose: ref Pose
Returns
void
InjectAllHandRootOffset ( hand )
Injects all required dependencies for a dynamically instantiated HandRootOffset.
This method exists to support Interaction SDK's dependency injection pattern and is not needed for typical Unity Editor-based usage.
Signature 
void Oculus.Interaction.HandRootOffset.InjectAllHandRootOffset(IHand hand)
Parameters
hand: IHand
Returns
void
InjectAllHandWristOffset ( hand , offset , rotation )
Signature 
void Oculus.Interaction.HandRootOffset.InjectAllHandWristOffset(IHand hand, Vector3 offset, Quaternion rotation)
Parameters
hand: IHand
offset: Vector3
rotation: Quaternion
Returns
void
InjectHand ( hand )
Sets the underlying IHand for a dynamically instantiated HandRootOffset.
This method exists to support Interaction SDK's dependency injection pattern and is not needed for typical Unity Editor-based usage.
Signature 
void Oculus.Interaction.HandRootOffset.InjectHand(IHand hand)
Parameters
hand: IHand
Returns
void
InjectOffset ( offset )
Signature 
void Oculus.Interaction.HandRootOffset.InjectOffset(Vector3 offset)
Parameters
offset: Vector3
Returns
void
InjectRotation ( rotation )
Signature 
void Oculus.Interaction.HandRootOffset.InjectRotation(Quaternion rotation)
Parameters
rotation: Quaternion
Returns
void
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2026 Meta