class_gltfstate.rst 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427
  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 GLTFState.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_GLTFState:
  6. GLTFState
  7. =========
  8. **Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. Description
  10. -----------
  11. **Note:** This class is only compiled in editor builds. Run-time glTF loading and saving is *not* available in exported projects. References to ``GLTFState`` within a script will cause an error in an exported project.
  12. Properties
  13. ----------
  14. +-------------------------------------------+----------------------------------------------------------------------------+-----------------------+
  15. | :ref:`Array<class_Array>` | :ref:`buffers<class_GLTFState_property_buffers>` | ``[ ]`` |
  16. +-------------------------------------------+----------------------------------------------------------------------------+-----------------------+
  17. | :ref:`PoolByteArray<class_PoolByteArray>` | :ref:`glb_data<class_GLTFState_property_glb_data>` | ``PoolByteArray( )`` |
  18. +-------------------------------------------+----------------------------------------------------------------------------+-----------------------+
  19. | :ref:`Dictionary<class_Dictionary>` | :ref:`json<class_GLTFState_property_json>` | ``{}`` |
  20. +-------------------------------------------+----------------------------------------------------------------------------+-----------------------+
  21. | :ref:`int<class_int>` | :ref:`major_version<class_GLTFState_property_major_version>` | ``0`` |
  22. +-------------------------------------------+----------------------------------------------------------------------------+-----------------------+
  23. | :ref:`int<class_int>` | :ref:`minor_version<class_GLTFState_property_minor_version>` | ``0`` |
  24. +-------------------------------------------+----------------------------------------------------------------------------+-----------------------+
  25. | :ref:`Array<class_Array>` | :ref:`root_nodes<class_GLTFState_property_root_nodes>` | ``[ ]`` |
  26. +-------------------------------------------+----------------------------------------------------------------------------+-----------------------+
  27. | :ref:`String<class_String>` | :ref:`scene_name<class_GLTFState_property_scene_name>` | ``""`` |
  28. +-------------------------------------------+----------------------------------------------------------------------------+-----------------------+
  29. | :ref:`bool<class_bool>` | :ref:`use_named_skin_binds<class_GLTFState_property_use_named_skin_binds>` | ``false`` |
  30. +-------------------------------------------+----------------------------------------------------------------------------+-----------------------+
  31. Methods
  32. -------
  33. +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
  34. | :ref:`Array<class_Array>` | :ref:`get_accessors<class_GLTFState_method_get_accessors>` **(** **)** |
  35. +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
  36. | :ref:`AnimationPlayer<class_AnimationPlayer>` | :ref:`get_animation_player<class_GLTFState_method_get_animation_player>` **(** :ref:`int<class_int>` idx **)** |
  37. +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
  38. | :ref:`int<class_int>` | :ref:`get_animation_players_count<class_GLTFState_method_get_animation_players_count>` **(** :ref:`int<class_int>` idx **)** |
  39. +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
  40. | :ref:`Array<class_Array>` | :ref:`get_animations<class_GLTFState_method_get_animations>` **(** **)** |
  41. +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
  42. | :ref:`Array<class_Array>` | :ref:`get_buffer_views<class_GLTFState_method_get_buffer_views>` **(** **)** |
  43. +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
  44. | :ref:`Array<class_Array>` | :ref:`get_cameras<class_GLTFState_method_get_cameras>` **(** **)** |
  45. +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
  46. | :ref:`Array<class_Array>` | :ref:`get_images<class_GLTFState_method_get_images>` **(** **)** |
  47. +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
  48. | :ref:`Array<class_Array>` | :ref:`get_lights<class_GLTFState_method_get_lights>` **(** **)** |
  49. +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
  50. | :ref:`Array<class_Array>` | :ref:`get_materials<class_GLTFState_method_get_materials>` **(** **)** |
  51. +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
  52. | :ref:`Array<class_Array>` | :ref:`get_meshes<class_GLTFState_method_get_meshes>` **(** **)** |
  53. +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
  54. | :ref:`Array<class_Array>` | :ref:`get_nodes<class_GLTFState_method_get_nodes>` **(** **)** |
  55. +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
  56. | :ref:`Node<class_Node>` | :ref:`get_scene_node<class_GLTFState_method_get_scene_node>` **(** :ref:`int<class_int>` idx **)** |
  57. +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
  58. | :ref:`Dictionary<class_Dictionary>` | :ref:`get_skeleton_to_node<class_GLTFState_method_get_skeleton_to_node>` **(** **)** |
  59. +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
  60. | :ref:`Array<class_Array>` | :ref:`get_skeletons<class_GLTFState_method_get_skeletons>` **(** **)** |
  61. +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
  62. | :ref:`Array<class_Array>` | :ref:`get_skins<class_GLTFState_method_get_skins>` **(** **)** |
  63. +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
  64. | :ref:`Array<class_Array>` | :ref:`get_textures<class_GLTFState_method_get_textures>` **(** **)** |
  65. +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
  66. | :ref:`Array<class_Array>` | :ref:`get_unique_animation_names<class_GLTFState_method_get_unique_animation_names>` **(** **)** |
  67. +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
  68. | :ref:`Array<class_Array>` | :ref:`get_unique_names<class_GLTFState_method_get_unique_names>` **(** **)** |
  69. +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
  70. | void | :ref:`set_accessors<class_GLTFState_method_set_accessors>` **(** :ref:`Array<class_Array>` accessors **)** |
  71. +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
  72. | void | :ref:`set_animations<class_GLTFState_method_set_animations>` **(** :ref:`Array<class_Array>` animations **)** |
  73. +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
  74. | void | :ref:`set_buffer_views<class_GLTFState_method_set_buffer_views>` **(** :ref:`Array<class_Array>` buffer_views **)** |
  75. +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
  76. | void | :ref:`set_cameras<class_GLTFState_method_set_cameras>` **(** :ref:`Array<class_Array>` cameras **)** |
  77. +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
  78. | void | :ref:`set_images<class_GLTFState_method_set_images>` **(** :ref:`Array<class_Array>` images **)** |
  79. +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
  80. | void | :ref:`set_lights<class_GLTFState_method_set_lights>` **(** :ref:`Array<class_Array>` lights **)** |
  81. +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
  82. | void | :ref:`set_materials<class_GLTFState_method_set_materials>` **(** :ref:`Array<class_Array>` materials **)** |
  83. +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
  84. | void | :ref:`set_meshes<class_GLTFState_method_set_meshes>` **(** :ref:`Array<class_Array>` meshes **)** |
  85. +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
  86. | void | :ref:`set_nodes<class_GLTFState_method_set_nodes>` **(** :ref:`Array<class_Array>` nodes **)** |
  87. +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
  88. | void | :ref:`set_skeleton_to_node<class_GLTFState_method_set_skeleton_to_node>` **(** :ref:`Dictionary<class_Dictionary>` skeleton_to_node **)** |
  89. +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
  90. | void | :ref:`set_skeletons<class_GLTFState_method_set_skeletons>` **(** :ref:`Array<class_Array>` skeletons **)** |
  91. +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
  92. | void | :ref:`set_skins<class_GLTFState_method_set_skins>` **(** :ref:`Array<class_Array>` skins **)** |
  93. +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
  94. | void | :ref:`set_textures<class_GLTFState_method_set_textures>` **(** :ref:`Array<class_Array>` textures **)** |
  95. +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
  96. | void | :ref:`set_unique_animation_names<class_GLTFState_method_set_unique_animation_names>` **(** :ref:`Array<class_Array>` unique_animation_names **)** |
  97. +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
  98. | void | :ref:`set_unique_names<class_GLTFState_method_set_unique_names>` **(** :ref:`Array<class_Array>` unique_names **)** |
  99. +-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
  100. Property Descriptions
  101. ---------------------
  102. .. _class_GLTFState_property_buffers:
  103. - :ref:`Array<class_Array>` **buffers**
  104. +-----------+--------------------+
  105. | *Default* | ``[ ]`` |
  106. +-----------+--------------------+
  107. | *Setter* | set_buffers(value) |
  108. +-----------+--------------------+
  109. | *Getter* | get_buffers() |
  110. +-----------+--------------------+
  111. ----
  112. .. _class_GLTFState_property_glb_data:
  113. - :ref:`PoolByteArray<class_PoolByteArray>` **glb_data**
  114. +-----------+-----------------------+
  115. | *Default* | ``PoolByteArray( )`` |
  116. +-----------+-----------------------+
  117. | *Setter* | set_glb_data(value) |
  118. +-----------+-----------------------+
  119. | *Getter* | get_glb_data() |
  120. +-----------+-----------------------+
  121. ----
  122. .. _class_GLTFState_property_json:
  123. - :ref:`Dictionary<class_Dictionary>` **json**
  124. +-----------+-----------------+
  125. | *Default* | ``{}`` |
  126. +-----------+-----------------+
  127. | *Setter* | set_json(value) |
  128. +-----------+-----------------+
  129. | *Getter* | get_json() |
  130. +-----------+-----------------+
  131. ----
  132. .. _class_GLTFState_property_major_version:
  133. - :ref:`int<class_int>` **major_version**
  134. +-----------+--------------------------+
  135. | *Default* | ``0`` |
  136. +-----------+--------------------------+
  137. | *Setter* | set_major_version(value) |
  138. +-----------+--------------------------+
  139. | *Getter* | get_major_version() |
  140. +-----------+--------------------------+
  141. ----
  142. .. _class_GLTFState_property_minor_version:
  143. - :ref:`int<class_int>` **minor_version**
  144. +-----------+--------------------------+
  145. | *Default* | ``0`` |
  146. +-----------+--------------------------+
  147. | *Setter* | set_minor_version(value) |
  148. +-----------+--------------------------+
  149. | *Getter* | get_minor_version() |
  150. +-----------+--------------------------+
  151. ----
  152. .. _class_GLTFState_property_root_nodes:
  153. - :ref:`Array<class_Array>` **root_nodes**
  154. +-----------+-----------------------+
  155. | *Default* | ``[ ]`` |
  156. +-----------+-----------------------+
  157. | *Setter* | set_root_nodes(value) |
  158. +-----------+-----------------------+
  159. | *Getter* | get_root_nodes() |
  160. +-----------+-----------------------+
  161. ----
  162. .. _class_GLTFState_property_scene_name:
  163. - :ref:`String<class_String>` **scene_name**
  164. +-----------+-----------------------+
  165. | *Default* | ``""`` |
  166. +-----------+-----------------------+
  167. | *Setter* | set_scene_name(value) |
  168. +-----------+-----------------------+
  169. | *Getter* | get_scene_name() |
  170. +-----------+-----------------------+
  171. ----
  172. .. _class_GLTFState_property_use_named_skin_binds:
  173. - :ref:`bool<class_bool>` **use_named_skin_binds**
  174. +-----------+---------------------------------+
  175. | *Default* | ``false`` |
  176. +-----------+---------------------------------+
  177. | *Setter* | set_use_named_skin_binds(value) |
  178. +-----------+---------------------------------+
  179. | *Getter* | get_use_named_skin_binds() |
  180. +-----------+---------------------------------+
  181. Method Descriptions
  182. -------------------
  183. .. _class_GLTFState_method_get_accessors:
  184. - :ref:`Array<class_Array>` **get_accessors** **(** **)**
  185. ----
  186. .. _class_GLTFState_method_get_animation_player:
  187. - :ref:`AnimationPlayer<class_AnimationPlayer>` **get_animation_player** **(** :ref:`int<class_int>` idx **)**
  188. ----
  189. .. _class_GLTFState_method_get_animation_players_count:
  190. - :ref:`int<class_int>` **get_animation_players_count** **(** :ref:`int<class_int>` idx **)**
  191. ----
  192. .. _class_GLTFState_method_get_animations:
  193. - :ref:`Array<class_Array>` **get_animations** **(** **)**
  194. ----
  195. .. _class_GLTFState_method_get_buffer_views:
  196. - :ref:`Array<class_Array>` **get_buffer_views** **(** **)**
  197. ----
  198. .. _class_GLTFState_method_get_cameras:
  199. - :ref:`Array<class_Array>` **get_cameras** **(** **)**
  200. ----
  201. .. _class_GLTFState_method_get_images:
  202. - :ref:`Array<class_Array>` **get_images** **(** **)**
  203. ----
  204. .. _class_GLTFState_method_get_lights:
  205. - :ref:`Array<class_Array>` **get_lights** **(** **)**
  206. ----
  207. .. _class_GLTFState_method_get_materials:
  208. - :ref:`Array<class_Array>` **get_materials** **(** **)**
  209. ----
  210. .. _class_GLTFState_method_get_meshes:
  211. - :ref:`Array<class_Array>` **get_meshes** **(** **)**
  212. ----
  213. .. _class_GLTFState_method_get_nodes:
  214. - :ref:`Array<class_Array>` **get_nodes** **(** **)**
  215. ----
  216. .. _class_GLTFState_method_get_scene_node:
  217. - :ref:`Node<class_Node>` **get_scene_node** **(** :ref:`int<class_int>` idx **)**
  218. ----
  219. .. _class_GLTFState_method_get_skeleton_to_node:
  220. - :ref:`Dictionary<class_Dictionary>` **get_skeleton_to_node** **(** **)**
  221. ----
  222. .. _class_GLTFState_method_get_skeletons:
  223. - :ref:`Array<class_Array>` **get_skeletons** **(** **)**
  224. ----
  225. .. _class_GLTFState_method_get_skins:
  226. - :ref:`Array<class_Array>` **get_skins** **(** **)**
  227. ----
  228. .. _class_GLTFState_method_get_textures:
  229. - :ref:`Array<class_Array>` **get_textures** **(** **)**
  230. ----
  231. .. _class_GLTFState_method_get_unique_animation_names:
  232. - :ref:`Array<class_Array>` **get_unique_animation_names** **(** **)**
  233. ----
  234. .. _class_GLTFState_method_get_unique_names:
  235. - :ref:`Array<class_Array>` **get_unique_names** **(** **)**
  236. ----
  237. .. _class_GLTFState_method_set_accessors:
  238. - void **set_accessors** **(** :ref:`Array<class_Array>` accessors **)**
  239. ----
  240. .. _class_GLTFState_method_set_animations:
  241. - void **set_animations** **(** :ref:`Array<class_Array>` animations **)**
  242. ----
  243. .. _class_GLTFState_method_set_buffer_views:
  244. - void **set_buffer_views** **(** :ref:`Array<class_Array>` buffer_views **)**
  245. ----
  246. .. _class_GLTFState_method_set_cameras:
  247. - void **set_cameras** **(** :ref:`Array<class_Array>` cameras **)**
  248. ----
  249. .. _class_GLTFState_method_set_images:
  250. - void **set_images** **(** :ref:`Array<class_Array>` images **)**
  251. ----
  252. .. _class_GLTFState_method_set_lights:
  253. - void **set_lights** **(** :ref:`Array<class_Array>` lights **)**
  254. ----
  255. .. _class_GLTFState_method_set_materials:
  256. - void **set_materials** **(** :ref:`Array<class_Array>` materials **)**
  257. ----
  258. .. _class_GLTFState_method_set_meshes:
  259. - void **set_meshes** **(** :ref:`Array<class_Array>` meshes **)**
  260. ----
  261. .. _class_GLTFState_method_set_nodes:
  262. - void **set_nodes** **(** :ref:`Array<class_Array>` nodes **)**
  263. ----
  264. .. _class_GLTFState_method_set_skeleton_to_node:
  265. - void **set_skeleton_to_node** **(** :ref:`Dictionary<class_Dictionary>` skeleton_to_node **)**
  266. ----
  267. .. _class_GLTFState_method_set_skeletons:
  268. - void **set_skeletons** **(** :ref:`Array<class_Array>` skeletons **)**
  269. ----
  270. .. _class_GLTFState_method_set_skins:
  271. - void **set_skins** **(** :ref:`Array<class_Array>` skins **)**
  272. ----
  273. .. _class_GLTFState_method_set_textures:
  274. - void **set_textures** **(** :ref:`Array<class_Array>` textures **)**
  275. ----
  276. .. _class_GLTFState_method_set_unique_animation_names:
  277. - void **set_unique_animation_names** **(** :ref:`Array<class_Array>` unique_animation_names **)**
  278. ----
  279. .. _class_GLTFState_method_set_unique_names:
  280. - void **set_unique_names** **(** :ref:`Array<class_Array>` unique_names **)**
  281. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  282. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  283. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`