class_primitivemesh.rst 2.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the PrimitiveMesh.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_PrimitiveMesh:
  5. PrimitiveMesh
  6. =============
  7. **Inherits:** :ref:`Mesh<class_mesh>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
  8. **Inherited By:** :ref:`PlaneMesh<class_planemesh>`, :ref:`CubeMesh<class_cubemesh>`, :ref:`SphereMesh<class_spheremesh>`, :ref:`CylinderMesh<class_cylindermesh>`, :ref:`CapsuleMesh<class_capsulemesh>`, :ref:`QuadMesh<class_quadmesh>`, :ref:`PrismMesh<class_prismmesh>`
  9. **Category:** Core
  10. Brief Description
  11. -----------------
  12. Base class for all primitive meshes. Handles applying a :ref:`Material<class_material>` to a primitive mesh.
  13. Member Functions
  14. ----------------
  15. +----------------------------------+--------------------------------------------------------------------------------------------------------------+
  16. | :ref:`Material<class_material>` | :ref:`get_material<class_PrimitiveMesh_get_material>` **(** **)** const |
  17. +----------------------------------+--------------------------------------------------------------------------------------------------------------+
  18. | :ref:`Array<class_array>` | :ref:`get_mesh_arrays<class_PrimitiveMesh_get_mesh_arrays>` **(** **)** const |
  19. +----------------------------------+--------------------------------------------------------------------------------------------------------------+
  20. | void | :ref:`set_material<class_PrimitiveMesh_set_material>` **(** :ref:`Material<class_material>` material **)** |
  21. +----------------------------------+--------------------------------------------------------------------------------------------------------------+
  22. Member Variables
  23. ----------------
  24. - :ref:`Material<class_material>` **material** - The current [Material] of the primitive mesh.
  25. Description
  26. -----------
  27. Base class for all primitive meshes. Handles applying a :ref:`Material<class_material>` to a primitive mesh.
  28. Member Function Description
  29. ---------------------------
  30. .. _class_PrimitiveMesh_get_material:
  31. - :ref:`Material<class_material>` **get_material** **(** **)** const
  32. .. _class_PrimitiveMesh_get_mesh_arrays:
  33. - :ref:`Array<class_array>` **get_mesh_arrays** **(** **)** const
  34. .. _class_PrimitiveMesh_set_material:
  35. - void **set_material** **(** :ref:`Material<class_material>` material **)**