2
0

class_meshdatatool.rst 29 KB

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