diff options
Diffstat (limited to 'doc/classes/MeshDataTool.xml')
| -rw-r--r-- | doc/classes/MeshDataTool.xml | 58 |
1 files changed, 29 insertions, 29 deletions
diff --git a/doc/classes/MeshDataTool.xml b/doc/classes/MeshDataTool.xml index 5cee9915ff..22c31306bf 100644 --- a/doc/classes/MeshDataTool.xml +++ b/doc/classes/MeshDataTool.xml @@ -4,9 +4,9 @@ Helper tool to access and edit [Mesh] data. </brief_description> <description> - The 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 the 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 the MeshDataTool may be used. + 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) @@ -111,7 +111,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Returns meta data associated with given face. + Returns the metadata associated with the given face. </description> </method> <method name="get_face_normal" qualifiers="const"> @@ -120,7 +120,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Calculates and returns face normal of given face. + Calculates and returns the face normal of the given face. </description> </method> <method name="get_face_vertex" qualifiers="const"> @@ -131,7 +131,7 @@ <argument index="1" name="vertex" type="int"> </argument> <description> - Returns specified vertex of given face. + Returns the specified vertex of the given face. Vertex argument must be 2 or less because faces contain three vertices. </description> </method> @@ -139,15 +139,15 @@ <return type="int"> </return> <description> - Returns format of [Mesh]. 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]. - For list of format flags see [enum ArrayMesh.ArrayFormat]. + 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 material assigned to the [Mesh]. + Returns the material assigned to the [Mesh]. </description> </method> <method name="get_vertex" qualifiers="const"> @@ -190,7 +190,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Returns array of edges that share given vertex. + Returns an array of edges that share the given vertex. </description> </method> <method name="get_vertex_faces" qualifiers="const"> @@ -199,7 +199,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Returns array of faces that share given vertex. + Returns an array of faces that share the given vertex. </description> </method> <method name="get_vertex_meta" qualifiers="const"> @@ -208,7 +208,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Returns meta data associated with given vertex. + Returns the metadata associated with the given vertex. </description> </method> <method name="get_vertex_normal" qualifiers="const"> @@ -217,7 +217,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Returns normal of given vertex. + Returns the normal of the given vertex. </description> </method> <method name="get_vertex_tangent" qualifiers="const"> @@ -226,7 +226,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Returns tangent of given vertex. + Returns the tangent of the given vertex. </description> </method> <method name="get_vertex_uv" qualifiers="const"> @@ -235,7 +235,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Returns UV of given vertex. + Returns the UV of the given vertex. </description> </method> <method name="get_vertex_uv2" qualifiers="const"> @@ -244,7 +244,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Returns UV2 of given vertex. + Returns the UV2 of the given vertex. </description> </method> <method name="get_vertex_weights" qualifiers="const"> @@ -253,7 +253,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Returns bone weights of given vertex. + Returns bone weights of the given vertex. </description> </method> <method name="set_edge_meta"> @@ -264,7 +264,7 @@ <argument index="1" name="meta" type="Variant"> </argument> <description> - Sets the meta data of given edge. + Sets the metadata of the given edge. </description> </method> <method name="set_face_meta"> @@ -275,7 +275,7 @@ <argument index="1" name="meta" type="Variant"> </argument> <description> - Sets the meta data of given face. + Sets the metadata of the given face. </description> </method> <method name="set_material"> @@ -284,7 +284,7 @@ <argument index="0" name="material" type="Material"> </argument> <description> - Sets the material to be used by newly constructed [Mesh]. + Sets the material to be used by newly-constructed [Mesh]. </description> </method> <method name="set_vertex"> @@ -295,7 +295,7 @@ <argument index="1" name="vertex" type="Vector3"> </argument> <description> - Sets the position of given vertex. + Sets the position of the given vertex. </description> </method> <method name="set_vertex_bones"> @@ -306,7 +306,7 @@ <argument index="1" name="bones" type="PoolIntArray"> </argument> <description> - Sets the bones of given vertex. + Sets the bones of the given vertex. </description> </method> <method name="set_vertex_color"> @@ -317,7 +317,7 @@ <argument index="1" name="color" type="Color"> </argument> <description> - Sets the color of given vertex. + Sets the color of the given vertex. </description> </method> <method name="set_vertex_meta"> @@ -328,7 +328,7 @@ <argument index="1" name="meta" type="Variant"> </argument> <description> - Sets the meta data associated with given vertex. + Sets the metadata associated with the given vertex. </description> </method> <method name="set_vertex_normal"> @@ -339,7 +339,7 @@ <argument index="1" name="normal" type="Vector3"> </argument> <description> - Sets the normal of given vertex. + Sets the normal of the given vertex. </description> </method> <method name="set_vertex_tangent"> @@ -350,7 +350,7 @@ <argument index="1" name="tangent" type="Plane"> </argument> <description> - Sets the tangent of given vertex. + Sets the tangent of the given vertex. </description> </method> <method name="set_vertex_uv"> @@ -361,7 +361,7 @@ <argument index="1" name="uv" type="Vector2"> </argument> <description> - Sets the UV of given vertex. + Sets the UV of the given vertex. </description> </method> <method name="set_vertex_uv2"> @@ -372,7 +372,7 @@ <argument index="1" name="uv2" type="Vector2"> </argument> <description> - Sets the UV2 of given vertex. + Sets the UV2 of the given vertex. </description> </method> <method name="set_vertex_weights"> @@ -383,7 +383,7 @@ <argument index="1" name="weights" type="PoolRealArray"> </argument> <description> - Sets the bone weights of given vertex. + Sets the bone weights of the given vertex. </description> </method> </methods> |