2024-02-20 14:56:59 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
<class name= "XRHandModifier3D" inherits= "Node3D" xmlns:xsi= "http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation= "../class.xsd" >
<brief_description >
A node for driving hand meshes from [XRHandTracker] data.
</brief_description>
<description >
This node uses hand tracking data from a [XRHandTracker] to animate the skeleton of a hand mesh.
2024-03-04 04:08:23 +00:00
This node positions itself at the [constant XRHandTracker.HAND_JOINT_PALM] position and scales itself to [member XRServer.world_scale]. Adding the hand model as a child of this node will result in the model being positioned and scaled correctly for XR experiences.
The hand tracking position-data is scaled by [member Skeleton3D.motion_scale] when applied to the skeleton, which can be used to adjust the tracked hand to match the scale of the hand model.
2024-02-20 14:56:59 +00:00
</description>
<tutorials >
<link title= "XR documentation index" > $DOCS_URL/tutorials/xr/index.html</link>
</tutorials>
<members >
<member name= "bone_update" type= "int" setter= "set_bone_update" getter= "get_bone_update" enum= "XRHandModifier3D.BoneUpdate" default= "0" >
Specifies the type of updates to perform on the bones.
</member>
<member name= "hand_tracker" type= "StringName" setter= "set_hand_tracker" getter= "get_hand_tracker" default= "&"/user/left"" >
The name of the [XRHandTracker] registered with [XRServer] to obtain the hand tracking data from.
</member>
<member name= "target" type= "NodePath" setter= "set_target" getter= "get_target" default= "NodePath("")" >
A [NodePath] to a [Skeleton3D] to animate.
</member>
</members>
<constants >
<constant name= "BONE_UPDATE_FULL" value= "0" enum= "BoneUpdate" >
The skeleton's bones are fully updated (both position and rotation) to match the tracked bones.
</constant>
<constant name= "BONE_UPDATE_ROTATION_ONLY" value= "1" enum= "BoneUpdate" >
The skeleton's bones are only rotated to align with the tracked bones, preserving bone length.
</constant>
<constant name= "BONE_UPDATE_MAX" value= "2" enum= "BoneUpdate" >
Represents the size of the [enum BoneUpdate] enum.
</constant>
</constants>
</class>
