API reference

HandJoint Class

Extends MonoBehaviour

Standalone MonoBehavior representation of a tracked hand joint within an IHand.

This a low-level type used primarily in core Interaction SDK operations such as detecting grabs and pinches. While various values in this type can be modified publicly, doing so is something only experts should consider trying.

Protected Fields

_started : bool

Signature

bool _started

Properties

Hand : IHand [Get]	The IHand to which this joint belongs. This property is populated during MonoBehaviour start-up with the value of the `_hand` field, which is set through the Unity Editor. Signature IHand Hand
HandJointId : HandJointId [Get][Set]	Gets and sets the HandJointId for this joint. This value is useful when mapping HandJoints to visualizations or other logic which must distinguish between the various tracked joints. Signature HandJointId HandJointId
LocalPositionOffset : Vector3 [Get][Set]	Gets and sets the position offset associated with this HandJoint. This is a low-level value which characterizes the expected shapes of certain tracked hand features (for example, phalanges, a.k.a. finger bones) according to the tracking system's hand model. These values can be set to fundamentally change the shape produced by hand tracking data, but this is something only experts should consider trying. Signature Vector3 LocalPositionOffset
MirrorOffsetsForLeftHand : bool [Get][Set]	When the attached IHand's handedness is set to 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 MirrorOffsetsForLeftHand
RotationOffset : Quaternion [Get][Set]	Gets and sets the rotation offset associated with this HandJoint. This is a low-level value which characterizes the expected relative orientations of certain tracked hand features (for example, phalanges, a.k.a. finger bones) when compared to the tracking data of a given hand tracking system. These values can be set to fundamentally change the shape produced by hand tracking data, but this is something only experts should consider trying. Signature Quaternion RotationOffset

Protected Methods

Awake ()	Signature virtual void Awake() Returns `void`
OnDisable ()	Signature virtual void OnDisable() Returns `void`
OnEnable ()	Signature virtual void OnEnable() Returns `void`
Start ()	Signature virtual void Start() Returns `void`

Methods

InjectAllHandJoint ( hand )

Convenience method for injecting all requirements to a dynamically instantiated HandJoint.

Because the only requirement of HandJoint is an IHand, this simply wraps InjectHand(IHand). This method exists to support Interaction SDK's dependency injection pattern and is not needed for typical Unity Editor-based usage.