Struct MeshInstance
Node that instances meshes into a scenario.
struct MeshInstance
;
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.
Properties
| Name | Type | Description |
|---|---|---|
mesh[get, set]
|
Mesh | The Mesh resource for the instance.
|
skeleton[get, set]
|
NodePath | NodePath to the Skeleton associated with the instance.
|
skin[get, set]
|
Skin | Sets the skin to be used by this instance. |
Methods
| Name | Description |
|---|---|
_meshChanged
|
|
createConvexCollision
|
This helper creates a StaticBody child node with a ConvexPolygonShape collision shape calculated from the mesh geometry. It's mainly used for testing.
|
createDebugTangents
|
This helper creates a MeshInstance child node with gizmos at every vertex calculated from the mesh geometry. It's mainly used for testing.
|
createTrimeshCollision
|
This helper creates a StaticBody child node with a ConcavePolygonShape collision shape calculated from the mesh geometry. It's mainly used for testing.
|
getMesh
|
|
getSkeletonPath
|
|
getSkin
|
|
getSurfaceMaterial
|
Returns the Material for a surface of the Mesh resource.
|
getSurfaceMaterialCount
|
Returns the number of surface materials. |
setMesh
|
|
setSkeletonPath
|
|
setSkin
|
|
setSurfaceMaterial
|
Sets the Material for a surface of the Mesh resource.
|