Merge pull request #21561 from BastiaanOlij/doc_mesh

Update ArrayMesh/Mesh documentation
This commit is contained in:
Rémi Verschelde 2018-08-29 13:16:57 +02:00 committed by GitHub
commit 24ecc4abb0
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 43 additions and 34 deletions

View file

@ -66,13 +66,6 @@
Returns the name of the blend shape at this index. Returns the name of the blend shape at this index.
</description> </description>
</method> </method>
<method name="get_surface_count" qualifiers="const">
<return type="int">
</return>
<description>
Return the amount of surfaces that the [code]ArrayMesh[/code] holds.
</description>
</method>
<method name="lightmap_unwrap"> <method name="lightmap_unwrap">
<return type="int" enum="Error"> <return type="int" enum="Error">
</return> </return>
@ -118,24 +111,6 @@
Return the length in vertices of the vertex array in the requested surface (see [method add_surface_from_arrays]). Return the length in vertices of the vertex array in the requested surface (see [method add_surface_from_arrays]).
</description> </description>
</method> </method>
<method name="surface_get_arrays" qualifiers="const">
<return type="Array">
</return>
<argument index="0" name="surf_idx" type="int">
</argument>
<description>
Returns the arrays for the vertices, normals, uvs, etc. that make up the requested surface (see [method add_surface_from_arrays]).
</description>
</method>
<method name="surface_get_blend_shape_arrays" qualifiers="const">
<return type="Array">
</return>
<argument index="0" name="surf_idx" type="int">
</argument>
<description>
Returns the blend shape arrays for the requested surface.
</description>
</method>
<method name="surface_get_format" qualifiers="const"> <method name="surface_get_format" qualifiers="const">
<return type="int"> <return type="int">
</return> </return>
@ -145,15 +120,6 @@
Return the format mask of the requested surface (see [method add_surface_from_arrays]). Return the format mask of the requested surface (see [method add_surface_from_arrays]).
</description> </description>
</method> </method>
<method name="surface_get_material" qualifiers="const">
<return type="Material">
</return>
<argument index="0" name="surf_idx" type="int">
</argument>
<description>
Return a [Material] in a given surface. Surface is rendered using this material.
</description>
</method>
<method name="surface_get_name" qualifiers="const"> <method name="surface_get_name" qualifiers="const">
<return type="String"> <return type="String">
</return> </return>

View file

@ -48,6 +48,40 @@
Returns all the vertices that make up the faces of the mesh. Each three vertices represent one triangle. Returns all the vertices that make up the faces of the mesh. Each three vertices represent one triangle.
</description> </description>
</method> </method>
<method name="get_surface_count" qualifiers="const">
<return type="int">
</return>
<description>
Return the amount of surfaces that the [code]Mesh[/code] holds.
</description>
</method>
<method name="surface_get_arrays" qualifiers="const">
<return type="Array">
</return>
<argument index="0" name="surf_idx" type="int">
</argument>
<description>
Returns the arrays for the vertices, normals, uvs, etc. that make up the requested surface (see [method ArrayMesh.add_surface_from_arrays]).
</description>
</method>
<method name="surface_get_blend_shape_arrays" qualifiers="const">
<return type="Array">
</return>
<argument index="0" name="surf_idx" type="int">
</argument>
<description>
Returns the blend shape arrays for the requested surface.
</description>
</method>
<method name="surface_get_material" qualifiers="const">
<return type="Material">
</return>
<argument index="0" name="surf_idx" type="int">
</argument>
<description>
Return a [Material] in a given surface. Surface is rendered using this material.
</description>
</method>
</methods> </methods>
<members> <members>
<member name="lightmap_size_hint" type="Vector2" setter="set_lightmap_size_hint" getter="get_lightmap_size_hint"> <member name="lightmap_size_hint" type="Vector2" setter="set_lightmap_size_hint" getter="get_lightmap_size_hint">
@ -124,22 +158,31 @@
<constant name="ARRAY_COMPRESS_DEFAULT" value="97280" enum="ArrayFormat"> <constant name="ARRAY_COMPRESS_DEFAULT" value="97280" enum="ArrayFormat">
</constant> </constant>
<constant name="ARRAY_VERTEX" value="0" enum="ArrayType"> <constant name="ARRAY_VERTEX" value="0" enum="ArrayType">
Array of vertices.
</constant> </constant>
<constant name="ARRAY_NORMAL" value="1" enum="ArrayType"> <constant name="ARRAY_NORMAL" value="1" enum="ArrayType">
Array of normals.
</constant> </constant>
<constant name="ARRAY_TANGENT" value="2" enum="ArrayType"> <constant name="ARRAY_TANGENT" value="2" enum="ArrayType">
Array of tangents as an array of floats, 4 floats per tangent.
</constant> </constant>
<constant name="ARRAY_COLOR" value="3" enum="ArrayType"> <constant name="ARRAY_COLOR" value="3" enum="ArrayType">
Array of colors.
</constant> </constant>
<constant name="ARRAY_TEX_UV" value="4" enum="ArrayType"> <constant name="ARRAY_TEX_UV" value="4" enum="ArrayType">
Array of UV coordinates.
</constant> </constant>
<constant name="ARRAY_TEX_UV2" value="5" enum="ArrayType"> <constant name="ARRAY_TEX_UV2" value="5" enum="ArrayType">
Array of second set of UV coordinates.
</constant> </constant>
<constant name="ARRAY_BONES" value="6" enum="ArrayType"> <constant name="ARRAY_BONES" value="6" enum="ArrayType">
Array of bone data.
</constant> </constant>
<constant name="ARRAY_WEIGHTS" value="7" enum="ArrayType"> <constant name="ARRAY_WEIGHTS" value="7" enum="ArrayType">
Array of weights.
</constant> </constant>
<constant name="ARRAY_INDEX" value="8" enum="ArrayType"> <constant name="ARRAY_INDEX" value="8" enum="ArrayType">
Array of indices.
</constant> </constant>
<constant name="ARRAY_MAX" value="9" enum="ArrayType"> <constant name="ARRAY_MAX" value="9" enum="ArrayType">
</constant> </constant>