:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/modules/openxr/doc_classes/OpenXRRenderModelExtension.xml. .. _class_OpenXRRenderModelExtension: OpenXRRenderModelExtension ========================== **Inherits:** :ref:`OpenXRExtensionWrapper` **<** :ref:`Object` This class implements the OpenXR Render Model Extension. .. rst-class:: classref-introduction-group Description ----------- This class implements the OpenXR Render Model Extension, if enabled it will maintain a list of active render models and provides an interface to the render model data. .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_active`\ (\ ) |const| | +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`render_model_create`\ (\ render_model_id\: :ref:`int`\ ) | +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`render_model_destroy`\ (\ render_model\: :ref:`RID`\ ) | +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array`\[:ref:`RID`\] | :ref:`render_model_get_all`\ (\ ) | +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`render_model_get_animatable_node_count`\ (\ render_model\: :ref:`RID`\ ) |const| | +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`render_model_get_animatable_node_name`\ (\ render_model\: :ref:`RID`, index\: :ref:`int`\ ) |const| | +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform3D` | :ref:`render_model_get_animatable_node_transform`\ (\ render_model\: :ref:`RID`, index\: :ref:`int`\ ) |const| | +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`TrackingConfidence` | :ref:`render_model_get_confidence`\ (\ render_model\: :ref:`RID`\ ) |const| | +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform3D` | :ref:`render_model_get_root_transform`\ (\ render_model\: :ref:`RID`\ ) |const| | +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedStringArray` | :ref:`render_model_get_subaction_paths`\ (\ render_model\: :ref:`RID`\ ) | +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`render_model_get_top_level_path`\ (\ render_model\: :ref:`RID`\ ) |const| | +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`render_model_is_animatable_node_visible`\ (\ render_model\: :ref:`RID`, index\: :ref:`int`\ ) |const| | +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Node3D` | :ref:`render_model_new_scene_instance`\ (\ render_model\: :ref:`RID`\ ) |const| | +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Signals ------- .. _class_OpenXRRenderModelExtension_signal_render_model_added: .. rst-class:: classref-signal **render_model_added**\ (\ render_model\: :ref:`RID`\ ) :ref:`🔗` Emitted when a new render model is added. .. rst-class:: classref-item-separator ---- .. _class_OpenXRRenderModelExtension_signal_render_model_removed: .. rst-class:: classref-signal **render_model_removed**\ (\ render_model\: :ref:`RID`\ ) :ref:`🔗` Emitted when a render model is removed. .. rst-class:: classref-item-separator ---- .. _class_OpenXRRenderModelExtension_signal_render_model_top_level_path_changed: .. rst-class:: classref-signal **render_model_top_level_path_changed**\ (\ render_model\: :ref:`RID`\ ) :ref:`🔗` Emitted when the top level path associated with a render model changed. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_OpenXRRenderModelExtension_method_is_active: .. rst-class:: classref-method :ref:`bool` **is_active**\ (\ ) |const| :ref:`🔗` Returns ``true`` if OpenXR's render model extension is supported and enabled. \ **Note:** This only returns a valid value after OpenXR has been initialized. .. rst-class:: classref-item-separator ---- .. _class_OpenXRRenderModelExtension_method_render_model_create: .. rst-class:: classref-method :ref:`RID` **render_model_create**\ (\ render_model_id\: :ref:`int`\ ) :ref:`🔗` Creates a render model object within OpenXR using a render model id. \ **Note:** This function is exposed for dependent OpenXR extensions that provide render model ids to be used with the render model extension. .. rst-class:: classref-item-separator ---- .. _class_OpenXRRenderModelExtension_method_render_model_destroy: .. rst-class:: classref-method |void| **render_model_destroy**\ (\ render_model\: :ref:`RID`\ ) :ref:`🔗` Destroys a render model object within OpenXR that was previously created with :ref:`render_model_create()`. \ **Note:** This function is exposed for dependent OpenXR extensions that provide render model ids to be used with the render model extension. .. rst-class:: classref-item-separator ---- .. _class_OpenXRRenderModelExtension_method_render_model_get_all: .. rst-class:: classref-method :ref:`Array`\[:ref:`RID`\] **render_model_get_all**\ (\ ) :ref:`🔗` Returns an array of all currently active render models registered with this extension. .. rst-class:: classref-item-separator ---- .. _class_OpenXRRenderModelExtension_method_render_model_get_animatable_node_count: .. rst-class:: classref-method :ref:`int` **render_model_get_animatable_node_count**\ (\ render_model\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the number of animatable nodes this render model has. .. rst-class:: classref-item-separator ---- .. _class_OpenXRRenderModelExtension_method_render_model_get_animatable_node_name: .. rst-class:: classref-method :ref:`String` **render_model_get_animatable_node_name**\ (\ render_model\: :ref:`RID`, index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the name of the given animatable node. .. rst-class:: classref-item-separator ---- .. _class_OpenXRRenderModelExtension_method_render_model_get_animatable_node_transform: .. rst-class:: classref-method :ref:`Transform3D` **render_model_get_animatable_node_transform**\ (\ render_model\: :ref:`RID`, index\: :ref:`int`\ ) |const| :ref:`🔗` Returns the current local transform for an animatable node. This is updated every frame. .. rst-class:: classref-item-separator ---- .. _class_OpenXRRenderModelExtension_method_render_model_get_confidence: .. rst-class:: classref-method :ref:`TrackingConfidence` **render_model_get_confidence**\ (\ render_model\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the tracking confidence of the tracking data for the render model. .. rst-class:: classref-item-separator ---- .. _class_OpenXRRenderModelExtension_method_render_model_get_root_transform: .. rst-class:: classref-method :ref:`Transform3D` **render_model_get_root_transform**\ (\ render_model\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the root transform of a render model. This is the tracked position relative to our :ref:`XROrigin3D` node. .. rst-class:: classref-item-separator ---- .. _class_OpenXRRenderModelExtension_method_render_model_get_subaction_paths: .. rst-class:: classref-method :ref:`PackedStringArray` **render_model_get_subaction_paths**\ (\ render_model\: :ref:`RID`\ ) :ref:`🔗` Returns a list of active subaction paths for this ``render_model``. \ **Note:** If different devices are bound to your actions than available in suggested interaction bindings, this information shows paths related to the interaction bindings being mimicked by that device. .. rst-class:: classref-item-separator ---- .. _class_OpenXRRenderModelExtension_method_render_model_get_top_level_path: .. rst-class:: classref-method :ref:`String` **render_model_get_top_level_path**\ (\ render_model\: :ref:`RID`\ ) |const| :ref:`🔗` Returns the top level path associated with this ``render_model``. If provided this identifies whether the render model is associated with the player's hands or other body part. .. rst-class:: classref-item-separator ---- .. _class_OpenXRRenderModelExtension_method_render_model_is_animatable_node_visible: .. rst-class:: classref-method :ref:`bool` **render_model_is_animatable_node_visible**\ (\ render_model\: :ref:`RID`, index\: :ref:`int`\ ) |const| :ref:`🔗` Returns ``true`` if this animatable node should be visible. .. rst-class:: classref-item-separator ---- .. _class_OpenXRRenderModelExtension_method_render_model_new_scene_instance: .. rst-class:: classref-method :ref:`Node3D` **render_model_new_scene_instance**\ (\ render_model\: :ref:`RID`\ ) |const| :ref:`🔗` Returns an instance of a subscene that contains all :ref:`MeshInstance3D` nodes that allow you to visualize the render model. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` .. |void| replace:: :abbr:`void (No return value.)`