Files
godot-docs/classes/class_gltfskin.rst

298 lines
12 KiB
ReStructuredText

: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/gltf/doc_classes/GLTFSkin.xml.
.. _class_GLTFSkin:
GLTFSkin
========
**Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
.. container:: contribute
There is currently no description for this class. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. rst-class:: classref-reftable-group
Properties
----------
.. table::
:widths: auto
+-------------------------------------------------+-----------------------------------------------------------------+------------------------+
| :ref:`Skin<class_Skin>` | :ref:`godot_skin<class_GLTFSkin_property_godot_skin>` | |
+-------------------------------------------------+-----------------------------------------------------------------+------------------------+
| :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`joints<class_GLTFSkin_property_joints>` | ``PackedInt32Array()`` |
+-------------------------------------------------+-----------------------------------------------------------------+------------------------+
| :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`joints_original<class_GLTFSkin_property_joints_original>` | ``PackedInt32Array()`` |
+-------------------------------------------------+-----------------------------------------------------------------+------------------------+
| :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`non_joints<class_GLTFSkin_property_non_joints>` | ``PackedInt32Array()`` |
+-------------------------------------------------+-----------------------------------------------------------------+------------------------+
| :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`roots<class_GLTFSkin_property_roots>` | ``PackedInt32Array()`` |
+-------------------------------------------------+-----------------------------------------------------------------+------------------------+
| :ref:`int<class_int>` | :ref:`skeleton<class_GLTFSkin_property_skeleton>` | ``-1`` |
+-------------------------------------------------+-----------------------------------------------------------------+------------------------+
| :ref:`int<class_int>` | :ref:`skin_root<class_GLTFSkin_property_skin_root>` | ``-1`` |
+-------------------------------------------------+-----------------------------------------------------------------+------------------------+
.. rst-class:: classref-reftable-group
Methods
-------
.. table::
:widths: auto
+-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform3D[]<class_Transform3D>` | :ref:`get_inverse_binds<class_GLTFSkin_method_get_inverse_binds>` **(** **)** |
+-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Dictionary<class_Dictionary>` | :ref:`get_joint_i_to_bone_i<class_GLTFSkin_method_get_joint_i_to_bone_i>` **(** **)** |
+-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Dictionary<class_Dictionary>` | :ref:`get_joint_i_to_name<class_GLTFSkin_method_get_joint_i_to_name>` **(** **)** |
+-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_inverse_binds<class_GLTFSkin_method_set_inverse_binds>` **(** :ref:`Transform3D[]<class_Transform3D>` inverse_binds **)** |
+-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_joint_i_to_bone_i<class_GLTFSkin_method_set_joint_i_to_bone_i>` **(** :ref:`Dictionary<class_Dictionary>` joint_i_to_bone_i **)** |
+-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_joint_i_to_name<class_GLTFSkin_method_set_joint_i_to_name>` **(** :ref:`Dictionary<class_Dictionary>` joint_i_to_name **)** |
+-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Property Descriptions
---------------------
.. _class_GLTFSkin_property_godot_skin:
.. rst-class:: classref-property
:ref:`Skin<class_Skin>` **godot_skin**
.. rst-class:: classref-property-setget
- void **set_godot_skin** **(** :ref:`Skin<class_Skin>` value **)**
- :ref:`Skin<class_Skin>` **get_godot_skin** **(** **)**
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. rst-class:: classref-item-separator
----
.. _class_GLTFSkin_property_joints:
.. rst-class:: classref-property
:ref:`PackedInt32Array<class_PackedInt32Array>` **joints** = ``PackedInt32Array()``
.. rst-class:: classref-property-setget
- void **set_joints** **(** :ref:`PackedInt32Array<class_PackedInt32Array>` value **)**
- :ref:`PackedInt32Array<class_PackedInt32Array>` **get_joints** **(** **)**
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. rst-class:: classref-item-separator
----
.. _class_GLTFSkin_property_joints_original:
.. rst-class:: classref-property
:ref:`PackedInt32Array<class_PackedInt32Array>` **joints_original** = ``PackedInt32Array()``
.. rst-class:: classref-property-setget
- void **set_joints_original** **(** :ref:`PackedInt32Array<class_PackedInt32Array>` value **)**
- :ref:`PackedInt32Array<class_PackedInt32Array>` **get_joints_original** **(** **)**
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. rst-class:: classref-item-separator
----
.. _class_GLTFSkin_property_non_joints:
.. rst-class:: classref-property
:ref:`PackedInt32Array<class_PackedInt32Array>` **non_joints** = ``PackedInt32Array()``
.. rst-class:: classref-property-setget
- void **set_non_joints** **(** :ref:`PackedInt32Array<class_PackedInt32Array>` value **)**
- :ref:`PackedInt32Array<class_PackedInt32Array>` **get_non_joints** **(** **)**
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. rst-class:: classref-item-separator
----
.. _class_GLTFSkin_property_roots:
.. rst-class:: classref-property
:ref:`PackedInt32Array<class_PackedInt32Array>` **roots** = ``PackedInt32Array()``
.. rst-class:: classref-property-setget
- void **set_roots** **(** :ref:`PackedInt32Array<class_PackedInt32Array>` value **)**
- :ref:`PackedInt32Array<class_PackedInt32Array>` **get_roots** **(** **)**
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. rst-class:: classref-item-separator
----
.. _class_GLTFSkin_property_skeleton:
.. rst-class:: classref-property
:ref:`int<class_int>` **skeleton** = ``-1``
.. rst-class:: classref-property-setget
- void **set_skeleton** **(** :ref:`int<class_int>` value **)**
- :ref:`int<class_int>` **get_skeleton** **(** **)**
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. rst-class:: classref-item-separator
----
.. _class_GLTFSkin_property_skin_root:
.. rst-class:: classref-property
:ref:`int<class_int>` **skin_root** = ``-1``
.. rst-class:: classref-property-setget
- void **set_skin_root** **(** :ref:`int<class_int>` value **)**
- :ref:`int<class_int>` **get_skin_root** **(** **)**
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Method Descriptions
-------------------
.. _class_GLTFSkin_method_get_inverse_binds:
.. rst-class:: classref-method
:ref:`Transform3D[]<class_Transform3D>` **get_inverse_binds** **(** **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. rst-class:: classref-item-separator
----
.. _class_GLTFSkin_method_get_joint_i_to_bone_i:
.. rst-class:: classref-method
:ref:`Dictionary<class_Dictionary>` **get_joint_i_to_bone_i** **(** **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. rst-class:: classref-item-separator
----
.. _class_GLTFSkin_method_get_joint_i_to_name:
.. rst-class:: classref-method
:ref:`Dictionary<class_Dictionary>` **get_joint_i_to_name** **(** **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. rst-class:: classref-item-separator
----
.. _class_GLTFSkin_method_set_inverse_binds:
.. rst-class:: classref-method
void **set_inverse_binds** **(** :ref:`Transform3D[]<class_Transform3D>` inverse_binds **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. rst-class:: classref-item-separator
----
.. _class_GLTFSkin_method_set_joint_i_to_bone_i:
.. rst-class:: classref-method
void **set_joint_i_to_bone_i** **(** :ref:`Dictionary<class_Dictionary>` joint_i_to_bone_i **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. rst-class:: classref-item-separator
----
.. _class_GLTFSkin_method_set_joint_i_to_name:
.. rst-class:: classref-method
void **set_joint_i_to_name** **(** :ref:`Dictionary<class_Dictionary>` joint_i_to_name **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |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.)`