Helper tool to access and edit [Mesh] data.
MeshDataTool provides access to individual vertices in a [Mesh]. It allows users to read and edit vertex data of meshes. It also creates an array of faces and edges. To use MeshDataTool, load a mesh with [method create_from_surface]. When you are finished editing the data commit the data to a mesh with [method commit_to_surface]. Below is an example of how MeshDataTool may be used. [codeblocks] [gdscript] var mesh = ArrayMesh.new() mesh.add_surface_from_arrays(Mesh.PRIMITIVE_TRIANGLES, BoxMesh.new().get_mesh_arrays()) var mdt = MeshDataTool.new() mdt.create_from_surface(mesh, 0) for i in range(mdt.get_vertex_count()): var vertex = mdt.get_vertex(i) # In this example we extend the mesh by one unit, which results in separated faces as it is flat shaded. vertex += mdt.get_vertex_normal(i) # Save your change. mdt.set_vertex(i, vertex) mesh.clear_surfaces() mdt.commit_to_surface(mesh) var mi = MeshInstance.new() mi.mesh = mesh add_child(mi) [/gdscript] [csharp] var mesh = new ArrayMesh(); mesh.AddSurfaceFromArrays(Mesh.PrimitiveType.Triangles, new BoxMesh().GetMeshArrays()); var mdt = new MeshDataTool(); mdt.CreateFromSurface(mesh, 0); for (var i = 0; i < mdt.GetVertexCount(); i++) { Vector3 vertex = mdt.GetVertex(i); // In this example we extend the mesh by one unit, which results in separated faces as it is flat shaded. vertex += mdt.GetVertexNormal(i); // Save your change. mdt.SetVertex(i, vertex); } mesh.ClearSurfaces(); mdt.CommitToSurface(mesh); var mi = new MeshInstance(); mi.Mesh = mesh; AddChild(mi); [/csharp] [/codeblocks] See also [ArrayMesh], [ImmediateMesh] 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.
$DOCS_URL/tutorials/3d/procedural_geometry/meshdatatool.html
Clears all data currently in MeshDataTool.
Adds a new surface to specified [Mesh] with edited data.
Uses specified surface of given [Mesh] to populate data for MeshDataTool. Requires [Mesh] with primitive type [constant Mesh.PRIMITIVE_TRIANGLES].
Returns the number of edges in this [Mesh].
Returns array of faces that touch given edge.
Returns meta information assigned to given edge.
Returns the index of the specified [param vertex] connected to the edge at index [param idx]. [param vertex] can only be [code]0[/code] or [code]1[/code], as edges are composed of two vertices.
Returns the number of faces in this [Mesh].
Returns the edge associated with the face at index [param idx]. [param edge] argument must be either [code]0[/code], [code]1[/code], or [code]2[/code] because a face only has three edges.
Returns the metadata associated with the given face.
Calculates and returns the face normal of the given face.
Returns the specified vertex index of the given face. [param vertex] must be either [code]0[/code], [code]1[/code], or [code]2[/code] because faces contain three vertices. [codeblocks] [gdscript] var index = mesh_data_tool.get_face_vertex(0, 1) # Gets the index of the second vertex of the first face. var position = mesh_data_tool.get_vertex(index) var normal = mesh_data_tool.get_vertex_normal(index) [/gdscript] [csharp] int index = meshDataTool.GetFaceVertex(0, 1); // Gets the index of the second vertex of the first face. Vector3 position = meshDataTool.GetVertex(index); Vector3 normal = meshDataTool.GetVertexNormal(index); [/csharp] [/codeblocks]
Returns the [Mesh]'s format as a combination of the [enum Mesh.ArrayFormat] flags. For example, a mesh containing both vertices and normals would return a format of [code]3[/code] because [constant Mesh.ARRAY_FORMAT_VERTEX] is [code]1[/code] and [constant Mesh.ARRAY_FORMAT_NORMAL] is [code]2[/code].
Returns the material assigned to the [Mesh].
Returns the position of the given vertex.
Returns the bones of the given vertex.
Returns the color of the given vertex.
Returns the total number of vertices in [Mesh].
Returns an array of edges that share the given vertex.
Returns an array of faces that share the given vertex.
Returns the metadata associated with the given vertex.
Returns the normal of the given vertex.
Returns the tangent of the given vertex.
Returns the UV of the given vertex.
Returns the UV2 of the given vertex.
Returns bone weights of the given vertex.
Sets the metadata of the given edge.
Sets the metadata of the given face.
Sets the material to be used by newly-constructed [Mesh].
Sets the position of the given vertex.
Sets the bones of the given vertex.
Sets the color of the given vertex.
Sets the metadata associated with the given vertex.
Sets the normal of the given vertex.
Sets the tangent of the given vertex. [b]Note:[/b] Even though [param tangent] is a [Plane], it does not directly represent the tangent plane. Its [member Plane.x], [member Plane.y], and [member Plane.z] represent the tangent vector and [member Plane.d] should be either [code]-1[/code] or [code]1[/code]. See also [constant Mesh.ARRAY_TANGENT].
Sets the UV of the given vertex.
Sets the UV2 of the given vertex.
Sets the bone weights of the given vertex.