godotengine
/
godot-docs
镜像来自 https://github.com/godotengine/godot-docs


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256
							.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the MeshDataTool.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_MeshDataTool:

MeshDataTool
============

**Inherits:** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`

**Category:** Core

Brief Description
-----------------


Member Functions
----------------

+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                       | :ref:`clear<class_MeshDataTool_clear>` **(** **)**                                                                                                        |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                      | :ref:`commit_to_surface<class_MeshDataTool_commit_to_surface>` **(** :ref:`ArrayMesh<class_arraymesh>` mesh **)**                                         |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                      | :ref:`create_from_surface<class_MeshDataTool_create_from_surface>` **(** :ref:`ArrayMesh<class_arraymesh>` mesh, :ref:`int<class_int>` surface **)**      |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                      | :ref:`get_edge_count<class_MeshDataTool_get_edge_count>` **(** **)** const                                                                                |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolIntArray<class_poolintarray>`    | :ref:`get_edge_faces<class_MeshDataTool_get_edge_faces>` **(** :ref:`int<class_int>` idx **)** const                                                      |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_variant>`              | :ref:`get_edge_meta<class_MeshDataTool_get_edge_meta>` **(** :ref:`int<class_int>` idx **)** const                                                        |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                      | :ref:`get_edge_vertex<class_MeshDataTool_get_edge_vertex>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` vertex **)** const                      |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                      | :ref:`get_face_count<class_MeshDataTool_get_face_count>` **(** **)** const                                                                                |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                      | :ref:`get_face_edge<class_MeshDataTool_get_face_edge>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` edge **)** const                            |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_variant>`              | :ref:`get_face_meta<class_MeshDataTool_get_face_meta>` **(** :ref:`int<class_int>` idx **)** const                                                        |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>`              | :ref:`get_face_normal<class_MeshDataTool_get_face_normal>` **(** :ref:`int<class_int>` idx **)** const                                                    |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                      | :ref:`get_face_vertex<class_MeshDataTool_get_face_vertex>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` vertex **)** const                      |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                      | :ref:`get_format<class_MeshDataTool_get_format>` **(** **)** const                                                                                        |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Material<class_material>`            | :ref:`get_material<class_MeshDataTool_get_material>` **(** **)** const                                                                                    |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>`              | :ref:`get_vertex<class_MeshDataTool_get_vertex>` **(** :ref:`int<class_int>` idx **)** const                                                              |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolIntArray<class_poolintarray>`    | :ref:`get_vertex_bones<class_MeshDataTool_get_vertex_bones>` **(** :ref:`int<class_int>` idx **)** const                                                  |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>`                  | :ref:`get_vertex_color<class_MeshDataTool_get_vertex_color>` **(** :ref:`int<class_int>` idx **)** const                                                  |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                      | :ref:`get_vertex_count<class_MeshDataTool_get_vertex_count>` **(** **)** const                                                                            |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolIntArray<class_poolintarray>`    | :ref:`get_vertex_edges<class_MeshDataTool_get_vertex_edges>` **(** :ref:`int<class_int>` idx **)** const                                                  |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolIntArray<class_poolintarray>`    | :ref:`get_vertex_faces<class_MeshDataTool_get_vertex_faces>` **(** :ref:`int<class_int>` idx **)** const                                                  |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_variant>`              | :ref:`get_vertex_meta<class_MeshDataTool_get_vertex_meta>` **(** :ref:`int<class_int>` idx **)** const                                                    |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>`              | :ref:`get_vertex_normal<class_MeshDataTool_get_vertex_normal>` **(** :ref:`int<class_int>` idx **)** const                                                |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Plane<class_plane>`                  | :ref:`get_vertex_tangent<class_MeshDataTool_get_vertex_tangent>` **(** :ref:`int<class_int>` idx **)** const                                              |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>`              | :ref:`get_vertex_uv<class_MeshDataTool_get_vertex_uv>` **(** :ref:`int<class_int>` idx **)** const                                                        |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>`              | :ref:`get_vertex_uv2<class_MeshDataTool_get_vertex_uv2>` **(** :ref:`int<class_int>` idx **)** const                                                      |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolRealArray<class_poolrealarray>`  | :ref:`get_vertex_weights<class_MeshDataTool_get_vertex_weights>` **(** :ref:`int<class_int>` idx **)** const                                              |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                       | :ref:`set_edge_meta<class_MeshDataTool_set_edge_meta>` **(** :ref:`int<class_int>` idx, :ref:`Variant<class_variant>` meta **)**                          |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                       | :ref:`set_face_meta<class_MeshDataTool_set_face_meta>` **(** :ref:`int<class_int>` idx, :ref:`Variant<class_variant>` meta **)**                          |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                       | :ref:`set_material<class_MeshDataTool_set_material>` **(** :ref:`Material<class_material>` material **)**                                                 |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                       | :ref:`set_vertex<class_MeshDataTool_set_vertex>` **(** :ref:`int<class_int>` idx, :ref:`Vector3<class_vector3>` vertex **)**                              |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                       | :ref:`set_vertex_bones<class_MeshDataTool_set_vertex_bones>` **(** :ref:`int<class_int>` idx, :ref:`PoolIntArray<class_poolintarray>` bones **)**         |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                       | :ref:`set_vertex_color<class_MeshDataTool_set_vertex_color>` **(** :ref:`int<class_int>` idx, :ref:`Color<class_color>` color **)**                       |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                       | :ref:`set_vertex_meta<class_MeshDataTool_set_vertex_meta>` **(** :ref:`int<class_int>` idx, :ref:`Variant<class_variant>` meta **)**                      |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                       | :ref:`set_vertex_normal<class_MeshDataTool_set_vertex_normal>` **(** :ref:`int<class_int>` idx, :ref:`Vector3<class_vector3>` normal **)**                |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                       | :ref:`set_vertex_tangent<class_MeshDataTool_set_vertex_tangent>` **(** :ref:`int<class_int>` idx, :ref:`Plane<class_plane>` tangent **)**                 |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                       | :ref:`set_vertex_uv<class_MeshDataTool_set_vertex_uv>` **(** :ref:`int<class_int>` idx, :ref:`Vector2<class_vector2>` uv **)**                            |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                       | :ref:`set_vertex_uv2<class_MeshDataTool_set_vertex_uv2>` **(** :ref:`int<class_int>` idx, :ref:`Vector2<class_vector2>` uv2 **)**                         |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                       | :ref:`set_vertex_weights<class_MeshDataTool_set_vertex_weights>` **(** :ref:`int<class_int>` idx, :ref:`PoolRealArray<class_poolrealarray>` weights **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+

Member Function Description
---------------------------

.. _class_MeshDataTool_clear:

- void **clear** **(** **)**

.. _class_MeshDataTool_commit_to_surface:

- :ref:`int<class_int>` **commit_to_surface** **(** :ref:`ArrayMesh<class_arraymesh>` mesh **)**

.. _class_MeshDataTool_create_from_surface:

- :ref:`int<class_int>` **create_from_surface** **(** :ref:`ArrayMesh<class_arraymesh>` mesh, :ref:`int<class_int>` surface **)**

.. _class_MeshDataTool_get_edge_count:

- :ref:`int<class_int>` **get_edge_count** **(** **)** const

.. _class_MeshDataTool_get_edge_faces:

- :ref:`PoolIntArray<class_poolintarray>` **get_edge_faces** **(** :ref:`int<class_int>` idx **)** const

.. _class_MeshDataTool_get_edge_meta:

- :ref:`Variant<class_variant>` **get_edge_meta** **(** :ref:`int<class_int>` idx **)** const

.. _class_MeshDataTool_get_edge_vertex:

- :ref:`int<class_int>` **get_edge_vertex** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` vertex **)** const

