2017-09-12 22:42:36 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
2018-01-13 11:43:06 +01:00
<class name= "ArrayMesh" inherits= "Mesh" category= "Core" version= "3.0-rc1" >
2017-09-12 22:42:36 +02:00
<brief_description >
</brief_description>
<description >
</description>
<tutorials >
</tutorials>
<demos >
</demos>
<methods >
<method name= "add_blend_shape" >
<return type= "void" >
</return>
<argument index= "0" name= "name" type= "String" >
</argument>
<description >
</description>
</method>
<method name= "add_surface_from_arrays" >
<return type= "void" >
</return>
<argument index= "0" name= "primitive" type= "int" enum= "Mesh.PrimitiveType" >
</argument>
<argument index= "1" name= "arrays" type= "Array" >
</argument>
<argument index= "2" name= "blend_shapes" type= "Array" default= "[ ]" >
</argument>
<argument index= "3" name= "compress_flags" type= "int" default= "97792" >
</argument>
<description >
Create a new surface ([method get_surface_count] that will become surf_idx for this.
Surfaces are created to be rendered using a "primitive", which may be PRIMITIVE_POINTS, PRIMITIVE_LINES, PRIMITIVE_LINE_STRIP, PRIMITIVE_LINE_LOOP, PRIMITIVE_TRIANGLES, PRIMITIVE_TRIANGLE_STRIP, PRIMITIVE_TRIANGLE_FAN. (As a note, when using indices, it is recommended to only use just points, lines or triangles).
</description>
</method>
<method name= "center_geometry" >
<return type= "void" >
</return>
<description >
</description>
</method>
<method name= "clear_blend_shapes" >
<return type= "void" >
</return>
<description >
</description>
</method>
<method name= "get_blend_shape_count" qualifiers= "const" >
<return type= "int" >
</return>
<description >
</description>
</method>
<method name= "get_blend_shape_name" qualifiers= "const" >
<return type= "String" >
</return>
<argument index= "0" name= "index" type= "int" >
</argument>
<description >
</description>
</method>
<method name= "get_surface_count" qualifiers= "const" >
<return type= "int" >
</return>
<description >
2017-10-22 12:56:11 +02:00
Return the amount of surfaces that the [code]ArrayMesh[/code] holds.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "regen_normalmaps" >
<return type= "void" >
</return>
<description >
</description>
</method>
<method name= "surface_get_array_index_len" qualifiers= "const" >
<return type= "int" >
</return>
<argument index= "0" name= "surf_idx" type= "int" >
</argument>
<description >
Return the length in indices of the index array in the requested surface (see [method add_surface]).
</description>
</method>
<method name= "surface_get_array_len" qualifiers= "const" >
<return type= "int" >
</return>
<argument index= "0" name= "surf_idx" type= "int" >
</argument>
<description >
Return the length in vertices of the vertex array in the requested surface (see [method add_surface]).
</description>
</method>
<method name= "surface_get_arrays" qualifiers= "const" >
<return type= "Array" >
</return>
<argument index= "0" name= "surf_idx" type= "int" >
</argument>
<description >
</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 >
</description>
</method>
<method name= "surface_get_format" qualifiers= "const" >
<return type= "int" >
</return>
<argument index= "0" name= "surf_idx" type= "int" >
</argument>
<description >
Return the format mask of the requested surface (see [method add_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>
<method name= "surface_get_name" qualifiers= "const" >
<return type= "String" >
</return>
<argument index= "0" name= "surf_idx" type= "int" >
</argument>
<description >
</description>
</method>
<method name= "surface_get_primitive_type" qualifiers= "const" >
<return type= "int" enum= "Mesh.PrimitiveType" >
</return>
<argument index= "0" name= "surf_idx" type= "int" >
</argument>
<description >
Return the primitive type of the requested surface (see [method add_surface]).
</description>
</method>
<method name= "surface_remove" >
<return type= "void" >
</return>
<argument index= "0" name= "surf_idx" type= "int" >
</argument>
<description >
Remove a surface at position surf_idx, shifting greater surfaces one surf_idx slot down.
</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>
<description >
</description>
</method>
<method name= "surface_set_name" >
<return type= "void" >
</return>
<argument index= "0" name= "surf_idx" type= "int" >
</argument>
<argument index= "1" name= "name" type= "String" >
</argument>
<description >
Set a [Material] for a given surface. Surface will be rendered using this material.
</description>
</method>
2017-11-15 20:35:18 +01:00
<method name= "surface_update_region" >
<return type= "void" >
</return>
<argument index= "0" name= "surf_idx" type= "int" >
</argument>
<argument index= "1" name= "offset" type= "int" >
</argument>
<argument index= "2" name= "data" type= "PoolByteArray" >
</argument>
<description >
</description>
</method>
2017-09-12 22:42:36 +02:00
</methods>
2018-01-11 23:38:35 +01:00
<members >
<member name= "blend_shape_mode" type= "int" setter= "set_blend_shape_mode" getter= "get_blend_shape_mode" enum= "Mesh.BlendShapeMode" >
</member>
<member name= "custom_aabb" type= "AABB" setter= "set_custom_aabb" getter= "get_custom_aabb" >
</member>
</members>
2017-09-12 22:42:36 +02:00
<constants >
2017-11-24 23:16:30 +01:00
<constant name= "NO_INDEX_ARRAY" value= "-1" >
2017-09-12 22:42:36 +02:00
Default value used for index_array_len when no indices are present.
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "ARRAY_WEIGHTS_SIZE" value= "4" >
2017-09-12 22:42:36 +02:00
Amount of weights/bone indices per vertex (always 4).
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "ARRAY_VERTEX" value= "0" enum= "ArrayType" >
2017-09-12 22:42:36 +02:00
Vertex array (array of [Vector3] vertices).
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "ARRAY_NORMAL" value= "1" enum= "ArrayType" >
2017-09-12 22:42:36 +02:00
Normal array (array of [Vector3] normals).
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "ARRAY_TANGENT" value= "2" enum= "ArrayType" >
2017-09-12 22:42:36 +02:00
Tangent array, array of groups of 4 floats. first 3 floats determine the tangent, and the last the binormal direction as -1 or 1.
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "ARRAY_COLOR" value= "3" enum= "ArrayType" >
2017-09-12 22:42:36 +02:00
Vertex array (array of [Color] colors).
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "ARRAY_TEX_UV" value= "4" enum= "ArrayType" >
2017-09-12 22:42:36 +02:00
UV array (array of [Vector3] UVs or float array of groups of 2 floats (u,v)).
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "ARRAY_TEX_UV2" value= "5" enum= "ArrayType" >
2017-09-12 22:42:36 +02:00
Second UV array (array of [Vector3] UVs or float array of groups of 2 floats (u,v)).
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "ARRAY_BONES" value= "6" enum= "ArrayType" >
2017-09-12 22:42:36 +02:00
Array of bone indices, as a float array. Each element in groups of 4 floats.
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "ARRAY_WEIGHTS" value= "7" enum= "ArrayType" >
2017-09-12 22:42:36 +02:00
Array of bone weights, as a float array. Each element in groups of 4 floats.
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "ARRAY_INDEX" value= "8" enum= "ArrayType" >
2017-09-12 22:42:36 +02:00
Array of integers, used as indices referencing vertices. No index can be beyond the vertex array size.
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "ARRAY_MAX" value= "9" enum= "ArrayType" >
2017-09-12 22:42:36 +02:00
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "ARRAY_FORMAT_VERTEX" value= "1" enum= "ArrayFormat" >
2017-09-12 22:42:36 +02:00
Array format will include vertices (mandatory).
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "ARRAY_FORMAT_NORMAL" value= "2" enum= "ArrayFormat" >
2017-09-12 22:42:36 +02:00
Array format will include normals
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "ARRAY_FORMAT_TANGENT" value= "4" enum= "ArrayFormat" >
2017-09-12 22:42:36 +02:00
Array format will include tangents
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "ARRAY_FORMAT_COLOR" value= "8" enum= "ArrayFormat" >
2017-09-12 22:42:36 +02:00
Array format will include a color array.
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "ARRAY_FORMAT_TEX_UV" value= "16" enum= "ArrayFormat" >
2017-09-12 22:42:36 +02:00
Array format will include UVs.
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "ARRAY_FORMAT_TEX_UV2" value= "32" enum= "ArrayFormat" >
2017-09-12 22:42:36 +02:00
Array format will include another set of UVs.
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "ARRAY_FORMAT_BONES" value= "64" enum= "ArrayFormat" >
2017-09-12 22:42:36 +02:00
Array format will include bone indices.
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "ARRAY_FORMAT_WEIGHTS" value= "128" enum= "ArrayFormat" >
2017-09-12 22:42:36 +02:00
Array format will include bone weights.
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "ARRAY_FORMAT_INDEX" value= "256" enum= "ArrayFormat" >
2017-09-12 22:42:36 +02:00
Index array will be used.
</constant>
</constants>
</class>