2017-09-13 04:42:36 +08:00
<?xml version="1.0" encoding="UTF-8" ?>
2020-02-01 09:03:48 +08:00
<class name= "Mesh" inherits= "Resource" version= "4.0" >
2017-09-13 04:42:36 +08:00
<brief_description >
2019-06-22 07:04:47 +08:00
A [Resource] that contains vertex array-based geometry.
2017-09-13 04:42:36 +08:00
</brief_description>
<description >
2019-06-22 07:04:47 +08:00
Mesh is a type of [Resource] that contains vertex array-based geometry, divided in [i]surfaces[/i]. Each surface contains a completely separate array and a material used to draw it. Design wise, a mesh with multiple surfaces is preferred to a single surface, because objects created in 3D editing software commonly contain multiple materials.
2017-09-13 04:42:36 +08:00
</description>
<tutorials >
2020-10-01 16:34:47 +08:00
<link title= "3D Material Testers Demo" > https://godotengine.org/asset-library/asset/123</link>
<link title= "3D Kinematic Character Demo" > https://godotengine.org/asset-library/asset/126</link>
<link title= "3D Platformer Demo" > https://godotengine.org/asset-library/asset/125</link>
<link title= "Third Person Shooter Demo" > https://godotengine.org/asset-library/asset/678</link>
2017-09-13 04:42:36 +08:00
</tutorials>
<methods >
<method name= "create_convex_shape" qualifiers= "const" >
2020-03-31 00:22:57 +08:00
<return type= "Shape3D" >
2017-09-13 04:42:36 +08:00
</return>
<description >
2020-03-31 00:22:57 +08:00
Calculate a [ConvexPolygonShape3D] from the mesh.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name= "create_outline" qualifiers= "const" >
<return type= "Mesh" >
</return>
<argument index= "0" name= "margin" type= "float" >
</argument>
<description >
2019-06-22 07:04:47 +08:00
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).
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name= "create_trimesh_shape" qualifiers= "const" >
2020-03-31 00:22:57 +08:00
<return type= "Shape3D" >
2017-09-13 04:42:36 +08:00
</return>
<description >
2020-03-31 00:22:57 +08:00
Calculate a [ConcavePolygonShape3D] from the mesh.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name= "generate_triangle_mesh" qualifiers= "const" >
<return type= "TriangleMesh" >
</return>
<description >
Generate a [TriangleMesh] from the mesh.
</description>
</method>
2019-12-08 10:23:05 +08:00
<method name= "get_aabb" qualifiers= "const" >
<return type= "AABB" >
</return>
<description >
2020-09-16 21:53:10 +08:00
Returns the smallest [AABB] enclosing this mesh in local space. Not affected by [code]custom_aabb[/code]. See also [method VisualInstance3D.get_transformed_aabb].
2019-12-08 10:23:05 +08:00
[b]Note:[/b] This is only implemented for [ArrayMesh] and [PrimitiveMesh].
</description>
</method>
2017-09-13 04:42:36 +08:00
<method name= "get_faces" qualifiers= "const" >
2020-02-18 20:59:24 +08:00
<return type= "PackedVector3Array" >
2017-09-13 04:42:36 +08:00
</return>
<description >
Returns all the vertices that make up the faces of the mesh. Each three vertices represent one triangle.
</description>
</method>
2018-08-29 19:02:48 +08:00
<method name= "get_surface_count" qualifiers= "const" >
<return type= "int" >
</return>
<description >
2019-05-24 10:15:43 +08:00
Returns the amount of surfaces that the [Mesh] holds.
2018-08-29 19:02:48 +08:00
</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 >
2019-05-24 10:15:43 +08:00
Returns a [Material] in a given surface. Surface is rendered using this material.
2018-08-29 19:02:48 +08:00
</description>
</method>
2019-02-01 01:04:36 +08:00
<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>
<description >
2019-06-22 07:04:47 +08:00
Sets a [Material] for a given surface. Surface will be rendered using this material.
2019-02-01 01:04:36 +08:00
</description>
</method>
2017-09-13 04:42:36 +08:00
</methods>
2017-12-10 07:43:30 +08:00
<members >
2020-05-12 16:10:34 +08:00
<member name= "lightmap_size_hint" type= "Vector2i" setter= "set_lightmap_size_hint" getter= "get_lightmap_size_hint" default= "Vector2i( 0, 0 )" >
2020-02-12 16:59:06 +08:00
Sets a hint to be used for lightmap resolution.
2017-12-10 07:43:30 +08:00
</member>
</members>
2017-09-13 04:42:36 +08:00
<constants >
2017-11-25 06:16:30 +08:00
<constant name= "PRIMITIVE_POINTS" value= "0" enum= "PrimitiveType" >
2017-09-13 04:42:36 +08:00
Render array as points (one vertex equals one point).
</constant>
2017-11-25 06:16:30 +08:00
<constant name= "PRIMITIVE_LINES" value= "1" enum= "PrimitiveType" >
2017-09-13 04:42:36 +08:00
Render array as lines (every two vertices a line is created).
</constant>
2017-11-25 06:16:30 +08:00
<constant name= "PRIMITIVE_LINE_STRIP" value= "2" enum= "PrimitiveType" >
2017-09-13 04:42:36 +08:00
Render array as line strip.
</constant>
2020-02-12 16:59:06 +08:00
<constant name= "PRIMITIVE_TRIANGLES" value= "3" enum= "PrimitiveType" >
2017-09-13 04:42:36 +08:00
Render array as triangles (every three vertices a triangle is created).
</constant>
2020-02-12 16:59:06 +08:00
<constant name= "PRIMITIVE_TRIANGLE_STRIP" value= "4" enum= "PrimitiveType" >
2017-09-13 04:42:36 +08:00
Render array as triangle strips.
</constant>
2017-11-25 06:16:30 +08:00
<constant name= "BLEND_SHAPE_MODE_NORMALIZED" value= "0" enum= "BlendShapeMode" >
2020-01-15 05:27:14 +08:00
Blend shapes are normalized.
2017-09-16 07:46:14 +08:00
</constant>
2017-11-25 06:16:30 +08:00
<constant name= "BLEND_SHAPE_MODE_RELATIVE" value= "1" enum= "BlendShapeMode" >
2020-01-15 05:27:14 +08:00
Blend shapes are relative to base weight.
2017-09-16 07:46:14 +08:00
</constant>
2017-11-25 06:16:30 +08:00
<constant name= "ARRAY_FORMAT_VERTEX" value= "1" enum= "ArrayFormat" >
2020-01-15 05:27:14 +08:00
Mesh array contains vertices. All meshes require a vertex array so this should always be present.
2017-09-16 07:46:14 +08:00
</constant>
2017-11-25 06:16:30 +08:00
<constant name= "ARRAY_FORMAT_NORMAL" value= "2" enum= "ArrayFormat" >
2020-01-15 05:27:14 +08:00
Mesh array contains normals.
2017-09-16 07:46:14 +08:00
</constant>
2017-11-25 06:16:30 +08:00
<constant name= "ARRAY_FORMAT_TANGENT" value= "4" enum= "ArrayFormat" >
2020-01-15 05:27:14 +08:00
Mesh array contains tangents.
2017-09-16 07:46:14 +08:00
</constant>
2017-11-25 06:16:30 +08:00
<constant name= "ARRAY_FORMAT_COLOR" value= "8" enum= "ArrayFormat" >
2020-01-15 05:27:14 +08:00
Mesh array contains colors.
2017-09-16 07:46:14 +08:00
</constant>
2017-11-25 06:16:30 +08:00
<constant name= "ARRAY_FORMAT_TEX_UV" value= "16" enum= "ArrayFormat" >
2020-01-15 05:27:14 +08:00
Mesh array contains UVs.
2017-09-16 07:46:14 +08:00
</constant>
2017-11-25 06:16:30 +08:00
<constant name= "ARRAY_FORMAT_TEX_UV2" value= "32" enum= "ArrayFormat" >
2020-01-15 05:27:14 +08:00
Mesh array contains second UV.
2017-09-16 07:46:14 +08:00
</constant>
2017-11-25 06:16:30 +08:00
<constant name= "ARRAY_FORMAT_BONES" value= "64" enum= "ArrayFormat" >
2020-01-15 05:27:14 +08:00
Mesh array contains bones.
2017-09-16 07:46:14 +08:00
</constant>
2017-11-25 06:16:30 +08:00
<constant name= "ARRAY_FORMAT_WEIGHTS" value= "128" enum= "ArrayFormat" >
2020-01-15 05:27:14 +08:00
Mesh array contains bone weights.
2017-09-16 07:46:14 +08:00
</constant>
2017-11-25 06:16:30 +08:00
<constant name= "ARRAY_FORMAT_INDEX" value= "256" enum= "ArrayFormat" >
2020-01-15 05:27:14 +08:00
Mesh array uses indices.
2017-09-16 07:46:14 +08:00
</constant>
2017-11-25 06:16:30 +08:00
<constant name= "ARRAY_COMPRESS_NORMAL" value= "1024" enum= "ArrayFormat" >
2020-01-15 05:27:14 +08:00
Flag used to mark a compressed (half float) normal array.
2017-09-16 07:46:14 +08:00
</constant>
2017-11-25 06:16:30 +08:00
<constant name= "ARRAY_COMPRESS_TANGENT" value= "2048" enum= "ArrayFormat" >
2020-01-15 05:27:14 +08:00
Flag used to mark a compressed (half float) tangent array.
2017-09-16 07:46:14 +08:00
</constant>
2017-11-25 06:16:30 +08:00
<constant name= "ARRAY_COMPRESS_COLOR" value= "4096" enum= "ArrayFormat" >
2020-01-15 05:27:14 +08:00
Flag used to mark a compressed (half float) color array.
2017-09-16 07:46:14 +08:00
</constant>
2017-11-25 06:16:30 +08:00
<constant name= "ARRAY_COMPRESS_TEX_UV" value= "8192" enum= "ArrayFormat" >
2020-01-15 05:27:14 +08:00
Flag used to mark a compressed (half float) UV coordinates array.
2017-09-16 07:46:14 +08:00
</constant>
2017-11-25 06:16:30 +08:00
<constant name= "ARRAY_COMPRESS_TEX_UV2" value= "16384" enum= "ArrayFormat" >
2020-01-15 05:27:14 +08:00
Flag used to mark a compressed (half float) UV coordinates array for the second UV coordinates.
2017-09-16 07:46:14 +08:00
</constant>
2017-11-25 06:16:30 +08:00
<constant name= "ARRAY_COMPRESS_INDEX" value= "131072" enum= "ArrayFormat" >
2020-01-15 05:27:14 +08:00
Flag used to mark a compressed index array.
2017-09-16 07:46:14 +08:00
</constant>
2017-11-25 06:16:30 +08:00
<constant name= "ARRAY_FLAG_USE_2D_VERTICES" value= "262144" enum= "ArrayFormat" >
2020-01-15 05:27:14 +08:00
Flag used to mark that the array contains 2D vertices.
2017-09-16 07:46:14 +08:00
</constant>
2020-02-12 16:59:06 +08:00
<constant name= "ARRAY_COMPRESS_DEFAULT" value= "31744" enum= "ArrayFormat" >
Used to set flags [constant ARRAY_COMPRESS_NORMAL], [constant ARRAY_COMPRESS_TANGENT], [constant ARRAY_COMPRESS_COLOR], [constant ARRAY_COMPRESS_TEX_UV] and [constant ARRAY_COMPRESS_TEX_UV2] quickly.
2017-09-16 07:46:14 +08:00
</constant>
2017-11-25 06:16:30 +08:00
<constant name= "ARRAY_VERTEX" value= "0" enum= "ArrayType" >
2018-08-29 19:02:48 +08:00
Array of vertices.
2017-09-16 07:46:14 +08:00
</constant>
2017-11-25 06:16:30 +08:00
<constant name= "ARRAY_NORMAL" value= "1" enum= "ArrayType" >
2018-08-29 19:02:48 +08:00
Array of normals.
2017-09-16 07:46:14 +08:00
</constant>
2017-11-25 06:16:30 +08:00
<constant name= "ARRAY_TANGENT" value= "2" enum= "ArrayType" >
2018-08-29 19:02:48 +08:00
Array of tangents as an array of floats, 4 floats per tangent.
2017-09-16 07:46:14 +08:00
</constant>
2017-11-25 06:16:30 +08:00
<constant name= "ARRAY_COLOR" value= "3" enum= "ArrayType" >
2018-08-29 19:02:48 +08:00
Array of colors.
2017-09-16 07:46:14 +08:00
</constant>
2017-11-25 06:16:30 +08:00
<constant name= "ARRAY_TEX_UV" value= "4" enum= "ArrayType" >
2018-08-29 19:02:48 +08:00
Array of UV coordinates.
2017-09-16 07:46:14 +08:00
</constant>
2017-11-25 06:16:30 +08:00
<constant name= "ARRAY_TEX_UV2" value= "5" enum= "ArrayType" >
2018-08-29 19:02:48 +08:00
Array of second set of UV coordinates.
2017-09-16 07:46:14 +08:00
</constant>
2017-11-25 06:16:30 +08:00
<constant name= "ARRAY_BONES" value= "6" enum= "ArrayType" >
2018-08-29 19:02:48 +08:00
Array of bone data.
2017-09-16 07:46:14 +08:00
</constant>
2017-11-25 06:16:30 +08:00
<constant name= "ARRAY_WEIGHTS" value= "7" enum= "ArrayType" >
2018-08-29 19:02:48 +08:00
Array of weights.
2017-09-16 07:46:14 +08:00
</constant>
2017-11-25 06:16:30 +08:00
<constant name= "ARRAY_INDEX" value= "8" enum= "ArrayType" >
2018-08-29 19:02:48 +08:00
Array of indices.
2017-09-16 07:46:14 +08:00
</constant>
2017-11-25 06:16:30 +08:00
<constant name= "ARRAY_MAX" value= "9" enum= "ArrayType" >
2019-06-27 17:10:53 +08:00
Represents the size of the [enum ArrayType] enum.
2017-09-16 07:46:14 +08:00
</constant>
2017-09-13 04:42:36 +08:00
</constants>
</class>