class_gltfaccessor.rst 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334
  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/3.5/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/3.5/modules/gltf/doc_classes/GLTFAccessor.xml.
  6. .. _class_GLTFAccessor:
  7. GLTFAccessor
  8. ============
  9. **Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  10. .. rst-class:: classref-introduction-group
  11. Description
  12. -----------
  13. **Note:** This class is only compiled in editor builds. Run-time glTF loading and saving is *not* available in exported projects. References to **GLTFAccessor** within a script will cause an error in an exported project.
  14. .. rst-class:: classref-reftable-group
  15. Properties
  16. ----------
  17. .. table::
  18. :widths: auto
  19. +-------------------------------------------+-------------------------------------------------------------------------------------------------+-----------------------+
  20. | :ref:`int<class_int>` | :ref:`buffer_view<class_GLTFAccessor_property_buffer_view>` | ``0`` |
  21. +-------------------------------------------+-------------------------------------------------------------------------------------------------+-----------------------+
  22. | :ref:`int<class_int>` | :ref:`byte_offset<class_GLTFAccessor_property_byte_offset>` | ``0`` |
  23. +-------------------------------------------+-------------------------------------------------------------------------------------------------+-----------------------+
  24. | :ref:`int<class_int>` | :ref:`component_type<class_GLTFAccessor_property_component_type>` | ``0`` |
  25. +-------------------------------------------+-------------------------------------------------------------------------------------------------+-----------------------+
  26. | :ref:`int<class_int>` | :ref:`count<class_GLTFAccessor_property_count>` | ``0`` |
  27. +-------------------------------------------+-------------------------------------------------------------------------------------------------+-----------------------+
  28. | :ref:`PoolRealArray<class_PoolRealArray>` | :ref:`max<class_GLTFAccessor_property_max>` | ``PoolRealArray( )`` |
  29. +-------------------------------------------+-------------------------------------------------------------------------------------------------+-----------------------+
  30. | :ref:`PoolRealArray<class_PoolRealArray>` | :ref:`min<class_GLTFAccessor_property_min>` | ``PoolRealArray( )`` |
  31. +-------------------------------------------+-------------------------------------------------------------------------------------------------+-----------------------+
  32. | :ref:`bool<class_bool>` | :ref:`normalized<class_GLTFAccessor_property_normalized>` | ``false`` |
  33. +-------------------------------------------+-------------------------------------------------------------------------------------------------+-----------------------+
  34. | :ref:`int<class_int>` | :ref:`sparse_count<class_GLTFAccessor_property_sparse_count>` | ``0`` |
  35. +-------------------------------------------+-------------------------------------------------------------------------------------------------+-----------------------+
  36. | :ref:`int<class_int>` | :ref:`sparse_indices_buffer_view<class_GLTFAccessor_property_sparse_indices_buffer_view>` | ``0`` |
  37. +-------------------------------------------+-------------------------------------------------------------------------------------------------+-----------------------+
  38. | :ref:`int<class_int>` | :ref:`sparse_indices_byte_offset<class_GLTFAccessor_property_sparse_indices_byte_offset>` | ``0`` |
  39. +-------------------------------------------+-------------------------------------------------------------------------------------------------+-----------------------+
  40. | :ref:`int<class_int>` | :ref:`sparse_indices_component_type<class_GLTFAccessor_property_sparse_indices_component_type>` | ``0`` |
  41. +-------------------------------------------+-------------------------------------------------------------------------------------------------+-----------------------+
  42. | :ref:`int<class_int>` | :ref:`sparse_values_buffer_view<class_GLTFAccessor_property_sparse_values_buffer_view>` | ``0`` |
  43. +-------------------------------------------+-------------------------------------------------------------------------------------------------+-----------------------+
  44. | :ref:`int<class_int>` | :ref:`sparse_values_byte_offset<class_GLTFAccessor_property_sparse_values_byte_offset>` | ``0`` |
  45. +-------------------------------------------+-------------------------------------------------------------------------------------------------+-----------------------+
  46. | :ref:`int<class_int>` | :ref:`type<class_GLTFAccessor_property_type>` | ``0`` |
  47. +-------------------------------------------+-------------------------------------------------------------------------------------------------+-----------------------+
  48. .. rst-class:: classref-section-separator
  49. ----
  50. .. rst-class:: classref-descriptions-group
  51. Property Descriptions
  52. ---------------------
  53. .. _class_GLTFAccessor_property_buffer_view:
  54. .. rst-class:: classref-property
  55. :ref:`int<class_int>` **buffer_view** = ``0``
  56. .. rst-class:: classref-property-setget
  57. - void **set_buffer_view** **(** :ref:`int<class_int>` value **)**
  58. - :ref:`int<class_int>` **get_buffer_view** **(** **)**
  59. .. container:: contribute
  60. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  61. .. rst-class:: classref-item-separator
  62. ----
  63. .. _class_GLTFAccessor_property_byte_offset:
  64. .. rst-class:: classref-property
  65. :ref:`int<class_int>` **byte_offset** = ``0``
  66. .. rst-class:: classref-property-setget
  67. - void **set_byte_offset** **(** :ref:`int<class_int>` value **)**
  68. - :ref:`int<class_int>` **get_byte_offset** **(** **)**
  69. .. container:: contribute
  70. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  71. .. rst-class:: classref-item-separator
  72. ----
  73. .. _class_GLTFAccessor_property_component_type:
  74. .. rst-class:: classref-property
  75. :ref:`int<class_int>` **component_type** = ``0``
  76. .. rst-class:: classref-property-setget
  77. - void **set_component_type** **(** :ref:`int<class_int>` value **)**
  78. - :ref:`int<class_int>` **get_component_type** **(** **)**
  79. .. container:: contribute
  80. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  81. .. rst-class:: classref-item-separator
  82. ----
  83. .. _class_GLTFAccessor_property_count:
  84. .. rst-class:: classref-property
  85. :ref:`int<class_int>` **count** = ``0``
  86. .. rst-class:: classref-property-setget
  87. - void **set_count** **(** :ref:`int<class_int>` value **)**
  88. - :ref:`int<class_int>` **get_count** **(** **)**
  89. .. container:: contribute
  90. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  91. .. rst-class:: classref-item-separator
  92. ----
  93. .. _class_GLTFAccessor_property_max:
  94. .. rst-class:: classref-property
  95. :ref:`PoolRealArray<class_PoolRealArray>` **max** = ``PoolRealArray( )``
  96. .. rst-class:: classref-property-setget
  97. - void **set_max** **(** :ref:`PoolRealArray<class_PoolRealArray>` value **)**
  98. - :ref:`PoolRealArray<class_PoolRealArray>` **get_max** **(** **)**
  99. .. container:: contribute
  100. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  101. .. rst-class:: classref-item-separator
  102. ----
  103. .. _class_GLTFAccessor_property_min:
  104. .. rst-class:: classref-property
  105. :ref:`PoolRealArray<class_PoolRealArray>` **min** = ``PoolRealArray( )``
  106. .. rst-class:: classref-property-setget
  107. - void **set_min** **(** :ref:`PoolRealArray<class_PoolRealArray>` value **)**
  108. - :ref:`PoolRealArray<class_PoolRealArray>` **get_min** **(** **)**
  109. .. container:: contribute
  110. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  111. .. rst-class:: classref-item-separator
  112. ----
  113. .. _class_GLTFAccessor_property_normalized:
  114. .. rst-class:: classref-property
  115. :ref:`bool<class_bool>` **normalized** = ``false``
  116. .. rst-class:: classref-property-setget
  117. - void **set_normalized** **(** :ref:`bool<class_bool>` value **)**
  118. - :ref:`bool<class_bool>` **get_normalized** **(** **)**
  119. .. container:: contribute
  120. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  121. .. rst-class:: classref-item-separator
  122. ----
  123. .. _class_GLTFAccessor_property_sparse_count:
  124. .. rst-class:: classref-property
  125. :ref:`int<class_int>` **sparse_count** = ``0``
  126. .. rst-class:: classref-property-setget
  127. - void **set_sparse_count** **(** :ref:`int<class_int>` value **)**
  128. - :ref:`int<class_int>` **get_sparse_count** **(** **)**
  129. .. container:: contribute
  130. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  131. .. rst-class:: classref-item-separator
  132. ----
  133. .. _class_GLTFAccessor_property_sparse_indices_buffer_view:
  134. .. rst-class:: classref-property
  135. :ref:`int<class_int>` **sparse_indices_buffer_view** = ``0``
  136. .. rst-class:: classref-property-setget
  137. - void **set_sparse_indices_buffer_view** **(** :ref:`int<class_int>` value **)**
  138. - :ref:`int<class_int>` **get_sparse_indices_buffer_view** **(** **)**
  139. .. container:: contribute
  140. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  141. .. rst-class:: classref-item-separator
  142. ----
  143. .. _class_GLTFAccessor_property_sparse_indices_byte_offset:
  144. .. rst-class:: classref-property
  145. :ref:`int<class_int>` **sparse_indices_byte_offset** = ``0``
  146. .. rst-class:: classref-property-setget
  147. - void **set_sparse_indices_byte_offset** **(** :ref:`int<class_int>` value **)**
  148. - :ref:`int<class_int>` **get_sparse_indices_byte_offset** **(** **)**
  149. .. container:: contribute
  150. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  151. .. rst-class:: classref-item-separator
  152. ----
  153. .. _class_GLTFAccessor_property_sparse_indices_component_type:
  154. .. rst-class:: classref-property
  155. :ref:`int<class_int>` **sparse_indices_component_type** = ``0``
  156. .. rst-class:: classref-property-setget
  157. - void **set_sparse_indices_component_type** **(** :ref:`int<class_int>` value **)**
  158. - :ref:`int<class_int>` **get_sparse_indices_component_type** **(** **)**
  159. .. container:: contribute
  160. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  161. .. rst-class:: classref-item-separator
  162. ----
  163. .. _class_GLTFAccessor_property_sparse_values_buffer_view:
  164. .. rst-class:: classref-property
  165. :ref:`int<class_int>` **sparse_values_buffer_view** = ``0``
  166. .. rst-class:: classref-property-setget
  167. - void **set_sparse_values_buffer_view** **(** :ref:`int<class_int>` value **)**
  168. - :ref:`int<class_int>` **get_sparse_values_buffer_view** **(** **)**
  169. .. container:: contribute
  170. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  171. .. rst-class:: classref-item-separator
  172. ----
  173. .. _class_GLTFAccessor_property_sparse_values_byte_offset:
  174. .. rst-class:: classref-property
  175. :ref:`int<class_int>` **sparse_values_byte_offset** = ``0``
  176. .. rst-class:: classref-property-setget
  177. - void **set_sparse_values_byte_offset** **(** :ref:`int<class_int>` value **)**
  178. - :ref:`int<class_int>` **get_sparse_values_byte_offset** **(** **)**
  179. .. container:: contribute
  180. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  181. .. rst-class:: classref-item-separator
  182. ----
  183. .. _class_GLTFAccessor_property_type:
  184. .. rst-class:: classref-property
  185. :ref:`int<class_int>` **type** = ``0``
  186. .. rst-class:: classref-property-setget
  187. - void **set_type** **(** :ref:`int<class_int>` value **)**
  188. - :ref:`int<class_int>` **get_type** **(** **)**
  189. .. container:: contribute
  190. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  191. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  192. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  193. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  194. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`