class_meshdatatool.rst 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/4.0/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/4.0/doc/classes/MeshDataTool.xml.
  6. .. _class_MeshDataTool:
  7. MeshDataTool
  8. ============
  9. **Inherits:** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  10. Helper tool to access and edit :ref:`Mesh<class_Mesh>` data.
  11. .. rst-class:: classref-introduction-group
  12. Description
  13. -----------
  14. MeshDataTool provides access to individual vertices in a :ref:`Mesh<class_Mesh>`. It allows users to read and edit vertex data of meshes. It also creates an array of faces and edges.
  15. To use MeshDataTool, load a mesh with :ref:`create_from_surface<class_MeshDataTool_method_create_from_surface>`. When you are finished editing the data commit the data to a mesh with :ref:`commit_to_surface<class_MeshDataTool_method_commit_to_surface>`.
  16. Below is an example of how MeshDataTool may be used.
  17. .. tabs::
  18. .. code-tab:: gdscript
  19. var mesh = ArrayMesh.new()
  20. mesh.add_surface_from_arrays(Mesh.PRIMITIVE_TRIANGLES, BoxMesh.new().get_mesh_arrays())
  21. var mdt = MeshDataTool.new()
  22. mdt.create_from_surface(mesh, 0)
  23. for i in range(mdt.get_vertex_count()):
  24. var vertex = mdt.get_vertex(i)
  25. # In this example we extend the mesh by one unit, which results in separated faces as it is flat shaded.
  26. vertex += mdt.get_vertex_normal(i)
  27. # Save your change.
  28. mdt.set_vertex(i, vertex)
  29. mesh.clear_surfaces()
  30. mdt.commit_to_surface(mesh)
  31. var mi = MeshInstance.new()
  32. mi.mesh = mesh
  33. add_child(mi)
  34. .. code-tab:: csharp
  35. var mesh = new ArrayMesh();
  36. mesh.AddSurfaceFromArrays(Mesh.PrimitiveType.Triangles, new BoxMesh().GetMeshArrays());
  37. var mdt = new MeshDataTool();
  38. mdt.CreateFromSurface(mesh, 0);
  39. for (var i = 0; i < mdt.GetVertexCount(); i++)
  40. {
  41. Vector3 vertex = mdt.GetVertex(i);
  42. // In this example we extend the mesh by one unit, which results in separated faces as it is flat shaded.
  43. vertex += mdt.GetVertexNormal(i);
  44. // Save your change.
  45. mdt.SetVertex(i, vertex);
  46. }
  47. mesh.ClearSurfaces();
  48. mdt.CommitToSurface(mesh);
  49. var mi = new MeshInstance();
  50. mi.Mesh = mesh;
  51. AddChild(mi);
  52. See also :ref:`ArrayMesh<class_ArrayMesh>`, :ref:`ImmediateMesh<class_ImmediateMesh>` and :ref:`SurfaceTool<class_SurfaceTool>` for procedural geometry generation.
  53. \ **Note:** Godot uses clockwise `winding order <https://learnopengl.com/Advanced-OpenGL/Face-culling>`__ for front faces of triangle primitive modes.
  54. .. rst-class:: classref-reftable-group
  55. Methods
  56. -------
  57. .. table::
  58. :widths: auto
  59. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  60. | void | :ref:`clear<class_MeshDataTool_method_clear>` **(** **)** |
  61. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  62. | :ref:`Error<enum_@GlobalScope_Error>` | :ref:`commit_to_surface<class_MeshDataTool_method_commit_to_surface>` **(** :ref:`ArrayMesh<class_ArrayMesh>` mesh **)** |
  63. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  64. | :ref:`Error<enum_@GlobalScope_Error>` | :ref:`create_from_surface<class_MeshDataTool_method_create_from_surface>` **(** :ref:`ArrayMesh<class_ArrayMesh>` mesh, :ref:`int<class_int>` surface **)** |
  65. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  66. | :ref:`int<class_int>` | :ref:`get_edge_count<class_MeshDataTool_method_get_edge_count>` **(** **)** |const| |
  67. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  68. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`get_edge_faces<class_MeshDataTool_method_get_edge_faces>` **(** :ref:`int<class_int>` idx **)** |const| |
  69. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  70. | :ref:`Variant<class_Variant>` | :ref:`get_edge_meta<class_MeshDataTool_method_get_edge_meta>` **(** :ref:`int<class_int>` idx **)** |const| |
  71. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  72. | :ref:`int<class_int>` | :ref:`get_edge_vertex<class_MeshDataTool_method_get_edge_vertex>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` vertex **)** |const| |
  73. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  74. | :ref:`int<class_int>` | :ref:`get_face_count<class_MeshDataTool_method_get_face_count>` **(** **)** |const| |
  75. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  76. | :ref:`int<class_int>` | :ref:`get_face_edge<class_MeshDataTool_method_get_face_edge>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` edge **)** |const| |
  77. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  78. | :ref:`Variant<class_Variant>` | :ref:`get_face_meta<class_MeshDataTool_method_get_face_meta>` **(** :ref:`int<class_int>` idx **)** |const| |
  79. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  80. | :ref:`Vector3<class_Vector3>` | :ref:`get_face_normal<class_MeshDataTool_method_get_face_normal>` **(** :ref:`int<class_int>` idx **)** |const| |
  81. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  82. | :ref:`int<class_int>` | :ref:`get_face_vertex<class_MeshDataTool_method_get_face_vertex>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` vertex **)** |const| |
  83. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  84. | :ref:`int<class_int>` | :ref:`get_format<class_MeshDataTool_method_get_format>` **(** **)** |const| |
  85. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  86. | :ref:`Material<class_Material>` | :ref:`get_material<class_MeshDataTool_method_get_material>` **(** **)** |const| |
  87. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  88. | :ref:`Vector3<class_Vector3>` | :ref:`get_vertex<class_MeshDataTool_method_get_vertex>` **(** :ref:`int<class_int>` idx **)** |const| |
  89. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  90. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`get_vertex_bones<class_MeshDataTool_method_get_vertex_bones>` **(** :ref:`int<class_int>` idx **)** |const| |
  91. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  92. | :ref:`Color<class_Color>` | :ref:`get_vertex_color<class_MeshDataTool_method_get_vertex_color>` **(** :ref:`int<class_int>` idx **)** |const| |
  93. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  94. | :ref:`int<class_int>` | :ref:`get_vertex_count<class_MeshDataTool_method_get_vertex_count>` **(** **)** |const| |
  95. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  96. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`get_vertex_edges<class_MeshDataTool_method_get_vertex_edges>` **(** :ref:`int<class_int>` idx **)** |const| |
  97. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  98. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`get_vertex_faces<class_MeshDataTool_method_get_vertex_faces>` **(** :ref:`int<class_int>` idx **)** |const| |
  99. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  100. | :ref:`Variant<class_Variant>` | :ref:`get_vertex_meta<class_MeshDataTool_method_get_vertex_meta>` **(** :ref:`int<class_int>` idx **)** |const| |
  101. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  102. | :ref:`Vector3<class_Vector3>` | :ref:`get_vertex_normal<class_MeshDataTool_method_get_vertex_normal>` **(** :ref:`int<class_int>` idx **)** |const| |
  103. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  104. | :ref:`Plane<class_Plane>` | :ref:`get_vertex_tangent<class_MeshDataTool_method_get_vertex_tangent>` **(** :ref:`int<class_int>` idx **)** |const| |
  105. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  106. | :ref:`Vector2<class_Vector2>` | :ref:`get_vertex_uv<class_MeshDataTool_method_get_vertex_uv>` **(** :ref:`int<class_int>` idx **)** |const| |
  107. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  108. | :ref:`Vector2<class_Vector2>` | :ref:`get_vertex_uv2<class_MeshDataTool_method_get_vertex_uv2>` **(** :ref:`int<class_int>` idx **)** |const| |
  109. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  110. | :ref:`PackedFloat32Array<class_PackedFloat32Array>` | :ref:`get_vertex_weights<class_MeshDataTool_method_get_vertex_weights>` **(** :ref:`int<class_int>` idx **)** |const| |
  111. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  112. | void | :ref:`set_edge_meta<class_MeshDataTool_method_set_edge_meta>` **(** :ref:`int<class_int>` idx, :ref:`Variant<class_Variant>` meta **)** |
  113. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  114. | void | :ref:`set_face_meta<class_MeshDataTool_method_set_face_meta>` **(** :ref:`int<class_int>` idx, :ref:`Variant<class_Variant>` meta **)** |
  115. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  116. | void | :ref:`set_material<class_MeshDataTool_method_set_material>` **(** :ref:`Material<class_Material>` material **)** |
  117. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  118. | void | :ref:`set_vertex<class_MeshDataTool_method_set_vertex>` **(** :ref:`int<class_int>` idx, :ref:`Vector3<class_Vector3>` vertex **)** |
  119. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  120. | void | :ref:`set_vertex_bones<class_MeshDataTool_method_set_vertex_bones>` **(** :ref:`int<class_int>` idx, :ref:`PackedInt32Array<class_PackedInt32Array>` bones **)** |
  121. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  122. | void | :ref:`set_vertex_color<class_MeshDataTool_method_set_vertex_color>` **(** :ref:`int<class_int>` idx, :ref:`Color<class_Color>` color **)** |
  123. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  124. | void | :ref:`set_vertex_meta<class_MeshDataTool_method_set_vertex_meta>` **(** :ref:`int<class_int>` idx, :ref:`Variant<class_Variant>` meta **)** |
  125. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  126. | void | :ref:`set_vertex_normal<class_MeshDataTool_method_set_vertex_normal>` **(** :ref:`int<class_int>` idx, :ref:`Vector3<class_Vector3>` normal **)** |
  127. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  128. | void | :ref:`set_vertex_tangent<class_MeshDataTool_method_set_vertex_tangent>` **(** :ref:`int<class_int>` idx, :ref:`Plane<class_Plane>` tangent **)** |
  129. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  130. | void | :ref:`set_vertex_uv<class_MeshDataTool_method_set_vertex_uv>` **(** :ref:`int<class_int>` idx, :ref:`Vector2<class_Vector2>` uv **)** |
  131. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  132. | void | :ref:`set_vertex_uv2<class_MeshDataTool_method_set_vertex_uv2>` **(** :ref:`int<class_int>` idx, :ref:`Vector2<class_Vector2>` uv2 **)** |
  133. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  134. | void | :ref:`set_vertex_weights<class_MeshDataTool_method_set_vertex_weights>` **(** :ref:`int<class_int>` idx, :ref:`PackedFloat32Array<class_PackedFloat32Array>` weights **)** |
  135. +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  136. .. rst-class:: classref-section-separator
  137. ----
  138. .. rst-class:: classref-descriptions-group
  139. Method Descriptions
  140. -------------------
  141. .. _class_MeshDataTool_method_clear:
  142. .. rst-class:: classref-method
  143. void **clear** **(** **)**
  144. Clears all data currently in MeshDataTool.
  145. .. rst-class:: classref-item-separator
  146. ----
  147. .. _class_MeshDataTool_method_commit_to_surface:
  148. .. rst-class:: classref-method
  149. :ref:`Error<enum_@GlobalScope_Error>` **commit_to_surface** **(** :ref:`ArrayMesh<class_ArrayMesh>` mesh **)**
  150. Adds a new surface to specified :ref:`Mesh<class_Mesh>` with edited data.
  151. .. rst-class:: classref-item-separator
  152. ----
  153. .. _class_MeshDataTool_method_create_from_surface:
  154. .. rst-class:: classref-method
  155. :ref:`Error<enum_@GlobalScope_Error>` **create_from_surface** **(** :ref:`ArrayMesh<class_ArrayMesh>` mesh, :ref:`int<class_int>` surface **)**
  156. Uses specified surface of given :ref:`Mesh<class_Mesh>` to populate data for MeshDataTool.
  157. Requires :ref:`Mesh<class_Mesh>` with primitive type :ref:`Mesh.PRIMITIVE_TRIANGLES<class_Mesh_constant_PRIMITIVE_TRIANGLES>`.
  158. .. rst-class:: classref-item-separator
  159. ----
  160. .. _class_MeshDataTool_method_get_edge_count:
  161. .. rst-class:: classref-method
  162. :ref:`int<class_int>` **get_edge_count** **(** **)** |const|
  163. Returns the number of edges in this :ref:`Mesh<class_Mesh>`.
  164. .. rst-class:: classref-item-separator
  165. ----
  166. .. _class_MeshDataTool_method_get_edge_faces:
  167. .. rst-class:: classref-method
  168. :ref:`PackedInt32Array<class_PackedInt32Array>` **get_edge_faces** **(** :ref:`int<class_int>` idx **)** |const|
  169. Returns array of faces that touch given edge.
  170. .. rst-class:: classref-item-separator
  171. ----
  172. .. _class_MeshDataTool_method_get_edge_meta:
  173. .. rst-class:: classref-method
  174. :ref:`Variant<class_Variant>` **get_edge_meta** **(** :ref:`int<class_int>` idx **)** |const|
  175. Returns meta information assigned to given edge.
  176. .. rst-class:: classref-item-separator
  177. ----
  178. .. _class_MeshDataTool_method_get_edge_vertex:
  179. .. rst-class:: classref-method
  180. :ref:`int<class_int>` **get_edge_vertex** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` vertex **)** |const|
  181. Returns index of specified vertex connected to given edge.
  182. Vertex argument can only be 0 or 1 because edges are comprised of two vertices.
  183. .. rst-class:: classref-item-separator
  184. ----
  185. .. _class_MeshDataTool_method_get_face_count:
  186. .. rst-class:: classref-method
  187. :ref:`int<class_int>` **get_face_count** **(** **)** |const|
  188. Returns the number of faces in this :ref:`Mesh<class_Mesh>`.
  189. .. rst-class:: classref-item-separator
  190. ----
  191. .. _class_MeshDataTool_method_get_face_edge:
  192. .. rst-class:: classref-method
  193. :ref:`int<class_int>` **get_face_edge** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` edge **)** |const|
  194. Returns specified edge associated with given face.
  195. Edge argument must be either 0, 1, or 2 because a face only has three edges.
  196. .. rst-class:: classref-item-separator
  197. ----
  198. .. _class_MeshDataTool_method_get_face_meta:
  199. .. rst-class:: classref-method
  200. :ref:`Variant<class_Variant>` **get_face_meta** **(** :ref:`int<class_int>` idx **)** |const|
  201. Returns the metadata associated with the given face.
  202. .. rst-class:: classref-item-separator
  203. ----
  204. .. _class_MeshDataTool_method_get_face_normal:
  205. .. rst-class:: classref-method
  206. :ref:`Vector3<class_Vector3>` **get_face_normal** **(** :ref:`int<class_int>` idx **)** |const|
  207. Calculates and returns the face normal of the given face.
  208. .. rst-class:: classref-item-separator
  209. ----
  210. .. _class_MeshDataTool_method_get_face_vertex:
  211. .. rst-class:: classref-method
  212. :ref:`int<class_int>` **get_face_vertex** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` vertex **)** |const|
  213. Returns the specified vertex of the given face.
  214. Vertex argument must be either 0, 1, or 2 because faces contain three vertices.
  215. .. rst-class:: classref-item-separator
  216. ----
  217. .. _class_MeshDataTool_method_get_format:
  218. .. rst-class:: classref-method
  219. :ref:`int<class_int>` **get_format** **(** **)** |const|
  220. Returns the :ref:`Mesh<class_Mesh>`'s format. Format is an integer made up of :ref:`Mesh<class_Mesh>` format flags combined together. For example, a mesh containing both vertices and normals would return a format of ``3`` because :ref:`Mesh.ARRAY_FORMAT_VERTEX<class_Mesh_constant_ARRAY_FORMAT_VERTEX>` is ``1`` and :ref:`Mesh.ARRAY_FORMAT_NORMAL<class_Mesh_constant_ARRAY_FORMAT_NORMAL>` is ``2``.
  221. See :ref:`ArrayFormat<enum_Mesh_ArrayFormat>` for a list of format flags.
  222. .. rst-class:: classref-item-separator
  223. ----
  224. .. _class_MeshDataTool_method_get_material:
  225. .. rst-class:: classref-method
  226. :ref:`Material<class_Material>` **get_material** **(** **)** |const|
  227. Returns the material assigned to the :ref:`Mesh<class_Mesh>`.
  228. .. rst-class:: classref-item-separator
  229. ----
  230. .. _class_MeshDataTool_method_get_vertex:
  231. .. rst-class:: classref-method
  232. :ref:`Vector3<class_Vector3>` **get_vertex** **(** :ref:`int<class_int>` idx **)** |const|
  233. Returns the vertex at given index.
  234. .. rst-class:: classref-item-separator
  235. ----
  236. .. _class_MeshDataTool_method_get_vertex_bones:
  237. .. rst-class:: classref-method
  238. :ref:`PackedInt32Array<class_PackedInt32Array>` **get_vertex_bones** **(** :ref:`int<class_int>` idx **)** |const|
  239. Returns the bones of the given vertex.
  240. .. rst-class:: classref-item-separator
  241. ----
  242. .. _class_MeshDataTool_method_get_vertex_color:
  243. .. rst-class:: classref-method
  244. :ref:`Color<class_Color>` **get_vertex_color** **(** :ref:`int<class_int>` idx **)** |const|
  245. Returns the color of the given vertex.
  246. .. rst-class:: classref-item-separator
  247. ----
  248. .. _class_MeshDataTool_method_get_vertex_count:
  249. .. rst-class:: classref-method
  250. :ref:`int<class_int>` **get_vertex_count** **(** **)** |const|
  251. Returns the total number of vertices in :ref:`Mesh<class_Mesh>`.
  252. .. rst-class:: classref-item-separator
  253. ----
  254. .. _class_MeshDataTool_method_get_vertex_edges:
  255. .. rst-class:: classref-method
  256. :ref:`PackedInt32Array<class_PackedInt32Array>` **get_vertex_edges** **(** :ref:`int<class_int>` idx **)** |const|
  257. Returns an array of edges that share the given vertex.
  258. .. rst-class:: classref-item-separator
  259. ----
  260. .. _class_MeshDataTool_method_get_vertex_faces:
  261. .. rst-class:: classref-method
  262. :ref:`PackedInt32Array<class_PackedInt32Array>` **get_vertex_faces** **(** :ref:`int<class_int>` idx **)** |const|
  263. Returns an array of faces that share the given vertex.
  264. .. rst-class:: classref-item-separator
  265. ----
  266. .. _class_MeshDataTool_method_get_vertex_meta:
  267. .. rst-class:: classref-method
  268. :ref:`Variant<class_Variant>` **get_vertex_meta** **(** :ref:`int<class_int>` idx **)** |const|
  269. Returns the metadata associated with the given vertex.
  270. .. rst-class:: classref-item-separator
  271. ----
  272. .. _class_MeshDataTool_method_get_vertex_normal:
  273. .. rst-class:: classref-method
  274. :ref:`Vector3<class_Vector3>` **get_vertex_normal** **(** :ref:`int<class_int>` idx **)** |const|
  275. Returns the normal of the given vertex.
  276. .. rst-class:: classref-item-separator
  277. ----
  278. .. _class_MeshDataTool_method_get_vertex_tangent:
  279. .. rst-class:: classref-method
  280. :ref:`Plane<class_Plane>` **get_vertex_tangent** **(** :ref:`int<class_int>` idx **)** |const|
  281. Returns the tangent of the given vertex.
  282. .. rst-class:: classref-item-separator
  283. ----
  284. .. _class_MeshDataTool_method_get_vertex_uv:
  285. .. rst-class:: classref-method
  286. :ref:`Vector2<class_Vector2>` **get_vertex_uv** **(** :ref:`int<class_int>` idx **)** |const|
  287. Returns the UV of the given vertex.
  288. .. rst-class:: classref-item-separator
  289. ----
  290. .. _class_MeshDataTool_method_get_vertex_uv2:
  291. .. rst-class:: classref-method
  292. :ref:`Vector2<class_Vector2>` **get_vertex_uv2** **(** :ref:`int<class_int>` idx **)** |const|
  293. Returns the UV2 of the given vertex.
  294. .. rst-class:: classref-item-separator
  295. ----
  296. .. _class_MeshDataTool_method_get_vertex_weights:
  297. .. rst-class:: classref-method
  298. :ref:`PackedFloat32Array<class_PackedFloat32Array>` **get_vertex_weights** **(** :ref:`int<class_int>` idx **)** |const|
  299. Returns bone weights of the given vertex.
  300. .. rst-class:: classref-item-separator
  301. ----
  302. .. _class_MeshDataTool_method_set_edge_meta:
  303. .. rst-class:: classref-method
  304. void **set_edge_meta** **(** :ref:`int<class_int>` idx, :ref:`Variant<class_Variant>` meta **)**
  305. Sets the metadata of the given edge.
  306. .. rst-class:: classref-item-separator
  307. ----
  308. .. _class_MeshDataTool_method_set_face_meta:
  309. .. rst-class:: classref-method
  310. void **set_face_meta** **(** :ref:`int<class_int>` idx, :ref:`Variant<class_Variant>` meta **)**
  311. Sets the metadata of the given face.
  312. .. rst-class:: classref-item-separator
  313. ----
  314. .. _class_MeshDataTool_method_set_material:
  315. .. rst-class:: classref-method
  316. void **set_material** **(** :ref:`Material<class_Material>` material **)**
  317. Sets the material to be used by newly-constructed :ref:`Mesh<class_Mesh>`.
  318. .. rst-class:: classref-item-separator
  319. ----
  320. .. _class_MeshDataTool_method_set_vertex:
  321. .. rst-class:: classref-method
  322. void **set_vertex** **(** :ref:`int<class_int>` idx, :ref:`Vector3<class_Vector3>` vertex **)**
  323. Sets the position of the given vertex.
  324. .. rst-class:: classref-item-separator
  325. ----
  326. .. _class_MeshDataTool_method_set_vertex_bones:
  327. .. rst-class:: classref-method
  328. void **set_vertex_bones** **(** :ref:`int<class_int>` idx, :ref:`PackedInt32Array<class_PackedInt32Array>` bones **)**
  329. Sets the bones of the given vertex.
  330. .. rst-class:: classref-item-separator
  331. ----
  332. .. _class_MeshDataTool_method_set_vertex_color:
  333. .. rst-class:: classref-method
  334. void **set_vertex_color** **(** :ref:`int<class_int>` idx, :ref:`Color<class_Color>` color **)**
  335. Sets the color of the given vertex.
  336. .. rst-class:: classref-item-separator
  337. ----
  338. .. _class_MeshDataTool_method_set_vertex_meta:
  339. .. rst-class:: classref-method
  340. void **set_vertex_meta** **(** :ref:`int<class_int>` idx, :ref:`Variant<class_Variant>` meta **)**
  341. Sets the metadata associated with the given vertex.
  342. .. rst-class:: classref-item-separator
  343. ----
  344. .. _class_MeshDataTool_method_set_vertex_normal:
  345. .. rst-class:: classref-method
  346. void **set_vertex_normal** **(** :ref:`int<class_int>` idx, :ref:`Vector3<class_Vector3>` normal **)**
  347. Sets the normal of the given vertex.
  348. .. rst-class:: classref-item-separator
  349. ----
  350. .. _class_MeshDataTool_method_set_vertex_tangent:
  351. .. rst-class:: classref-method
  352. void **set_vertex_tangent** **(** :ref:`int<class_int>` idx, :ref:`Plane<class_Plane>` tangent **)**
  353. Sets the tangent of the given vertex.
  354. .. rst-class:: classref-item-separator
  355. ----
  356. .. _class_MeshDataTool_method_set_vertex_uv:
  357. .. rst-class:: classref-method
  358. void **set_vertex_uv** **(** :ref:`int<class_int>` idx, :ref:`Vector2<class_Vector2>` uv **)**
  359. Sets the UV of the given vertex.
  360. .. rst-class:: classref-item-separator
  361. ----
  362. .. _class_MeshDataTool_method_set_vertex_uv2:
  363. .. rst-class:: classref-method
  364. void **set_vertex_uv2** **(** :ref:`int<class_int>` idx, :ref:`Vector2<class_Vector2>` uv2 **)**
  365. Sets the UV2 of the given vertex.
  366. .. rst-class:: classref-item-separator
  367. ----
  368. .. _class_MeshDataTool_method_set_vertex_weights:
  369. .. rst-class:: classref-method
  370. void **set_vertex_weights** **(** :ref:`int<class_int>` idx, :ref:`PackedFloat32Array<class_PackedFloat32Array>` weights **)**
  371. Sets the bone weights of the given vertex.
  372. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  373. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  374. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  375. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  376. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  377. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`