MeshInstance

Inherits: GeometryInstance < VisualInstance < Spatial < Node < Object

Inherited By: SoftBody

Category: Core

Brief Description

Node that instances meshes into a scenario.

Methods

void create_convex_collision ( )
void create_debug_tangents ( )
void create_trimesh_collision ( )
Material get_surface_material ( int surface ) const
void set_surface_material ( int surface, Material material )

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 to reuse geometry and 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.

Property Descriptions

Setter set_mesh(value)
Getter get_mesh()

The Mesh resource for the instance.

Setter set_skeleton_path(value)
Getter get_skeleton_path()

NodePath to the Skeleton associated with the instance.

Method Descriptions

  • void create_convex_collision ( )

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

  • 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_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 for a surface of the Mesh resource.

  • void set_surface_material ( int surface, Material material )

Sets the Material for a surface of the Mesh resource.