diff options
| author | David Snopek <dsnopek@gmail.com> | 2024-02-20 08:56:59 -0600 |
|---|---|---|
| committer | David Snopek <dsnopek@gmail.com> | 2024-02-23 12:20:22 -0600 |
| commit | 2184fa96985d459f10793f3569f2ca96cb57f839 (patch) | |
| tree | 91402fc78e7990c13191fe72f564fa5ba2202947 /doc/classes/XRHandModifier3D.xml | |
| parent | 16d61427cab3a8e43f0a9a8ee724fc176b6433c6 (diff) | |
| download | redot-engine-2184fa96985d459f10793f3569f2ca96cb57f839.tar.gz | |
Provide generic interface for XR hand tracking
Diffstat (limited to 'doc/classes/XRHandModifier3D.xml')
| -rw-r--r-- | doc/classes/XRHandModifier3D.xml | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/doc/classes/XRHandModifier3D.xml b/doc/classes/XRHandModifier3D.xml new file mode 100644 index 0000000000..7e08d3f687 --- /dev/null +++ b/doc/classes/XRHandModifier3D.xml @@ -0,0 +1,34 @@ +<?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. + </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> |