|
| 1 | +<?xml version="1.0" encoding="UTF-8" ?> |
| 2 | +<class name="OpenXRRenderModelExtension" inherits="OpenXRExtensionWrapper" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> |
| 3 | + <brief_description> |
| 4 | + </brief_description> |
| 5 | + <description> |
| 6 | + </description> |
| 7 | + <tutorials> |
| 8 | + </tutorials> |
| 9 | + <methods> |
| 10 | + <method name="is_active" qualifiers="const"> |
| 11 | + <return type="bool" /> |
| 12 | + <description> |
| 13 | + Returns [code]true[/code] if OpenXR's render model extension is supported and enabled. |
| 14 | + [b]Note:[/b] This only returns a valid value after OpenXR has been initialized. |
| 15 | + </description> |
| 16 | + </method> |
| 17 | + <method name="render_model_create"> |
| 18 | + <return type="RID" /> |
| 19 | + <param index="0" name="render_model_id" type="int" /> |
| 20 | + <description> |
| 21 | + Creates a render model object within OpenXR using a render model id. |
| 22 | + [b]Note:[/b] This function is exposed for dependent OpenXR extensions that provide render model ids to be used with the render model extension. |
| 23 | + </description> |
| 24 | + </method> |
| 25 | + <method name="render_model_destroy"> |
| 26 | + <return type="void" /> |
| 27 | + <param index="0" name="render_model" type="RID" /> |
| 28 | + <description> |
| 29 | + Destroys a render model object within OpenXR that was previously created with [method render_model_create]. |
| 30 | + [b]Note:[/b] This function is exposed for dependent OpenXR extensions that provide render model ids to be used with the render model extension. |
| 31 | + </description> |
| 32 | + </method> |
| 33 | + <method name="render_model_get_all"> |
| 34 | + <return type="RID[]" /> |
| 35 | + <description> |
| 36 | + Returns an array of all currently active render models registered with this extension. |
| 37 | + </description> |
| 38 | + </method> |
| 39 | + <method name="render_model_get_animatable_node_count" qualifiers="const"> |
| 40 | + <return type="int" /> |
| 41 | + <param index="0" name="render_model" type="RID" /> |
| 42 | + <description> |
| 43 | + Returns the number of animatable nodes this render model has. |
| 44 | + </description> |
| 45 | + </method> |
| 46 | + <method name="render_model_get_animatable_node_name" qualifiers="const"> |
| 47 | + <return type="String" /> |
| 48 | + <param index="0" name="render_model" type="RID" /> |
| 49 | + <param index="1" name="index" type="int" /> |
| 50 | + <description> |
| 51 | + Returns the name of the given animatable node. |
| 52 | + </description> |
| 53 | + </method> |
| 54 | + <method name="render_model_get_animatable_node_transform" qualifiers="const"> |
| 55 | + <return type="Transform3D" /> |
| 56 | + <param index="0" name="render_model" type="RID" /> |
| 57 | + <param index="1" name="index" type="int" /> |
| 58 | + <description> |
| 59 | + Returns the current local transform for an animatable node. This is updated every frame. |
| 60 | + </description> |
| 61 | + </method> |
| 62 | + <method name="render_model_get_confidence" qualifiers="const"> |
| 63 | + <return type="int" enum="XRPose.TrackingConfidence" /> |
| 64 | + <param index="0" name="render_model" type="RID" /> |
| 65 | + <description> |
| 66 | + Returns the tracking confidence of the tracking data for the render model. |
| 67 | + </description> |
| 68 | + </method> |
| 69 | + <method name="render_model_get_root_transform" qualifiers="const"> |
| 70 | + <return type="Transform3D" /> |
| 71 | + <param index="0" name="render_model" type="RID" /> |
| 72 | + <description> |
| 73 | + Returns the root transform of a render model. This is the tracked position relative to our [XROrigin3D] node. |
| 74 | + </description> |
| 75 | + </method> |
| 76 | + <method name="render_model_get_subaction_paths"> |
| 77 | + <return type="PackedStringArray" /> |
| 78 | + <param index="0" name="render_model" type="RID" /> |
| 79 | + <description> |
| 80 | + Returns a list of active subaction paths for this [param render_model]. |
| 81 | + [b]Note:[/b] if different devices are bound to your actions than available in suggested interaction bindings, this information shows path related to the interaction bindings being mimicked by that device. |
| 82 | + </description> |
| 83 | + </method> |
| 84 | + <method name="render_model_get_top_level_path" qualifiers="const"> |
| 85 | + <return type="String" /> |
| 86 | + <param index="0" name="render_model" type="RID" /> |
| 87 | + <description> |
| 88 | + Returns the top level path associated with this [param render_model]. If provided this identifies whether the render model is associated with the players hands or other body part. |
| 89 | + </description> |
| 90 | + </method> |
| 91 | + <method name="render_model_is_animatable_node_visible" qualifiers="const"> |
| 92 | + <return type="bool" /> |
| 93 | + <param index="0" name="render_model" type="RID" /> |
| 94 | + <param index="1" name="index" type="int" /> |
| 95 | + <description> |
| 96 | + Returns [code]true[/code] if this animatable node should be visible. |
| 97 | + </description> |
| 98 | + </method> |
| 99 | + <method name="render_model_new_scene_instance" qualifiers="const"> |
| 100 | + <return type="Node3D" /> |
| 101 | + <param index="0" name="render_model" type="RID" /> |
| 102 | + <description> |
| 103 | + Returns an instance of a subscene that contains all [MeshInstance3D] nodes that allow you to visualize the render model. |
| 104 | + </description> |
| 105 | + </method> |
| 106 | + </methods> |
| 107 | + <signals> |
| 108 | + <signal name="render_model_added"> |
| 109 | + <param index="0" name="render_model" type="RID" /> |
| 110 | + <description> |
| 111 | + Informs that a new render model was added. |
| 112 | + </description> |
| 113 | + </signal> |
| 114 | + <signal name="render_model_removed"> |
| 115 | + <param index="0" name="render_model" type="RID" /> |
| 116 | + <description> |
| 117 | + Informs that a render model was removed. |
| 118 | + </description> |
| 119 | + </signal> |
| 120 | + <signal name="render_model_toplevel_path_changed"> |
| 121 | + <param index="0" name="render_model" type="RID" /> |
| 122 | + <description> |
| 123 | + Informs that the top level path associated with a render model changed. |
| 124 | + </description> |
| 125 | + </signal> |
| 126 | + </signals> |
| 127 | +</class> |
0 commit comments