| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859 |
- :github_url: hide
- .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
- .. DO NOT EDIT THIS FILE, but the MultiMeshInstance3D.xml source instead.
- .. The source is found in doc/classes or modules/<name>/doc_classes.
- .. _class_MultiMeshInstance3D:
- MultiMeshInstance3D
- ===================
- **Inherits:** :ref:`GeometryInstance3D<class_GeometryInstance3D>` **<** :ref:`VisualInstance3D<class_VisualInstance3D>` **<** :ref:`Node3D<class_Node3D>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
- Node that instances a :ref:`MultiMesh<class_MultiMesh>`.
- Description
- -----------
- ``MultiMeshInstance3D`` is a specialized node to instance :ref:`GeometryInstance3D<class_GeometryInstance3D>`\ s based on a :ref:`MultiMesh<class_MultiMesh>` resource.
- This is useful to optimize the rendering of a high amount of instances of a given mesh (for example trees in a forest or grass strands).
- Tutorials
- ---------
- - :doc:`Animating thousands of fish with MultiMeshInstance <../tutorials/performance/vertex_animation/animating_thousands_of_fish>`
- - :doc:`Using MultiMeshInstance <../tutorials/3d/using_multi_mesh_instance>`
- - :doc:`Optimization using MultiMeshes <../tutorials/performance/using_multimesh>`
- Properties
- ----------
- +-----------------------------------+----------------------------------------------------------------+
- | :ref:`MultiMesh<class_MultiMesh>` | :ref:`multimesh<class_MultiMeshInstance3D_property_multimesh>` |
- +-----------------------------------+----------------------------------------------------------------+
- Property Descriptions
- ---------------------
- .. _class_MultiMeshInstance3D_property_multimesh:
- - :ref:`MultiMesh<class_MultiMesh>` **multimesh**
- +----------+----------------------+
- | *Setter* | set_multimesh(value) |
- +----------+----------------------+
- | *Getter* | get_multimesh() |
- +----------+----------------------+
- The :ref:`MultiMesh<class_MultiMesh>` resource that will be used and shared among all instances of the ``MultiMeshInstance3D``.
- .. |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.)`
|
