صفحهٔ اصلی گشت‌و‌گذار راهنما
ورود
Godot
/
godot-docs
mirrorاز https://github.com/godotengine/godot-docs.git
2
0
انشعاب 0
پرونده‌ها مشکلات 0 ویکی
درخت: 30bc58bbda
شاخه‌ها تگ‌ها
godot-docs
/
classes
/
class_arraymesh.rst

class_arraymesh.rst 18 KB
تاريخچه خام

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197 
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
    2. 

  2. .. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
    3. 

  3. 

  4. .. _class_ArrayMesh:
    5. 

  5. 

  6. ArrayMesh
    7. 

  7. =========
    8. 

  8. 

  9. **Inherits:** :ref:`Mesh<class_mesh>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
    10. 

  10. 

  11. **Category:** Core
    12. 

  12. 

  13. Brief Description
    14. 

  14. -----------------
    15. 

  15. 

  16. 

  17. 

  18. Member Functions
    19. 

  19. ----------------
    20. 

  20. 

  21. +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    22. 

  22. | void                             | :ref:`add_blend_shape<class_ArrayMesh_add_blend_shape>`  **(** :ref:`String<class_string>` name  **)**                                                                                                                                           |
    23. 

  23. +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    24. 

  24. | void                             | :ref:`add_surface_from_arrays<class_ArrayMesh_add_surface_from_arrays>`  **(** :ref:`int<class_int>` primitive, :ref:`Array<class_array>` arrays, :ref:`Array<class_array>` blend_shapes=[  ], :ref:`int<class_int>` compress_flags=97792  **)** |
    25. 

  25. +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    26. 

  26. | void                             | :ref:`center_geometry<class_ArrayMesh_center_geometry>`  **(** **)**                                                                                                                                                                             |
    27. 

  27. +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    28. 

  28. | void                             | :ref:`clear_blend_shapes<class_ArrayMesh_clear_blend_shapes>`  **(** **)**                                                                                                                                                                       |
    29. 

  29. +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    30. 

  30. | :ref:`int<class_int>`            | :ref:`get_blend_shape_count<class_ArrayMesh_get_blend_shape_count>`  **(** **)** const                                                                                                                                                           |
    31. 

  31. +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    32. 

  32. | :ref:`int<class_int>`            | :ref:`get_blend_shape_mode<class_ArrayMesh_get_blend_shape_mode>`  **(** **)** const                                                                                                                                                             |
    33. 

  33. +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    34. 

  34. | :ref:`String<class_string>`      | :ref:`get_blend_shape_name<class_ArrayMesh_get_blend_shape_name>`  **(** :ref:`int<class_int>` index  **)** const                                                                                                                                |
    35. 

  35. +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    36. 

  36. | :ref:`Rect3<class_rect3>`        | :ref:`get_custom_aabb<class_ArrayMesh_get_custom_aabb>`  **(** **)** const                                                                                                                                                                       |
    37. 

  37. +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    38. 

  38. | :ref:`int<class_int>`            | :ref:`get_surface_count<class_ArrayMesh_get_surface_count>`  **(** **)** const                                                                                                                                                                   |
    39. 

  39. +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    40. 

  40. | void                             | :ref:`regen_normalmaps<class_ArrayMesh_regen_normalmaps>`  **(** **)**                                                                                                                                                                           |
    41. 

  41. +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    42. 

  42. | void                             | :ref:`set_blend_shape_mode<class_ArrayMesh_set_blend_shape_mode>`  **(** :ref:`int<class_int>` mode  **)**                                                                                                                                       |
    43. 

  43. +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    44. 

  44. | void                             | :ref:`set_custom_aabb<class_ArrayMesh_set_custom_aabb>`  **(** :ref:`Rect3<class_rect3>` aabb  **)**                                                                                                                                             |
    45. 

  45. +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    46. 

  46. | :ref:`int<class_int>`            | :ref:`surface_get_array_index_len<class_ArrayMesh_surface_get_array_index_len>`  **(** :ref:`int<class_int>` surf_idx  **)** const                                                                                                               |
    47. 

  47. +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    48. 

  48. | :ref:`int<class_int>`            | :ref:`surface_get_array_len<class_ArrayMesh_surface_get_array_len>`  **(** :ref:`int<class_int>` surf_idx  **)** const                                                                                                                           |
    49. 

  49. +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    50. 

  50. | :ref:`int<class_int>`            | :ref:`surface_get_format<class_ArrayMesh_surface_get_format>`  **(** :ref:`int<class_int>` surf_idx  **)** const                                                                                                                                 |
    51. 

  51. +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    52. 

  52. | :ref:`Material<class_material>`  | :ref:`surface_get_material<class_ArrayMesh_surface_get_material>`  **(** :ref:`int<class_int>` surf_idx  **)** const                                                                                                                             |
    53. 

  53. +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    54. 

  54. | :ref:`String<class_string>`      | :ref:`surface_get_name<class_ArrayMesh_surface_get_name>`  **(** :ref:`int<class_int>` surf_idx  **)** const                                                                                                                                     |
    55. 

  55. +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    56. 

  56. | :ref:`int<class_int>`            | :ref:`surface_get_primitive_type<class_ArrayMesh_surface_get_primitive_type>`  **(** :ref:`int<class_int>` surf_idx  **)** const                                                                                                                 |
    57. 

  57. +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    58. 

  58. | void                             | :ref:`surface_remove<class_ArrayMesh_surface_remove>`  **(** :ref:`int<class_int>` surf_idx  **)**                                                                                                                                               |
    59. 

  59. +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    60. 

  60. | void                             | :ref:`surface_set_material<class_ArrayMesh_surface_set_material>`  **(** :ref:`int<class_int>` surf_idx, :ref:`Material<class_material>` material  **)**                                                                                         |
    61. 

  61. +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    62. 

  62. | void                             | :ref:`surface_set_name<class_ArrayMesh_surface_set_name>`  **(** :ref:`int<class_int>` surf_idx, :ref:`String<class_string>` name  **)**                                                                                                         |
    63. 

  63. +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    64. 

  64. 

  65. Numeric Constants
    66. 

  66. -----------------
    67. 

  67. 

  68. - **NO_INDEX_ARRAY** = **-1** --- Default value used for index_array_len when no indices are present.
    69. 

  69. - **ARRAY_WEIGHTS_SIZE** = **4** --- Amount of weights/bone indices per vertex (always 4).
    70. 

  70. - **ARRAY_VERTEX** = **0** --- Vertex array (array of :ref:`Vector3<class_vector3>` vertices).
    71. 

  71. - **ARRAY_NORMAL** = **1** --- Normal array (array of :ref:`Vector3<class_vector3>` normals).
    72. 

  72. - **ARRAY_TANGENT** = **2** --- Tangent array, array of groups of 4 floats. first 3 floats determine the tangent, and the last the binormal direction as -1 or 1.
    73. 

  73. - **ARRAY_COLOR** = **3** --- Vertex array (array of :ref:`Color<class_color>` colors).
    74. 

  74. - **ARRAY_TEX_UV** = **4** --- UV array (array of :ref:`Vector3<class_vector3>` UVs or float array of groups of 2 floats (u,v)).
    75. 

  75. - **ARRAY_TEX_UV2** = **5** --- Second UV array (array of :ref:`Vector3<class_vector3>` UVs or float array of groups of 2 floats (u,v)).
    76. 

  76. - **ARRAY_BONES** = **6** --- Array of bone indices, as a float array. Each element in groups of 4 floats.
    77. 

  77. - **ARRAY_WEIGHTS** = **7** --- Array of bone weights, as a float array. Each element in groups of 4 floats.
    78. 

  78. - **ARRAY_INDEX** = **8** --- Array of integers, used as indices referencing vertices. No index can be beyond the vertex array size.
    79. 

  79. - **ARRAY_MAX** = **9**
    80. 

  80. - **ARRAY_FORMAT_VERTEX** = **1** --- Array format will include vertices (mandatory).
    81. 

  81. - **ARRAY_FORMAT_NORMAL** = **2** --- Array format will include normals
    82. 

  82. - **ARRAY_FORMAT_TANGENT** = **4** --- Array format will include tangents
    83. 

  83. - **ARRAY_FORMAT_COLOR** = **8** --- Array format will include a color array.
    84. 

  84. - **ARRAY_FORMAT_TEX_UV** = **16** --- Array format will include UVs.
    85. 

  85. - **ARRAY_FORMAT_TEX_UV2** = **32** --- Array format will include another set of UVs.
    86. 

  86. - **ARRAY_FORMAT_BONES** = **64** --- Array format will include bone indices.
    87. 

  87. - **ARRAY_FORMAT_WEIGHTS** = **128** --- Array format will include bone weights.
    88. 

  88. - **ARRAY_FORMAT_INDEX** = **256** --- Index array will be used.
    89. 

  89. 

  90. Member Function Description
    91. 

  91. ---------------------------
    92. 

  92. 

  93. .. _class_ArrayMesh_add_blend_shape:
    94. 

  94. 

  95. - void  **add_blend_shape**  **(** :ref:`String<class_string>` name  **)**
    96. 

  96. 

  97. .. _class_ArrayMesh_add_surface_from_arrays:
    98. 

  98. 

  99. - void  **add_surface_from_arrays**  **(** :ref:`int<class_int>` primitive, :ref:`Array<class_array>` arrays, :ref:`Array<class_array>` blend_shapes=[  ], :ref:`int<class_int>` compress_flags=97792  **)**
    100. 

  100. 

  101. Create a new surface (:ref:`get_surface_count<class_ArrayMesh_get_surface_count>` that will become surf_idx for this.
    102. 

  102. 

  103. Surfaces are created to be rendered using a "primitive", which may be PRIMITIVE_POINTS, PRIMITIVE_LINES, PRIMITIVE_LINE_STRIP, PRIMITIVE_LINE_LOOP, PRIMITIVE_TRIANGLES, PRIMITIVE_TRIANGLE_STRIP, PRIMITIVE_TRIANGLE_FAN. (As a note, when using indices, it is recommended to only use just points, lines or triangles).
    104. 

  104. 

  105. .. _class_ArrayMesh_center_geometry:
    106. 

  106. 

  107. - void  **center_geometry**  **(** **)**
    108. 

  108. 

  109. .. _class_ArrayMesh_clear_blend_shapes:
    110. 

  110. 

  111. - void  **clear_blend_shapes**  **(** **)**
    112. 

  112. 

  113. .. _class_ArrayMesh_get_blend_shape_count:
    114. 

  114. 

  115. - :ref:`int<class_int>`  **get_blend_shape_count**  **(** **)** const
    116. 

  116. 

  117. .. _class_ArrayMesh_get_blend_shape_mode:
    118. 

  118. 

  119. - :ref:`int<class_int>`  **get_blend_shape_mode**  **(** **)** const
    120. 

  120. 

  121. .. _class_ArrayMesh_get_blend_shape_name:
    122. 

  122. 

  123. - :ref:`String<class_string>`  **get_blend_shape_name**  **(** :ref:`int<class_int>` index  **)** const
    124. 

  124. 

  125. .. _class_ArrayMesh_get_custom_aabb:
    126. 

  126. 

  127. - :ref:`Rect3<class_rect3>`  **get_custom_aabb**  **(** **)** const
    128. 

  128. 

  129. .. _class_ArrayMesh_get_surface_count:
    130. 

  130. 

  131. - :ref:`int<class_int>`  **get_surface_count**  **(** **)** const
    132. 

  132. 

  133. Return the amount of surfaces that the :ref:`ArrayMesh<class_arraymesh>` holds.
    134. 

  134. 

  135. .. _class_ArrayMesh_regen_normalmaps:
    136. 

  136. 

  137. - void  **regen_normalmaps**  **(** **)**
    138. 

  138. 

  139. .. _class_ArrayMesh_set_blend_shape_mode:
    140. 

  140. 

  141. - void  **set_blend_shape_mode**  **(** :ref:`int<class_int>` mode  **)**
    142. 

  142. 

  143. .. _class_ArrayMesh_set_custom_aabb:
    144. 

  144. 

  145. - void  **set_custom_aabb**  **(** :ref:`Rect3<class_rect3>` aabb  **)**
    146. 

  146. 

  147. .. _class_ArrayMesh_surface_get_array_index_len:
    148. 

  148. 

  149. - :ref:`int<class_int>`  **surface_get_array_index_len**  **(** :ref:`int<class_int>` surf_idx  **)** const
    150. 

  150. 

  151. Return the length in indices of the index array in the requested surface (see :ref:`add_surface<class_ArrayMesh_add_surface>`).
    152. 

  152. 

  153. .. _class_ArrayMesh_surface_get_array_len:
    154. 

  154. 

  155. - :ref:`int<class_int>`  **surface_get_array_len**  **(** :ref:`int<class_int>` surf_idx  **)** const
    156. 

  156. 

  157. Return the length in vertices of the vertex array in the requested surface (see :ref:`add_surface<class_ArrayMesh_add_surface>`).
    158. 

  158. 

  159. .. _class_ArrayMesh_surface_get_format:
    160. 

  160. 

  161. - :ref:`int<class_int>`  **surface_get_format**  **(** :ref:`int<class_int>` surf_idx  **)** const
    162. 

  162. 

  163. Return the format mask of the requested surface (see :ref:`add_surface<class_ArrayMesh_add_surface>`).
    164. 

  164. 

  165. .. _class_ArrayMesh_surface_get_material:
    166. 

  166. 

  167. - :ref:`Material<class_material>`  **surface_get_material**  **(** :ref:`int<class_int>` surf_idx  **)** const
    168. 

  168. 

  169. Return a :ref:`Material<class_material>` in a given surface. Surface is rendered using this material.
    170. 

  170. 

  171. .. _class_ArrayMesh_surface_get_name:
    172. 

  172. 

  173. - :ref:`String<class_string>`  **surface_get_name**  **(** :ref:`int<class_int>` surf_idx  **)** const
    174. 

  174. 

  175. .. _class_ArrayMesh_surface_get_primitive_type:
    176. 

  176. 

  177. - :ref:`int<class_int>`  **surface_get_primitive_type**  **(** :ref:`int<class_int>` surf_idx  **)** const
    178. 

  178. 

  179. Return the primitive type of the requested surface (see :ref:`add_surface<class_ArrayMesh_add_surface>`).
    180. 

  180. 

  181. .. _class_ArrayMesh_surface_remove:
    182. 

  182. 

  183. - void  **surface_remove**  **(** :ref:`int<class_int>` surf_idx  **)**
    184. 

  184. 

  185. Remove a surface at position surf_idx, shifting greater surfaces one surf_idx slot down.
    186. 

  186. 

  187. .. _class_ArrayMesh_surface_set_material:
    188. 

  188. 

  189. - void  **surface_set_material**  **(** :ref:`int<class_int>` surf_idx, :ref:`Material<class_material>` material  **)**
    190. 

  190. 

  191. .. _class_ArrayMesh_surface_set_name:
    192. 

  192. 

  193. - void  **surface_set_name**  **(** :ref:`int<class_int>` surf_idx, :ref:`String<class_string>` name  **)**
    194. 

  194. 

  195. Set a :ref:`Material<class_material>` for a given surface. Surface will be rendered using this material.
    196. 

  196. 

  197.