godot/doc/classes/ArrayMesh.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="ArrayMesh" inherits="Mesh" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		[Mesh] type that provides utility for constructing a surface from arrays.
	</brief_description>
	<description>
		The [ArrayMesh] is used to construct a [Mesh] by specifying the attributes as arrays.
		The most basic example is the creation of a single triangle:
		[codeblocks]
		[gdscript]
		var vertices = PackedVector3Array()
		vertices.push_back(Vector3(0, 1, 0))
		vertices.push_back(Vector3(1, 0, 0))
		vertices.push_back(Vector3(0, 0, 1))

		# Initialize the ArrayMesh.
		var arr_mesh = ArrayMesh.new()
		var arrays = []
		arrays.resize(Mesh.ARRAY_MAX)
		arrays[Mesh.ARRAY_VERTEX] = vertices

		# Create the Mesh.
		arr_mesh.add_surface_from_arrays(Mesh.PRIMITIVE_TRIANGLES, arrays)
		var m = MeshInstance3D.new()
		m.mesh = arr_mesh
		[/gdscript]
		[csharp]
		var vertices = new Vector3[]
		{
		    new Vector3(0, 1, 0),
		    new Vector3(1, 0, 0),
		    new Vector3(0, 0, 1),
		};

		// Initialize the ArrayMesh.
		var arrMesh = new ArrayMesh();
		var arrays = new Godot.Collections.Array();
		arrays.Resize((int)Mesh.ArrayType.Max);
		arrays[(int)Mesh.ArrayType.Vertex] = vertices;

		// Create the Mesh.
		arrMesh.AddSurfaceFromArrays(Mesh.PrimitiveType.Triangles, arrays);
		var m = new MeshInstance3D();
		m.Mesh = arrMesh;
		[/csharp]
		[/codeblocks]
		The [MeshInstance3D] is ready to be added to the [SceneTree] to be shown.
		See also [ImmediateMesh], [MeshDataTool] and [SurfaceTool] for procedural geometry generation.
		[b]Note:[/b] Godot uses clockwise [url=https://learnopengl.com/Advanced-OpenGL/Face-culling]winding order[/url] for front faces of triangle primitive modes.
	</description>
	<tutorials>
		<link title="Procedural geometry using the ArrayMesh">$DOCS_URL/tutorials/3d/procedural_geometry/arraymesh.html</link>
	</tutorials>
	<methods>
		<method name="add_blend_shape">
			<return type="void" />
			<param index="0" name="name" type="StringName" />
			<description>
				Adds name for a blend shape that will be added with [method add_surface_from_arrays]. Must be called before surface is added.
			</description>
		</method>
		<method name="add_surface_from_arrays">
			<return type="void" />
			<param index="0" name="primitive" type="int" enum="Mesh.PrimitiveType" />
			<param index="1" name="arrays" type="Array" />
			<param index="2" name="blend_shapes" type="Array[]" default="[]" />
			<param index="3" name="lods" type="Dictionary" default="{}" />
			<param index="4" name="flags" type="int" enum="Mesh.ArrayFormat" default="0" />
			<description>
				Creates a new surface. [method Mesh.get_surface_count] will become the [code]surf_idx[/code] for this new surface.
				Surfaces are created to be rendered using a [param primitive], which may be any of the values defined in [enum Mesh.PrimitiveType].
				The [param arrays] argument is an array of arrays. Each of the [constant Mesh.ARRAY_MAX] elements contains an array with some of the mesh data for this surface as described by the corresponding member of [enum Mesh.ArrayType] or [code]null[/code] if it is not used by the surface. For example, [code]arrays[0][/code] is the array of vertices. That first vertex sub-array is always required; the others are optional. Adding an index array puts this surface into "index mode" where the vertex and other arrays become the sources of data and the index array defines the vertex order. All sub-arrays must have the same length as the vertex array (or be an exact multiple of the vertex array's length, when multiple elements of a sub-array correspond to a single vertex) or be empty, except for [constant Mesh.ARRAY_INDEX] if it is used.
				The [param blend_shapes] argument is an array of vertex data for each blend shape. Each element is an array of the same structure as [param arrays], but [constant Mesh.ARRAY_VERTEX], [constant Mesh.ARRAY_NORMAL], and [constant Mesh.ARRAY_TANGENT] are set if and only if they are set in [param arrays] and all other entries are [code]null[/code].
				The [param lods] argument is a dictionary with [float] keys and [PackedInt32Array] values. Each entry in the dictionary represents a LOD level of the surface, where the value is the [constant Mesh.ARRAY_INDEX] array to use for the LOD level and the key is roughly proportional to the distance at which the LOD stats being used. I.e., increasing the key of a LOD also increases the distance that the objects has to be from the camera before the LOD is used.
				The [param flags] argument is the bitwise or of, as required: One value of [enum Mesh.ArrayCustomFormat] left shifted by [code]ARRAY_FORMAT_CUSTOMn_SHIFT[/code] for each custom channel in use, [constant Mesh.ARRAY_FLAG_USE_DYNAMIC_UPDATE], [constant Mesh.ARRAY_FLAG_USE_8_BONE_WEIGHTS], or [constant Mesh.ARRAY_FLAG_USES_EMPTY_VERTEX_ARRAY].
				[b]Note:[/b] When using indices, it is recommended to only use points, lines, or triangles.
			</description>
		</method>
		<method name="clear_blend_shapes">
			<return type="void" />
			<description>
				Removes all blend shapes from this [ArrayMesh].
			</description>
		</method>
		<method name="clear_surfaces">
			<return type="void" />
			<description>
				Removes all surfaces from this [ArrayMesh].
			</description>
		</method>
		<method name="get_blend_shape_count" qualifiers="const">
			<return type="int" />
			<description>
				Returns the number of blend shapes that the [ArrayMesh] holds.
			</description>
		</method>
		<method name="get_blend_shape_name" qualifiers="const">
			<return type="StringName" />
			<param index="0" name="index" type="int" />
			<description>
				Returns the name of the blend shape at this index.
			</description>
		</method>
		<method name="lightmap_unwrap">
			<return type="int" enum="Error" />
			<param index="0" name="transform" type="Transform3D" />
			<param index="1" name="texel_size" type="float" />
			<description>
				Performs a UV unwrap on the [ArrayMesh] to prepare the mesh for lightmapping.
			</description>
		</method>
		<method name="regen_normal_maps">
			<return type="void" />
			<description>
				Regenerates tangents for each of the [ArrayMesh]'s surfaces.
			</description>
		</method>
		<method name="set_blend_shape_name">
			<return type="void" />
			<param index="0" name="index" type="int" />
			<param index="1" name="name" type="StringName" />
			<description>
				Sets the name of the blend shape at this index.
			</description>
		</method>
		<method name="surface_find_by_name" qualifiers="const">
			<return type="int" />
			<param index="0" name="name" type="String" />
			<description>
				Returns the index of the first surface with this name held within this [ArrayMesh]. If none are found, -1 is returned.
			</description>
		</method>
		<method name="surface_get_array_index_len" qualifiers="const">
			<return type="int" />
			<param index="0" name="surf_idx" type="int" />
			<description>
				Returns the length in indices of the index array in the requested surface (see [method add_surface_from_arrays]).
			</description>
		</method>
		<method name="surface_get_array_len" qualifiers="const">
			<return type="int" />
			<param index="0" name="surf_idx" type="int" />
			<description>
				Returns the length in vertices of the vertex array in the requested surface (see [method add_surface_from_arrays]).
			</description>
		</method>
		<method name="surface_get_format" qualifiers="const">
			<return type="int" enum="Mesh.ArrayFormat" />
			<param index="0" name="surf_idx" type="int" />
			<description>
				Returns the format mask of the requested surface (see [method add_surface_from_arrays]).
			</description>
		</method>
		<method name="surface_get_name" qualifiers="const">
			<return type="String" />
			<param index="0" name="surf_idx" type="int" />
			<description>
				Gets the name assigned to this surface.
			</description>
		</method>
		<method name="surface_get_primitive_type" qualifiers="const">
			<return type="int" enum="Mesh.PrimitiveType" />
			<param index="0" name="surf_idx" type="int" />
			<description>
				Returns the primitive type of the requested surface (see [method add_surface_from_arrays]).
			</description>
		</method>
		<method name="surface_set_name">
			<return type="void" />
			<param index="0" name="surf_idx" type="int" />
			<param index="1" name="name" type="String" />
			<description>
				Sets a name for a given surface.
			</description>
		</method>
		<method name="surface_update_attribute_region">
			<return type="void" />
			<param index="0" name="surf_idx" type="int" />
			<param index="1" name="offset" type="int" />
			<param index="2" name="data" type="PackedByteArray" />
			<description>
			</description>
		</method>
		<method name="surface_update_skin_region">
			<return type="void" />
			<param index="0" name="surf_idx" type="int" />
			<param index="1" name="offset" type="int" />
			<param index="2" name="data" type="PackedByteArray" />
			<description>
			</description>
		</method>
		<method name="surface_update_vertex_region">
			<return type="void" />
			<param index="0" name="surf_idx" type="int" />
			<param index="1" name="offset" type="int" />
			<param index="2" name="data" type="PackedByteArray" />
			<description>
			</description>
		</method>
	</methods>
	<members>
		<member name="blend_shape_mode" type="int" setter="set_blend_shape_mode" getter="get_blend_shape_mode" enum="Mesh.BlendShapeMode" default="1">
			Sets the blend shape mode to one of [enum Mesh.BlendShapeMode].
		</member>
		<member name="custom_aabb" type="AABB" setter="set_custom_aabb" getter="get_custom_aabb" default="AABB(0, 0, 0, 0, 0, 0)">
			Overrides the [AABB] with one defined by user for use with frustum culling. Especially useful to avoid unexpected culling when using a shader to offset vertices.
		</member>
		<member name="shadow_mesh" type="ArrayMesh" setter="set_shadow_mesh" getter="get_shadow_mesh">
		</member>
	</members>
</class>