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

HandVisual Class

Extends MonoBehaviour
Implements Oculus.Interaction.IHandVisual
Renders an IHand.
This component drives a transform hierarchy corresponding to the bone positions of a Hand skeleton, and toggles the Mesh Renderer of the hand model.

Fields

IsVisible : bool
Implementation of IHandVisual.IsVisible.
For detailed information, refer to the related documentation provided for that interface.
Signature 
bool Oculus.Interaction.HandVisual.IsVisible

Properties

ForceOffVisibility : bool
[Get][Set]
Implementation of IHandVisual.ForceOffVisibility.
For detailed information, refer to the related documentation provided for that interface.
Signature 
bool Oculus.Interaction.HandVisual.ForceOffVisibility
Hand : IHand
[Get]
Implementation of IHandVisual.Hand.
For detailed information, refer to the related documentation provided for that interface.
Signature 
IHand Oculus.Interaction.HandVisual.Hand
Joints : IList< Transform >
[Get]
List of transforms corresponding to the hand joint poses from Hand.
Specific joints in this list can be accessed by using the integer value of HandJointId as the index.
Signature 
IList<Transform> Oculus.Interaction.HandVisual.Joints
Root : Transform
[Get]
The root of the transform hierarchy corresponding to the joint poses from Hand.
Signature 
Transform Oculus.Interaction.HandVisual.Root

Events

WhenHandVisualUpdated : Action
Implementation of IHandVisual.WhenHandVisualUpdated.
For detailed information, refer to the related documentation provided for that interface.
Signature 
Action Oculus.Interaction.HandVisual.WhenHandVisualUpdated

Protected Methods

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

Methods

GetJointPose ( jointId , space )
Implementation of IHandVisual.GetJointPose(HandJointId, Space).
For detailed information, refer to the related documentation provided for that interface.
Signature 
Pose Oculus.Interaction.HandVisual.GetJointPose(HandJointId jointId, Space space)
Parameters
jointId: HandJointId
space: Space
Returns
Pose
GetTransformByHandJointId ( handJointId )
Returns the transform that this component is driving, corresponding to a provided HandJointId.
Signature 
Transform Oculus.Interaction.HandVisual.GetTransformByHandJointId(HandJointId handJointId)
Parameters
handJointId: HandJointId
Returns
Transform
InjectAllHandSkeletonVisual ( hand , skinnedMeshRenderer )
Injects all required dependencies for a dynamically instantiated HandVisual.
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.HandVisual.InjectAllHandSkeletonVisual(IHand hand, SkinnedMeshRenderer skinnedMeshRenderer)
Parameters
hand: IHand
skinnedMeshRenderer: SkinnedMeshRenderer
Returns
void
InjectHand ( hand )
Sets the underlying IHand for a dynamically instantiated HandVisual.
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.HandVisual.InjectHand(IHand hand)
Parameters
hand: IHand
Returns
void
InjectOptionalMaterialPropertyBlockEditor ( editor )
Sets the HandMaterialPropertyBlockEditor property for a dynamically instantiated HandVisual.
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.HandVisual.InjectOptionalMaterialPropertyBlockEditor(MaterialPropertyBlockEditor editor)
Parameters
editor: MaterialPropertyBlockEditor
Returns
void
InjectOptionalRoot ( root )
Sets the Root property for a dynamically instantiated HandVisual.
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.HandVisual.InjectOptionalRoot(Transform root)
Parameters
root: Transform
Returns
void
InjectOptionalUpdateRootPose ( updateRootPose )
Sets the _updateRootPose field for a dynamically instantiated HandVisual.
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.HandVisual.InjectOptionalUpdateRootPose(bool updateRootPose)
Parameters
updateRootPose: bool
Returns
void
InjectOptionalUpdateRootScale ( updateRootScale )
Sets the _updateRootScale field for a dynamically instantiated HandVisual.
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.HandVisual.InjectOptionalUpdateRootScale(bool updateRootScale)
Parameters
updateRootScale: bool
Returns
void
InjectSkinnedMeshRenderer ( skinnedMeshRenderer )
Sets the underlying UnityEngine.SkinnedMeshRenderer for a dynamically instantiated HandVisual.
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.HandVisual.InjectSkinnedMeshRenderer(SkinnedMeshRenderer skinnedMeshRenderer)
Parameters
skinnedMeshRenderer: SkinnedMeshRenderer
Returns
void
UpdateSkeleton ()
This method updates the skeleton transform hierarchy and renderer visibility.
This method is specific to the HandVisual component and should not be called directly.
Signature 
void Oculus.Interaction.HandVisual.UpdateSkeleton()
Returns
void
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2026 Meta