Files
godot-docs-l10n/classes/ru/class_openxrrendermodelextension.rst

274 lines
19 KiB
ReStructuredText
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

:github_url: hide
.. _class_OpenXRRenderModelExtension:
OpenXRRenderModelExtension
==========================
**Наследует:** :ref:`OpenXRExtensionWrapper<class_OpenXRExtensionWrapper>` **<** :ref:`Object<class_Object>`
Этот класс реализует расширение модели рендеринга OpenXR.
.. rst-class:: classref-introduction-group
Описание
----------------
Этот класс реализует расширение модели рендеринга OpenXR. Если оно включено, оно будет поддерживать список активных моделей рендеринга и предоставлять интерфейс к данным модели рендеринга.
.. rst-class:: classref-reftable-group
Методы
------------
.. table::
:widths: auto
+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_active<class_OpenXRRenderModelExtension_method_is_active>`\ (\ ) |const| |
+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_RID>` | :ref:`render_model_create<class_OpenXRRenderModelExtension_method_render_model_create>`\ (\ render_model_id\: :ref:`int<class_int>`\ ) |
+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`render_model_destroy<class_OpenXRRenderModelExtension_method_render_model_destroy>`\ (\ render_model\: :ref:`RID<class_RID>`\ ) |
+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_Array>`\[:ref:`RID<class_RID>`\] | :ref:`render_model_get_all<class_OpenXRRenderModelExtension_method_render_model_get_all>`\ (\ ) |
+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`render_model_get_animatable_node_count<class_OpenXRRenderModelExtension_method_render_model_get_animatable_node_count>`\ (\ render_model\: :ref:`RID<class_RID>`\ ) |const| |
+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`render_model_get_animatable_node_name<class_OpenXRRenderModelExtension_method_render_model_get_animatable_node_name>`\ (\ render_model\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`\ ) |const| |
+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform3D<class_Transform3D>` | :ref:`render_model_get_animatable_node_transform<class_OpenXRRenderModelExtension_method_render_model_get_animatable_node_transform>`\ (\ render_model\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`\ ) |const| |
+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`TrackingConfidence<enum_XRPose_TrackingConfidence>` | :ref:`render_model_get_confidence<class_OpenXRRenderModelExtension_method_render_model_get_confidence>`\ (\ render_model\: :ref:`RID<class_RID>`\ ) |const| |
+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform3D<class_Transform3D>` | :ref:`render_model_get_root_transform<class_OpenXRRenderModelExtension_method_render_model_get_root_transform>`\ (\ render_model\: :ref:`RID<class_RID>`\ ) |const| |
+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`render_model_get_subaction_paths<class_OpenXRRenderModelExtension_method_render_model_get_subaction_paths>`\ (\ render_model\: :ref:`RID<class_RID>`\ ) |
+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`render_model_get_top_level_path<class_OpenXRRenderModelExtension_method_render_model_get_top_level_path>`\ (\ render_model\: :ref:`RID<class_RID>`\ ) |const| |
+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`render_model_is_animatable_node_visible<class_OpenXRRenderModelExtension_method_render_model_is_animatable_node_visible>`\ (\ render_model\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`\ ) |const| |
+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Node3D<class_Node3D>` | :ref:`render_model_new_scene_instance<class_OpenXRRenderModelExtension_method_render_model_new_scene_instance>`\ (\ render_model\: :ref:`RID<class_RID>`\ ) |const| |
+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Сигналы
--------------
.. _class_OpenXRRenderModelExtension_signal_render_model_added:
.. rst-class:: classref-signal
**render_model_added**\ (\ render_model\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_OpenXRRenderModelExtension_signal_render_model_added>`
Вызывается при добавлении новой модели рендеринга.
.. rst-class:: classref-item-separator
----
.. _class_OpenXRRenderModelExtension_signal_render_model_removed:
.. rst-class:: classref-signal
**render_model_removed**\ (\ render_model\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_OpenXRRenderModelExtension_signal_render_model_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<class_RID>`\ ) :ref:`🔗<class_OpenXRRenderModelExtension_signal_render_model_top_level_path_changed>`
Вызывается при изменении пути верхнего уровня, связанного с моделью рендеринга.
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Описания метода
------------------------------
.. _class_OpenXRRenderModelExtension_method_is_active:
.. rst-class:: classref-method
:ref:`bool<class_bool>` **is_active**\ (\ ) |const| :ref:`🔗<class_OpenXRRenderModelExtension_method_is_active>`
Возвращает ``true``, если расширение модели рендеринга OpenXR поддерживается и включено.
\ **Примечание:** Возвращает допустимое значение только после инициализации OpenXR.
.. rst-class:: classref-item-separator
----
.. _class_OpenXRRenderModelExtension_method_render_model_create:
.. rst-class:: classref-method
:ref:`RID<class_RID>` **render_model_create**\ (\ render_model_id\: :ref:`int<class_int>`\ ) :ref:`🔗<class_OpenXRRenderModelExtension_method_render_model_create>`
Создаёт объект модели рендеринга в OpenXR, используя идентификатор модели рендеринга.
\ **Примечание:** Эта функция доступна для зависимых расширений OpenXR, которые предоставляют идентификаторы моделей рендеринга для использования с расширением модели рендеринга.
.. rst-class:: classref-item-separator
----
.. _class_OpenXRRenderModelExtension_method_render_model_destroy:
.. rst-class:: classref-method
|void| **render_model_destroy**\ (\ render_model\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_OpenXRRenderModelExtension_method_render_model_destroy>`
Уничтожает объект модели рендеринга в OpenXR, ранее созданный с помощью :ref:`render_model_create()<class_OpenXRRenderModelExtension_method_render_model_create>`.
\ **Примечание:** Эта функция доступна для зависимых расширений OpenXR, которые предоставляют идентификаторы моделей рендеринга для использования с расширением модели рендеринга.
.. rst-class:: classref-item-separator
----
.. _class_OpenXRRenderModelExtension_method_render_model_get_all:
.. rst-class:: classref-method
:ref:`Array<class_Array>`\[:ref:`RID<class_RID>`\] **render_model_get_all**\ (\ ) :ref:`🔗<class_OpenXRRenderModelExtension_method_render_model_get_all>`
Возвращает массив всех активных в данный момент моделей рендеринга, зарегистрированных с помощью этого расширения.
.. rst-class:: classref-item-separator
----
.. _class_OpenXRRenderModelExtension_method_render_model_get_animatable_node_count:
.. rst-class:: classref-method
:ref:`int<class_int>` **render_model_get_animatable_node_count**\ (\ render_model\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_OpenXRRenderModelExtension_method_render_model_get_animatable_node_count>`
Возвращает количество анимируемых узлов в этой модели рендеринга.
.. rst-class:: classref-item-separator
----
.. _class_OpenXRRenderModelExtension_method_render_model_get_animatable_node_name:
.. rst-class:: classref-method
:ref:`String<class_String>` **render_model_get_animatable_node_name**\ (\ render_model\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_OpenXRRenderModelExtension_method_render_model_get_animatable_node_name>`
Возвращает имя заданного анимируемого узла.
.. rst-class:: classref-item-separator
----
.. _class_OpenXRRenderModelExtension_method_render_model_get_animatable_node_transform:
.. rst-class:: classref-method
:ref:`Transform3D<class_Transform3D>` **render_model_get_animatable_node_transform**\ (\ render_model\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_OpenXRRenderModelExtension_method_render_model_get_animatable_node_transform>`
Возвращает текущее локальное преобразование для анимируемого узла. Обновляется в каждом кадре.
.. rst-class:: classref-item-separator
----
.. _class_OpenXRRenderModelExtension_method_render_model_get_confidence:
.. rst-class:: classref-method
:ref:`TrackingConfidence<enum_XRPose_TrackingConfidence>` **render_model_get_confidence**\ (\ render_model\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_OpenXRRenderModelExtension_method_render_model_get_confidence>`
Возвращает достоверность отслеживания данных отслеживания для модели рендеринга.
.. rst-class:: classref-item-separator
----
.. _class_OpenXRRenderModelExtension_method_render_model_get_root_transform:
.. rst-class:: classref-method
:ref:`Transform3D<class_Transform3D>` **render_model_get_root_transform**\ (\ render_model\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_OpenXRRenderModelExtension_method_render_model_get_root_transform>`
Возвращает корневое преобразование модели рендеринга. Это отслеживаемое положение относительно узла :ref:`XROrigin3D<class_XROrigin3D>`.
.. rst-class:: classref-item-separator
----
.. _class_OpenXRRenderModelExtension_method_render_model_get_subaction_paths:
.. rst-class:: classref-method
:ref:`PackedStringArray<class_PackedStringArray>` **render_model_get_subaction_paths**\ (\ render_model\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_OpenXRRenderModelExtension_method_render_model_get_subaction_paths>`
Возвращает список активных путей поддействий для этого ``render_model``.
\ **Примечание:** Если к вашим действиям привязаны устройства, отличные от доступных в предлагаемых привязках взаимодействия, эта информация показывает пути, связанные с привязками взаимодействия, имитируемыми этим устройством.
.. rst-class:: classref-item-separator
----
.. _class_OpenXRRenderModelExtension_method_render_model_get_top_level_path:
.. rst-class:: classref-method
:ref:`String<class_String>` **render_model_get_top_level_path**\ (\ render_model\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_OpenXRRenderModelExtension_method_render_model_get_top_level_path>`
Возвращает путь верхнего уровня, связанный с этим ``render_model``. Если этот параметр указан, он определяет, связана ли модель рендеринга с руками игрока или другими частями тела.
.. rst-class:: classref-item-separator
----
.. _class_OpenXRRenderModelExtension_method_render_model_is_animatable_node_visible:
.. rst-class:: classref-method
:ref:`bool<class_bool>` **render_model_is_animatable_node_visible**\ (\ render_model\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_OpenXRRenderModelExtension_method_render_model_is_animatable_node_visible>`
Возвращает ``true``, если этот анимируемый узел должен быть видимым.
.. rst-class:: classref-item-separator
----
.. _class_OpenXRRenderModelExtension_method_render_model_new_scene_instance:
.. rst-class:: classref-method
:ref:`Node3D<class_Node3D>` **render_model_new_scene_instance**\ (\ render_model\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_OpenXRRenderModelExtension_method_render_model_new_scene_instance>`
Возвращает экземпляр подсцены, содержащей все узлы :ref:`MeshInstance3D<class_MeshInstance3D>`, позволяющие визуализировать модель рендеринга.
.. |virtual| replace:: :abbr:`virtual (Этот метод обычно должен быть переопределен пользователем, чтобы иметь какой-либо эффект.)`
.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`
.. |const| replace:: :abbr:`const (Этот метод не имеет побочных эффектов. Он не изменяет ни одну из переменных-членов экземпляра.)`
.. |vararg| replace:: :abbr:`vararg (Этот метод принимает любое количество аргументов после описанных здесь.)`
.. |constructor| replace:: :abbr:`constructor (Этот метод используется для создания типа.)`
.. |static| replace:: :abbr:`static (Этот метод не нуждается в вызове экземпляра, поэтому его можно вызвать напрямую, используя имя класса.)`
.. |operator| replace:: :abbr:`operator (Этот метод описывает допустимый оператор для использования с этим типом в качестве левого операнда.)`
.. |bitfield| replace:: :abbr:`BitField (Это значение является целым числом, составленным как битовая маска следующих флагов.)`
.. |void| replace:: :abbr:`void (Нет возвращаемого значения.)`