.. Generated automatically by doc/tools/makerst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. .. _class_ArrayMesh: ArrayMesh ========= **Inherits:** :ref:`Mesh` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description ----------------- Member Functions ---------------- +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_blend_shape` **(** :ref:`String` name **)** | +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_surface_from_arrays` **(** :ref:`int` primitive, :ref:`Array` arrays, :ref:`Array` blend_shapes=null, :ref:`int` compress_flags=null **)** | +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`center_geometry` **(** **)** | +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_blend_shapes` **(** **)** | +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_blend_shape_count` **(** **)** const | +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_blend_shape_mode` **(** **)** const | +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_blend_shape_name` **(** :ref:`int` index **)** const | +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Rect3` | :ref:`get_custom_aabb` **(** **)** const | +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_surface_count` **(** **)** const | +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`regen_normalmaps` **(** **)** | +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_blend_shape_mode` **(** :ref:`int` mode **)** | +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_custom_aabb` **(** :ref:`Rect3` aabb **)** | +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`surface_get_array_index_len` **(** :ref:`int` surf_idx **)** const | +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`surface_get_array_len` **(** :ref:`int` surf_idx **)** const | +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`surface_get_format` **(** :ref:`int` surf_idx **)** const | +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Material` | :ref:`surface_get_material` **(** :ref:`int` surf_idx **)** const | +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`surface_get_name` **(** :ref:`int` surf_idx **)** const | +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`surface_get_primitive_type` **(** :ref:`int` surf_idx **)** const | +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`surface_remove` **(** :ref:`int` surf_idx **)** | +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`surface_set_material` **(** :ref:`int` surf_idx, :ref:`Material` material **)** | +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`surface_set_name` **(** :ref:`int` surf_idx, :ref:`String` name **)** | +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- - **NO_INDEX_ARRAY** = **-1** --- Default value used for index_array_len when no indices are present. - **ARRAY_WEIGHTS_SIZE** = **4** --- Amount of weights/bone indices per vertex (always 4). - **ARRAY_VERTEX** = **0** --- Vertex array (array of :ref:`Vector3` vertices). - **ARRAY_NORMAL** = **1** --- Normal array (array of :ref:`Vector3` normals). - **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. - **ARRAY_COLOR** = **3** --- Vertex array (array of :ref:`Color` colors). - **ARRAY_TEX_UV** = **4** --- UV array (array of :ref:`Vector3` UVs or float array of groups of 2 floats (u,v)). - **ARRAY_TEX_UV2** = **5** --- Second UV array (array of :ref:`Vector3` UVs or float array of groups of 2 floats (u,v)). - **ARRAY_BONES** = **6** --- Array of bone indices, as a float array. Each element in groups of 4 floats. - **ARRAY_WEIGHTS** = **7** --- Array of bone weights, as a float array. Each element in groups of 4 floats. - **ARRAY_INDEX** = **8** --- Array of integers, used as indices referencing vertices. No index can be beyond the vertex array size. - **ARRAY_MAX** = **9** - **ARRAY_FORMAT_VERTEX** = **1** --- Array format will include vertices (mandatory). - **ARRAY_FORMAT_NORMAL** = **2** --- Array format will include normals - **ARRAY_FORMAT_TANGENT** = **4** --- Array format will include tangents - **ARRAY_FORMAT_COLOR** = **8** --- Array format will include a color array. - **ARRAY_FORMAT_TEX_UV** = **16** --- Array format will include UVs. - **ARRAY_FORMAT_TEX_UV2** = **32** --- Array format will include another set of UVs. - **ARRAY_FORMAT_BONES** = **64** --- Array format will include bone indices. - **ARRAY_FORMAT_WEIGHTS** = **128** --- Array format will include bone weights. - **ARRAY_FORMAT_INDEX** = **256** --- Index array will be used. Member Function Description --------------------------- .. _class_ArrayMesh_add_blend_shape: - void **add_blend_shape** **(** :ref:`String` name **)** .. _class_ArrayMesh_add_surface_from_arrays: - void **add_surface_from_arrays** **(** :ref:`int` primitive, :ref:`Array` arrays, :ref:`Array` blend_shapes=null, :ref:`int` compress_flags=null **)** Create a new surface (:ref:`get_surface_count` that will become surf_idx for this. 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). .. _class_ArrayMesh_center_geometry: - void **center_geometry** **(** **)** .. _class_ArrayMesh_clear_blend_shapes: - void **clear_blend_shapes** **(** **)** .. _class_ArrayMesh_get_blend_shape_count: - :ref:`int` **get_blend_shape_count** **(** **)** const .. _class_ArrayMesh_get_blend_shape_mode: - :ref:`int` **get_blend_shape_mode** **(** **)** const .. _class_ArrayMesh_get_blend_shape_name: - :ref:`String` **get_blend_shape_name** **(** :ref:`int` index **)** const .. _class_ArrayMesh_get_custom_aabb: - :ref:`Rect3` **get_custom_aabb** **(** **)** const .. _class_ArrayMesh_get_surface_count: - :ref:`int` **get_surface_count** **(** **)** const Return the amount of surfaces that the :ref:`ArrayMesh` holds. .. _class_ArrayMesh_regen_normalmaps: - void **regen_normalmaps** **(** **)** .. _class_ArrayMesh_set_blend_shape_mode: - void **set_blend_shape_mode** **(** :ref:`int` mode **)** .. _class_ArrayMesh_set_custom_aabb: - void **set_custom_aabb** **(** :ref:`Rect3` aabb **)** .. _class_ArrayMesh_surface_get_array_index_len: - :ref:`int` **surface_get_array_index_len** **(** :ref:`int` surf_idx **)** const Return the length in indices of the index array in the requested surface (see :ref:`add_surface`). .. _class_ArrayMesh_surface_get_array_len: - :ref:`int` **surface_get_array_len** **(** :ref:`int` surf_idx **)** const Return the length in vertices of the vertex array in the requested surface (see :ref:`add_surface`). .. _class_ArrayMesh_surface_get_format: - :ref:`int` **surface_get_format** **(** :ref:`int` surf_idx **)** const Return the format mask of the requested surface (see :ref:`add_surface`). .. _class_ArrayMesh_surface_get_material: - :ref:`Material` **surface_get_material** **(** :ref:`int` surf_idx **)** const Return a :ref:`Material` in a given surface. Surface is rendered using this material. .. _class_ArrayMesh_surface_get_name: - :ref:`String` **surface_get_name** **(** :ref:`int` surf_idx **)** const .. _class_ArrayMesh_surface_get_primitive_type: - :ref:`int` **surface_get_primitive_type** **(** :ref:`int` surf_idx **)** const Return the primitive type of the requested surface (see :ref:`add_surface`). .. _class_ArrayMesh_surface_remove: - void **surface_remove** **(** :ref:`int` surf_idx **)** Remove a surface at position surf_idx, shifting greater surfaces one surf_idx slot down. .. _class_ArrayMesh_surface_set_material: - void **surface_set_material** **(** :ref:`int` surf_idx, :ref:`Material` material **)** .. _class_ArrayMesh_surface_set_name: - void **surface_set_name** **(** :ref:`int` surf_idx, :ref:`String` name **)** Set a :ref:`Material` for a given surface. Surface will be rendered using this material.