class_gltfskin.rst 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/4.0/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/4.0/modules/gltf/doc_classes/GLTFSkin.xml.
  6. .. _class_GLTFSkin:
  7. GLTFSkin
  8. ========
  9. **Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  10. .. container:: contribute
  11. There is currently no description for this class. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  12. .. rst-class:: classref-reftable-group
  13. Properties
  14. ----------
  15. .. table::
  16. :widths: auto
  17. +-------------------------------------------------+-----------------------------------------------------------------+------------------------+
  18. | :ref:`Skin<class_Skin>` | :ref:`godot_skin<class_GLTFSkin_property_godot_skin>` | |
  19. +-------------------------------------------------+-----------------------------------------------------------------+------------------------+
  20. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`joints<class_GLTFSkin_property_joints>` | ``PackedInt32Array()`` |
  21. +-------------------------------------------------+-----------------------------------------------------------------+------------------------+
  22. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`joints_original<class_GLTFSkin_property_joints_original>` | ``PackedInt32Array()`` |
  23. +-------------------------------------------------+-----------------------------------------------------------------+------------------------+
  24. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`non_joints<class_GLTFSkin_property_non_joints>` | ``PackedInt32Array()`` |
  25. +-------------------------------------------------+-----------------------------------------------------------------+------------------------+
  26. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`roots<class_GLTFSkin_property_roots>` | ``PackedInt32Array()`` |
  27. +-------------------------------------------------+-----------------------------------------------------------------+------------------------+
  28. | :ref:`int<class_int>` | :ref:`skeleton<class_GLTFSkin_property_skeleton>` | ``-1`` |
  29. +-------------------------------------------------+-----------------------------------------------------------------+------------------------+
  30. | :ref:`int<class_int>` | :ref:`skin_root<class_GLTFSkin_property_skin_root>` | ``-1`` |
  31. +-------------------------------------------------+-----------------------------------------------------------------+------------------------+
  32. .. rst-class:: classref-reftable-group
  33. Methods
  34. -------
  35. .. table::
  36. :widths: auto
  37. +-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
  38. | :ref:`Transform3D[]<class_Transform3D>` | :ref:`get_inverse_binds<class_GLTFSkin_method_get_inverse_binds>` **(** **)** |
  39. +-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
  40. | :ref:`Dictionary<class_Dictionary>` | :ref:`get_joint_i_to_bone_i<class_GLTFSkin_method_get_joint_i_to_bone_i>` **(** **)** |
  41. +-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
  42. | :ref:`Dictionary<class_Dictionary>` | :ref:`get_joint_i_to_name<class_GLTFSkin_method_get_joint_i_to_name>` **(** **)** |
  43. +-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
  44. | void | :ref:`set_inverse_binds<class_GLTFSkin_method_set_inverse_binds>` **(** :ref:`Transform3D[]<class_Transform3D>` inverse_binds **)** |
  45. +-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
  46. | 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 **)** |
  47. +-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
  48. | void | :ref:`set_joint_i_to_name<class_GLTFSkin_method_set_joint_i_to_name>` **(** :ref:`Dictionary<class_Dictionary>` joint_i_to_name **)** |
  49. +-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
  50. .. rst-class:: classref-section-separator
  51. ----
  52. .. rst-class:: classref-descriptions-group
  53. Property Descriptions
  54. ---------------------
  55. .. _class_GLTFSkin_property_godot_skin:
  56. .. rst-class:: classref-property
  57. :ref:`Skin<class_Skin>` **godot_skin**
  58. .. rst-class:: classref-property-setget
  59. - void **set_godot_skin** **(** :ref:`Skin<class_Skin>` value **)**
  60. - :ref:`Skin<class_Skin>` **get_godot_skin** **(** **)**
  61. .. container:: contribute
  62. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  63. .. rst-class:: classref-item-separator
  64. ----
  65. .. _class_GLTFSkin_property_joints:
  66. .. rst-class:: classref-property
  67. :ref:`PackedInt32Array<class_PackedInt32Array>` **joints** = ``PackedInt32Array()``
  68. .. rst-class:: classref-property-setget
  69. - void **set_joints** **(** :ref:`PackedInt32Array<class_PackedInt32Array>` value **)**
  70. - :ref:`PackedInt32Array<class_PackedInt32Array>` **get_joints** **(** **)**
  71. .. container:: contribute
  72. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  73. .. rst-class:: classref-item-separator
  74. ----
  75. .. _class_GLTFSkin_property_joints_original:
  76. .. rst-class:: classref-property
  77. :ref:`PackedInt32Array<class_PackedInt32Array>` **joints_original** = ``PackedInt32Array()``
  78. .. rst-class:: classref-property-setget
  79. - void **set_joints_original** **(** :ref:`PackedInt32Array<class_PackedInt32Array>` value **)**
  80. - :ref:`PackedInt32Array<class_PackedInt32Array>` **get_joints_original** **(** **)**
  81. .. container:: contribute
  82. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  83. .. rst-class:: classref-item-separator
  84. ----
  85. .. _class_GLTFSkin_property_non_joints:
  86. .. rst-class:: classref-property
  87. :ref:`PackedInt32Array<class_PackedInt32Array>` **non_joints** = ``PackedInt32Array()``
  88. .. rst-class:: classref-property-setget
  89. - void **set_non_joints** **(** :ref:`PackedInt32Array<class_PackedInt32Array>` value **)**
  90. - :ref:`PackedInt32Array<class_PackedInt32Array>` **get_non_joints** **(** **)**
  91. .. container:: contribute
  92. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  93. .. rst-class:: classref-item-separator
  94. ----
  95. .. _class_GLTFSkin_property_roots:
  96. .. rst-class:: classref-property
  97. :ref:`PackedInt32Array<class_PackedInt32Array>` **roots** = ``PackedInt32Array()``
  98. .. rst-class:: classref-property-setget
  99. - void **set_roots** **(** :ref:`PackedInt32Array<class_PackedInt32Array>` value **)**
  100. - :ref:`PackedInt32Array<class_PackedInt32Array>` **get_roots** **(** **)**
  101. .. container:: contribute
  102. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  103. .. rst-class:: classref-item-separator
  104. ----
  105. .. _class_GLTFSkin_property_skeleton:
  106. .. rst-class:: classref-property
  107. :ref:`int<class_int>` **skeleton** = ``-1``
  108. .. rst-class:: classref-property-setget
  109. - void **set_skeleton** **(** :ref:`int<class_int>` value **)**
  110. - :ref:`int<class_int>` **get_skeleton** **(** **)**
  111. .. container:: contribute
  112. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  113. .. rst-class:: classref-item-separator
  114. ----
  115. .. _class_GLTFSkin_property_skin_root:
  116. .. rst-class:: classref-property
  117. :ref:`int<class_int>` **skin_root** = ``-1``
  118. .. rst-class:: classref-property-setget
  119. - void **set_skin_root** **(** :ref:`int<class_int>` value **)**
  120. - :ref:`int<class_int>` **get_skin_root** **(** **)**
  121. .. container:: contribute
  122. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  123. .. rst-class:: classref-section-separator
  124. ----
  125. .. rst-class:: classref-descriptions-group
  126. Method Descriptions
  127. -------------------
  128. .. _class_GLTFSkin_method_get_inverse_binds:
  129. .. rst-class:: classref-method
  130. :ref:`Transform3D[]<class_Transform3D>` **get_inverse_binds** **(** **)**
  131. .. container:: contribute
  132. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  133. .. rst-class:: classref-item-separator
  134. ----
  135. .. _class_GLTFSkin_method_get_joint_i_to_bone_i:
  136. .. rst-class:: classref-method
  137. :ref:`Dictionary<class_Dictionary>` **get_joint_i_to_bone_i** **(** **)**
  138. .. container:: contribute
  139. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  140. .. rst-class:: classref-item-separator
  141. ----
  142. .. _class_GLTFSkin_method_get_joint_i_to_name:
  143. .. rst-class:: classref-method
  144. :ref:`Dictionary<class_Dictionary>` **get_joint_i_to_name** **(** **)**
  145. .. container:: contribute
  146. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  147. .. rst-class:: classref-item-separator
  148. ----
  149. .. _class_GLTFSkin_method_set_inverse_binds:
  150. .. rst-class:: classref-method
  151. void **set_inverse_binds** **(** :ref:`Transform3D[]<class_Transform3D>` inverse_binds **)**
  152. .. container:: contribute
  153. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  154. .. rst-class:: classref-item-separator
  155. ----
  156. .. _class_GLTFSkin_method_set_joint_i_to_bone_i:
  157. .. rst-class:: classref-method
  158. void **set_joint_i_to_bone_i** **(** :ref:`Dictionary<class_Dictionary>` joint_i_to_bone_i **)**
  159. .. container:: contribute
  160. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  161. .. rst-class:: classref-item-separator
  162. ----
  163. .. _class_GLTFSkin_method_set_joint_i_to_name:
  164. .. rst-class:: classref-method
  165. void **set_joint_i_to_name** **(** :ref:`Dictionary<class_Dictionary>` joint_i_to_name **)**
  166. .. container:: contribute
  167. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  168. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  169. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  170. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  171. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  172. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  173. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`