MeshInstance3D
Inherits: GeometryInstance3D < VisualInstance3D < Spatial3D < Actor < Object
Inherited by: SoftBody3D
Actor that instances meshes into a scenario.
Description
Section titled “Description”MeshInstance3D is an actor that takes a Mesh resource and adds it to the current scenario by creating an instance of it. This is the class most often used to render 3D geometry and can be used to instance a single Mesh in many places. This allows reusing geometry, which can save on resources. When a Mesh has to be instantiated more than thousands of times at close proximity, consider using a MultiMesh in a MultiMeshInstance3D instead.
Properties
Section titled “Properties”| Type | Name | Default |
|---|---|---|
| Mesh | mesh | |
| NodePath | skeleton | NodePath("") |
| Skin | skin |
Methods
Section titled “Methods”| Returns | Method |
|---|---|
| ArrayMesh | bake_mesh_from_current_blend_shape_mix(existing) |
| ArrayMesh | bake_mesh_from_current_skeleton_pose(existing) |
| void | create_convex_collision(clean, simplify) |
| void | create_debug_tangents() |
| void | create_multiple_convex_collisions(settings) |
| void | create_trimesh_collision() |
| int | find_blend_shape_by_name(name) |
| MaterialInterface | get_active_material(surface) |
| int | get_blend_shape_count() |
| float | get_blend_shape_value(blend_shape_idx) |
| SkinReference | get_skin_reference() |
| MaterialInterface | get_surface_override_material(surface) |
| int | get_surface_override_material_count() |
| void | set_blend_shape_value(blend_shape_idx, value) |
| void | set_surface_override_material(surface, material) |
Property descriptions
Section titled “Property descriptions”Mesh mesh
Setter/getter: set_mesh(), get_mesh()
The Mesh resource for the instance.
skeleton
Section titled “skeleton”NodePath skeleton = NodePath("")
Setter/getter: set_skeleton_path(), get_skeleton_path()
NodePath to the Skeleton3D associated with the instance.
Skin skin
Setter/getter: set_skin(), get_skin()
The Skin to be used by this instance.
Method descriptions
Section titled “Method descriptions”bake_mesh_from_current_blend_shape_mix
Section titled “bake_mesh_from_current_blend_shape_mix”ArrayMesh bake_mesh_from_current_blend_shape_mix(existing: ArrayMesh = null)
Takes a snapshot from the current ArrayMesh with all blend shapes applied according to their current weights and bakes it to the provided existing mesh. If no existing mesh is provided a new ArrayMesh is created, baked and returned. Mesh surface materials are not copied.
Performance: Mesh data needs to be received from the GPU, stalling the Render in the process.
bake_mesh_from_current_skeleton_pose
Section titled “bake_mesh_from_current_skeleton_pose”ArrayMesh bake_mesh_from_current_skeleton_pose(existing: ArrayMesh = null)
Takes a snapshot of the current animated skeleton pose of the skinned mesh and bakes it to the provided existing mesh. If no existing mesh is provided a new ArrayMesh is created, baked, and returned. Requires a skeleton with a registered skin to work. Blendshapes are ignored. Mesh surface materials are not copied.
Performance: Mesh data needs to be retrieved from the GPU, stalling the Render in the process.
create_convex_collision
Section titled “create_convex_collision”void create_convex_collision(clean: bool = true, simplify: bool = false)
This helper creates a StaticBody3D child actor with a ConvexPolygonShape3D collision shape calculated from the mesh geometry. It’s mainly used for testing.
If clean is true (default), duplicate and interior vertices are removed automatically. You can set it to false to make the process faster if not needed.
If simplify is true, the geometry can be further simplified to reduce the number of vertices. Disabled by default.
create_debug_tangents
Section titled “create_debug_tangents”void create_debug_tangents()
This helper creates a MeshInstance3D child actor with gizmos at every vertex calculated from the mesh geometry. It’s mainly used for testing.
create_multiple_convex_collisions
Section titled “create_multiple_convex_collisions”void create_multiple_convex_collisions(settings: MeshConvexDecompositionSettings = null)
This helper creates a StaticBody3D child actor with multiple ConvexPolygonShape3D collision shapes calculated from the mesh geometry via convex decomposition. The convex decomposition operation can be controlled with parameters from the optional settings.
create_trimesh_collision
Section titled “create_trimesh_collision”void create_trimesh_collision()
This helper creates a StaticBody3D child actor with a ConcavePolygonShape3D collision shape calculated from the mesh geometry. It’s mainly used for testing.
find_blend_shape_by_name
Section titled “find_blend_shape_by_name”int find_blend_shape_by_name(name: StringName)
Returns the index of the blend shape with the given name. Returns -1 if no blend shape with this name exists, including when mesh is null.
get_active_material
Section titled “get_active_material”MaterialInterface get_active_material(surface: int) const
Returns the MaterialInterface that will be used by the Mesh when drawing. This can return the GeometryInstance3D.material_override, the surface override MaterialInterface defined in this MeshInstance3D, or the surface MaterialInterface defined in the mesh. For example, if GeometryInstance3D.material_override is used, all surfaces will return the override material.
Returns null if no material is active, including when mesh is null.
get_blend_shape_count
Section titled “get_blend_shape_count”int get_blend_shape_count() const
Returns the number of blend shapes available. Produces an error if mesh is null.
get_blend_shape_value
Section titled “get_blend_shape_value”float get_blend_shape_value(blend_shape_idx: int) const
Returns the value of the blend shape at the given blend_shape_idx. Returns 0.0 and produces an error if mesh is null or doesn’t have a blend shape at that index.
get_skin_reference
Section titled “get_skin_reference”SkinReference get_skin_reference() const
Returns the internal SkinReference containing the skeleton’s RID attached to this RID. See also Resource.get_rid(), SkinReference.get_skeleton(), and Render.instance_attach_skeleton().
get_surface_override_material
Section titled “get_surface_override_material”MaterialInterface get_surface_override_material(surface: int) const
Returns the override MaterialInterface for the specified surface of the Mesh resource. See also get_surface_override_material_count().
Note: This returns the MaterialInterface associated to the MeshInstance3D’s Surface Material Override properties, not the material within the Mesh resource. To get the material within the Mesh resource, use Mesh.surface_get_material() instead.
get_surface_override_material_count
Section titled “get_surface_override_material_count”int get_surface_override_material_count() const
Returns the number of surface override materials. This is equivalent to Mesh.get_surface_count(). See also get_surface_override_material().
set_blend_shape_value
Section titled “set_blend_shape_value”void set_blend_shape_value(blend_shape_idx: int, value: float)
Sets the value of the blend shape at blend_shape_idx to value. Produces an error if mesh is null or doesn’t have a blend shape at that index.
set_surface_override_material
Section titled “set_surface_override_material”void set_surface_override_material(surface: int, material: MaterialInterface)
Sets the override material for the specified surface of the Mesh resource. This material is associated with this MeshInstance3D rather than with mesh.
Note: This assigns the MaterialInterface associated to the MeshInstance3D’s Surface Material Override properties, not the material within the Mesh resource. To set the material within the Mesh resource, use Mesh.surface_set_material() instead.