Struct MeshDataTool

pub struct MeshDataTool { /* private fields */ }

Expand description

Godot class MeshDataTool.

Inherits RefCounted.

Related symbols:

mesh_data_tool: sidecar module with related enum/flag types
IMeshDataTool: virtual methods

§Construction

This class is reference-counted. You can create a new instance using MeshDataTool::new_gd().

§Godot docs

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 create_from_surface. When you are finished editing the data commit the data to a mesh with commit_to_surface.

Below is an example of how MeshDataTool may be used.

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)

See also ArrayMesh, ImmediateMesh and SurfaceTool for procedural geometry generation.

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

Implementations§

§

impl MeshDataTool

pub fn clear(&mut self)

Clears all data currently in MeshDataTool.

pub fn create_from_surface( &mut self, mesh: impl AsArg<Option<Gd<ArrayMesh>>>, surface: i32, ) -> Error

Uses specified surface of given Mesh to populate data for MeshDataTool.

Requires Mesh with primitive type PrimitiveType::TRIANGLES.

pub fn commit_to_surface( &mut self, mesh: impl AsArg<Option<Gd<ArrayMesh>>>, ) -> Error

To set the default parameters, use commit_to_surface_ex and its builder methods. See the book for detailed usage instructions. Adds a new surface to specified Mesh with edited data.

pub fn commit_to_surface_ex<'ex>( &'ex mut self, mesh: impl AsArg<Option<Gd<ArrayMesh>>> + 'ex, ) -> ExCommitToSurface<'ex>

Adds a new surface to specified Mesh with edited data.

pub fn get_format(&self) -> u64

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 3 because ArrayFormat::VERTEX is 1 and ArrayFormat::NORMAL is 2.

pub fn get_vertex_count(&self) -> i32

Returns the total number of vertices in Mesh.

pub fn get_edge_count(&self) -> i32

Returns the number of edges in this Mesh.

pub fn get_face_count(&self) -> i32

Returns the number of faces in this Mesh.

pub fn set_vertex(&mut self, idx: i32, vertex: Vector3)

Sets the position of the given vertex.

pub fn get_vertex(&self, idx: i32) -> Vector3

Returns the position of the given vertex.

pub fn set_vertex_normal(&mut self, idx: i32, normal: Vector3)

Sets the normal of the given vertex.

pub fn get_vertex_normal(&self, idx: i32) -> Vector3

Returns the normal of the given vertex.

pub fn set_vertex_tangent(&mut self, idx: i32, tangent: Plane)

Sets the tangent of the given vertex.

Note: Even though 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 -1 or 1. See also ArrayType::TANGENT.

pub fn get_vertex_tangent(&self, idx: i32) -> Plane

Returns the tangent of the given vertex.

pub fn set_vertex_uv(&mut self, idx: i32, uv: Vector2)

Sets the UV of the given vertex.

pub fn get_vertex_uv(&self, idx: i32) -> Vector2

Returns the UV of the given vertex.

pub fn set_vertex_uv2(&mut self, idx: i32, uv2: Vector2)

Sets the UV2 of the given vertex.

pub fn get_vertex_uv2(&self, idx: i32) -> Vector2

Returns the UV2 of the given vertex.

pub fn set_vertex_color(&mut self, idx: i32, color: Color)

Sets the color of the given vertex.

pub fn get_vertex_color(&self, idx: i32) -> Color

Returns the color of the given vertex.

pub fn set_vertex_bones(&mut self, idx: i32, bones: &PackedArray<i32>)

Sets the bones of the given vertex.

pub fn get_vertex_bones(&self, idx: i32) -> PackedArray<i32>

Returns the bones of the given vertex.

pub fn set_vertex_weights(&mut self, idx: i32, weights: &PackedArray<f32>)

Sets the bone weights of the given vertex.

pub fn get_vertex_weights(&self, idx: i32) -> PackedArray<f32>

Returns bone weights of the given vertex.

pub fn set_vertex_meta(&mut self, idx: i32, meta: &Variant)

Sets the metadata associated with the given vertex.

pub fn get_vertex_meta(&self, idx: i32) -> Variant

Returns the metadata associated with the given vertex.

pub fn get_vertex_edges(&self, idx: i32) -> PackedArray<i32>

Returns an array of edges that share the given vertex.

pub fn get_vertex_faces(&self, idx: i32) -> PackedArray<i32>

Returns an array of faces that share the given vertex.

pub fn get_edge_vertex(&self, idx: i32, vertex: i32) -> i32

Returns the index of the specified vertex connected to the edge at index idx.

vertex can only be 0 or 1, as edges are composed of two vertices.

pub fn get_edge_faces(&self, idx: i32) -> PackedArray<i32>

Returns array of faces that touch given edge.

pub fn set_edge_meta(&mut self, idx: i32, meta: &Variant)

Sets the metadata of the given edge.

pub fn get_edge_meta(&self, idx: i32) -> Variant

Returns meta information assigned to given edge.

pub fn get_face_vertex(&self, idx: i32, vertex: i32) -> i32

Returns the specified vertex index of the given face.

vertex must be either 0, 1, or 2 because faces contain three vertices.

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)

pub fn get_face_edge(&self, idx: i32, edge: i32) -> i32

Returns the edge associated with the face at index idx.

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

pub fn set_face_meta(&mut self, idx: i32, meta: &Variant)

Sets the metadata of the given face.

pub fn get_face_meta(&self, idx: i32) -> Variant

Returns the metadata associated with the given face.

pub fn get_face_normal(&self, idx: i32) -> Vector3

Calculates and returns the face normal of the given face.

pub fn set_material(&mut self, material: impl AsArg<Option<Gd<Material>>>)

