class_textureprogress.rst 7.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126
  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_TextureProgress:
  4. TextureProgress
  5. ===============
  6. **Inherits:** :ref:`Range<class_range>` **<** :ref:`Control<class_control>` **<** :ref:`CanvasItem<class_canvasitem>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
  7. **Category:** Core
  8. Brief Description
  9. -----------------
  10. Textured progress bar implementation.
  11. Member Functions
  12. ----------------
  13. +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
  14. | :ref:`float<class_float>` | :ref:`get_fill_degrees<class_TextureProgress_get_fill_degrees>` **(** **)** |
  15. +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
  16. | :ref:`int<class_int>` | :ref:`get_fill_mode<class_TextureProgress_get_fill_mode>` **(** **)** |
  17. +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
  18. | :ref:`Object<class_object>` | :ref:`get_over_texture<class_TextureProgress_get_over_texture>` **(** **)** const |
  19. +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
  20. | :ref:`Object<class_object>` | :ref:`get_progress_texture<class_TextureProgress_get_progress_texture>` **(** **)** const |
  21. +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
  22. | :ref:`Vector2<class_vector2>` | :ref:`get_radial_center_offset<class_TextureProgress_get_radial_center_offset>` **(** **)** |
  23. +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
  24. | :ref:`float<class_float>` | :ref:`get_radial_initial_angle<class_TextureProgress_get_radial_initial_angle>` **(** **)** |
  25. +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
  26. | :ref:`Object<class_object>` | :ref:`get_under_texture<class_TextureProgress_get_under_texture>` **(** **)** const |
  27. +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
  28. | void | :ref:`set_fill_degrees<class_TextureProgress_set_fill_degrees>` **(** :ref:`float<class_float>` mode **)** |
  29. +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
  30. | void | :ref:`set_fill_mode<class_TextureProgress_set_fill_mode>` **(** :ref:`int<class_int>` mode **)** |
  31. +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
  32. | void | :ref:`set_over_texture<class_TextureProgress_set_over_texture>` **(** :ref:`Object<class_object>` tex **)** |
  33. +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
  34. | void | :ref:`set_progress_texture<class_TextureProgress_set_progress_texture>` **(** :ref:`Object<class_object>` tex **)** |
  35. +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
  36. | void | :ref:`set_radial_center_offset<class_TextureProgress_set_radial_center_offset>` **(** :ref:`Vector2<class_vector2>` mode **)** |
  37. +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
  38. | void | :ref:`set_radial_initial_angle<class_TextureProgress_set_radial_initial_angle>` **(** :ref:`float<class_float>` mode **)** |
  39. +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
  40. | void | :ref:`set_under_texture<class_TextureProgress_set_under_texture>` **(** :ref:`Object<class_object>` tex **)** |
  41. +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
  42. Numeric Constants
  43. -----------------
  44. - **FILL_LEFT_TO_RIGHT** = **0**
  45. - **FILL_RIGHT_TO_LEFT** = **1**
  46. - **FILL_TOP_TO_BOTTOM** = **2**
  47. - **FILL_BOTTOM_TO_TOP** = **3**
  48. - **FILL_CLOCKWISE** = **4**
  49. - **FILL_COUNTER_CLOCKWISE** = **5**
  50. Description
  51. -----------
  52. :ref:`ProgressBar<class_progressbar>` implementation that is easier to theme (by just passing a few textures).
  53. Member Function Description
  54. ---------------------------
  55. .. _class_TextureProgress_get_fill_degrees:
  56. - :ref:`float<class_float>` **get_fill_degrees** **(** **)**
  57. .. _class_TextureProgress_get_fill_mode:
  58. - :ref:`int<class_int>` **get_fill_mode** **(** **)**
  59. .. _class_TextureProgress_get_over_texture:
  60. - :ref:`Object<class_object>` **get_over_texture** **(** **)** const
  61. .. _class_TextureProgress_get_progress_texture:
  62. - :ref:`Object<class_object>` **get_progress_texture** **(** **)** const
  63. .. _class_TextureProgress_get_radial_center_offset:
  64. - :ref:`Vector2<class_vector2>` **get_radial_center_offset** **(** **)**
  65. .. _class_TextureProgress_get_radial_initial_angle:
  66. - :ref:`float<class_float>` **get_radial_initial_angle** **(** **)**
  67. .. _class_TextureProgress_get_under_texture:
  68. - :ref:`Object<class_object>` **get_under_texture** **(** **)** const
  69. .. _class_TextureProgress_set_fill_degrees:
  70. - void **set_fill_degrees** **(** :ref:`float<class_float>` mode **)**
  71. .. _class_TextureProgress_set_fill_mode:
  72. - void **set_fill_mode** **(** :ref:`int<class_int>` mode **)**
  73. .. _class_TextureProgress_set_over_texture:
  74. - void **set_over_texture** **(** :ref:`Object<class_object>` tex **)**
  75. .. _class_TextureProgress_set_progress_texture:
  76. - void **set_progress_texture** **(** :ref:`Object<class_object>` tex **)**
  77. .. _class_TextureProgress_set_radial_center_offset:
  78. - void **set_radial_center_offset** **(** :ref:`Vector2<class_vector2>` mode **)**
  79. .. _class_TextureProgress_set_radial_initial_angle:
  80. - void **set_radial_initial_angle** **(** :ref:`float<class_float>` mode **)**
  81. .. _class_TextureProgress_set_under_texture:
  82. - void **set_under_texture** **(** :ref:`Object<class_object>` tex **)**