Description

MeshDataTool provides access to individual vertices in aMesh. 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 withcreate_from_surface(). When you are finished editing the data commit the data to a mesh withcommit_to_surface().

Below is an example of how MeshDataTool may be used.

varmesh=ArrayMesh.new()mesh.add_surface_from_arrays(Mesh.PRIMITIVE_TRIANGLES,BoxMesh.new().get_mesh_arrays())varmdt=MeshDataTool.new()mdt.create_from_surface(mesh,0)foriinrange(mdt.get_vertex_count()):varvertex=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)varmi=MeshInstance.new()mi.mesh=meshadd_child(mi)

varmesh=newArrayMesh();mesh.AddSurfaceFromArrays(Mesh.PrimitiveType.Triangles,newBoxMesh().GetMeshArrays());varmdt=newMeshDataTool();mdt.CreateFromSurface(mesh,0);for(vari=0;i<mdt.GetVertexCount();i++){Vector3vertex=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);varmi=newMeshInstance();mi.Mesh=mesh;AddChild(mi);

See alsoArrayMesh,ImmediateMesh andSurfaceTool for procedural geometry generation.

Note: Godot uses clockwisewinding order for front faces of triangle primitive modes.

Tutorials

• Using the MeshDataTool

Methods

Method Descriptions

voidclear()🔗

Clears all data currently in MeshDataTool.

Errorcommit_to_surface(mesh:ArrayMesh, compression_flags:int = 0)🔗

Adds a new surface to specifiedMesh with edited data.

Errorcreate_from_surface(mesh:ArrayMesh, surface:int)🔗

Uses specified surface of givenMesh to populate data for MeshDataTool.

RequiresMesh with primitive typeMesh.PRIMITIVE_TRIANGLES.

intget_edge_count()const🔗

Returns the number of edges in thisMesh.

PackedInt32Arrayget_edge_faces(idx:int)const🔗

Returns array of faces that touch given edge.

Variantget_edge_meta(idx:int)const🔗

Returns meta information assigned to given edge.

intget_edge_vertex(idx:int, vertex:int)const🔗

Returns index of specified vertex connected to given edge.

Vertex argument can only be 0 or 1 because edges are comprised of two vertices.

intget_face_count()const🔗

Returns the number of faces in thisMesh.

intget_face_edge(idx:int, edge:int)const🔗

Returns specified edge associated with given face.

Edge argument must be either 0, 1, or 2 because a face only has three edges.

Variantget_face_meta(idx:int)const🔗

Returns the metadata associated with the given face.

Vector3get_face_normal(idx:int)const🔗

Calculates and returns the face normal of the given face.

intget_face_vertex(idx:int, vertex:int)const🔗

Returns the specified vertex index of the given face.

vertex must be either0,1, or2 because faces contain three vertices.

varindex=mesh_data_tool.get_face_vertex(0,1)# Gets the index of the second vertex of the first face.varposition=mesh_data_tool.get_vertex(index)varnormal=mesh_data_tool.get_vertex_normal(index)

intindex=meshDataTool.GetFaceVertex(0,1);// Gets the index of the second vertex of the first face.Vector3position=meshDataTool.GetVertex(index);Vector3normal=meshDataTool.GetVertexNormal(index);

intget_format()const🔗

Returns theMesh's format as a combination of theArrayFormat flags. For example, a mesh containing both vertices and normals would return a format of3 becauseMesh.ARRAY_FORMAT_VERTEX is1 andMesh.ARRAY_FORMAT_NORMAL is2.

Materialget_material()const🔗

Returns the material assigned to theMesh.

Vector3get_vertex(idx:int)const🔗

Returns the position of the given vertex.

PackedInt32Arrayget_vertex_bones(idx:int)const🔗

Returns the bones of the given vertex.

Colorget_vertex_color(idx:int)const🔗

Returns the color of the given vertex.

intget_vertex_count()const🔗

Returns the total number of vertices inMesh.

PackedInt32Arrayget_vertex_edges(idx:int)const🔗

Returns an array of edges that share the given vertex.

PackedInt32Arrayget_vertex_faces(idx:int)const🔗

Returns an array of faces that share the given vertex.

Variantget_vertex_meta(idx:int)const🔗

Returns the metadata associated with the given vertex.

Vector3get_vertex_normal(idx:int)const🔗

Returns the normal of the given vertex.

Planeget_vertex_tangent(idx:int)const🔗

Returns the tangent of the given vertex.

Vector2get_vertex_uv(idx:int)const🔗

Returns the UV of the given vertex.

Vector2get_vertex_uv2(idx:int)const🔗

Returns the UV2 of the given vertex.

PackedFloat32Arrayget_vertex_weights(idx:int)const🔗

Returns bone weights of the given vertex.

voidset_edge_meta(idx:int, meta:Variant)🔗

Sets the metadata of the given edge.

voidset_face_meta(idx:int, meta:Variant)🔗

Sets the metadata of the given face.

voidset_material(material:Material)🔗

Sets the material to be used by newly-constructedMesh.

voidset_vertex(idx:int, vertex:Vector3)🔗

Sets the position of the given vertex.

voidset_vertex_bones(idx:int, bones:PackedInt32Array)🔗

Sets the bones of the given vertex.

voidset_vertex_color(idx:int, color:Color)🔗

Sets the color of the given vertex.

voidset_vertex_meta(idx:int, meta:Variant)🔗

Sets the metadata associated with the given vertex.

voidset_vertex_normal(idx:int, normal:Vector3)🔗

Sets the normal of the given vertex.

voidset_vertex_tangent(idx:int, tangent:Plane)🔗

Sets the tangent of the given vertex.

voidset_vertex_uv(idx:int, uv:Vector2)🔗

Sets the UV of the given vertex.

voidset_vertex_uv2(idx:int, uv2:Vector2)🔗

Sets the UV2 of the given vertex.

voidset_vertex_weights(idx:int, weights:PackedFloat32Array)🔗

Sets the bone weights of the given vertex.