.. _class_MeshDataTool_get_face_count:

- :ref:`int<class_int>` **get_face_count** **(** **)** const

.. _class_MeshDataTool_get_face_edge:

- :ref:`int<class_int>` **get_face_edge** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` edge **)** const

.. _class_MeshDataTool_get_face_meta:

- :ref:`Variant<class_variant>` **get_face_meta** **(** :ref:`int<class_int>` idx **)** const

.. _class_MeshDataTool_get_face_normal:

- :ref:`Vector3<class_vector3>` **get_face_normal** **(** :ref:`int<class_int>` idx **)** const

.. _class_MeshDataTool_get_face_vertex:

- :ref:`int<class_int>` **get_face_vertex** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` vertex **)** const

.. _class_MeshDataTool_get_format:

- :ref:`int<class_int>` **get_format** **(** **)** const

.. _class_MeshDataTool_get_material:

- :ref:`Material<class_material>` **get_material** **(** **)** const

.. _class_MeshDataTool_get_vertex:

- :ref:`Vector3<class_vector3>` **get_vertex** **(** :ref:`int<class_int>` idx **)** const

.. _class_MeshDataTool_get_vertex_bones:

- :ref:`PoolIntArray<class_poolintarray>` **get_vertex_bones** **(** :ref:`int<class_int>` idx **)** const

