ReadonlyapiGeneric object accessible by other instances of ScriptComponent. Use this object to store references to properties and methods that need to be accessible from other ScriptComponents.
When enabled, the system will automatically map tracking data to the hand model's joints. Disable only if you need manual control over individual joint assignments.
If disabled, the Component will stop enacting its behavior.
Reference to the HandInteractor component that provides gesture recognition and tracking for this hand.
Reference to the RenderMeshVisual of the full hand mesh.
Reference to the RenderMeshVisual of the hand mesh with only an index & thumb for efficiency.
Reference to the RenderMeshVisual of the full hand mesh to pin SceneObjects to.
The SceneObject of the indexKnuckle joint
The SceneObject of the indexMidJoint joint
The SceneObject of the indexTip joint
The SceneObject of the indexToWrist joint
The SceneObject of the indexUpperJoint joint
True when this class is ready to use.
initialize can be used to initialize the instance.
ReadonlyisReturns true if this Component, its SceneObject, and all of that SceneObjects parents are enabled.
The SceneObject of the middleKnuckle joint
The SceneObject of the middleMidJoint joint
The SceneObject of the middleTip joint
The SceneObject of the middleToWrist joint
The SceneObject of the middleUpperJoint joint
The SceneObject of the pinkyKnuckle joint
The SceneObject of the pinkyMidJoint joint
The SceneObject of the pinkyTip joint
The SceneObject of the pinkyToWrist joint
The SceneObject of the pinkyUpperJoint joint
The SceneObject of the ringKnuckle joint
The SceneObject of the ringMidJoint joint
The SceneObject of the ringTip joint
The SceneObject of the ringToWrist joint
The SceneObject of the ringUpperJoint joint
The root SceneObject, parent of the hand rig and hand mesh
ReadonlysceneThe SceneObject this component is on.
The SceneObject of the thumbBaseJoint joint
The SceneObject of the thumbKnuckle joint
The SceneObject of the thumbMidJoint joint
The SceneObject of the thumbTip joint
The SceneObject of the thumbToWrist joint
ReadonlyuniqueThe SceneObject of the wrist joint
Gets the glow effect view that provides visual feedback for hand interactions.
Gets the full hand mesh visual.
Gets whether the hand visual is visible. When false, all hand visual components (mesh, glow effects, and wrist) will not be shown regardless of tracking status.
Sets whether the hand visual is visible. When false, all hand visual components (mesh, glow effects, and wrist) will not be shown regardless of tracking status.
Gets the current mesh type being displayed
the current selection of the hand visual to present to user
Sets the selection of the hand visual to present to user
Adds a hand visual override for a specific interactable.
The HandVisualOverride to add.
Adds a new SceneEvent, triggered by eventType events, to the ScriptComponent.
ProtecteddefineProtecteddefineProtecteddefineDestroys the component.
Returns the SceneObject the component is attached to.
Returns the Transform this component is attached to.
StaticgetReturns the name of this object's type.
Sets up all joint Transforms and sets initialized to true.
Returns true if the object matches or derives from the passed in type.
Returns true if this object is the same as other. Useful for checking if two references point to the same thing.
Removes a previously added SceneEvent from the ScriptComponent.
Removes a hand visual override by its unique ID.
True if removed, false if not found.
This class provides a visual representation of the hand, with the ability to automatically wire joints to the hand mesh. It also provides the ability to add a radial gradient occlusion effect and a glow effect to the hand mesh.