class_capsulemesh.rst 4.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the CapsuleMesh.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_CapsuleMesh:
  5. CapsuleMesh
  6. ===========
  7. **Inherits:** :ref:`PrimitiveMesh<class_primitivemesh>` **<** :ref:`Mesh<class_mesh>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. Class representing a capsule-shaped :ref:`PrimitiveMesh<class_primitivemesh>`.
  12. Member Functions
  13. ----------------
  14. +----------------------------+----------------------------------------------------------------------------------------------------------------+
  15. | :ref:`float<class_float>` | :ref:`get_mid_height<class_CapsuleMesh_get_mid_height>` **(** **)** const |
  16. +----------------------------+----------------------------------------------------------------------------------------------------------------+
  17. | :ref:`int<class_int>` | :ref:`get_radial_segments<class_CapsuleMesh_get_radial_segments>` **(** **)** const |
  18. +----------------------------+----------------------------------------------------------------------------------------------------------------+
  19. | :ref:`float<class_float>` | :ref:`get_radius<class_CapsuleMesh_get_radius>` **(** **)** const |
  20. +----------------------------+----------------------------------------------------------------------------------------------------------------+
  21. | :ref:`int<class_int>` | :ref:`get_rings<class_CapsuleMesh_get_rings>` **(** **)** const |
  22. +----------------------------+----------------------------------------------------------------------------------------------------------------+
  23. | void | :ref:`set_mid_height<class_CapsuleMesh_set_mid_height>` **(** :ref:`float<class_float>` mid_height **)** |
  24. +----------------------------+----------------------------------------------------------------------------------------------------------------+
  25. | void | :ref:`set_radial_segments<class_CapsuleMesh_set_radial_segments>` **(** :ref:`int<class_int>` segments **)** |
  26. +----------------------------+----------------------------------------------------------------------------------------------------------------+
  27. | void | :ref:`set_radius<class_CapsuleMesh_set_radius>` **(** :ref:`float<class_float>` radius **)** |
  28. +----------------------------+----------------------------------------------------------------------------------------------------------------+
  29. | void | :ref:`set_rings<class_CapsuleMesh_set_rings>` **(** :ref:`int<class_int>` rings **)** |
  30. +----------------------------+----------------------------------------------------------------------------------------------------------------+
  31. Member Variables
  32. ----------------
  33. - :ref:`float<class_float>` **mid_height** - Height of the capsule mesh from the center point. Defaults to 1.0.
  34. - :ref:`int<class_int>` **radial_segments** - Number of radial segments on the capsule mesh. Defaults to 64.
  35. - :ref:`float<class_float>` **radius** - Radius of the capsule mesh. Defaults to 1.0.
  36. - :ref:`int<class_int>` **rings** - Number of rings along the height of the capsule. Defaults to 8.
  37. Description
  38. -----------
  39. Class representing a capsule-shaped :ref:`PrimitiveMesh<class_primitivemesh>`.
  40. Member Function Description
  41. ---------------------------
  42. .. _class_CapsuleMesh_get_mid_height:
  43. - :ref:`float<class_float>` **get_mid_height** **(** **)** const
  44. .. _class_CapsuleMesh_get_radial_segments:
  45. - :ref:`int<class_int>` **get_radial_segments** **(** **)** const
  46. .. _class_CapsuleMesh_get_radius:
  47. - :ref:`float<class_float>` **get_radius** **(** **)** const
  48. .. _class_CapsuleMesh_get_rings:
  49. - :ref:`int<class_int>` **get_rings** **(** **)** const
  50. .. _class_CapsuleMesh_set_mid_height:
  51. - void **set_mid_height** **(** :ref:`float<class_float>` mid_height **)**
  52. .. _class_CapsuleMesh_set_radial_segments:
  53. - void **set_radial_segments** **(** :ref:`int<class_int>` segments **)**
  54. .. _class_CapsuleMesh_set_radius:
  55. - void **set_radius** **(** :ref:`float<class_float>` radius **)**
  56. .. _class_CapsuleMesh_set_rings:
  57. - void **set_rings** **(** :ref:`int<class_int>` rings **)**