class_gltfaccessor.rst 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252
  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. Properties
  11. ----------
  12. +-----------------------------------------------------+-------------------------------------------------------------------------------------------------+--------------------------+
  13. | :ref:`int<class_int>` | :ref:`buffer_view<class_GLTFAccessor_property_buffer_view>` | ``0`` |
  14. +-----------------------------------------------------+-------------------------------------------------------------------------------------------------+--------------------------+
  15. | :ref:`int<class_int>` | :ref:`byte_offset<class_GLTFAccessor_property_byte_offset>` | ``0`` |
  16. +-----------------------------------------------------+-------------------------------------------------------------------------------------------------+--------------------------+
  17. | :ref:`int<class_int>` | :ref:`component_type<class_GLTFAccessor_property_component_type>` | ``0`` |
  18. +-----------------------------------------------------+-------------------------------------------------------------------------------------------------+--------------------------+
  19. | :ref:`int<class_int>` | :ref:`count<class_GLTFAccessor_property_count>` | ``0`` |
  20. +-----------------------------------------------------+-------------------------------------------------------------------------------------------------+--------------------------+
  21. | :ref:`PackedFloat64Array<class_PackedFloat64Array>` | :ref:`max<class_GLTFAccessor_property_max>` | ``PackedFloat64Array()`` |
  22. +-----------------------------------------------------+-------------------------------------------------------------------------------------------------+--------------------------+
  23. | :ref:`PackedFloat64Array<class_PackedFloat64Array>` | :ref:`min<class_GLTFAccessor_property_min>` | ``PackedFloat64Array()`` |
  24. +-----------------------------------------------------+-------------------------------------------------------------------------------------------------+--------------------------+
  25. | :ref:`bool<class_bool>` | :ref:`normalized<class_GLTFAccessor_property_normalized>` | ``false`` |
  26. +-----------------------------------------------------+-------------------------------------------------------------------------------------------------+--------------------------+
  27. | :ref:`int<class_int>` | :ref:`sparse_count<class_GLTFAccessor_property_sparse_count>` | ``0`` |
  28. +-----------------------------------------------------+-------------------------------------------------------------------------------------------------+--------------------------+
  29. | :ref:`int<class_int>` | :ref:`sparse_indices_buffer_view<class_GLTFAccessor_property_sparse_indices_buffer_view>` | ``0`` |
  30. +-----------------------------------------------------+-------------------------------------------------------------------------------------------------+--------------------------+
  31. | :ref:`int<class_int>` | :ref:`sparse_indices_byte_offset<class_GLTFAccessor_property_sparse_indices_byte_offset>` | ``0`` |
  32. +-----------------------------------------------------+-------------------------------------------------------------------------------------------------+--------------------------+
  33. | :ref:`int<class_int>` | :ref:`sparse_indices_component_type<class_GLTFAccessor_property_sparse_indices_component_type>` | ``0`` |
  34. +-----------------------------------------------------+-------------------------------------------------------------------------------------------------+--------------------------+
  35. | :ref:`int<class_int>` | :ref:`sparse_values_buffer_view<class_GLTFAccessor_property_sparse_values_buffer_view>` | ``0`` |
  36. +-----------------------------------------------------+-------------------------------------------------------------------------------------------------+--------------------------+
  37. | :ref:`int<class_int>` | :ref:`sparse_values_byte_offset<class_GLTFAccessor_property_sparse_values_byte_offset>` | ``0`` |
  38. +-----------------------------------------------------+-------------------------------------------------------------------------------------------------+--------------------------+
  39. | :ref:`int<class_int>` | :ref:`type<class_GLTFAccessor_property_type>` | ``0`` |
  40. +-----------------------------------------------------+-------------------------------------------------------------------------------------------------+--------------------------+
  41. Property Descriptions
  42. ---------------------
  43. .. _class_GLTFAccessor_property_buffer_view:
  44. - :ref:`int<class_int>` **buffer_view**
  45. +-----------+------------------------+
  46. | *Default* | ``0`` |
  47. +-----------+------------------------+
  48. | *Setter* | set_buffer_view(value) |
  49. +-----------+------------------------+
  50. | *Getter* | get_buffer_view() |
  51. +-----------+------------------------+
  52. ----
  53. .. _class_GLTFAccessor_property_byte_offset:
  54. - :ref:`int<class_int>` **byte_offset**
  55. +-----------+------------------------+
  56. | *Default* | ``0`` |
  57. +-----------+------------------------+
  58. | *Setter* | set_byte_offset(value) |
  59. +-----------+------------------------+
  60. | *Getter* | get_byte_offset() |
  61. +-----------+------------------------+
  62. ----
  63. .. _class_GLTFAccessor_property_component_type:
  64. - :ref:`int<class_int>` **component_type**
  65. +-----------+---------------------------+
  66. | *Default* | ``0`` |
  67. +-----------+---------------------------+
  68. | *Setter* | set_component_type(value) |
  69. +-----------+---------------------------+
  70. | *Getter* | get_component_type() |
  71. +-----------+---------------------------+
  72. ----
  73. .. _class_GLTFAccessor_property_count:
  74. - :ref:`int<class_int>` **count**
  75. +-----------+------------------+
  76. | *Default* | ``0`` |
  77. +-----------+------------------+
  78. | *Setter* | set_count(value) |
  79. +-----------+------------------+
  80. | *Getter* | get_count() |
  81. +-----------+------------------+
  82. ----
  83. .. _class_GLTFAccessor_property_max:
  84. - :ref:`PackedFloat64Array<class_PackedFloat64Array>` **max**
  85. +-----------+--------------------------+
  86. | *Default* | ``PackedFloat64Array()`` |
  87. +-----------+--------------------------+
  88. | *Setter* | set_max(value) |
  89. +-----------+--------------------------+
  90. | *Getter* | get_max() |
  91. +-----------+--------------------------+
  92. ----
  93. .. _class_GLTFAccessor_property_min:
  94. - :ref:`PackedFloat64Array<class_PackedFloat64Array>` **min**
  95. +-----------+--------------------------+
  96. | *Default* | ``PackedFloat64Array()`` |
  97. +-----------+--------------------------+
  98. | *Setter* | set_min(value) |
  99. +-----------+--------------------------+
  100. | *Getter* | get_min() |
  101. +-----------+--------------------------+
  102. ----
  103. .. _class_GLTFAccessor_property_normalized:
  104. - :ref:`bool<class_bool>` **normalized**
  105. +-----------+-----------------------+
  106. | *Default* | ``false`` |
  107. +-----------+-----------------------+
  108. | *Setter* | set_normalized(value) |
  109. +-----------+-----------------------+
  110. | *Getter* | get_normalized() |
  111. +-----------+-----------------------+
  112. ----
  113. .. _class_GLTFAccessor_property_sparse_count:
  114. - :ref:`int<class_int>` **sparse_count**
  115. +-----------+-------------------------+
  116. | *Default* | ``0`` |
  117. +-----------+-------------------------+
  118. | *Setter* | set_sparse_count(value) |
  119. +-----------+-------------------------+
  120. | *Getter* | get_sparse_count() |
  121. +-----------+-------------------------+
  122. ----
  123. .. _class_GLTFAccessor_property_sparse_indices_buffer_view:
  124. - :ref:`int<class_int>` **sparse_indices_buffer_view**
  125. +-----------+---------------------------------------+
  126. | *Default* | ``0`` |
  127. +-----------+---------------------------------------+
  128. | *Setter* | set_sparse_indices_buffer_view(value) |
  129. +-----------+---------------------------------------+
  130. | *Getter* | get_sparse_indices_buffer_view() |
  131. +-----------+---------------------------------------+
  132. ----
  133. .. _class_GLTFAccessor_property_sparse_indices_byte_offset:
  134. - :ref:`int<class_int>` **sparse_indices_byte_offset**
  135. +-----------+---------------------------------------+
  136. | *Default* | ``0`` |
  137. +-----------+---------------------------------------+
  138. | *Setter* | set_sparse_indices_byte_offset(value) |
  139. +-----------+---------------------------------------+
  140. | *Getter* | get_sparse_indices_byte_offset() |
  141. +-----------+---------------------------------------+
  142. ----
  143. .. _class_GLTFAccessor_property_sparse_indices_component_type:
  144. - :ref:`int<class_int>` **sparse_indices_component_type**
  145. +-----------+------------------------------------------+
  146. | *Default* | ``0`` |
  147. +-----------+------------------------------------------+
  148. | *Setter* | set_sparse_indices_component_type(value) |
  149. +-----------+------------------------------------------+
  150. | *Getter* | get_sparse_indices_component_type() |
  151. +-----------+------------------------------------------+
  152. ----
  153. .. _class_GLTFAccessor_property_sparse_values_buffer_view:
  154. - :ref:`int<class_int>` **sparse_values_buffer_view**
  155. +-----------+--------------------------------------+
  156. | *Default* | ``0`` |
  157. +-----------+--------------------------------------+
  158. | *Setter* | set_sparse_values_buffer_view(value) |
  159. +-----------+--------------------------------------+
  160. | *Getter* | get_sparse_values_buffer_view() |
  161. +-----------+--------------------------------------+
  162. ----
  163. .. _class_GLTFAccessor_property_sparse_values_byte_offset:
  164. - :ref:`int<class_int>` **sparse_values_byte_offset**
  165. +-----------+--------------------------------------+
  166. | *Default* | ``0`` |
  167. +-----------+--------------------------------------+
  168. | *Setter* | set_sparse_values_byte_offset(value) |
  169. +-----------+--------------------------------------+
  170. | *Getter* | get_sparse_values_byte_offset() |
  171. +-----------+--------------------------------------+
  172. ----
  173. .. _class_GLTFAccessor_property_type:
  174. - :ref:`int<class_int>` **type**
  175. +-----------+-----------------+
  176. | *Default* | ``0`` |
  177. +-----------+-----------------+
  178. | *Setter* | set_type(value) |
  179. +-----------+-----------------+
  180. | *Getter* | get_type() |
  181. +-----------+-----------------+
  182. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  183. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  184. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  185. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  186. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  187. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`