.. _class_MeshDataTool_get_vertex_color:

- :ref:`Color<class_color>` **get_vertex_color** **(** :ref:`int<class_int>` idx **)** const

.. _class_MeshDataTool_get_vertex_count:

- :ref:`int<class_int>` **get_vertex_count** **(** **)** const

.. _class_MeshDataTool_get_vertex_edges:

- :ref:`PoolIntArray<class_poolintarray>` **get_vertex_edges** **(** :ref:`int<class_int>` idx **)** const

.. _class_MeshDataTool_get_vertex_faces:

- :ref:`PoolIntArray<class_poolintarray>` **get_vertex_faces** **(** :ref:`int<class_int>` idx **)** const

.. _class_MeshDataTool_get_vertex_meta:

- :ref:`Variant<class_variant>` **get_vertex_meta** **(** :ref:`int<class_int>` idx **)** const

.. _class_MeshDataTool_get_vertex_normal:

- :ref:`Vector3<class_vector3>` **get_vertex_normal** **(** :ref:`int<class_int>` idx **)** const

.. _class_MeshDataTool_get_vertex_tangent:

- :ref:`Plane<class_plane>` **get_vertex_tangent** **(** :ref:`int<class_int>` idx **)** const

.. _class_MeshDataTool_get_vertex_uv:

- :ref:`Vector2<class_vector2>` **get_vertex_uv** **(** :ref:`int<class_int>` idx **)** const

.. _class_MeshDataTool_get_vertex_uv2:

- :ref:`Vector2<class_vector2>` **get_vertex_uv2** **(** :ref:`int<class_int>` idx **)** const

.. _class_MeshDataTool_get_vertex_weights:

- :ref:`PoolRealArray<class_poolrealarray>` **get_vertex_weights** **(** :ref:`int<class_int>` idx **)** const

.. _class_MeshDataTool_set_edge_meta:

- void **set_edge_meta** **(** :ref:`int<class_int>` idx, :ref:`Variant<class_variant>` meta **)**

.. _class_MeshDataTool_set_face_meta:

- void **set_face_meta** **(** :ref:`int<class_int>` idx, :ref:`Variant<class_variant>` meta **)**

.. _class_MeshDataTool_set_material:

- void **set_material** **(** :ref:`Material<class_material>` material **)**

.. _class_MeshDataTool_set_vertex:

- void **set_vertex** **(** :ref:`int<class_int>` idx, :ref:`Vector3<class_vector3>` vertex **)**

.. _class_MeshDataTool_set_vertex_bones:

- void **set_vertex_bones** **(** :ref:`int<class_int>` idx, :ref:`PoolIntArray<class_poolintarray>` bones **)**

.. _class_MeshDataTool_set_vertex_color:

- void **set_vertex_color** **(** :ref:`int<class_int>` idx, :ref:`Color<class_color>` color **)**

.. _class_MeshDataTool_set_vertex_meta:

- void **set_vertex_meta** **(** :ref:`int<class_int>` idx, :ref:`Variant<class_variant>` meta **)**

.. _class_MeshDataTool_set_vertex_normal:

- void **set_vertex_normal** **(** :ref:`int<class_int>` idx, :ref:`Vector3<class_vector3>` normal **)**

.. _class_MeshDataTool_set_vertex_tangent:

- void **set_vertex_tangent** **(** :ref:`int<class_int>` idx, :ref:`Plane<class_plane>` tangent **)**

.. _class_MeshDataTool_set_vertex_uv:

- void **set_vertex_uv** **(** :ref:`int<class_int>` idx, :ref:`Vector2<class_vector2>` uv **)**

.. _class_MeshDataTool_set_vertex_uv2:

- void **set_vertex_uv2** **(** :ref:`int<class_int>` idx, :ref:`Vector2<class_vector2>` uv2 **)**

.. _class_MeshDataTool_set_vertex_weights:

- void **set_vertex_weights** **(** :ref:`int<class_int>` idx, :ref:`PoolRealArray<class_poolrealarray>` weights **)**