Sets the material to be used by newly-constructed Mesh.

pub fn get_material(&self) -> Option<Gd<Material>>

Returns the material assigned to the Mesh.

Methods from Deref<Target = RefCounted>§

pub fn get_reference_count(&self) -> i32

Returns the current reference count.

Methods from Deref<Target = Object>§

pub fn get_script(&self) -> Option<Gd<Script>>

pub fn set_script(&mut self, script: impl AsArg<Option<Gd<Script>>>)

pub fn connect( &mut self, signal: impl AsArg<StringName>, callable: &Callable, ) -> Error

pub fn connect_flags( &mut self, signal: impl AsArg<StringName>, callable: &Callable, flags: ConnectFlags, ) -> Error

pub fn get_class(&self) -> GString

Returns the object’s built-in class name, as a String. See also is_class.

Note: This method ignores class_name declarations. If this object’s script has defined a class_name, the base, built-in class name is returned instead.

pub fn is_class(&self, class: impl AsArg<GString>) -> bool

Returns true if the object inherits from the given class. See also get_class.

var sprite2d = Sprite2D.new()
sprite2d.is_class("Sprite2D") # Returns true
sprite2d.is_class("Node")     # Returns true
sprite2d.is_class("Node3D")   # Returns false

Note: This method ignores class_name declarations in the object’s script.

pub fn set(&mut self, property: impl AsArg<StringName>, value: &Variant)

Assigns value to the given property. If the property does not exist or the given value’s type doesn’t match, nothing happens.

var node = Node2D.new()
node.set("global_scale", Vector2(8, 2.5))
print(node.global_scale) # Prints (8.0, 2.5)

Note: In C#, property must be in snake_case when referring to built-in Godot properties. Prefer using the names exposed in the PropertyName class to avoid allocating a new StringName on each call.

pub fn get(&self, property: impl AsArg<StringName>) -> Variant

Returns the Variant value of the given property. If the property does not exist, this method returns null.

var node = Node2D.new()
node.rotation = 1.5
var a = node.get("rotation") # a is 1.5

Note: In C#, property must be in snake_case when referring to built-in Godot properties. Prefer using the names exposed in the PropertyName class to avoid allocating a new StringName on each call.

pub fn set_indexed( &mut self, property_path: impl AsArg<NodePath>, value: &Variant, )

Assigns a new value to the property identified by the property_path. The path should be a NodePath relative to this object, and can use the colon character (:) to access nested properties.

var node = Node2D.new()
node.set_indexed("position", Vector2(42, 0))
node.set_indexed("position:y", -10)
print(node.position) # Prints (42.0, -10.0)

Note: In C#, property_path must be in snake_case when referring to built-in Godot properties. Prefer using the names exposed in the PropertyName class to avoid allocating a new StringName on each call.

pub fn get_indexed(&self, property_path: impl AsArg<NodePath>) -> Variant

Gets the object’s property indexed by the given property_path. The path should be a NodePath relative to the current object and can use the colon character (:) to access nested properties.

Examples: "position:x" or "material:next_pass:blend_mode".

var node = Node2D.new()
node.position = Vector2(5, -10)
var a = node.get_indexed("position")   # a is Vector2(5, -10)
var b = node.get_indexed("position:y") # b is -10

Note: In C#, property_path must be in snake_case when referring to built-in Godot properties. Prefer using the names exposed in the PropertyName class to avoid allocating a new StringName on each call.

Note: This method does not support actual paths to nodes in the SceneTree, only sub-property paths. In the context of nodes, use get_node_and_resource instead.

pub fn get_property_list(&self) -> Array<Dictionary<Variant, Variant>>

Returns the object’s property list as an Array of dictionaries. Each Dictionary contains the following entries:

name is the property’s name, as a String;
class_name is an empty StringName, unless the property is VariantType::OBJECT and it inherits from a class;
type is the property’s type, as an int (see [enum Variant.Type]);
hint is how the property is meant to be edited (see [enum PropertyHint]);
hint_string depends on the hint (see [enum PropertyHint]);
usage is a combination of [enum PropertyUsageFlags].

Note: In GDScript, all class members are treated as properties. In C# and GDExtension, it may be necessary to explicitly mark class members as Godot properties using decorators or attributes.

pub fn get_method_list(&self) -> Array<Dictionary<Variant, Variant>>

Returns this object’s methods and their signatures as an Array of dictionaries. Each Dictionary contains the following entries:

name is the name of the method, as a String;
args is an Array of dictionaries representing the arguments;
default_args is the default arguments as an Array of variants;
flags is a combination of [enum MethodFlags];
id is the method’s internal identifier int;
return is the returned value, as a Dictionary;

Note: The dictionaries of args and return are formatted identically to the results of get_property_list, although not all entries are used.

pub fn property_can_revert(&self, property: impl AsArg<StringName>) -> bool

Returns true if the given property has a custom default value. Use property_get_revert to get the property’s default value.

Note: This method is used by the Inspector dock to display a revert icon. The object must implement [method _property_can_revert] to customize the default value. If [method _property_can_revert] is not implemented, this method returns false.

pub fn property_get_revert(&self, property: impl AsArg<StringName>) -> Variant

Returns the custom default value of the given property. Use property_can_revert to check if the property has a custom default value.

Note: This method is used by the Inspector dock to display a revert icon. The object must implement [method _property_get_revert] to customize the default value. If [method _property_get_revert] is not implemented, this method returns null.

pub fn set_meta(&mut self, name: impl AsArg<StringName>, value: &Variant)

Adds or changes the entry name inside the object’s metadata. The metadata value can be any Variant, although some types cannot be serialized correctly.

If value is null, the entry is removed. This is the equivalent of using remove_meta. See also has_meta and get_meta.