godot-docs/classes/class_gltfskin.rst

:github_url: hide

.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the GLTFSkin.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_GLTFSkin:

GLTFSkin
========

**Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`



Properties
----------

+-----------------------------------------+-----------------------------------------------------------------+----------------------+
| :ref:`Skin<class_Skin>`                 | :ref:`godot_skin<class_GLTFSkin_property_godot_skin>`           |                      |
+-----------------------------------------+-----------------------------------------------------------------+----------------------+
| :ref:`PoolIntArray<class_PoolIntArray>` | :ref:`joints<class_GLTFSkin_property_joints>`                   | ``PoolIntArray(  )`` |
+-----------------------------------------+-----------------------------------------------------------------+----------------------+
| :ref:`PoolIntArray<class_PoolIntArray>` | :ref:`joints_original<class_GLTFSkin_property_joints_original>` | ``PoolIntArray(  )`` |
+-----------------------------------------+-----------------------------------------------------------------+----------------------+
| :ref:`PoolIntArray<class_PoolIntArray>` | :ref:`non_joints<class_GLTFSkin_property_non_joints>`           | ``PoolIntArray(  )`` |
+-----------------------------------------+-----------------------------------------------------------------+----------------------+
| :ref:`PoolIntArray<class_PoolIntArray>` | :ref:`roots<class_GLTFSkin_property_roots>`                     | ``PoolIntArray(  )`` |
+-----------------------------------------+-----------------------------------------------------------------+----------------------+
| :ref:`int<class_int>`                   | :ref:`skeleton<class_GLTFSkin_property_skeleton>`               | ``-1``               |
+-----------------------------------------+-----------------------------------------------------------------+----------------------+
| :ref:`int<class_int>`                   | :ref:`skin_root<class_GLTFSkin_property_skin_root>`             | ``-1``               |
+-----------------------------------------+-----------------------------------------------------------------+----------------------+

Methods
-------

+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_Array>`           | :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:`Array<class_Array>` 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 **)**       |
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+

Property Descriptions
---------------------

.. _class_GLTFSkin_property_godot_skin:

- :ref:`Skin<class_Skin>` **godot_skin**

+----------+-----------------------+
| *Setter* | set_godot_skin(value) |
+----------+-----------------------+
| *Getter* | get_godot_skin()      |
+----------+-----------------------+

----

.. _class_GLTFSkin_property_joints:

- :ref:`PoolIntArray<class_PoolIntArray>` **joints**

+-----------+----------------------+
| *Default* | ``PoolIntArray(  )`` |
+-----------+----------------------+
| *Setter*  | set_joints(value)    |
+-----------+----------------------+
| *Getter*  | get_joints()         |
+-----------+----------------------+

----

.. _class_GLTFSkin_property_joints_original:

- :ref:`PoolIntArray<class_PoolIntArray>` **joints_original**

+-----------+----------------------------+
| *Default* | ``PoolIntArray(  )``       |
+-----------+----------------------------+
| *Setter*  | set_joints_original(value) |
+-----------+----------------------------+
| *Getter*  | get_joints_original()      |
+-----------+----------------------------+

----

.. _class_GLTFSkin_property_non_joints:

- :ref:`PoolIntArray<class_PoolIntArray>` **non_joints**

+-----------+-----------------------+
| *Default* | ``PoolIntArray(  )``  |
+-----------+-----------------------+
| *Setter*  | set_non_joints(value) |
+-----------+-----------------------+
| *Getter*  | get_non_joints()      |
+-----------+-----------------------+

----

.. _class_GLTFSkin_property_roots:

- :ref:`PoolIntArray<class_PoolIntArray>` **roots**

+-----------+----------------------+
| *Default* | ``PoolIntArray(  )`` |
+-----------+----------------------+
| *Setter*  | set_roots(value)     |
+-----------+----------------------+
| *Getter*  | get_roots()          |
+-----------+----------------------+

----

.. _class_GLTFSkin_property_skeleton:

- :ref:`int<class_int>` **skeleton**

+-----------+---------------------+
| *Default* | ``-1``              |
+-----------+---------------------+
| *Setter*  | set_skeleton(value) |
+-----------+---------------------+
| *Getter*  | get_skeleton()      |
+-----------+---------------------+

----

.. _class_GLTFSkin_property_skin_root:

- :ref:`int<class_int>` **skin_root**

+-----------+----------------------+
| *Default* | ``-1``               |
+-----------+----------------------+
| *Setter*  | set_skin_root(value) |
+-----------+----------------------+
| *Getter*  | get_skin_root()      |
+-----------+----------------------+

Method Descriptions
-------------------

.. _class_GLTFSkin_method_get_inverse_binds:

- :ref:`Array<class_Array>` **get_inverse_binds** **(** **)**

----

.. _class_GLTFSkin_method_get_joint_i_to_bone_i:

- :ref:`Dictionary<class_Dictionary>` **get_joint_i_to_bone_i** **(** **)**

----

.. _class_GLTFSkin_method_get_joint_i_to_name:

- :ref:`Dictionary<class_Dictionary>` **get_joint_i_to_name** **(** **)**

----

.. _class_GLTFSkin_method_set_inverse_binds:

- void **set_inverse_binds** **(** :ref:`Array<class_Array>` inverse_binds **)**

----

.. _class_GLTFSkin_method_set_joint_i_to_bone_i:

- void **set_joint_i_to_bone_i** **(** :ref:`Dictionary<class_Dictionary>` joint_i_to_bone_i **)**

----

.. _class_GLTFSkin_method_set_joint_i_to_name:

- void **set_joint_i_to_name** **(** :ref:`Dictionary<class_Dictionary>` joint_i_to_name **)**

.. |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.)`