godot-docs/classes/class_gltfskin.rst

: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>`



Properties
----------

+-------------------------------------------------+-----------------------------------------------------------------+------------------------+
| :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``                 |
+-------------------------------------------------+-----------------------------------------------------------------+------------------------+

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:`PackedInt32Array<class_PackedInt32Array>` **joints**

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

----

.. _class_GLTFSkin_property_joints_original:

- :ref:`PackedInt32Array<class_PackedInt32Array>` **joints_original**

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

----

.. _class_GLTFSkin_property_non_joints:

- :ref:`PackedInt32Array<class_PackedInt32Array>` **non_joints**

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

----

.. _class_GLTFSkin_property_roots:

- :ref:`PackedInt32Array<class_PackedInt32Array>` **roots**

+-----------+------------------------+
| *Default* | ``PackedInt32Array()`` |
+-----------+------------------------+
| *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.)`
.. |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.)`