stan220/godot-docs
1
0
Fork 0
mirror of https://github.com/stan220/godot-docs.git synced 2026-09-08 21:29:07 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
31ff1beb7fe210ebd7ce5e4f6b48aaeda3fe33bd
godot-docs/classes/class_mesh.rst
T
Rémi Verschelde 1204e3ea17 Add a warning header to each classref file 
To tell potential contributors that they should NOT edit those files but instead should work on the class.xml source of the main Godot repo
2016-02-17 22:04:18 +01:00

211 lines
18 KiB
ReStructuredText
Raw Blame History

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
.. _class_Mesh:
Mesh
====
**Inherits:** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
A :ref:`Resource<class_resource>` that contains vertex-array based geometry.
Member Functions
----------------
+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_morph_target<class_Mesh_add_morph_target>` **(** :ref:`String<class_string>` name **)** |
+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_morph_target_count<class_Mesh_get_morph_target_count>` **(** **)** const |
+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_morph_target_name<class_Mesh_get_morph_target_name>` **(** :ref:`int<class_int>` index **)** const |
+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_morph_targets<class_Mesh_clear_morph_targets>` **(** **)** |
+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_morph_target_mode<class_Mesh_set_morph_target_mode>` **(** :ref:`int<class_int>` mode **)** |
+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_morph_target_mode<class_Mesh_get_morph_target_mode>` **(** **)** const |
+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_surface<class_Mesh_add_surface>` **(** :ref:`int<class_int>` primitive, :ref:`Array<class_array>` arrays, :ref:`Array<class_array>` morph_arrays=Array(), :ref:`bool<class_bool>` alphasort=false **)** |
+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_surface_count<class_Mesh_get_surface_count>` **(** **)** const |
+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`surface_remove<class_Mesh_surface_remove>` **(** :ref:`int<class_int>` surf_idx **)** |
+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`surface_get_array_len<class_Mesh_surface_get_array_len>` **(** :ref:`int<class_int>` surf_idx **)** const |
+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`surface_get_array_index_len<class_Mesh_surface_get_array_index_len>` **(** :ref:`int<class_int>` surf_idx **)** const |
+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`surface_get_format<class_Mesh_surface_get_format>` **(** :ref:`int<class_int>` surf_idx **)** const |
+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`surface_get_primitive_type<class_Mesh_surface_get_primitive_type>` **(** :ref:`int<class_int>` surf_idx **)** const |
+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`surface_set_material<class_Mesh_surface_set_material>` **(** :ref:`int<class_int>` surf_idx, :ref:`Material<class_material>` material **)** |
+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Material<class_material>` | :ref:`surface_get_material<class_Mesh_surface_get_material>` **(** :ref:`int<class_int>` surf_idx **)** const |
+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`surface_set_name<class_Mesh_surface_set_name>` **(** :ref:`int<class_int>` surf_idx, :ref:`String<class_string>` name **)** |
+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`surface_get_name<class_Mesh_surface_get_name>` **(** :ref:`int<class_int>` surf_idx **)** const |
+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`center_geometry<class_Mesh_center_geometry>` **(** **)** |
+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`regen_normalmaps<class_Mesh_regen_normalmaps>` **(** **)** |
+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_custom_aabb<class_Mesh_set_custom_aabb>` **(** :ref:`AABB<class_aabb>` aabb **)** |
+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`AABB<class_aabb>` | :ref:`get_custom_aabb<class_Mesh_get_custom_aabb>` **(** **)** const |
+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Numeric Constants
-----------------
- **NO_INDEX_ARRAY** = **-1** --- Default value used for index_array_len when no indices are present.
- **ARRAY_WEIGHTS_SIZE** = **4** --- Amount of weights/bone indices per vertex (always 4).
- **ARRAY_VERTEX** = **0** --- Vertex array (array of :ref:`Vector3<class_vector3>` vertices).
- **ARRAY_NORMAL** = **1** --- Normal array (array of :ref:`Vector3<class_vector3>` normals).
- **ARRAY_TANGENT** = **2** --- Tangent array, array of groups of 4 floats. first 3 floats determine the tangent, and the last the binormal direction as -1 or 1.
- **ARRAY_COLOR** = **3** --- Vertex array (array of :ref:`Color<class_color>` colors).
- **ARRAY_TEX_UV** = **4** --- UV array (array of :ref:`Vector3<class_vector3>` UVs or float array of groups of 2 floats (u,v)).
- **ARRAY_TEX_UV2** = **5** --- Second UV array (array of :ref:`Vector3<class_vector3>` UVs or float array of groups of 2 floats (u,v)).
- **ARRAY_BONES** = **6** --- Array of bone indices, as a float array. Each element in groups of 4 floats.
- **ARRAY_WEIGHTS** = **7** --- Array of bone weights, as a float array. Each element in groups of 4 floats.
- **ARRAY_INDEX** = **8** --- Array of integers, used as indices referencing vertices. No index can be beyond the vertex array size.
- **ARRAY_FORMAT_VERTEX** = **1** --- Array format will include vertices (mandatory).
- **ARRAY_FORMAT_NORMAL** = **2** --- Array format will include normals
- **ARRAY_FORMAT_TANGENT** = **4** --- Array format will include tangents
- **ARRAY_FORMAT_COLOR** = **8** --- Array format will include a color array.
- **ARRAY_FORMAT_TEX_UV** = **16** --- Array format will include UVs.
- **ARRAY_FORMAT_TEX_UV2** = **32** --- Array format will include another set of UVs.
- **ARRAY_FORMAT_BONES** = **64** --- Array format will include bone indices.
- **ARRAY_FORMAT_WEIGHTS** = **128** --- Array format will include bone weights.
- **ARRAY_FORMAT_INDEX** = **256** --- Index array will be used.
- **PRIMITIVE_POINTS** = **0** --- Render array as points (one vertex equals one point).
- **PRIMITIVE_LINES** = **1** --- Render array as lines (every two vertices a line is created).
- **PRIMITIVE_LINE_STRIP** = **2** --- Render array as line strip.
- **PRIMITIVE_LINE_LOOP** = **3** --- Render array as line loop (like line strip, but closed).
- **PRIMITIVE_TRIANGLES** = **4** --- Render array as triangles (every three vertices a triangle is created).
- **PRIMITIVE_TRIANGLE_STRIP** = **5** --- Render array as triangle strips.
- **PRIMITIVE_TRIANGLE_FAN** = **6** --- Render array as triangle fans.
Description
-----------
Mesh is a type of :ref:`Resource<class_resource>` that contains vertex-array based geometry, divided in *surfaces*. 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.
Member Function Description
---------------------------
.. _class_Mesh_add_morph_target:
- void **add_morph_target** **(** :ref:`String<class_string>` name **)**
.. _class_Mesh_get_morph_target_count:
- :ref:`int<class_int>` **get_morph_target_count** **(** **)** const
.. _class_Mesh_get_morph_target_name:
- :ref:`String<class_string>` **get_morph_target_name** **(** :ref:`int<class_int>` index **)** const
.. _class_Mesh_clear_morph_targets:
- void **clear_morph_targets** **(** **)**
.. _class_Mesh_set_morph_target_mode:
- void **set_morph_target_mode** **(** :ref:`int<class_int>` mode **)**
.. _class_Mesh_get_morph_target_mode:
- :ref:`int<class_int>` **get_morph_target_mode** **(** **)** const
.. _class_Mesh_add_surface:
- void **add_surface** **(** :ref:`int<class_int>` primitive, :ref:`Array<class_array>` arrays, :ref:`Array<class_array>` morph_arrays=Array(), :ref:`bool<class_bool>` alphasort=false **)**
Create a new surface (:ref:`get_surface_count<class_Mesh_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).
The format of a surface determines which arrays it will allocate and hold, so "format" is a combination of ARRAY_FORMAT\_\* mask constants ORed together. ARRAY_FORMAT_VERTEX must be always present. "array_len" determines the amount of vertices in the array (not primitives!). if ARRAY_FORMAT_INDEX is in the format mask, then it means that an index array will be allocated and "index_array_len" must be passed.
.. _class_Mesh_get_surface_count:
- :ref:`int<class_int>` **get_surface_count** **(** **)** const
Return the amount of surfaces that the :ref:`Mesh<class_mesh>` holds.
.. _class_Mesh_surface_remove:
- void **surface_remove** **(** :ref:`int<class_int>` surf_idx **)**
Remove a surface at position surf_idx, shifting greater surfaces one surf_idx slot down.
.. _class_Mesh_surface_get_array_len:
- :ref:`int<class_int>` **surface_get_array_len** **(** :ref:`int<class_int>` surf_idx **)** const
Return the length in vertices of the vertex array in the requested surface (see :ref:`add_surface<class_Mesh_add_surface>`).
.. _class_Mesh_surface_get_array_index_len:
- :ref:`int<class_int>` **surface_get_array_index_len** **(** :ref:`int<class_int>` surf_idx **)** const
Return the length in indices of the index array in the requested surface (see :ref:`add_surface<class_Mesh_add_surface>`).
.. _class_Mesh_surface_get_format:
- :ref:`int<class_int>` **surface_get_format** **(** :ref:`int<class_int>` surf_idx **)** const
Return the format mask of the requested surface (see :ref:`add_surface<class_Mesh_add_surface>`).
.. _class_Mesh_surface_get_primitive_type:
- :ref:`int<class_int>` **surface_get_primitive_type** **(** :ref:`int<class_int>` surf_idx **)** const
Return the primitive type of the requested surface (see :ref:`add_surface<class_Mesh_add_surface>`).
.. _class_Mesh_surface_set_material:
- void **surface_set_material** **(** :ref:`int<class_int>` surf_idx, :ref:`Material<class_material>` material **)**
Set a :ref:`Material<class_material>` for a given surface. Surface will be rendered using this material.
.. _class_Mesh_surface_get_material:
- :ref:`Material<class_material>` **surface_get_material** **(** :ref:`int<class_int>` surf_idx **)** const
Return a :ref:`Material<class_material>` in a given surface. Surface is rendered using this material.
.. _class_Mesh_surface_set_name:
- void **surface_set_name** **(** :ref:`int<class_int>` surf_idx, :ref:`String<class_string>` name **)**
.. _class_Mesh_surface_get_name:
- :ref:`String<class_string>` **surface_get_name** **(** :ref:`int<class_int>` surf_idx **)** const
.. _class_Mesh_center_geometry:
- void **center_geometry** **(** **)**
.. _class_Mesh_regen_normalmaps:
- void **regen_normalmaps** **(** **)**
.. _class_Mesh_set_custom_aabb:
- void **set_custom_aabb** **(** :ref:`AABB<class_aabb>` aabb **)**
.. _class_Mesh_get_custom_aabb:
- :ref:`AABB<class_aabb>` **get_custom_aabb** **(** **)** const
Reference in New Issue View Git Blame Copy Permalink