| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697 |
- :github_url: hide
- .. DO NOT EDIT THIS FILE!!!
- .. Generated automatically from Godot engine sources.
- .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
- .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/MeshInstance2D.xml.
- .. _class_MeshInstance2D:
- MeshInstance2D
- ==============
- **Inherits:** :ref:`Node2D<class_Node2D>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
- Node used for displaying a :ref:`Mesh<class_Mesh>` in 2D.
- Description
- -----------
- Node used for displaying a :ref:`Mesh<class_Mesh>` in 2D. A ``MeshInstance2D`` can be automatically created from an existing :ref:`Sprite2D<class_Sprite2D>` via a tool in the editor toolbar. Select the :ref:`Sprite2D<class_Sprite2D>` node, then choose **Sprite2D > Convert to MeshInstance2D** at the top of the 2D editor viewport.
- Tutorials
- ---------
- - :doc:`2D meshes <../tutorials/2d/2d_meshes>`
- Properties
- ----------
- +-----------------------------------+-------------------------------------------------------------+
- | :ref:`Mesh<class_Mesh>` | :ref:`mesh<class_MeshInstance2D_property_mesh>` |
- +-----------------------------------+-------------------------------------------------------------+
- | :ref:`Texture2D<class_Texture2D>` | :ref:`normal_map<class_MeshInstance2D_property_normal_map>` |
- +-----------------------------------+-------------------------------------------------------------+
- | :ref:`Texture2D<class_Texture2D>` | :ref:`texture<class_MeshInstance2D_property_texture>` |
- +-----------------------------------+-------------------------------------------------------------+
- Signals
- -------
- .. _class_MeshInstance2D_signal_texture_changed:
- - **texture_changed** **(** **)**
- Emitted when the :ref:`texture<class_MeshInstance2D_property_texture>` is changed.
- Property Descriptions
- ---------------------
- .. _class_MeshInstance2D_property_mesh:
- - :ref:`Mesh<class_Mesh>` **mesh**
- +----------+-----------------+
- | *Setter* | set_mesh(value) |
- +----------+-----------------+
- | *Getter* | get_mesh() |
- +----------+-----------------+
- The :ref:`Mesh<class_Mesh>` that will be drawn by the ``MeshInstance2D``.
- ----
- .. _class_MeshInstance2D_property_normal_map:
- - :ref:`Texture2D<class_Texture2D>` **normal_map**
- +----------+-----------------------+
- | *Setter* | set_normal_map(value) |
- +----------+-----------------------+
- | *Getter* | get_normal_map() |
- +----------+-----------------------+
- The normal map that will be used if using the default :ref:`CanvasItemMaterial<class_CanvasItemMaterial>`.
- \ **Note:** Godot expects the normal map to use X+, Y+, and Z+ coordinates. See `this page <http://wiki.polycount.com/wiki/Normal_Map_Technical_Details#Common_Swizzle_Coordinates>`__ for a comparison of normal map coordinates expected by popular engines.
- ----
- .. _class_MeshInstance2D_property_texture:
- - :ref:`Texture2D<class_Texture2D>` **texture**
- +----------+--------------------+
- | *Setter* | set_texture(value) |
- +----------+--------------------+
- | *Getter* | get_texture() |
- +----------+--------------------+
- The :ref:`Texture2D<class_Texture2D>` that will be used if using the default :ref:`CanvasItemMaterial<class_CanvasItemMaterial>`. Can be accessed as ``TEXTURE`` in CanvasItem shader.
- .. |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.)`
|
