class_gltfaccessor.rst 12 KB

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