Home Explore Help
Sign In
godotengine
/
godot-docs
mirror of https://github.com/godotengine/godot-docs
Watch 1
Star 1
Fork 0
Files
Tree: 9ffd5f53c4
Branches Tags
godot-docs
/
classes
/
class_importermesh.rst

class_importermesh.rst 36 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395 
  1. :github_url: hide
    2. 

  2. 

  3. .. DO NOT EDIT THIS FILE!!!
    4. 

  4. .. Generated automatically from Godot engine sources.
    5. 

  5. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
    6. 

  6. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ImporterMesh.xml.
    7. 

  7. 

  8. .. _class_ImporterMesh:
    9. 

  9. 

  10. ImporterMesh
    11. 

  11. ============
    12. 

  12. 

  13. **Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
    14. 

  14. 

  15. A :ref:`Resource<class_Resource>` that contains vertex array-based geometry during the import process.
    16. 

  16. 

  17. .. rst-class:: classref-introduction-group
    18. 

  18. 

  19. Description
    20. 

  20. -----------
    21. 

  21. 

  22. 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.
    23. 

  23. 

  24. 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.
    25. 

  25. 

  26. .. rst-class:: classref-reftable-group
    27. 

  27. 

  28. Methods
    29. 

  29. -------
    30. 

  30. 

  31. .. table::
    32. 

  32.    :widths: auto
    33. 

  33. 

  34.    +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    35. 

  35.    | |void|                                          | :ref:`add_blend_shape<class_ImporterMesh_method_add_blend_shape>`\ (\ name\: :ref:`String<class_String>`\ )                                                                                                                                                                                                                                                                                                                |
    36. 

  36.    +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    37. 

  37.    | |void|                                          | :ref:`add_surface<class_ImporterMesh_method_add_surface>`\ (\ primitive\: :ref:`PrimitiveType<enum_Mesh_PrimitiveType>`, arrays\: :ref:`Array<class_Array>`, blend_shapes\: :ref:`Array<class_Array>`\[:ref:`Array<class_Array>`\] = [], lods\: :ref:`Dictionary<class_Dictionary>` = {}, material\: :ref:`Material<class_Material>` = null, name\: :ref:`String<class_String>` = "", flags\: :ref:`int<class_int>` = 0\ ) |
    38. 

  38.    +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    39. 

  39.    | |void|                                          | :ref:`clear<class_ImporterMesh_method_clear>`\ (\ )                                                                                                                                                                                                                                                                                                                                                                        |
    40. 

  40.    +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    41. 

  41.    | |void|                                          | :ref:`generate_lods<class_ImporterMesh_method_generate_lods>`\ (\ normal_merge_angle\: :ref:`float<class_float>`, normal_split_angle\: :ref:`float<class_float>`, bone_transform_array\: :ref:`Array<class_Array>`\ )                                                                                                                                                                                                      |
    42. 

  42.    +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    43. 

  43.    | :ref:`int<class_int>`                           | :ref:`get_blend_shape_count<class_ImporterMesh_method_get_blend_shape_count>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                |
    44. 

  44.    +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    45. 

  45.    | :ref:`BlendShapeMode<enum_Mesh_BlendShapeMode>` | :ref:`get_blend_shape_mode<class_ImporterMesh_method_get_blend_shape_mode>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                  |
    46. 

  46.    +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    47. 

  47.    | :ref:`String<class_String>`                     | :ref:`get_blend_shape_name<class_ImporterMesh_method_get_blend_shape_name>`\ (\ blend_shape_idx\: :ref:`int<class_int>`\ ) |const|                                                                                                                                                                                                                                                                                         |
    48. 

  48.    +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    49. 

  49.    | :ref:`Vector2i<class_Vector2i>`                 | :ref:`get_lightmap_size_hint<class_ImporterMesh_method_get_lightmap_size_hint>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                              |
    50. 

  50.    +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    51. 

  51.    | :ref:`ArrayMesh<class_ArrayMesh>`               | :ref:`get_mesh<class_ImporterMesh_method_get_mesh>`\ (\ base_mesh\: :ref:`ArrayMesh<class_ArrayMesh>` = null\ )                                                                                                                                                                                                                                                                                                            |
    52. 

  52.    +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    53. 

  53.    | :ref:`Array<class_Array>`                       | :ref:`get_surface_arrays<class_ImporterMesh_method_get_surface_arrays>`\ (\ surface_idx\: :ref:`int<class_int>`\ ) |const|                                                                                                                                                                                                                                                                                                 |
    54. 

  54.    +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    55. 

  55.    | :ref:`Array<class_Array>`                       | :ref:`get_surface_blend_shape_arrays<class_ImporterMesh_method_get_surface_blend_shape_arrays>`\ (\ surface_idx\: :ref:`int<class_int>`, blend_shape_idx\: :ref:`int<class_int>`\ ) |const|                                                                                                                                                                                                                                |
    56. 

  56.    +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    57. 

  57.    | :ref:`int<class_int>`                           | :ref:`get_surface_count<class_ImporterMesh_method_get_surface_count>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                        |
    58. 

  58.    +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    59. 

  59.    | :ref:`int<class_int>`                           | :ref:`get_surface_format<class_ImporterMesh_method_get_surface_format>`\ (\ surface_idx\: :ref:`int<class_int>`\ ) |const|                                                                                                                                                                                                                                                                                                 |
    60. 

  60.    +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    61. 

  61.    | :ref:`int<class_int>`                           | :ref:`get_surface_lod_count<class_ImporterMesh_method_get_surface_lod_count>`\ (\ surface_idx\: :ref:`int<class_int>`\ ) |const|                                                                                                                                                                                                                                                                                           |
    62. 

  62.    +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    63. 

  63.    | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`get_surface_lod_indices<class_ImporterMesh_method_get_surface_lod_indices>`\ (\ surface_idx\: :ref:`int<class_int>`, lod_idx\: :ref:`int<class_int>`\ ) |const|                                                                                                                                                                                                                                                      |
    64. 

  64.    +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    65. 

  65.    | :ref:`float<class_float>`                       | :ref:`get_surface_lod_size<class_ImporterMesh_method_get_surface_lod_size>`\ (\ surface_idx\: :ref:`int<class_int>`, lod_idx\: :ref:`int<class_int>`\ ) |const|                                                                                                                                                                                                                                                            |
    66. 

  66.    +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    67. 

  67.    | :ref:`Material<class_Material>`                 | :ref:`get_surface_material<class_ImporterMesh_method_get_surface_material>`\ (\ surface_idx\: :ref:`int<class_int>`\ ) |const|                                                                                                                                                                                                                                                                                             |
    68. 

  68.    +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    69. 

  69.    | :ref:`String<class_String>`                     | :ref:`get_surface_name<class_ImporterMesh_method_get_surface_name>`\ (\ surface_idx\: :ref:`int<class_int>`\ ) |const|                                                                                                                                                                                                                                                                                                     |
    70. 

  70.    +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    71. 

  71.    | :ref:`PrimitiveType<enum_Mesh_PrimitiveType>`   | :ref:`get_surface_primitive_type<class_ImporterMesh_method_get_surface_primitive_type>`\ (\ surface_idx\: :ref:`int<class_int>`\ )                                                                                                                                                                                                                                                                                         |
    72. 

  72.    +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    73. 

  73.    | |void|                                          | :ref:`set_blend_shape_mode<class_ImporterMesh_method_set_blend_shape_mode>`\ (\ mode\: :ref:`BlendShapeMode<enum_Mesh_BlendShapeMode>`\ )                                                                                                                                                                                                                                                                                  |
    74. 

  74.    +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    75. 

  75.    | |void|                                          | :ref:`set_lightmap_size_hint<class_ImporterMesh_method_set_lightmap_size_hint>`\ (\ size\: :ref:`Vector2i<class_Vector2i>`\ )                                                                                                                                                                                                                                                                                              |
    76. 

  76.    +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    77. 

  77.    | |void|                                          | :ref:`set_surface_material<class_ImporterMesh_method_set_surface_material>`\ (\ surface_idx\: :ref:`int<class_int>`, material\: :ref:`Material<class_Material>`\ )                                                                                                                                                                                                                                                         |
    78. 

  78.    +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    79. 

  79.    | |void|                                          | :ref:`set_surface_name<class_ImporterMesh_method_set_surface_name>`\ (\ surface_idx\: :ref:`int<class_int>`, name\: :ref:`String<class_String>`\ )                                                                                                                                                                                                                                                                         |
    80. 

  80.    +-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    81. 

  81. 

  82. .. rst-class:: classref-section-separator
    83. 

  83. 

  84. ----
    85. 

  85. 

  86. .. rst-class:: classref-descriptions-group
    87. 

  87. 

  88. Method Descriptions
    89. 

  89. -------------------
    90. 

  90. 

  91. .. _class_ImporterMesh_method_add_blend_shape:
    92. 

  92. 

  93. .. rst-class:: classref-method
    94. 

  94. 

  95. |void| **add_blend_shape**\ (\ name\: :ref:`String<class_String>`\ ) :ref:`🔗<class_ImporterMesh_method_add_blend_shape>`
    96. 

  96. 

  97. 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.
    98. 

  98. 

  99. .. rst-class:: classref-item-separator
    100. 

  100. 

  101. ----
    102. 

  102. 

  103. .. _class_ImporterMesh_method_add_surface:
    104. 

  104. 

  105. .. rst-class:: classref-method
    106. 

  106. 

  107. |void| **add_surface**\ (\ primitive\: :ref:`PrimitiveType<enum_Mesh_PrimitiveType>`, arrays\: :ref:`Array<class_Array>`, blend_shapes\: :ref:`Array<class_Array>`\[:ref:`Array<class_Array>`\] = [], lods\: :ref:`Dictionary<class_Dictionary>` = {}, material\: :ref:`Material<class_Material>` = null, name\: :ref:`String<class_String>` = "", flags\: :ref:`int<class_int>` = 0\ ) :ref:`🔗<class_ImporterMesh_method_add_surface>`
    108. 

  108. 

  109. Creates a new surface. :ref:`Mesh.get_surface_count<class_Mesh_method_get_surface_count>` will become the ``surf_idx`` for this new surface.
    110. 

  110. 

  111. Surfaces are created to be rendered using a ``primitive``, which may be any of the values defined in :ref:`PrimitiveType<enum_Mesh_PrimitiveType>`.
    112. 

  112. 

  113. The ``arrays`` argument is an array of arrays. Each of the :ref:`Mesh.ARRAY_MAX<class_Mesh_constant_ARRAY_MAX>` elements contains an array with some of the mesh data for this surface as described by the corresponding member of :ref:`ArrayType<enum_Mesh_ArrayType>` or ``null`` if it is not used by the surface. 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 surface 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.
    114. 

  114. 

  115. The ``blend_shapes`` argument is an array of vertex data for each blend shape. Each element is an array of the same structure as ``arrays``, but :ref:`Mesh.ARRAY_VERTEX<class_Mesh_constant_ARRAY_VERTEX>`, :ref:`Mesh.ARRAY_NORMAL<class_Mesh_constant_ARRAY_NORMAL>`, and :ref:`Mesh.ARRAY_TANGENT<class_Mesh_constant_ARRAY_TANGENT>` are set if and only if they are set in ``arrays`` and all other entries are ``null``.
    116. 

  116. 

  117. The ``lods`` argument is a dictionary with :ref:`float<class_float>` keys and :ref:`PackedInt32Array<class_PackedInt32Array>` values. Each entry in the dictionary represents an LOD level of the surface, where the value is the :ref:`Mesh.ARRAY_INDEX<class_Mesh_constant_ARRAY_INDEX>` array to use for the LOD level and the key is roughly proportional to the distance at which the LOD stats being used. I.e., increasing the key of an LOD also increases the distance that the objects has to be from the camera before the LOD is used.
    118. 

  118. 

  119. The ``flags`` argument is the bitwise or of, as required: One value of :ref:`ArrayCustomFormat<enum_Mesh_ArrayCustomFormat>` left shifted by ``ARRAY_FORMAT_CUSTOMn_SHIFT`` for each custom channel in use, :ref:`Mesh.ARRAY_FLAG_USE_DYNAMIC_UPDATE<class_Mesh_constant_ARRAY_FLAG_USE_DYNAMIC_UPDATE>`, :ref:`Mesh.ARRAY_FLAG_USE_8_BONE_WEIGHTS<class_Mesh_constant_ARRAY_FLAG_USE_8_BONE_WEIGHTS>`, or :ref:`Mesh.ARRAY_FLAG_USES_EMPTY_VERTEX_ARRAY<class_Mesh_constant_ARRAY_FLAG_USES_EMPTY_VERTEX_ARRAY>`.
    120. 

  120. 

  121. \ **Note:** When using indices, it is recommended to only use points, lines, or triangles.
    122. 

  122. 

  123. .. rst-class:: classref-item-separator
    124. 

  124. 

  125. ----
    126. 

  126. 

  127. .. _class_ImporterMesh_method_clear:
    128. 

  128. 

  129. .. rst-class:: classref-method
    130. 

  130. 

  131. |void| **clear**\ (\ ) :ref:`🔗<class_ImporterMesh_method_clear>`
    132. 

  132. 

  133. Removes all surfaces and blend shapes from this **ImporterMesh**.
    134. 

  134. 

  135. .. rst-class:: classref-item-separator
    136. 

  136. 

  137. ----
    138. 

  138. 

  139. .. _class_ImporterMesh_method_generate_lods:
    140. 

  140. 

  141. .. rst-class:: classref-method
    142. 

  142. 

  143. |void| **generate_lods**\ (\ normal_merge_angle\: :ref:`float<class_float>`, normal_split_angle\: :ref:`float<class_float>`, bone_transform_array\: :ref:`Array<class_Array>`\ ) :ref:`🔗<class_ImporterMesh_method_generate_lods>`
    144. 

  144. 

  145. Generates all lods for this ImporterMesh.
    146. 

  146. 

  147. \ ``normal_merge_angle`` is in degrees and used in the same way as the importer settings in ``lods``.
    148. 

  148. 

  149. \ ``normal_split_angle`` is not used and only remains for compatibility with older versions of the API.
    150. 

  150. 

  151. 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>`.
    152. 

  152. 

  153. \ ``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.
    154. 

  154. 

  155. .. rst-class:: classref-item-separator
    156. 

  156. 

  157. ----
    158. 

  158. 

  159. .. _class_ImporterMesh_method_get_blend_shape_count:
    160. 

  160. 

  161. .. rst-class:: classref-method
    162. 

  162. 

  163. :ref:`int<class_int>` **get_blend_shape_count**\ (\ ) |const| :ref:`🔗<class_ImporterMesh_method_get_blend_shape_count>`
    164. 

  164. 

  165. Returns the number of blend shapes that the mesh holds.
    166. 

  166. 

  167. .. rst-class:: classref-item-separator
    168. 

  168. 

  169. ----
    170. 

  170. 

  171. .. _class_ImporterMesh_method_get_blend_shape_mode:
    172. 

  172. 

  173. .. rst-class:: classref-method
    174. 

  174. 

  175. :ref:`BlendShapeMode<enum_Mesh_BlendShapeMode>` **get_blend_shape_mode**\ (\ ) |const| :ref:`🔗<class_ImporterMesh_method_get_blend_shape_mode>`
    176. 

  176. 

  177. Returns the blend shape mode for this Mesh.
    178. 

  178. 

  179. .. rst-class:: classref-item-separator
    180. 

  180. 

  181. ----
    182. 

  182. 

  183. .. _class_ImporterMesh_method_get_blend_shape_name:
    184. 

  184. 

  185. .. rst-class:: classref-method
    186. 

  186. 

  187. :ref:`String<class_String>` **get_blend_shape_name**\ (\ blend_shape_idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_ImporterMesh_method_get_blend_shape_name>`
    188. 

  188. 

  189. Returns the name of the blend shape at this index.
    190. 

  190. 

  191. .. rst-class:: classref-item-separator
    192. 

  192. 

  193. ----
    194. 

  194. 

  195. .. _class_ImporterMesh_method_get_lightmap_size_hint:
    196. 

  196. 

  197. .. rst-class:: classref-method
    198. 

  198. 

  199. :ref:`Vector2i<class_Vector2i>` **get_lightmap_size_hint**\ (\ ) |const| :ref:`🔗<class_ImporterMesh_method_get_lightmap_size_hint>`
    200. 

  200. 

  201. Returns the size hint of this mesh for lightmap-unwrapping in UV-space.
    202. 

  202. 

  203. .. rst-class:: classref-item-separator
    204. 

  204. 

  205. ----
    206. 

  206. 

  207. .. _class_ImporterMesh_method_get_mesh:
    208. 

  208. 

  209. .. rst-class:: classref-method
    210. 

  210. 

  211. :ref:`ArrayMesh<class_ArrayMesh>` **get_mesh**\ (\ base_mesh\: :ref:`ArrayMesh<class_ArrayMesh>` = null\ ) :ref:`🔗<class_ImporterMesh_method_get_mesh>`
    212. 

  212. 

  213. Returns the mesh data represented by this **ImporterMesh** as a usable :ref:`ArrayMesh<class_ArrayMesh>`.
    214. 

  214. 

  215. This method caches the returned mesh, and subsequent calls will return the cached data until :ref:`clear<class_ImporterMesh_method_clear>` is called.
    216. 

  216. 

  217. If not yet cached and ``base_mesh`` is provided, ``base_mesh`` will be used and mutated.
    218. 

  218. 

  219. .. rst-class:: classref-item-separator
    220. 

  220. 

  221. ----
    222. 

  222. 

  223. .. _class_ImporterMesh_method_get_surface_arrays:
    224. 

  224. 

  225. .. rst-class:: classref-method
    226. 

  226. 

  227. :ref:`Array<class_Array>` **get_surface_arrays**\ (\ surface_idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_ImporterMesh_method_get_surface_arrays>`
    228. 

  228. 

  229. Returns the arrays for the vertices, normals, UVs, etc. that make up the requested surface. See :ref:`add_surface<class_ImporterMesh_method_add_surface>`.
    230. 

  230. 

  231. .. rst-class:: classref-item-separator
    232. 

  232. 

  233. ----
    234. 

  234. 

  235. .. _class_ImporterMesh_method_get_surface_blend_shape_arrays:
    236. 

  236. 

  237. .. rst-class:: classref-method
    238. 

  238. 

  239. :ref:`Array<class_Array>` **get_surface_blend_shape_arrays**\ (\ surface_idx\: :ref:`int<class_int>`, blend_shape_idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_ImporterMesh_method_get_surface_blend_shape_arrays>`
    240. 

  240. 

  241. Returns a single set of blend shape arrays for the requested blend shape index for a surface.
    242. 

  242. 

  243. .. rst-class:: classref-item-separator
    244. 

  244. 

  245. ----
    246. 

  246. 

  247. .. _class_ImporterMesh_method_get_surface_count:
    248. 

  248. 

  249. .. rst-class:: classref-method
    250. 

  250. 

  251. :ref:`int<class_int>` **get_surface_count**\ (\ ) |const| :ref:`🔗<class_ImporterMesh_method_get_surface_count>`
    252. 

  252. 

  253. Returns the number of surfaces that the mesh holds.
    254. 

  254. 

  255. .. rst-class:: classref-item-separator
    256. 

  256. 

  257. ----
    258. 

  258. 

  259. .. _class_ImporterMesh_method_get_surface_format:
    260. 

  260. 

  261. .. rst-class:: classref-method
    262. 

  262. 

  263. :ref:`int<class_int>` **get_surface_format**\ (\ surface_idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_ImporterMesh_method_get_surface_format>`
    264. 

  264. 

  265. Returns the format of the surface that the mesh holds.
    266. 

  266. 

  267. .. rst-class:: classref-item-separator
    268. 

  268. 

  269. ----
    270. 

  270. 

  271. .. _class_ImporterMesh_method_get_surface_lod_count:
    272. 

  272. 

  273. .. rst-class:: classref-method
    274. 

  274. 

  275. :ref:`int<class_int>` **get_surface_lod_count**\ (\ surface_idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_ImporterMesh_method_get_surface_lod_count>`
    276. 

  276. 

  277. Returns the number of lods that the mesh holds on a given surface.
    278. 

  278. 

  279. .. rst-class:: classref-item-separator
    280. 

  280. 

  281. ----
    282. 

  282. 

  283. .. _class_ImporterMesh_method_get_surface_lod_indices:
    284. 

  284. 

  285. .. rst-class:: classref-method
    286. 

  286. 

  287. :ref:`PackedInt32Array<class_PackedInt32Array>` **get_surface_lod_indices**\ (\ surface_idx\: :ref:`int<class_int>`, lod_idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_ImporterMesh_method_get_surface_lod_indices>`
    288. 

  288. 

  289. Returns the index buffer of a lod for a surface.
    290. 

  290. 

  291. .. rst-class:: classref-item-separator
    292. 

  292. 

  293. ----
    294. 

  294. 

  295. .. _class_ImporterMesh_method_get_surface_lod_size:
    296. 

  296. 

  297. .. rst-class:: classref-method
    298. 

  298. 

  299. :ref:`float<class_float>` **get_surface_lod_size**\ (\ surface_idx\: :ref:`int<class_int>`, lod_idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_ImporterMesh_method_get_surface_lod_size>`
    300. 

  300. 

  301. Returns the screen ratio which activates a lod for a surface.
    302. 

  302. 

  303. .. rst-class:: classref-item-separator
    304. 

  304. 

  305. ----
    306. 

  306. 

  307. .. _class_ImporterMesh_method_get_surface_material:
    308. 

  308. 

  309. .. rst-class:: classref-method
    310. 

  310. 

  311. :ref:`Material<class_Material>` **get_surface_material**\ (\ surface_idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_ImporterMesh_method_get_surface_material>`
    312. 

  312. 

  313. Returns a :ref:`Material<class_Material>` in a given surface. Surface is rendered using this material.
    314. 

  314. 

  315. .. rst-class:: classref-item-separator
    316. 

  316. 

  317. ----
    318. 

  318. 

  319. .. _class_ImporterMesh_method_get_surface_name:
    320. 

  320. 

  321. .. rst-class:: classref-method
    322. 

  322. 

  323. :ref:`String<class_String>` **get_surface_name**\ (\ surface_idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_ImporterMesh_method_get_surface_name>`
    324. 

  324. 

  325. Gets the name assigned to this surface.
    326. 

  326. 

  327. .. rst-class:: classref-item-separator
    328. 

  328. 

  329. ----
    330. 

  330. 

  331. .. _class_ImporterMesh_method_get_surface_primitive_type:
    332. 

  332. 

  333. .. rst-class:: classref-method
    334. 

  334. 

  335. :ref:`PrimitiveType<enum_Mesh_PrimitiveType>` **get_surface_primitive_type**\ (\ surface_idx\: :ref:`int<class_int>`\ ) :ref:`🔗<class_ImporterMesh_method_get_surface_primitive_type>`
    336. 

  336. 

  337. Returns the primitive type of the requested surface (see :ref:`add_surface<class_ImporterMesh_method_add_surface>`).
    338. 

  338. 

  339. .. rst-class:: classref-item-separator
    340. 

  340. 

  341. ----
    342. 

  342. 

  343. .. _class_ImporterMesh_method_set_blend_shape_mode:
    344. 

  344. 

  345. .. rst-class:: classref-method
    346. 

  346. 

  347. |void| **set_blend_shape_mode**\ (\ mode\: :ref:`BlendShapeMode<enum_Mesh_BlendShapeMode>`\ ) :ref:`🔗<class_ImporterMesh_method_set_blend_shape_mode>`
    348. 

  348. 

  349. Sets the blend shape mode to one of :ref:`BlendShapeMode<enum_Mesh_BlendShapeMode>`.
    350. 

  350. 

  351. .. rst-class:: classref-item-separator
    352. 

  352. 

  353. ----
    354. 

  354. 

  355. .. _class_ImporterMesh_method_set_lightmap_size_hint:
    356. 

  356. 

  357. .. rst-class:: classref-method
    358. 

  358. 

  359. |void| **set_lightmap_size_hint**\ (\ size\: :ref:`Vector2i<class_Vector2i>`\ ) :ref:`🔗<class_ImporterMesh_method_set_lightmap_size_hint>`
    360. 

  360. 

  361. Sets the size hint of this mesh for lightmap-unwrapping in UV-space.
    362. 

  362. 

  363. .. rst-class:: classref-item-separator
    364. 

  364. 

  365. ----
    366. 

  366. 

  367. .. _class_ImporterMesh_method_set_surface_material:
    368. 

  368. 

  369. .. rst-class:: classref-method
    370. 

  370. 

  371. |void| **set_surface_material**\ (\ surface_idx\: :ref:`int<class_int>`, material\: :ref:`Material<class_Material>`\ ) :ref:`🔗<class_ImporterMesh_method_set_surface_material>`
    372. 

  372. 

  373. Sets a :ref:`Material<class_Material>` for a given surface. Surface will be rendered using this material.
    374. 

  374. 

  375. .. rst-class:: classref-item-separator
    376. 

  376. 

  377. ----
    378. 

  378. 

  379. .. _class_ImporterMesh_method_set_surface_name:
    380. 

  380. 

  381. .. rst-class:: classref-method
    382. 

  382. 

  383. |void| **set_surface_name**\ (\ surface_idx\: :ref:`int<class_int>`, name\: :ref:`String<class_String>`\ ) :ref:`🔗<class_ImporterMesh_method_set_surface_name>`
    384. 

  384. 

  385. Sets a name for a given surface.
    386. 

  386. 

  387. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
    388. 

  388. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
    389. 

  389. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
    390. 

  390. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
    391. 

  391. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
    392. 

  392. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
    393. 

  393. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
    394. 

  394. .. |void| replace:: :abbr:`void (No return value.)`
    395. 

  395.