class_gltfmesh.rst 3.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the GLTFMesh.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_GLTFMesh:
  6. GLTFMesh
  7. ========
  8. **Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. Description
  10. -----------
  11. **Note:** This class is only compiled in editor builds. Run-time glTF loading and saving is *not* available in exported projects. References to ``GLTFMesh`` within a script will cause an error in an exported project.
  12. Properties
  13. ----------
  14. +-------------------------------------------+-----------------------------------------------------------------------+-----------------------+
  15. | :ref:`PoolRealArray<class_PoolRealArray>` | :ref:`blend_weights<class_GLTFMesh_property_blend_weights>` | ``PoolRealArray( )`` |
  16. +-------------------------------------------+-----------------------------------------------------------------------+-----------------------+
  17. | :ref:`Array<class_Array>` | :ref:`instance_materials<class_GLTFMesh_property_instance_materials>` | ``[ ]`` |
  18. +-------------------------------------------+-----------------------------------------------------------------------+-----------------------+
  19. | :ref:`ArrayMesh<class_ArrayMesh>` | :ref:`mesh<class_GLTFMesh_property_mesh>` | |
  20. +-------------------------------------------+-----------------------------------------------------------------------+-----------------------+
  21. Property Descriptions
  22. ---------------------
  23. .. _class_GLTFMesh_property_blend_weights:
  24. - :ref:`PoolRealArray<class_PoolRealArray>` **blend_weights**
  25. +-----------+--------------------------+
  26. | *Default* | ``PoolRealArray( )`` |
  27. +-----------+--------------------------+
  28. | *Setter* | set_blend_weights(value) |
  29. +-----------+--------------------------+
  30. | *Getter* | get_blend_weights() |
  31. +-----------+--------------------------+
  32. ----
  33. .. _class_GLTFMesh_property_instance_materials:
  34. - :ref:`Array<class_Array>` **instance_materials**
  35. +-----------+-------------------------------+
  36. | *Default* | ``[ ]`` |
  37. +-----------+-------------------------------+
  38. | *Setter* | set_instance_materials(value) |
  39. +-----------+-------------------------------+
  40. | *Getter* | get_instance_materials() |
  41. +-----------+-------------------------------+
  42. ----
  43. .. _class_GLTFMesh_property_mesh:
  44. - :ref:`ArrayMesh<class_ArrayMesh>` **mesh**
  45. +----------+-----------------+
  46. | *Setter* | set_mesh(value) |
  47. +----------+-----------------+
  48. | *Getter* | get_mesh() |
  49. +----------+-----------------+
  50. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  51. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  52. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`