diff options
| author | Malcolm Nixon <Malcolm.nixon@gmail.com> | 2024-02-24 19:20:11 -0500 |
|---|---|---|
| committer | Malcolm Nixon <Malcolm.nixon@gmail.com> | 2024-02-27 19:51:59 -0500 |
| commit | 57aa7345627075fa4cf3f1de33bcddf67baafe80 (patch) | |
| tree | 65197395e798f2db30789ae4f0e65c0cf6e2b8f1 /doc/classes/XRServer.xml | |
| parent | bb6b06c81343073f10cbbd2af515cf0dac1e6549 (diff) | |
| download | redot-engine-57aa7345627075fa4cf3f1de33bcddf67baafe80.tar.gz | |
Add body tracking support.
Diffstat (limited to 'doc/classes/XRServer.xml')
| -rw-r--r-- | doc/classes/XRServer.xml | 48 |
1 files changed, 48 insertions, 0 deletions
diff --git a/doc/classes/XRServer.xml b/doc/classes/XRServer.xml index 09e14f1b21..671cc8f15c 100644 --- a/doc/classes/XRServer.xml +++ b/doc/classes/XRServer.xml @@ -10,6 +10,14 @@ <link title="XR documentation index">$DOCS_URL/tutorials/xr/index.html</link> </tutorials> <methods> + <method name="add_body_tracker"> + <return type="void" /> + <param index="0" name="tracker_name" type="StringName" /> + <param index="1" name="body_tracker" type="XRBodyTracker" /> + <description> + Registers a new [XRBodyTracker] that tracks the joints of a body. + </description> + </method> <method name="add_face_tracker"> <return type="void" /> <param index="0" name="tracker_name" type="StringName" /> @@ -66,6 +74,19 @@ Finds an interface by its [param name]. For example, if your project uses capabilities of an AR/VR platform, you can find the interface for that platform by name and initialize it. </description> </method> + <method name="get_body_tracker" qualifiers="const"> + <return type="XRBodyTracker" /> + <param index="0" name="tracker_name" type="StringName" /> + <description> + Returns the [XRBodyTracker] with the given tracker name. + </description> + </method> + <method name="get_body_trackers" qualifiers="const"> + <return type="Dictionary" /> + <description> + Returns a dictionary of the registered body trackers. Each element of the dictionary is a tracker name mapping to the [XRBodyTracker] instance. + </description> + </method> <method name="get_face_tracker" qualifiers="const"> <return type="XRFaceTracker" /> <param index="0" name="tracker_name" type="StringName" /> @@ -137,6 +158,13 @@ Returns a dictionary of trackers for [param tracker_types]. </description> </method> + <method name="remove_body_tracker"> + <return type="void" /> + <param index="0" name="tracker_name" type="StringName" /> + <description> + Removes a registered [XRBodyTracker]. + </description> + </method> <method name="remove_face_tracker"> <return type="void" /> <param index="0" name="tracker_name" type="StringName" /> @@ -179,6 +207,26 @@ </member> </members> <signals> + <signal name="body_tracker_added"> + <param index="0" name="tracker_name" type="StringName" /> + <param index="1" name="body_tracker" type="XRBodyTracker" /> + <description> + Emitted when a new body tracker is added. + </description> + </signal> + <signal name="body_tracker_removed"> + <param index="0" name="tracker_name" type="StringName" /> + <description> + Emitted when a body tracker is removed. + </description> + </signal> + <signal name="body_tracker_updated"> + <param index="0" name="tracker_name" type="StringName" /> + <param index="1" name="body_tracker" type="XRBodyTracker" /> + <description> + Emitted when an existing body tracker is updated. + </description> + </signal> <signal name="face_tracker_added"> <param index="0" name="tracker_name" type="StringName" /> <param index="1" name="face_tracker" type="XRFaceTracker" /> |