class_giprobedata.rst 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/GIProbeData.xml.
  6. .. _class_GIProbeData:
  7. GIProbeData
  8. ===========
  9. **Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  10. .. container:: contribute
  11. There is currently no description for this class. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  12. .. rst-class:: classref-introduction-group
  13. Tutorials
  14. ---------
  15. - `Third Person Shooter Demo <https://godotengine.org/asset-library/asset/678>`__
  16. .. rst-class:: classref-reftable-group
  17. Properties
  18. ----------
  19. .. table::
  20. :widths: auto
  21. +-----------------------------------------+----------------------------------------------------------------+-----------------------------------------------------+
  22. | :ref:`float<class_float>` | :ref:`bias<class_GIProbeData_property_bias>` | ``0.4`` |
  23. +-----------------------------------------+----------------------------------------------------------------+-----------------------------------------------------+
  24. | :ref:`AABB<class_AABB>` | :ref:`bounds<class_GIProbeData_property_bounds>` | ``AABB( 0, 0, 0, 1, 1, 1 )`` |
  25. +-----------------------------------------+----------------------------------------------------------------+-----------------------------------------------------+
  26. | :ref:`float<class_float>` | :ref:`cell_size<class_GIProbeData_property_cell_size>` | ``1.0`` |
  27. +-----------------------------------------+----------------------------------------------------------------+-----------------------------------------------------+
  28. | :ref:`bool<class_bool>` | :ref:`compress<class_GIProbeData_property_compress>` | ``false`` |
  29. +-----------------------------------------+----------------------------------------------------------------+-----------------------------------------------------+
  30. | :ref:`PoolIntArray<class_PoolIntArray>` | :ref:`dynamic_data<class_GIProbeData_property_dynamic_data>` | ``PoolIntArray( )`` |
  31. +-----------------------------------------+----------------------------------------------------------------+-----------------------------------------------------+
  32. | :ref:`int<class_int>` | :ref:`dynamic_range<class_GIProbeData_property_dynamic_range>` | ``1`` |
  33. +-----------------------------------------+----------------------------------------------------------------+-----------------------------------------------------+
  34. | :ref:`float<class_float>` | :ref:`energy<class_GIProbeData_property_energy>` | ``1.0`` |
  35. +-----------------------------------------+----------------------------------------------------------------+-----------------------------------------------------+
  36. | :ref:`bool<class_bool>` | :ref:`interior<class_GIProbeData_property_interior>` | ``false`` |
  37. +-----------------------------------------+----------------------------------------------------------------+-----------------------------------------------------+
  38. | :ref:`float<class_float>` | :ref:`normal_bias<class_GIProbeData_property_normal_bias>` | ``0.4`` |
  39. +-----------------------------------------+----------------------------------------------------------------+-----------------------------------------------------+
  40. | :ref:`float<class_float>` | :ref:`propagation<class_GIProbeData_property_propagation>` | ``1.0`` |
  41. +-----------------------------------------+----------------------------------------------------------------+-----------------------------------------------------+
  42. | :ref:`Transform<class_Transform>` | :ref:`to_cell_xform<class_GIProbeData_property_to_cell_xform>` | ``Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )`` |
  43. +-----------------------------------------+----------------------------------------------------------------+-----------------------------------------------------+
  44. .. rst-class:: classref-section-separator
  45. ----
  46. .. rst-class:: classref-descriptions-group
  47. Property Descriptions
  48. ---------------------
  49. .. _class_GIProbeData_property_bias:
  50. .. rst-class:: classref-property
  51. :ref:`float<class_float>` **bias** = ``0.4``
  52. .. rst-class:: classref-property-setget
  53. - void **set_bias** **(** :ref:`float<class_float>` value **)**
  54. - :ref:`float<class_float>` **get_bias** **(** **)**
  55. .. container:: contribute
  56. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  57. .. rst-class:: classref-item-separator
  58. ----
  59. .. _class_GIProbeData_property_bounds:
  60. .. rst-class:: classref-property
  61. :ref:`AABB<class_AABB>` **bounds** = ``AABB( 0, 0, 0, 1, 1, 1 )``
  62. .. rst-class:: classref-property-setget
  63. - void **set_bounds** **(** :ref:`AABB<class_AABB>` value **)**
  64. - :ref:`AABB<class_AABB>` **get_bounds** **(** **)**
  65. .. container:: contribute
  66. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  67. .. rst-class:: classref-item-separator
  68. ----
  69. .. _class_GIProbeData_property_cell_size:
  70. .. rst-class:: classref-property
  71. :ref:`float<class_float>` **cell_size** = ``1.0``
  72. .. rst-class:: classref-property-setget
  73. - void **set_cell_size** **(** :ref:`float<class_float>` value **)**
  74. - :ref:`float<class_float>` **get_cell_size** **(** **)**
  75. .. container:: contribute
  76. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  77. .. rst-class:: classref-item-separator
  78. ----
  79. .. _class_GIProbeData_property_compress:
  80. .. rst-class:: classref-property
  81. :ref:`bool<class_bool>` **compress** = ``false``
  82. .. rst-class:: classref-property-setget
  83. - void **set_compress** **(** :ref:`bool<class_bool>` value **)**
  84. - :ref:`bool<class_bool>` **is_compressed** **(** **)**
  85. .. container:: contribute
  86. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  87. .. rst-class:: classref-item-separator
  88. ----
  89. .. _class_GIProbeData_property_dynamic_data:
  90. .. rst-class:: classref-property
  91. :ref:`PoolIntArray<class_PoolIntArray>` **dynamic_data** = ``PoolIntArray( )``
  92. .. rst-class:: classref-property-setget
  93. - void **set_dynamic_data** **(** :ref:`PoolIntArray<class_PoolIntArray>` value **)**
  94. - :ref:`PoolIntArray<class_PoolIntArray>` **get_dynamic_data** **(** **)**
  95. .. container:: contribute
  96. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  97. .. rst-class:: classref-item-separator
  98. ----
  99. .. _class_GIProbeData_property_dynamic_range:
  100. .. rst-class:: classref-property
  101. :ref:`int<class_int>` **dynamic_range** = ``1``
  102. .. rst-class:: classref-property-setget
  103. - void **set_dynamic_range** **(** :ref:`int<class_int>` value **)**
  104. - :ref:`int<class_int>` **get_dynamic_range** **(** **)**
  105. .. container:: contribute
  106. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  107. .. rst-class:: classref-item-separator
  108. ----
  109. .. _class_GIProbeData_property_energy:
  110. .. rst-class:: classref-property
  111. :ref:`float<class_float>` **energy** = ``1.0``
  112. .. rst-class:: classref-property-setget
  113. - void **set_energy** **(** :ref:`float<class_float>` value **)**
  114. - :ref:`float<class_float>` **get_energy** **(** **)**
  115. .. container:: contribute
  116. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  117. .. rst-class:: classref-item-separator
  118. ----
  119. .. _class_GIProbeData_property_interior:
  120. .. rst-class:: classref-property
  121. :ref:`bool<class_bool>` **interior** = ``false``
  122. .. rst-class:: classref-property-setget
  123. - void **set_interior** **(** :ref:`bool<class_bool>` value **)**
  124. - :ref:`bool<class_bool>` **is_interior** **(** **)**
  125. .. container:: contribute
  126. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  127. .. rst-class:: classref-item-separator
  128. ----
  129. .. _class_GIProbeData_property_normal_bias:
  130. .. rst-class:: classref-property
  131. :ref:`float<class_float>` **normal_bias** = ``0.4``
  132. .. rst-class:: classref-property-setget
  133. - void **set_normal_bias** **(** :ref:`float<class_float>` value **)**
  134. - :ref:`float<class_float>` **get_normal_bias** **(** **)**
  135. .. container:: contribute
  136. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  137. .. rst-class:: classref-item-separator
  138. ----
  139. .. _class_GIProbeData_property_propagation:
  140. .. rst-class:: classref-property
  141. :ref:`float<class_float>` **propagation** = ``1.0``
  142. .. rst-class:: classref-property-setget
  143. - void **set_propagation** **(** :ref:`float<class_float>` value **)**
  144. - :ref:`float<class_float>` **get_propagation** **(** **)**
  145. .. container:: contribute
  146. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  147. .. rst-class:: classref-item-separator
  148. ----
  149. .. _class_GIProbeData_property_to_cell_xform:
  150. .. rst-class:: classref-property
  151. :ref:`Transform<class_Transform>` **to_cell_xform** = ``Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )``
  152. .. rst-class:: classref-property-setget
  153. - void **set_to_cell_xform** **(** :ref:`Transform<class_Transform>` value **)**
  154. - :ref:`Transform<class_Transform>` **get_to_cell_xform** **(** **)**
  155. .. container:: contribute
  156. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  157. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  158. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  159. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  160. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`