class_mesh.rst 3.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
  3. .. _class_Mesh:
  4. Mesh
  5. ====
  6. **Inherits:** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
  7. **Inherited By:** :ref:`ArrayMesh<class_arraymesh>`, :ref:`PrimitiveMesh<class_primitivemesh>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. A :ref:`Resource<class_resource>` that contains vertex-array based geometry.
  12. Member Functions
  13. ----------------
  14. +--------------------------------------------------+-------------------------------------------------------------------------------------------------------+
  15. | :ref:`Shape<class_shape>` | :ref:`create_convex_shape<class_Mesh_create_convex_shape>` **(** **)** const |
  16. +--------------------------------------------------+-------------------------------------------------------------------------------------------------------+
  17. | :ref:`ArrayMesh<class_arraymesh>` | :ref:`create_outline<class_Mesh_create_outline>` **(** :ref:`float<class_float>` margin **)** const |
  18. +--------------------------------------------------+-------------------------------------------------------------------------------------------------------+
  19. | :ref:`Shape<class_shape>` | :ref:`create_trimesh_shape<class_Mesh_create_trimesh_shape>` **(** **)** const |
  20. +--------------------------------------------------+-------------------------------------------------------------------------------------------------------+
  21. | :ref:`TriangleMesh<class_trianglemesh>` | :ref:`generate_triangle_mesh<class_Mesh_generate_triangle_mesh>` **(** **)** const |
  22. +--------------------------------------------------+-------------------------------------------------------------------------------------------------------+
  23. | :ref:`PoolVector3Array<class_poolvector3array>` | :ref:`get_faces<class_Mesh_get_faces>` **(** **)** const |
  24. +--------------------------------------------------+-------------------------------------------------------------------------------------------------------+
  25. Description
  26. -----------
  27. 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.
  28. Member Function Description
  29. ---------------------------
  30. .. _class_Mesh_create_convex_shape:
  31. - :ref:`Shape<class_shape>` **create_convex_shape** **(** **)** const
  32. .. _class_Mesh_create_outline:
  33. - :ref:`ArrayMesh<class_arraymesh>` **create_outline** **(** :ref:`float<class_float>` margin **)** const
  34. .. _class_Mesh_create_trimesh_shape:
  35. - :ref:`Shape<class_shape>` **create_trimesh_shape** **(** **)** const
  36. .. _class_Mesh_generate_triangle_mesh:
  37. - :ref:`TriangleMesh<class_trianglemesh>` **generate_triangle_mesh** **(** **)** const
  38. .. _class_Mesh_get_faces:
  39. - :ref:`PoolVector3Array<class_poolvector3array>` **get_faces** **(** **)** const