summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRyan Roden-Corrent <ryan@rcorre.net>2020-07-15 08:09:27 -0400
committerRyan Roden-Corrent <ryan@rcorre.net>2020-07-15 08:09:27 -0400
commit933bf9652385c7e63418bc52f2c8e2bb2311d577 (patch)
treea1c0640e9035df20ff9a14b6f1a2fa6abc7be325
parent08dda79a9c0749b028743321c04bc5b1d7e94490 (diff)
Clarify how to convert PrimitiveMesh to ArrayMesh.
It took me a bit to figure this out, as I was initially doing something more complicated like this before I realized I just had to pass get_mesh_arrays directly to add_surface_from_arrays. ``` var arr_mesh = ArrayMesh.new() var arrays = [] arrays.resize(ArrayMesh.ARRAY_MAX) arrays[ArrayMesh.ARRAY_VERTEX] = c.get_mesh_arrays() arr_mesh.add_surface_from_arrays(Mesh.PRIMITIVE_TRIANGLES, arrays) ```
-rw-r--r--doc/classes/PrimitiveMesh.xml7
1 files changed, 6 insertions, 1 deletions
diff --git a/doc/classes/PrimitiveMesh.xml b/doc/classes/PrimitiveMesh.xml
index 77915bc538..9e7f26ed4f 100644
--- a/doc/classes/PrimitiveMesh.xml
+++ b/doc/classes/PrimitiveMesh.xml
@@ -13,7 +13,12 @@
<return type="Array">
</return>
<description>
- Returns mesh arrays used to constitute surface of [Mesh]. Mesh arrays can be used with [ArrayMesh] to create new surfaces.
+ Returns mesh arrays used to constitute surface of [Mesh]. The result can be passed to [method ArrayMesh.add_surface_from_arrays] to create a new surface. For example:
+ [codeblock]
+ var c := CylinderMesh.new()
+ var arr_mesh := ArrayMesh.new()
+ arr_mesh.add_surface_from_arrays(Mesh.PRIMITIVE_TRIANGLES, c.get_mesh_arrays())
+ [/codeblock]
</description>
</method>
</methods>