diff options
Diffstat (limited to 'doc/classes/Mesh.xml')
| -rw-r--r-- | doc/classes/Mesh.xml | 57 |
1 files changed, 22 insertions, 35 deletions
diff --git a/doc/classes/Mesh.xml b/doc/classes/Mesh.xml index ed7c39d4d9..bfa55c2d35 100644 --- a/doc/classes/Mesh.xml +++ b/doc/classes/Mesh.xml @@ -14,99 +14,86 @@ </tutorials> <methods> <method name="create_convex_shape" qualifiers="const"> - <return type="Shape3D"> - </return> + <return type="Shape3D" /> + <argument index="0" name="clean" type="bool" default="true" /> + <argument index="1" name="simplify" type="bool" default="false" /> <description> Calculate a [ConvexPolygonShape3D] from the mesh. + If [code]clean[/code] is [code]true[/code] (default), duplicate and interior vertices are removed automatically. You can set it to [code]false[/code] to make the process faster if not needed. + If [code]simplify[/code] is [code]true[/code], the geometry can be further simplified to reduce the amount of vertices. Disabled by default. </description> </method> <method name="create_outline" qualifiers="const"> - <return type="Mesh"> - </return> - <argument index="0" name="margin" type="float"> - </argument> + <return type="Mesh" /> + <argument index="0" name="margin" type="float" /> <description> Calculate an outline mesh at a defined offset (margin) from the original mesh. [b]Note:[/b] This method typically returns the vertices in reverse order (e.g. clockwise to counterclockwise). </description> </method> <method name="create_trimesh_shape" qualifiers="const"> - <return type="Shape3D"> - </return> + <return type="Shape3D" /> <description> Calculate a [ConcavePolygonShape3D] from the mesh. </description> </method> <method name="generate_triangle_mesh" qualifiers="const"> - <return type="TriangleMesh"> - </return> + <return type="TriangleMesh" /> <description> Generate a [TriangleMesh] from the mesh. </description> </method> <method name="get_aabb" qualifiers="const"> - <return type="AABB"> - </return> + <return type="AABB" /> <description> Returns the smallest [AABB] enclosing this mesh in local space. Not affected by [code]custom_aabb[/code]. See also [method VisualInstance3D.get_transformed_aabb]. [b]Note:[/b] This is only implemented for [ArrayMesh] and [PrimitiveMesh]. </description> </method> <method name="get_faces" qualifiers="const"> - <return type="PackedVector3Array"> - </return> + <return type="PackedVector3Array" /> <description> Returns all the vertices that make up the faces of the mesh. Each three vertices represent one triangle. </description> </method> <method name="get_surface_count" qualifiers="const"> - <return type="int"> - </return> + <return type="int" /> <description> Returns the amount of surfaces that the [Mesh] holds. </description> </method> <method name="surface_get_arrays" qualifiers="const"> - <return type="Array"> - </return> - <argument index="0" name="surf_idx" type="int"> - </argument> + <return type="Array" /> + <argument index="0" name="surf_idx" type="int" /> <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> + <return type="Array" /> + <argument index="0" name="surf_idx" type="int" /> <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> + <return type="Material" /> + <argument index="0" name="surf_idx" type="int" /> <description> Returns a [Material] in a given surface. Surface is rendered using this material. </description> </method> <method name="surface_set_material"> - <return type="void"> - </return> - <argument index="0" name="surf_idx" type="int"> - </argument> - <argument index="1" name="material" type="Material"> - </argument> + <return type="void" /> + <argument index="0" name="surf_idx" type="int" /> + <argument index="1" name="material" type="Material" /> <description> Sets a [Material] for a given surface. Surface will be rendered using this material. </description> </method> </methods> <members> - <member name="lightmap_size_hint" type="Vector2i" setter="set_lightmap_size_hint" getter="get_lightmap_size_hint" default="Vector2i( 0, 0 )"> + <member name="lightmap_size_hint" type="Vector2i" setter="set_lightmap_size_hint" getter="get_lightmap_size_hint" default="Vector2i(0, 0)"> Sets a hint to be used for lightmap resolution. </member> </members> |