:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/4.3/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/4.3/doc/classes/MeshInstance3D.xml. .. _class_MeshInstance3D: MeshInstance3D ============== **Inherits:** :ref:`GeometryInstance3D` **<** :ref:`VisualInstance3D` **<** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` **Inherited By:** :ref:`SoftBody3D` Node that instances meshes into a scenario. .. rst-class:: classref-introduction-group Description ----------- MeshInstance3D is a node that takes a :ref:`Mesh` resource and adds it to the current scenario by creating an instance of it. This is the class most often used render 3D geometry and can be used to instance a single :ref:`Mesh` in many places. This allows reusing geometry, which can save on resources. When a :ref:`Mesh` has to be instantiated more than thousands of times at close proximity, consider using a :ref:`MultiMesh` in a :ref:`MultiMeshInstance3D` instead. .. rst-class:: classref-introduction-group Tutorials --------- - `3D Material Testers Demo `__ - `3D Kinematic Character Demo `__ - `3D Platformer Demo `__ - `Third Person Shooter (TPS) Demo `__ .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +---------------------------------+---------------------------------------------------------+--------------------+ | :ref:`Mesh` | :ref:`mesh` | | +---------------------------------+---------------------------------------------------------+--------------------+ | :ref:`NodePath` | :ref:`skeleton` | ``NodePath("..")`` | +---------------------------------+---------------------------------------------------------+--------------------+ | :ref:`Skin` | :ref:`skin` | | +---------------------------------+---------------------------------------------------------+--------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`ArrayMesh` | :ref:`bake_mesh_from_current_blend_shape_mix`\ (\ existing\: :ref:`ArrayMesh` = null\ ) | +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`create_convex_collision`\ (\ clean\: :ref:`bool` = true, simplify\: :ref:`bool` = false\ ) | +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`create_debug_tangents`\ (\ ) | +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`create_multiple_convex_collisions`\ (\ settings\: :ref:`MeshConvexDecompositionSettings` = null\ ) | +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`create_trimesh_collision`\ (\ ) | +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`find_blend_shape_by_name`\ (\ name\: :ref:`StringName`\ ) | +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Material` | :ref:`get_active_material`\ (\ surface\: :ref:`int`\ ) |const| | +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_blend_shape_count`\ (\ ) |const| | +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_blend_shape_value`\ (\ blend_shape_idx\: :ref:`int`\ ) |const| | +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`SkinReference` | :ref:`get_skin_reference`\ (\ ) |const| | +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Material` | :ref:`get_surface_override_material`\ (\ surface\: :ref:`int`\ ) |const| | +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_surface_override_material_count`\ (\ ) |const| | +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_blend_shape_value`\ (\ blend_shape_idx\: :ref:`int`, value\: :ref:`float`\ ) | +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_surface_override_material`\ (\ surface\: :ref:`int`, material\: :ref:`Material`\ ) | +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_MeshInstance3D_property_mesh: .. rst-class:: classref-property :ref:`Mesh` **mesh** :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_mesh**\ (\ value\: :ref:`Mesh`\ ) - :ref:`Mesh` **get_mesh**\ (\ ) The :ref:`Mesh` resource for the instance. .. rst-class:: classref-item-separator ---- .. _class_MeshInstance3D_property_skeleton: .. rst-class:: classref-property :ref:`NodePath` **skeleton** = ``NodePath("..")`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_skeleton_path**\ (\ value\: :ref:`NodePath`\ ) - :ref:`NodePath` **get_skeleton_path**\ (\ ) :ref:`NodePath` to the :ref:`Skeleton3D` associated with the instance. .. rst-class:: classref-item-separator ---- .. _class_MeshInstance3D_property_skin: .. rst-class:: classref-property :ref:`Skin` **skin** :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_skin**\ (\ value\: :ref:`Skin`\ ) - :ref:`Skin` **get_skin**\ (\ ) The :ref:`Skin` to be used by this instance. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_MeshInstance3D_method_bake_mesh_from_current_blend_shape_mix: .. rst-class:: classref-method :ref:`ArrayMesh` **bake_mesh_from_current_blend_shape_mix**\ (\ existing\: :ref:`ArrayMesh` = null\ ) :ref:`🔗` Takes a snapshot from the current :ref:`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 :ref:`ArrayMesh` is created, baked and returned. Mesh surface materials are not copied. \ **Performance:** :ref:`Mesh` data needs to be received from the GPU, stalling the :ref:`RenderingServer` in the process. .. rst-class:: classref-item-separator ---- .. _class_MeshInstance3D_method_create_convex_collision: .. rst-class:: classref-method |void| **create_convex_collision**\ (\ clean\: :ref:`bool` = true, simplify\: :ref:`bool` = false\ ) :ref:`🔗` This helper creates a :ref:`StaticBody3D` child node with a :ref:`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. .. rst-class:: classref-item-separator ---- .. _class_MeshInstance3D_method_create_debug_tangents: .. rst-class:: classref-method |void| **create_debug_tangents**\ (\ ) :ref:`🔗` This helper creates a **MeshInstance3D** child node with gizmos at every vertex calculated from the mesh geometry. It's mainly used for testing. .. rst-class:: classref-item-separator ---- .. _class_MeshInstance3D_method_create_multiple_convex_collisions: .. rst-class:: classref-method |void| **create_multiple_convex_collisions**\ (\ settings\: :ref:`MeshConvexDecompositionSettings` = null\ ) :ref:`🔗` This helper creates a :ref:`StaticBody3D` child node with multiple :ref:`ConvexPolygonShape3D` collision shapes calculated from the mesh geometry via convex decomposition. The convex decomposition operation can be controlled with parameters from the optional ``settings``. .. rst-class:: classref-item-separator ---- .. _class_MeshInstance3D_method_create_trimesh_collision: .. rst-class:: classref-method |void| **create_trimesh_collision**\ (\ ) :ref:`🔗` This helper creates a :ref:`StaticBody3D` child node with a :ref:`ConcavePolygonShape3D` collision shape calculated from the mesh geometry. It's mainly used for testing. .. rst-class:: classref-item-separator ---- .. _class_MeshInstance3D_method_find_blend_shape_by_name: .. rst-class:: classref-method :ref:`int` **find_blend_shape_by_name**\ (\ name\: :ref:`StringName`\ ) :ref:`🔗` Returns the index of the blend shape with the given ``name``. Returns ``-1`` if no blend shape with this name exists, including when :ref:`mesh` is ``null``. .. rst-class:: classref-item-separator ---- .. _class_MeshInstance3D_method_get_active_material: .. rst-class:: classref-method :ref:`Material` **get_active_material**\ (\ surface\: :ref:`int`\ ) |const| :ref:`🔗` Returns the :ref:`Material` that will be used by the :ref:`Mesh` when drawing. This can return the :ref:`GeometryInstance3D.material_override`, the surface override :ref:`Material` defined in this **MeshInstance3D**, or the surface :ref:`Material` defined in the :ref:`mesh`. For example, if :ref:`GeometryInstance3D.material_override` is used, all surfaces will return the override material. Returns ``null`` if no material is active, including when :ref:`mesh` is ``null``. .. rst-class:: classref-item-separator ---- .. _class_MeshInstance3D_method_get_blend_shape_count: .. rst-class:: classref-method :ref:`int` **get_blend_shape_count**\ (\ ) |const| :ref:`🔗` Returns the number of blend shapes available. Produces an error if :ref:`mesh` is ``null``. .. rst-class:: classref-item-separator ---- .. _class_MeshInstance3D_method_get_blend_shape_value: .. rst-class:: classref-method :ref:`float` **get_blend_shape_value**\ (\ blend_shape_idx\: :ref:`int`\ ) |const| :ref:`🔗` Returns the value of the blend shape at the given ``blend_shape_idx``. Returns ``0.0`` and produces an error if :ref:`mesh` is ``null`` or doesn't have a blend shape at that index. .. rst-class:: classref-item-separator ---- .. _class_MeshInstance3D_method_get_skin_reference: .. rst-class:: classref-method :ref:`SkinReference` **get_skin_reference**\ (\ ) |const| :ref:`🔗` Returns the internal :ref:`SkinReference` containing the skeleton's :ref:`RID` attached to this RID. See also :ref:`Resource.get_rid`, :ref:`SkinReference.get_skeleton`, and :ref:`RenderingServer.instance_attach_skeleton`. .. rst-class:: classref-item-separator ---- .. _class_MeshInstance3D_method_get_surface_override_material: .. rst-class:: classref-method :ref:`Material` **get_surface_override_material**\ (\ surface\: :ref:`int`\ ) |const| :ref:`🔗` Returns the override :ref:`Material` for the specified ``surface`` of the :ref:`Mesh` resource. See also :ref:`get_surface_override_material_count`. \ **Note:** This returns the :ref:`Material` associated to the **MeshInstance3D**'s Surface Material Override properties, not the material within the :ref:`Mesh` resource. To get the material within the :ref:`Mesh` resource, use :ref:`Mesh.surface_get_material` instead. .. rst-class:: classref-item-separator ---- .. _class_MeshInstance3D_method_get_surface_override_material_count: .. rst-class:: classref-method :ref:`int` **get_surface_override_material_count**\ (\ ) |const| :ref:`🔗` Returns the number of surface override materials. This is equivalent to :ref:`Mesh.get_surface_count`. See also :ref:`get_surface_override_material`. .. rst-class:: classref-item-separator ---- .. _class_MeshInstance3D_method_set_blend_shape_value: .. rst-class:: classref-method |void| **set_blend_shape_value**\ (\ blend_shape_idx\: :ref:`int`, value\: :ref:`float`\ ) :ref:`🔗` Sets the value of the blend shape at ``blend_shape_idx`` to ``value``. Produces an error if :ref:`mesh` is ``null`` or doesn't have a blend shape at that index. .. rst-class:: classref-item-separator ---- .. _class_MeshInstance3D_method_set_surface_override_material: .. rst-class:: classref-method |void| **set_surface_override_material**\ (\ surface\: :ref:`int`, material\: :ref:`Material`\ ) :ref:`🔗` Sets the override ``material`` for the specified ``surface`` of the :ref:`Mesh` resource. This material is associated with this **MeshInstance3D** rather than with :ref:`mesh`. \ **Note:** This assigns the :ref:`Material` associated to the **MeshInstance3D**'s Surface Material Override properties, not the material within the :ref:`Mesh` resource. To set the material within the :ref:`Mesh` resource, use :ref:`Mesh.surface_get_material` instead. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` .. |void| replace:: :abbr:`void (No return value.)`