mirror of
https://github.com/godotengine/godot-docs-l10n.git
synced 2026-01-04 10:09:56 +03:00
288 lines
15 KiB
ReStructuredText
288 lines
15 KiB
ReStructuredText
:github_url: hide
|
||
|
||
.. _class_GLTFPhysicsShape:
|
||
|
||
GLTFPhysicsShape
|
||
================
|
||
|
||
**Наследует:** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
|
||
|
||
Представляет собой физическую форму glTF.
|
||
|
||
.. rst-class:: classref-introduction-group
|
||
|
||
Описание
|
||
----------------
|
||
|
||
Представляет физическую форму, определенную расширениями glTF ``OMI_physics_shape`` или ``OMI_collider``. Этот класс является посредником между данными glTF и узлами Godot, и он абстрагирован таким образом, что позволяет добавлять поддержку различных расширений физики glTF в будущем.
|
||
|
||
.. rst-class:: classref-introduction-group
|
||
|
||
Обучающие материалы
|
||
--------------------------------------
|
||
|
||
- :doc:`Загрузка и сохранение файла времени выполнения <../tutorials/io/runtime_file_loading_and_saving>`
|
||
|
||
- `OMI_physics_shape расширение glTF <https://github.com/omigroup/gltf-extensions/tree/main/extensions/2.0/OMI_physics_shape>`__
|
||
|
||
- `Расширение OMI_collider glTF <https://github.com/omigroup/gltf-extensions/tree/main/extensions/2.0/Archived/OMI_collider>`__
|
||
|
||
.. rst-class:: classref-reftable-group
|
||
|
||
Свойства
|
||
----------------
|
||
|
||
.. table::
|
||
:widths: auto
|
||
|
||
+-----------------------------------------+---------------------------------------------------------------------+----------------------+
|
||
| :ref:`float<class_float>` | :ref:`height<class_GLTFPhysicsShape_property_height>` | ``2.0`` |
|
||
+-----------------------------------------+---------------------------------------------------------------------+----------------------+
|
||
| :ref:`ImporterMesh<class_ImporterMesh>` | :ref:`importer_mesh<class_GLTFPhysicsShape_property_importer_mesh>` | |
|
||
+-----------------------------------------+---------------------------------------------------------------------+----------------------+
|
||
| :ref:`bool<class_bool>` | :ref:`is_trigger<class_GLTFPhysicsShape_property_is_trigger>` | ``false`` |
|
||
+-----------------------------------------+---------------------------------------------------------------------+----------------------+
|
||
| :ref:`int<class_int>` | :ref:`mesh_index<class_GLTFPhysicsShape_property_mesh_index>` | ``-1`` |
|
||
+-----------------------------------------+---------------------------------------------------------------------+----------------------+
|
||
| :ref:`float<class_float>` | :ref:`radius<class_GLTFPhysicsShape_property_radius>` | ``0.5`` |
|
||
+-----------------------------------------+---------------------------------------------------------------------+----------------------+
|
||
| :ref:`String<class_String>` | :ref:`shape_type<class_GLTFPhysicsShape_property_shape_type>` | ``""`` |
|
||
+-----------------------------------------+---------------------------------------------------------------------+----------------------+
|
||
| :ref:`Vector3<class_Vector3>` | :ref:`size<class_GLTFPhysicsShape_property_size>` | ``Vector3(1, 1, 1)`` |
|
||
+-----------------------------------------+---------------------------------------------------------------------+----------------------+
|
||
|
||
.. rst-class:: classref-reftable-group
|
||
|
||
Методы
|
||
------------
|
||
|
||
.. table::
|
||
:widths: auto
|
||
|
||
+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`GLTFPhysicsShape<class_GLTFPhysicsShape>` | :ref:`from_dictionary<class_GLTFPhysicsShape_method_from_dictionary>`\ (\ dictionary\: :ref:`Dictionary<class_Dictionary>`\ ) |static| |
|
||
+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`GLTFPhysicsShape<class_GLTFPhysicsShape>` | :ref:`from_node<class_GLTFPhysicsShape_method_from_node>`\ (\ shape_node\: :ref:`CollisionShape3D<class_CollisionShape3D>`\ ) |static| |
|
||
+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`GLTFPhysicsShape<class_GLTFPhysicsShape>` | :ref:`from_resource<class_GLTFPhysicsShape_method_from_resource>`\ (\ shape_resource\: :ref:`Shape3D<class_Shape3D>`\ ) |static| |
|
||
+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Dictionary<class_Dictionary>` | :ref:`to_dictionary<class_GLTFPhysicsShape_method_to_dictionary>`\ (\ ) |const| |
|
||
+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`CollisionShape3D<class_CollisionShape3D>` | :ref:`to_node<class_GLTFPhysicsShape_method_to_node>`\ (\ cache_shapes\: :ref:`bool<class_bool>` = false\ ) |
|
||
+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Shape3D<class_Shape3D>` | :ref:`to_resource<class_GLTFPhysicsShape_method_to_resource>`\ (\ cache_shapes\: :ref:`bool<class_bool>` = false\ ) |
|
||
+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||
|
||
.. rst-class:: classref-section-separator
|
||
|
||
----
|
||
|
||
.. rst-class:: classref-descriptions-group
|
||
|
||
Описания свойств
|
||
--------------------------------
|
||
|
||
.. _class_GLTFPhysicsShape_property_height:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`float<class_float>` **height** = ``2.0`` :ref:`🔗<class_GLTFPhysicsShape_property_height>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_height**\ (\ value\: :ref:`float<class_float>`\ )
|
||
- :ref:`float<class_float>` **get_height**\ (\ )
|
||
|
||
Высота формы в метрах. Используется только в том случае, если тип формы — ``"capsule"`` или ``"cylinder"``. Это значение не должно быть отрицательным, а для ``"capsule"`` оно должно быть как минимум в два раза больше радиуса.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_GLTFPhysicsShape_property_importer_mesh:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`ImporterMesh<class_ImporterMesh>` **importer_mesh** :ref:`🔗<class_GLTFPhysicsShape_property_importer_mesh>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_importer_mesh**\ (\ value\: :ref:`ImporterMesh<class_ImporterMesh>`\ )
|
||
- :ref:`ImporterMesh<class_ImporterMesh>` **get_importer_mesh**\ (\ )
|
||
|
||
Ресурс :ref:`ImporterMesh<class_ImporterMesh>` формы. Используется только когда тип формы — ``"hull"`` (выпуклая оболочка) или ``"trimesh"`` (вогнутая тримеш).
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_GLTFPhysicsShape_property_is_trigger:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`bool<class_bool>` **is_trigger** = ``false`` :ref:`🔗<class_GLTFPhysicsShape_property_is_trigger>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_is_trigger**\ (\ value\: :ref:`bool<class_bool>`\ )
|
||
- :ref:`bool<class_bool>` **get_is_trigger**\ (\ )
|
||
|
||
Если ``true``, это указывает, что эта форма является триггером. Для Godot это означает, что форма должна быть дочерним элементом узла :ref:`Area3D<class_Area3D>`.
|
||
|
||
Это единственная переменная, не используемая в методе :ref:`to_node()<class_GLTFPhysicsShape_method_to_node>`, она предназначена для использования вместе с ним при принятии решения о том, куда добавить сгенерированный узел в качестве дочернего элемента.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_GLTFPhysicsShape_property_mesh_index:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`int<class_int>` **mesh_index** = ``-1`` :ref:`🔗<class_GLTFPhysicsShape_property_mesh_index>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_mesh_index**\ (\ value\: :ref:`int<class_int>`\ )
|
||
- :ref:`int<class_int>` **get_mesh_index**\ (\ )
|
||
|
||
Индекс сетки формы в файле glTF. Используется только когда тип формы — ``"hull"`` (выпуклая оболочка) или ``"trimesh"`` (вогнутая тримеш).
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_GLTFPhysicsShape_property_radius:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`float<class_float>` **radius** = ``0.5`` :ref:`🔗<class_GLTFPhysicsShape_property_radius>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_radius**\ (\ value\: :ref:`float<class_float>`\ )
|
||
- :ref:`float<class_float>` **get_radius**\ (\ )
|
||
|
||
Радиус формы в метрах. Используется только в том случае, если тип формы — ``"capsule"``, ``"cylinder"`` или ``"sphere"``. Это значение не должно быть отрицательным.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_GLTFPhysicsShape_property_shape_type:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`String<class_String>` **shape_type** = ``""`` :ref:`🔗<class_GLTFPhysicsShape_property_shape_type>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_shape_type**\ (\ value\: :ref:`String<class_String>`\ )
|
||
- :ref:`String<class_String>` **get_shape_type**\ (\ )
|
||
|
||
Тип фигуры, которую представляет эта фигура. Допустимые значения: ``"box"``, ``"capsule"``, ``"cylinder"``, ``"sphere"``, ``"hull"`` и ``"trimesh"``.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_GLTFPhysicsShape_property_size:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`Vector3<class_Vector3>` **size** = ``Vector3(1, 1, 1)`` :ref:`🔗<class_GLTFPhysicsShape_property_size>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_size**\ (\ value\: :ref:`Vector3<class_Vector3>`\ )
|
||
- :ref:`Vector3<class_Vector3>` **get_size**\ (\ )
|
||
|
||
Размер фигуры в метрах. Используется только когда тип фигуры — ``"box"``, и представляет ``"diameter"`` коробки. Это значение не должно быть отрицательным.
|
||
|
||
.. rst-class:: classref-section-separator
|
||
|
||
----
|
||
|
||
.. rst-class:: classref-descriptions-group
|
||
|
||
Описания метода
|
||
------------------------------
|
||
|
||
.. _class_GLTFPhysicsShape_method_from_dictionary:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`GLTFPhysicsShape<class_GLTFPhysicsShape>` **from_dictionary**\ (\ dictionary\: :ref:`Dictionary<class_Dictionary>`\ ) |static| :ref:`🔗<class_GLTFPhysicsShape_method_from_dictionary>`
|
||
|
||
Создает новый экземпляр GLTFPhysicsShape путем анализа указанного :ref:`Dictionary<class_Dictionary>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_GLTFPhysicsShape_method_from_node:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`GLTFPhysicsShape<class_GLTFPhysicsShape>` **from_node**\ (\ shape_node\: :ref:`CollisionShape3D<class_CollisionShape3D>`\ ) |static| :ref:`🔗<class_GLTFPhysicsShape_method_from_node>`
|
||
|
||
Создает новый экземпляр GLTFPhysicsShape из заданного узла Godot :ref:`CollisionShape3D<class_CollisionShape3D>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_GLTFPhysicsShape_method_from_resource:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`GLTFPhysicsShape<class_GLTFPhysicsShape>` **from_resource**\ (\ shape_resource\: :ref:`Shape3D<class_Shape3D>`\ ) |static| :ref:`🔗<class_GLTFPhysicsShape_method_from_resource>`
|
||
|
||
Создает новый экземпляр GLTFPhysicsShape из заданного ресурса Godot :ref:`Shape3D<class_Shape3D>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_GLTFPhysicsShape_method_to_dictionary:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`Dictionary<class_Dictionary>` **to_dictionary**\ (\ ) |const| :ref:`🔗<class_GLTFPhysicsShape_method_to_dictionary>`
|
||
|
||
Сериализует этот экземпляр GLTFPhysicsShape в :ref:`Dictionary<class_Dictionary>` в формате, определенном ``OMI_physics_shape``.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_GLTFPhysicsShape_method_to_node:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`CollisionShape3D<class_CollisionShape3D>` **to_node**\ (\ cache_shapes\: :ref:`bool<class_bool>` = false\ ) :ref:`🔗<class_GLTFPhysicsShape_method_to_node>`
|
||
|
||
Преобразует этот экземпляр GLTFPhysicsShape в узел Godot :ref:`CollisionShape3D<class_CollisionShape3D>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_GLTFPhysicsShape_method_to_resource:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`Shape3D<class_Shape3D>` **to_resource**\ (\ cache_shapes\: :ref:`bool<class_bool>` = false\ ) :ref:`🔗<class_GLTFPhysicsShape_method_to_resource>`
|
||
|
||
Преобразует этот экземпляр GLTFPhysicsShape в ресурс Godot :ref:`Shape3D<class_Shape3D>`.
|
||
|
||
.. |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 (Нет возвращаемого значения.)`
|