blob: 1468d900b51787c722d16b54e7f1fa70880df563 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
|
<?xml version="1.0" encoding="UTF-8" ?>
<class name="MeshDataTool" inherits="Reference" version="3.2">
<brief_description>
Helper tool to access and edit [Mesh] data.
</brief_description>
<description>
MeshDataTool provides access to individual vertices in a [Mesh]. It allows users to read and edit vertex data of meshes. It also creates an array of faces and edges.
To use MeshDataTool, load a mesh with [method create_from_surface]. When you are finished editing the data commit the data to a mesh with [method commit_to_surface].
Below is an example of how MeshDataTool may be used.
[codeblock]
var mdt = MeshDataTool.new()
mdt.create_from_surface(mesh, 0)
for i in range(mdt.get_vertex_count()):
var vertex = mdt.get_vertex(i)
...
mdt.set_vertex(i, vertex)
mesh.surface_remove(0)
mdt.commit_to_surface(mesh)
[/codeblock]
</description>
<tutorials>
</tutorials>
<methods>
<method name="clear">
<return type="void">
</return>
<description>
Clears all data currently in MeshDataTool.
</description>
</method>
<method name="commit_to_surface">
<return type="int" enum="Error">
</return>
<argument index="0" name="mesh" type="ArrayMesh">
</argument>
<description>
Adds a new surface to specified [Mesh] with edited data.
</description>
</method>
<method name="create_from_surface">
<return type="int" enum="Error">
</return>
<argument index="0" name="mesh" type="ArrayMesh">
</argument>
<argument index="1" name="surface" type="int">
</argument>
<description>
Uses specified surface of given [Mesh] to populate data for MeshDataTool.
Requires [Mesh] with primitive type [constant Mesh.PRIMITIVE_TRIANGLES].
</description>
</method>
<method name="get_edge_count" qualifiers="const">
<return type="int">
</return>
<description>
Returns the number of edges in this [Mesh].
</description>
</method>
<method name="get_edge_faces" qualifiers="const">
<return type="PoolIntArray">
</return>
<argument index="0" name="idx" type="int">
</argument>
<description>
Returns array of faces that touch given edge.
</description>
</method>
<method name="get_edge_meta" qualifiers="const">
<return type="Variant">
</return>
<argument index="0" name="idx" type="int">
</argument>
<description>
Returns meta information assigned to given edge.
</description>
</method>
<method name="get_edge_vertex" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="idx" type="int">
</argument>
<argument index="1" name="vertex" type="int">
</argument>
<description>
Returns index of specified vertex connected to given edge.
Vertex argument can only be 0 or 1 because edges are comprised of two vertices.
</description>
</method>
<method name="get_face_count" qualifiers="const">
<return type="int">
</return>
<description>
Returns the number of faces in this [Mesh].
</description>
</method>
<method name="get_face_edge" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="idx" type="int">
</argument>
<argument index="1" name="edge" type="int">
</argument>
<description>
Returns specified edge associated with given face.
Edge argument must 2 or less because a face only has three edges.
</description>
</method>
<method name="get_face_meta" qualifiers="const">
<return type="Variant">
</return>
<argument index="0" name="idx" type="int">
</argument>
<description>
Returns the metadata associated with the given face.
</description>
</method>
<method name="get_face_normal" qualifiers="const">
<return type="Vector3">
</return>
<argument index="0" name="idx" type="int">
</argument>
<description>
Calculates and returns the face normal of the given face.
</description>
</method>
<method name="get_face_vertex" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="idx" type="int">
</argument>
<argument index="1" name="vertex" type="int">
</argument>
<description>
Returns the specified vertex of the given face.
Vertex argument must be 2 or less because faces contain three vertices.
</description>
</method>
<method name="get_format" qualifiers="const">
<return type="int">
</return>
<description>
Returns the [Mesh]'s format. Format is an integer made up of [Mesh] format flags combined together. For example, a mesh containing both vertices and normals would return a format of [code]3[/code] because [constant ArrayMesh.ARRAY_FORMAT_VERTEX] is [code]1[/code] and [constant ArrayMesh.ARRAY_FORMAT_NORMAL] is [code]2[/code].
See [enum ArrayMesh.ArrayFormat] for a list of format flags.
</description>
</method>
<method name="get_material" qualifiers="const">
<return type="Material">
</return>
<description>
Returns the material assigned to the [Mesh].
</description>
</method>
<method name="get_vertex" qualifiers="const">
<return type="Vector3">
</return>
<argument index="0" name="idx" type="int">
</argument>
<description>
Returns the vertex at given index.
</description>
</method>
<method name="get_vertex_bones" qualifiers="const">
<return type="PoolIntArray">
</return>
<argument index="0" name="idx" type="int">
</argument>
<description>
Returns the bones of the given vertex.
</description>
</method>
<method name="get_vertex_color" qualifiers="const">
<return type="Color">
</return>
<argument index="0" name="idx" type="int">
</argument>
<description>
Returns the color of the given vertex.
</description>
</method>
<method name="get_vertex_count" qualifiers="const">
<return type="int">
</return>
<description>
Returns the total number of vertices in [Mesh].
</description>
</method>
<method name="get_vertex_edges" qualifiers="const">
<return type="PoolIntArray">
</return>
<argument index="0" name="idx" type="int">
</argument>
<description>
Returns an array of edges that share the given vertex.
</description>
</method>
<method name="get_vertex_faces" qualifiers="const">
<return type="PoolIntArray">
</return>
<argument index="0" name="idx" type="int">
</argument>
<description>
Returns an array of faces that share the given vertex.
</description>
</method>
<method name="get_vertex_meta" qualifiers="const">
<return type="Variant">
</return>
<argument index="0" name="idx" type="int">
</argument>
<description>
Returns the metadata associated with the given vertex.
</description>
</method>
<method name="get_vertex_normal" qualifiers="const">
<return type="Vector3">
</return>
<argument index="0" name="idx" type="int">
</argument>
<description>
Returns the normal of the given vertex.
</description>
</method>
<method name="get_vertex_tangent" qualifiers="const">
<return type="Plane">
</return>
<argument index="0" name="idx" type="int">
</argument>
<description>
Returns the tangent of the given vertex.
</description>
</method>
<method name="get_vertex_uv" qualifiers="const">
<return type="Vector2">
</return>
<argument index="0" name="idx" type="int">
</argument>
<description>
Returns the UV of the given vertex.
</description>
</method>
<method name="get_vertex_uv2" qualifiers="const">
<return type="Vector2">
</return>
<argument index="0" name="idx" type="int">
</argument>
<description>
Returns the UV2 of the given vertex.
</description>
</method>
<method name="get_vertex_weights" qualifiers="const">
<return type="PoolRealArray">
</return>
<argument index="0" name="idx" type="int">
</argument>
<description>
Returns bone weights of the given vertex.
</description>
</method>
<method name="set_edge_meta">
<return type="void">
</return>
<argument index="0" name="idx" type="int">
</argument>
<argument index="1" name="meta" type="Variant">
</argument>
<description>
Sets the metadata of the given edge.
</description>
</method>
<method name="set_face_meta">
<return type="void">
</return>
<argument index="0" name="idx" type="int">
</argument>
<argument index="1" name="meta" type="Variant">
</argument>
<description>
Sets the metadata of the given face.
</description>
</method>
<method name="set_material">
<return type="void">
</return>
<argument index="0" name="material" type="Material">
</argument>
<description>
Sets the material to be used by newly-constructed [Mesh].
</description>
</method>
<method name="set_vertex">
<return type="void">
</return>
<argument index="0" name="idx" type="int">
</argument>
<argument index="1" name="vertex" type="Vector3">
</argument>
<description>
Sets the position of the given vertex.
</description>
</method>
<method name="set_vertex_bones">
<return type="void">
</return>
<argument index="0" name="idx" type="int">
</argument>
<argument index="1" name="bones" type="PoolIntArray">
</argument>
<description>
Sets the bones of the given vertex.
</description>
</method>
<method name="set_vertex_color">
<return type="void">
</return>
<argument index="0" name="idx" type="int">
</argument>
<argument index="1" name="color" type="Color">
</argument>
<description>
Sets the color of the given vertex.
</description>
</method>
<method name="set_vertex_meta">
<return type="void">
</return>
<argument index="0" name="idx" type="int">
</argument>
<argument index="1" name="meta" type="Variant">
</argument>
<description>
Sets the metadata associated with the given vertex.
</description>
</method>
<method name="set_vertex_normal">
<return type="void">
</return>
<argument index="0" name="idx" type="int">
</argument>
<argument index="1" name="normal" type="Vector3">
</argument>
<description>
Sets the normal of the given vertex.
</description>
</method>
<method name="set_vertex_tangent">
<return type="void">
</return>
<argument index="0" name="idx" type="int">
</argument>
<argument index="1" name="tangent" type="Plane">
</argument>
<description>
Sets the tangent of the given vertex.
</description>
</method>
<method name="set_vertex_uv">
<return type="void">
</return>
<argument index="0" name="idx" type="int">
</argument>
<argument index="1" name="uv" type="Vector2">
</argument>
<description>
Sets the UV of the given vertex.
</description>
</method>
<method name="set_vertex_uv2">
<return type="void">
</return>
<argument index="0" name="idx" type="int">
</argument>
<argument index="1" name="uv2" type="Vector2">
</argument>
<description>
Sets the UV2 of the given vertex.
</description>
</method>
<method name="set_vertex_weights">
<return type="void">
</return>
<argument index="0" name="idx" type="int">
</argument>
<argument index="1" name="weights" type="PoolRealArray">
</argument>
<description>
Sets the bone weights of the given vertex.
</description>
</method>
</methods>
<constants>
</constants>
</class>
|