MeshInstance

Inherits: GeometryInstance < VisualInstance < CullInstance < Spatial < Node < Object

Inherited By: SoftBody

Node that instances meshes into a scenario.

Description

MeshInstance is a node 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 get 3D geometry rendered 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 instanced more than thousands of times at close proximity, consider using a MultiMesh in a MultiMeshInstance instead.

Properties

Mesh

mesh

NodePath

skeleton

NodePath("..")

Skin

skin

bool

software_skinning_transform_normals

true

Methods

void

create_convex_collision ( bool clean=true, bool simplify=false )

void

create_debug_tangents ( )

void

create_multiple_convex_collisions ( )

void

create_trimesh_collision ( )

Material

get_active_material ( int surface ) const

Material

get_surface_material ( int surface ) const

int

get_surface_material_count ( ) const

void

set_surface_material ( int surface, Material material )

Property Descriptions

Setter

set_mesh(value)

Getter

get_mesh()

The Mesh resource for the instance.

Default

NodePath("..")

Setter

set_skeleton_path(value)

Getter

get_skeleton_path()

NodePath to the Skeleton associated with the instance.

Setter

set_skin(value)

Getter

get_skin()

Sets the skin to be used by this instance.

  • bool software_skinning_transform_normals

Default

true

Setter

set_software_skinning_transform_normals(value)

Getter

is_software_skinning_transform_normals_enabled()

If true, normals are transformed when software skinning is used. Set to false when normals are not needed for better performance.

See ProjectSettings.rendering/quality/skinning/software_skinning_fallback for details about how software skinning is enabled.

Method Descriptions

  • void create_convex_collision ( bool clean=true, bool simplify=false )

This helper creates a StaticBody child node with a ConvexPolygonShape 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 amount of vertices. Disabled by default.

  • void create_debug_tangents ( )

This helper creates a MeshInstance child node with gizmos at every vertex calculated from the mesh geometry. It's mainly used for testing.

  • void create_multiple_convex_collisions ( )

This helper creates a StaticBody child node with multiple ConvexPolygonShape collision shapes calculated from the mesh geometry via convex decomposition. It's mainly used for testing.

  • void create_trimesh_collision ( )

This helper creates a StaticBody child node with a ConcavePolygonShape collision shape calculated from the mesh geometry. It's mainly used for testing.

Returns the Material that will be used by the Mesh when drawing. This can return the GeometryInstance.material_override, the surface override Material defined in this MeshInstance, or the surface Material defined in the Mesh. For example, if GeometryInstance.material_override is used, all surfaces will return the override material.

Returns the override Material for a surface of the Mesh resource.

Note: This function only returns override materials associated with this MeshInstance. Consider using get_active_material or Mesh.surface_get_material to get materials associated with the Mesh resource.

  • int get_surface_material_count ( ) const

Returns the number of surface override materials.

  • void set_surface_material ( int surface, Material material )

Sets the override Material for the specified surface of the Mesh resource. This material is associated with this MeshInstance rather than with the Mesh resource.