class_skin.rst 6.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the Skin.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_Skin:
  6. Skin
  7. ====
  8. **Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  9. Methods
  10. -------
  11. +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
  12. | void | :ref:`add_bind<class_Skin_method_add_bind>` **(** :ref:`int<class_int>` bone, :ref:`Transform3D<class_Transform3D>` pose **)** |
  13. +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
  14. | void | :ref:`add_named_bind<class_Skin_method_add_named_bind>` **(** :ref:`String<class_String>` name, :ref:`Transform3D<class_Transform3D>` pose **)** |
  15. +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
  16. | void | :ref:`clear_binds<class_Skin_method_clear_binds>` **(** **)** |
  17. +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
  18. | :ref:`int<class_int>` | :ref:`get_bind_bone<class_Skin_method_get_bind_bone>` **(** :ref:`int<class_int>` bind_index **)** |const| |
  19. +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
  20. | :ref:`int<class_int>` | :ref:`get_bind_count<class_Skin_method_get_bind_count>` **(** **)** |const| |
  21. +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
  22. | :ref:`StringName<class_StringName>` | :ref:`get_bind_name<class_Skin_method_get_bind_name>` **(** :ref:`int<class_int>` bind_index **)** |const| |
  23. +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
  24. | :ref:`Transform3D<class_Transform3D>` | :ref:`get_bind_pose<class_Skin_method_get_bind_pose>` **(** :ref:`int<class_int>` bind_index **)** |const| |
  25. +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
  26. | void | :ref:`set_bind_bone<class_Skin_method_set_bind_bone>` **(** :ref:`int<class_int>` bind_index, :ref:`int<class_int>` bone **)** |
  27. +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
  28. | void | :ref:`set_bind_count<class_Skin_method_set_bind_count>` **(** :ref:`int<class_int>` bind_count **)** |
  29. +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
  30. | void | :ref:`set_bind_name<class_Skin_method_set_bind_name>` **(** :ref:`int<class_int>` bind_index, :ref:`StringName<class_StringName>` name **)** |
  31. +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
  32. | void | :ref:`set_bind_pose<class_Skin_method_set_bind_pose>` **(** :ref:`int<class_int>` bind_index, :ref:`Transform3D<class_Transform3D>` pose **)** |
  33. +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
  34. Method Descriptions
  35. -------------------
  36. .. _class_Skin_method_add_bind:
  37. - void **add_bind** **(** :ref:`int<class_int>` bone, :ref:`Transform3D<class_Transform3D>` pose **)**
  38. ----
  39. .. _class_Skin_method_add_named_bind:
  40. - void **add_named_bind** **(** :ref:`String<class_String>` name, :ref:`Transform3D<class_Transform3D>` pose **)**
  41. ----
  42. .. _class_Skin_method_clear_binds:
  43. - void **clear_binds** **(** **)**
  44. ----
  45. .. _class_Skin_method_get_bind_bone:
  46. - :ref:`int<class_int>` **get_bind_bone** **(** :ref:`int<class_int>` bind_index **)** |const|
  47. ----
  48. .. _class_Skin_method_get_bind_count:
  49. - :ref:`int<class_int>` **get_bind_count** **(** **)** |const|
  50. ----
  51. .. _class_Skin_method_get_bind_name:
  52. - :ref:`StringName<class_StringName>` **get_bind_name** **(** :ref:`int<class_int>` bind_index **)** |const|
  53. ----
  54. .. _class_Skin_method_get_bind_pose:
  55. - :ref:`Transform3D<class_Transform3D>` **get_bind_pose** **(** :ref:`int<class_int>` bind_index **)** |const|
  56. ----
  57. .. _class_Skin_method_set_bind_bone:
  58. - void **set_bind_bone** **(** :ref:`int<class_int>` bind_index, :ref:`int<class_int>` bone **)**
  59. ----
  60. .. _class_Skin_method_set_bind_count:
  61. - void **set_bind_count** **(** :ref:`int<class_int>` bind_count **)**
  62. ----
  63. .. _class_Skin_method_set_bind_name:
  64. - void **set_bind_name** **(** :ref:`int<class_int>` bind_index, :ref:`StringName<class_StringName>` name **)**
  65. ----
  66. .. _class_Skin_method_set_bind_pose:
  67. - void **set_bind_pose** **(** :ref:`int<class_int>` bind_index, :ref:`Transform3D<class_Transform3D>` pose **)**
  68. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  69. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  70. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  71. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  72. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  73. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`