class_gltfaccessor.rst 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342
  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/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/modules/gltf/doc_classes/GLTFAccessor.xml.
  6. .. _class_GLTFAccessor:
  7. GLTFAccessor
  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-introduction-group
  13. Tutorials
  14. ---------
  15. - :doc:`Runtime file loading and saving <../tutorials/io/runtime_file_loading_and_saving>`
  16. .. rst-class:: classref-reftable-group
  17. Properties
  18. ----------
  19. .. table::
  20. :widths: auto
  21. +-----------------------------------------------------+-------------------------------------------------------------------------------------------------+--------------------------+
  22. | :ref:`int<class_int>` | :ref:`buffer_view<class_GLTFAccessor_property_buffer_view>` | ``-1`` |
  23. +-----------------------------------------------------+-------------------------------------------------------------------------------------------------+--------------------------+
  24. | :ref:`int<class_int>` | :ref:`byte_offset<class_GLTFAccessor_property_byte_offset>` | ``0`` |
  25. +-----------------------------------------------------+-------------------------------------------------------------------------------------------------+--------------------------+
  26. | :ref:`int<class_int>` | :ref:`component_type<class_GLTFAccessor_property_component_type>` | ``0`` |
  27. +-----------------------------------------------------+-------------------------------------------------------------------------------------------------+--------------------------+
  28. | :ref:`int<class_int>` | :ref:`count<class_GLTFAccessor_property_count>` | ``0`` |
  29. +-----------------------------------------------------+-------------------------------------------------------------------------------------------------+--------------------------+
  30. | :ref:`PackedFloat64Array<class_PackedFloat64Array>` | :ref:`max<class_GLTFAccessor_property_max>` | ``PackedFloat64Array()`` |
  31. +-----------------------------------------------------+-------------------------------------------------------------------------------------------------+--------------------------+
  32. | :ref:`PackedFloat64Array<class_PackedFloat64Array>` | :ref:`min<class_GLTFAccessor_property_min>` | ``PackedFloat64Array()`` |
  33. +-----------------------------------------------------+-------------------------------------------------------------------------------------------------+--------------------------+
  34. | :ref:`bool<class_bool>` | :ref:`normalized<class_GLTFAccessor_property_normalized>` | ``false`` |
  35. +-----------------------------------------------------+-------------------------------------------------------------------------------------------------+--------------------------+
  36. | :ref:`int<class_int>` | :ref:`sparse_count<class_GLTFAccessor_property_sparse_count>` | ``0`` |
  37. +-----------------------------------------------------+-------------------------------------------------------------------------------------------------+--------------------------+
  38. | :ref:`int<class_int>` | :ref:`sparse_indices_buffer_view<class_GLTFAccessor_property_sparse_indices_buffer_view>` | ``0`` |
  39. +-----------------------------------------------------+-------------------------------------------------------------------------------------------------+--------------------------+
  40. | :ref:`int<class_int>` | :ref:`sparse_indices_byte_offset<class_GLTFAccessor_property_sparse_indices_byte_offset>` | ``0`` |
  41. +-----------------------------------------------------+-------------------------------------------------------------------------------------------------+--------------------------+
  42. | :ref:`int<class_int>` | :ref:`sparse_indices_component_type<class_GLTFAccessor_property_sparse_indices_component_type>` | ``0`` |
  43. +-----------------------------------------------------+-------------------------------------------------------------------------------------------------+--------------------------+
  44. | :ref:`int<class_int>` | :ref:`sparse_values_buffer_view<class_GLTFAccessor_property_sparse_values_buffer_view>` | ``0`` |
  45. +-----------------------------------------------------+-------------------------------------------------------------------------------------------------+--------------------------+
  46. | :ref:`int<class_int>` | :ref:`sparse_values_byte_offset<class_GLTFAccessor_property_sparse_values_byte_offset>` | ``0`` |
  47. +-----------------------------------------------------+-------------------------------------------------------------------------------------------------+--------------------------+
  48. | :ref:`int<class_int>` | :ref:`type<class_GLTFAccessor_property_type>` | ``0`` |
  49. +-----------------------------------------------------+-------------------------------------------------------------------------------------------------+--------------------------+
  50. .. rst-class:: classref-section-separator
  51. ----
  52. .. rst-class:: classref-descriptions-group
  53. Property Descriptions
  54. ---------------------
  55. .. _class_GLTFAccessor_property_buffer_view:
  56. .. rst-class:: classref-property
  57. :ref:`int<class_int>` **buffer_view** = ``-1``
  58. .. rst-class:: classref-property-setget
  59. - void **set_buffer_view** **(** :ref:`int<class_int>` value **)**
  60. - :ref:`int<class_int>` **get_buffer_view** **(** **)**
  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_GLTFAccessor_property_byte_offset:
  66. .. rst-class:: classref-property
  67. :ref:`int<class_int>` **byte_offset** = ``0``
  68. .. rst-class:: classref-property-setget
  69. - void **set_byte_offset** **(** :ref:`int<class_int>` value **)**
  70. - :ref:`int<class_int>` **get_byte_offset** **(** **)**
  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_GLTFAccessor_property_component_type:
  76. .. rst-class:: classref-property
  77. :ref:`int<class_int>` **component_type** = ``0``
  78. .. rst-class:: classref-property-setget
  79. - void **set_component_type** **(** :ref:`int<class_int>` value **)**
  80. - :ref:`int<class_int>` **get_component_type** **(** **)**
  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_GLTFAccessor_property_count:
  86. .. rst-class:: classref-property
  87. :ref:`int<class_int>` **count** = ``0``
  88. .. rst-class:: classref-property-setget
  89. - void **set_count** **(** :ref:`int<class_int>` value **)**
  90. - :ref:`int<class_int>` **get_count** **(** **)**
  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_GLTFAccessor_property_max:
  96. .. rst-class:: classref-property
  97. :ref:`PackedFloat64Array<class_PackedFloat64Array>` **max** = ``PackedFloat64Array()``
  98. .. rst-class:: classref-property-setget
  99. - void **set_max** **(** :ref:`PackedFloat64Array<class_PackedFloat64Array>` value **)**
  100. - :ref:`PackedFloat64Array<class_PackedFloat64Array>` **get_max** **(** **)**
  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_GLTFAccessor_property_min:
  106. .. rst-class:: classref-property
  107. :ref:`PackedFloat64Array<class_PackedFloat64Array>` **min** = ``PackedFloat64Array()``
  108. .. rst-class:: classref-property-setget
  109. - void **set_min** **(** :ref:`PackedFloat64Array<class_PackedFloat64Array>` value **)**
  110. - :ref:`PackedFloat64Array<class_PackedFloat64Array>` **get_min** **(** **)**
  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_GLTFAccessor_property_normalized:
  116. .. rst-class:: classref-property
  117. :ref:`bool<class_bool>` **normalized** = ``false``
  118. .. rst-class:: classref-property-setget
  119. - void **set_normalized** **(** :ref:`bool<class_bool>` value **)**
  120. - :ref:`bool<class_bool>` **get_normalized** **(** **)**
  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-item-separator
  124. ----
  125. .. _class_GLTFAccessor_property_sparse_count:
  126. .. rst-class:: classref-property
  127. :ref:`int<class_int>` **sparse_count** = ``0``
  128. .. rst-class:: classref-property-setget
  129. - void **set_sparse_count** **(** :ref:`int<class_int>` value **)**
  130. - :ref:`int<class_int>` **get_sparse_count** **(** **)**
  131. .. container:: contribute
  132. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  133. .. rst-class:: classref-item-separator
  134. ----
  135. .. _class_GLTFAccessor_property_sparse_indices_buffer_view:
  136. .. rst-class:: classref-property
  137. :ref:`int<class_int>` **sparse_indices_buffer_view** = ``0``
  138. .. rst-class:: classref-property-setget
  139. - void **set_sparse_indices_buffer_view** **(** :ref:`int<class_int>` value **)**
  140. - :ref:`int<class_int>` **get_sparse_indices_buffer_view** **(** **)**
  141. .. container:: contribute
  142. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  143. .. rst-class:: classref-item-separator
  144. ----
  145. .. _class_GLTFAccessor_property_sparse_indices_byte_offset:
  146. .. rst-class:: classref-property
  147. :ref:`int<class_int>` **sparse_indices_byte_offset** = ``0``
  148. .. rst-class:: classref-property-setget
  149. - void **set_sparse_indices_byte_offset** **(** :ref:`int<class_int>` value **)**
  150. - :ref:`int<class_int>` **get_sparse_indices_byte_offset** **(** **)**
  151. .. container:: contribute
  152. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  153. .. rst-class:: classref-item-separator
  154. ----
  155. .. _class_GLTFAccessor_property_sparse_indices_component_type:
  156. .. rst-class:: classref-property
  157. :ref:`int<class_int>` **sparse_indices_component_type** = ``0``
  158. .. rst-class:: classref-property-setget
  159. - void **set_sparse_indices_component_type** **(** :ref:`int<class_int>` value **)**
  160. - :ref:`int<class_int>` **get_sparse_indices_component_type** **(** **)**
  161. .. container:: contribute
  162. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  163. .. rst-class:: classref-item-separator
  164. ----
  165. .. _class_GLTFAccessor_property_sparse_values_buffer_view:
  166. .. rst-class:: classref-property
  167. :ref:`int<class_int>` **sparse_values_buffer_view** = ``0``
  168. .. rst-class:: classref-property-setget
  169. - void **set_sparse_values_buffer_view** **(** :ref:`int<class_int>` value **)**
  170. - :ref:`int<class_int>` **get_sparse_values_buffer_view** **(** **)**
  171. .. container:: contribute
  172. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  173. .. rst-class:: classref-item-separator
  174. ----
  175. .. _class_GLTFAccessor_property_sparse_values_byte_offset:
  176. .. rst-class:: classref-property
  177. :ref:`int<class_int>` **sparse_values_byte_offset** = ``0``
  178. .. rst-class:: classref-property-setget
  179. - void **set_sparse_values_byte_offset** **(** :ref:`int<class_int>` value **)**
  180. - :ref:`int<class_int>` **get_sparse_values_byte_offset** **(** **)**
  181. .. container:: contribute
  182. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  183. .. rst-class:: classref-item-separator
  184. ----
  185. .. _class_GLTFAccessor_property_type:
  186. .. rst-class:: classref-property
  187. :ref:`int<class_int>` **type** = ``0``
  188. .. rst-class:: classref-property-setget
  189. - void **set_type** **(** :ref:`int<class_int>` value **)**
  190. - :ref:`int<class_int>` **get_type** **(** **)**
  191. .. container:: contribute
  192. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  193. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  194. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  195. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  196. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  197. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  198. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  199. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`