class_importermesh.rst 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ImporterMesh.xml.
  6. .. _class_ImporterMesh:
  7. ImporterMesh
  8. ============
  9. **Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  10. A :ref:`Resource<class_Resource>` that contains vertex array-based geometry during the import process.
  11. Description
  12. -----------
  13. ImporterMesh is a type of :ref:`Resource<class_Resource>` analogous to :ref:`ArrayMesh<class_ArrayMesh>`. It 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.
  14. Unlike its runtime counterpart, ``ImporterMesh`` contains mesh data before various import steps, such as lod and shadow mesh generation, have taken place. Modify surface data by calling :ref:`clear<class_ImporterMesh_method_clear>`, followed by :ref:`add_surface<class_ImporterMesh_method_add_surface>` for each surface.
  15. Properties
  16. ----------
  17. +-------------------------------------+-------------------------------------------------+------------------------+
  18. | :ref:`Dictionary<class_Dictionary>` | :ref:`_data<class_ImporterMesh_property__data>` | ``{ "surfaces": [] }`` |
  19. +-------------------------------------+-------------------------------------------------+------------------------+
  20. Methods
  21. -------
  22. +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  23. | void | :ref:`add_blend_shape<class_ImporterMesh_method_add_blend_shape>` **(** :ref:`String<class_String>` name **)** |
  24. +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  25. | void | :ref:`add_surface<class_ImporterMesh_method_add_surface>` **(** :ref:`PrimitiveType<enum_Mesh_PrimitiveType>` primitive, :ref:`Array<class_Array>` arrays, :ref:`Array[]<class_Array>` blend_shapes=[], :ref:`Dictionary<class_Dictionary>` lods={}, :ref:`Material<class_Material>` material=null, :ref:`String<class_String>` name="", :ref:`int<class_int>` flags=0 **)** |
  26. +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  27. | void | :ref:`clear<class_ImporterMesh_method_clear>` **(** **)** |
  28. +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  29. | void | :ref:`generate_lods<class_ImporterMesh_method_generate_lods>` **(** :ref:`float<class_float>` normal_merge_angle, :ref:`float<class_float>` normal_split_angle, :ref:`Array<class_Array>` bone_transform_array **)** |
  30. +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  31. | :ref:`int<class_int>` | :ref:`get_blend_shape_count<class_ImporterMesh_method_get_blend_shape_count>` **(** **)** |const| |
  32. +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  33. | :ref:`BlendShapeMode<enum_Mesh_BlendShapeMode>` | :ref:`get_blend_shape_mode<class_ImporterMesh_method_get_blend_shape_mode>` **(** **)** |const| |
  34. +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  35. | :ref:`String<class_String>` | :ref:`get_blend_shape_name<class_ImporterMesh_method_get_blend_shape_name>` **(** :ref:`int<class_int>` blend_shape_idx **)** |const| |
  36. +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  37. | :ref:`Vector2i<class_Vector2i>` | :ref:`get_lightmap_size_hint<class_ImporterMesh_method_get_lightmap_size_hint>` **(** **)** |const| |
  38. +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  39. | :ref:`ArrayMesh<class_ArrayMesh>` | :ref:`get_mesh<class_ImporterMesh_method_get_mesh>` **(** :ref:`ArrayMesh<class_ArrayMesh>` base_mesh=null **)** |
  40. +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  41. | :ref:`Array<class_Array>` | :ref:`get_surface_arrays<class_ImporterMesh_method_get_surface_arrays>` **(** :ref:`int<class_int>` surface_idx **)** |const| |
  42. +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  43. | :ref:`Array<class_Array>` | :ref:`get_surface_blend_shape_arrays<class_ImporterMesh_method_get_surface_blend_shape_arrays>` **(** :ref:`int<class_int>` surface_idx, :ref:`int<class_int>` blend_shape_idx **)** |const| |
  44. +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  45. | :ref:`int<class_int>` | :ref:`get_surface_count<class_ImporterMesh_method_get_surface_count>` **(** **)** |const| |
  46. +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  47. | :ref:`int<class_int>` | :ref:`get_surface_format<class_ImporterMesh_method_get_surface_format>` **(** :ref:`int<class_int>` surface_idx **)** |const| |
  48. +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  49. | :ref:`int<class_int>` | :ref:`get_surface_lod_count<class_ImporterMesh_method_get_surface_lod_count>` **(** :ref:`int<class_int>` surface_idx **)** |const| |
  50. +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  51. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`get_surface_lod_indices<class_ImporterMesh_method_get_surface_lod_indices>` **(** :ref:`int<class_int>` surface_idx, :ref:`int<class_int>` lod_idx **)** |const| |
  52. +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  53. | :ref:`float<class_float>` | :ref:`get_surface_lod_size<class_ImporterMesh_method_get_surface_lod_size>` **(** :ref:`int<class_int>` surface_idx, :ref:`int<class_int>` lod_idx **)** |const| |
  54. +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  55. | :ref:`Material<class_Material>` | :ref:`get_surface_material<class_ImporterMesh_method_get_surface_material>` **(** :ref:`int<class_int>` surface_idx **)** |const| |
  56. +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  57. | :ref:`String<class_String>` | :ref:`get_surface_name<class_ImporterMesh_method_get_surface_name>` **(** :ref:`int<class_int>` surface_idx **)** |const| |
  58. +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  59. | :ref:`PrimitiveType<enum_Mesh_PrimitiveType>` | :ref:`get_surface_primitive_type<class_ImporterMesh_method_get_surface_primitive_type>` **(** :ref:`int<class_int>` surface_idx **)** |
  60. +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  61. | void | :ref:`set_blend_shape_mode<class_ImporterMesh_method_set_blend_shape_mode>` **(** :ref:`BlendShapeMode<enum_Mesh_BlendShapeMode>` mode **)** |
  62. +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  63. | void | :ref:`set_lightmap_size_hint<class_ImporterMesh_method_set_lightmap_size_hint>` **(** :ref:`Vector2i<class_Vector2i>` size **)** |
  64. +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  65. | void | :ref:`set_surface_material<class_ImporterMesh_method_set_surface_material>` **(** :ref:`int<class_int>` surface_idx, :ref:`Material<class_Material>` material **)** |
  66. +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  67. | void | :ref:`set_surface_name<class_ImporterMesh_method_set_surface_name>` **(** :ref:`int<class_int>` surface_idx, :ref:`String<class_String>` name **)** |
  68. +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  69. Property Descriptions
  70. ---------------------
  71. .. _class_ImporterMesh_property__data:
  72. - :ref:`Dictionary<class_Dictionary>` **_data**
  73. +-----------+------------------------+
  74. | *Default* | ``{ "surfaces": [] }`` |
  75. +-----------+------------------------+
  76. .. container:: contribute
  77. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  78. Method Descriptions
  79. -------------------
  80. .. _class_ImporterMesh_method_add_blend_shape:
  81. - void **add_blend_shape** **(** :ref:`String<class_String>` name **)**
  82. Adds name for a blend shape that will be added with :ref:`add_surface<class_ImporterMesh_method_add_surface>`. Must be called before surface is added.
  83. ----
  84. .. _class_ImporterMesh_method_add_surface:
  85. - void **add_surface** **(** :ref:`PrimitiveType<enum_Mesh_PrimitiveType>` primitive, :ref:`Array<class_Array>` arrays, :ref:`Array[]<class_Array>` blend_shapes=[], :ref:`Dictionary<class_Dictionary>` lods={}, :ref:`Material<class_Material>` material=null, :ref:`String<class_String>` name="", :ref:`int<class_int>` flags=0 **)**
  86. Creates a new surface, analogous to :ref:`ArrayMesh.add_surface_from_arrays<class_ArrayMesh_method_add_surface_from_arrays>`.
  87. Surfaces are created to be rendered using a ``primitive``, which may be any of the types defined in :ref:`PrimitiveType<enum_Mesh_PrimitiveType>`. (As a note, when using indices, it is recommended to only use points, lines, or triangles.) :ref:`Mesh.get_surface_count<class_Mesh_method_get_surface_count>` will become the ``surf_idx`` for this new surface.
  88. The ``arrays`` argument is an array of arrays. See :ref:`ArrayType<enum_Mesh_ArrayType>` for the values used in this array. For example, ``arrays[0]`` is the array of vertices. That first vertex sub-array is always required; the others are optional. Adding an index array puts this function into "index mode" where the vertex and other arrays become the sources of data and the index array defines the vertex order. All sub-arrays must have the same length as the vertex array (or be an exact multiple of the vertex array's length, when multiple elements of a sub-array correspond to a single vertex) or be empty, except for :ref:`Mesh.ARRAY_INDEX<class_Mesh_constant_ARRAY_INDEX>` if it is used.
  89. ----
  90. .. _class_ImporterMesh_method_clear:
  91. - void **clear** **(** **)**
  92. Removes all surfaces and blend shapes from this ``ImporterMesh``.
  93. ----
  94. .. _class_ImporterMesh_method_generate_lods:
  95. - void **generate_lods** **(** :ref:`float<class_float>` normal_merge_angle, :ref:`float<class_float>` normal_split_angle, :ref:`Array<class_Array>` bone_transform_array **)**
  96. Generates all lods for this ImporterMesh.
  97. \ ``normal_merge_angle`` and ``normal_split_angle`` are in degrees and used in the same way as the importer settings in ``lods``. As a good default, use 25 and 60 respectively.
  98. The number of generated lods can be accessed using :ref:`get_surface_lod_count<class_ImporterMesh_method_get_surface_lod_count>`, and each LOD is available in :ref:`get_surface_lod_size<class_ImporterMesh_method_get_surface_lod_size>` and :ref:`get_surface_lod_indices<class_ImporterMesh_method_get_surface_lod_indices>`.
  99. \ ``bone_transform_array`` is an :ref:`Array<class_Array>` which can be either empty or contain :ref:`Transform3D<class_Transform3D>`\ s which, for each of the mesh's bone IDs, will apply mesh skinning when generating the LOD mesh variations. This is usually used to account for discrepancies in scale between the mesh itself and its skinning data.
  100. ----
  101. .. _class_ImporterMesh_method_get_blend_shape_count:
  102. - :ref:`int<class_int>` **get_blend_shape_count** **(** **)** |const|
  103. Returns the number of blend shapes that the mesh holds.
  104. ----
  105. .. _class_ImporterMesh_method_get_blend_shape_mode:
  106. - :ref:`BlendShapeMode<enum_Mesh_BlendShapeMode>` **get_blend_shape_mode** **(** **)** |const|
  107. Returns the blend shape mode for this Mesh.
  108. ----
  109. .. _class_ImporterMesh_method_get_blend_shape_name:
  110. - :ref:`String<class_String>` **get_blend_shape_name** **(** :ref:`int<class_int>` blend_shape_idx **)** |const|
  111. Returns the name of the blend shape at this index.
  112. ----
  113. .. _class_ImporterMesh_method_get_lightmap_size_hint:
  114. - :ref:`Vector2i<class_Vector2i>` **get_lightmap_size_hint** **(** **)** |const|
  115. Returns the size hint of this mesh for lightmap-unwrapping in UV-space.
  116. ----
  117. .. _class_ImporterMesh_method_get_mesh:
  118. - :ref:`ArrayMesh<class_ArrayMesh>` **get_mesh** **(** :ref:`ArrayMesh<class_ArrayMesh>` base_mesh=null **)**
  119. Returns the mesh data represented by this ``ImporterMesh`` as a usable :ref:`ArrayMesh<class_ArrayMesh>`.
  120. This method caches the returned mesh, and subsequent calls will return the cached data until :ref:`clear<class_ImporterMesh_method_clear>` is called.
  121. If not yet cached and ``base_mesh`` is provided, ``base_mesh`` will be used and mutated.
  122. ----
  123. .. _class_ImporterMesh_method_get_surface_arrays:
  124. - :ref:`Array<class_Array>` **get_surface_arrays** **(** :ref:`int<class_int>` surface_idx **)** |const|
  125. Returns the arrays for the vertices, normals, uvs, etc. that make up the requested surface. See :ref:`add_surface<class_ImporterMesh_method_add_surface>`.
  126. ----
  127. .. _class_ImporterMesh_method_get_surface_blend_shape_arrays:
  128. - :ref:`Array<class_Array>` **get_surface_blend_shape_arrays** **(** :ref:`int<class_int>` surface_idx, :ref:`int<class_int>` blend_shape_idx **)** |const|
  129. Returns a single set of blend shape arrays for the requested blend shape index for a surface.
  130. ----
  131. .. _class_ImporterMesh_method_get_surface_count:
  132. - :ref:`int<class_int>` **get_surface_count** **(** **)** |const|
  133. Returns the number of surfaces that the mesh holds.
  134. ----
  135. .. _class_ImporterMesh_method_get_surface_format:
  136. - :ref:`int<class_int>` **get_surface_format** **(** :ref:`int<class_int>` surface_idx **)** |const|
  137. Returns the format of the surface that the mesh holds.
  138. ----
  139. .. _class_ImporterMesh_method_get_surface_lod_count:
  140. - :ref:`int<class_int>` **get_surface_lod_count** **(** :ref:`int<class_int>` surface_idx **)** |const|
  141. Returns the number of lods that the mesh holds on a given surface.
  142. ----
  143. .. _class_ImporterMesh_method_get_surface_lod_indices:
  144. - :ref:`PackedInt32Array<class_PackedInt32Array>` **get_surface_lod_indices** **(** :ref:`int<class_int>` surface_idx, :ref:`int<class_int>` lod_idx **)** |const|
  145. Returns the index buffer of a lod for a surface.
  146. ----
  147. .. _class_ImporterMesh_method_get_surface_lod_size:
  148. - :ref:`float<class_float>` **get_surface_lod_size** **(** :ref:`int<class_int>` surface_idx, :ref:`int<class_int>` lod_idx **)** |const|
  149. Returns the screen ratio which activates a lod for a surface.
  150. ----
  151. .. _class_ImporterMesh_method_get_surface_material:
  152. - :ref:`Material<class_Material>` **get_surface_material** **(** :ref:`int<class_int>` surface_idx **)** |const|
  153. Returns a :ref:`Material<class_Material>` in a given surface. Surface is rendered using this material.
  154. ----
  155. .. _class_ImporterMesh_method_get_surface_name:
  156. - :ref:`String<class_String>` **get_surface_name** **(** :ref:`int<class_int>` surface_idx **)** |const|
  157. Gets the name assigned to this surface.
  158. ----
  159. .. _class_ImporterMesh_method_get_surface_primitive_type:
  160. - :ref:`PrimitiveType<enum_Mesh_PrimitiveType>` **get_surface_primitive_type** **(** :ref:`int<class_int>` surface_idx **)**
  161. Returns the primitive type of the requested surface (see :ref:`add_surface<class_ImporterMesh_method_add_surface>`).
  162. ----
  163. .. _class_ImporterMesh_method_set_blend_shape_mode:
  164. - void **set_blend_shape_mode** **(** :ref:`BlendShapeMode<enum_Mesh_BlendShapeMode>` mode **)**
  165. Sets the blend shape mode to one of :ref:`BlendShapeMode<enum_Mesh_BlendShapeMode>`.
  166. ----
  167. .. _class_ImporterMesh_method_set_lightmap_size_hint:
  168. - void **set_lightmap_size_hint** **(** :ref:`Vector2i<class_Vector2i>` size **)**
  169. Sets the size hint of this mesh for lightmap-unwrapping in UV-space.
  170. ----
  171. .. _class_ImporterMesh_method_set_surface_material:
  172. - void **set_surface_material** **(** :ref:`int<class_int>` surface_idx, :ref:`Material<class_Material>` material **)**
  173. Sets a :ref:`Material<class_Material>` for a given surface. Surface will be rendered using this material.
  174. ----
  175. .. _class_ImporterMesh_method_set_surface_name:
  176. - void **set_surface_name** **(** :ref:`int<class_int>` surface_idx, :ref:`String<class_String>` name **)**
  177. Sets a name for a given surface.
  178. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  179. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  180. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  181. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  182. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  183. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`