| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201 |
- :github_url: hide
- .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
- .. DO NOT EDIT THIS FILE, but the GIProbeData.xml source instead.
- .. The source is found in doc/classes or modules/<name>/doc_classes.
- .. _class_GIProbeData:
- GIProbeData
- ===========
- **Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
- Properties
- ----------
- +-----------------------------------------+----------------------------------------------------------------+-----------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`bias<class_GIProbeData_property_bias>` | ``0.4`` |
- +-----------------------------------------+----------------------------------------------------------------+-----------------------------------------------------+
- | :ref:`AABB<class_AABB>` | :ref:`bounds<class_GIProbeData_property_bounds>` | ``AABB( 0, 0, 0, 1, 1, 1 )`` |
- +-----------------------------------------+----------------------------------------------------------------+-----------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`cell_size<class_GIProbeData_property_cell_size>` | ``1.0`` |
- +-----------------------------------------+----------------------------------------------------------------+-----------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`compress<class_GIProbeData_property_compress>` | ``false`` |
- +-----------------------------------------+----------------------------------------------------------------+-----------------------------------------------------+
- | :ref:`PoolIntArray<class_PoolIntArray>` | :ref:`dynamic_data<class_GIProbeData_property_dynamic_data>` | ``PoolIntArray( )`` |
- +-----------------------------------------+----------------------------------------------------------------+-----------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`dynamic_range<class_GIProbeData_property_dynamic_range>` | ``1`` |
- +-----------------------------------------+----------------------------------------------------------------+-----------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`energy<class_GIProbeData_property_energy>` | ``1.0`` |
- +-----------------------------------------+----------------------------------------------------------------+-----------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`interior<class_GIProbeData_property_interior>` | ``false`` |
- +-----------------------------------------+----------------------------------------------------------------+-----------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`normal_bias<class_GIProbeData_property_normal_bias>` | ``0.4`` |
- +-----------------------------------------+----------------------------------------------------------------+-----------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`propagation<class_GIProbeData_property_propagation>` | ``1.0`` |
- +-----------------------------------------+----------------------------------------------------------------+-----------------------------------------------------+
- | :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 )`` |
- +-----------------------------------------+----------------------------------------------------------------+-----------------------------------------------------+
- Property Descriptions
- ---------------------
- .. _class_GIProbeData_property_bias:
- - :ref:`float<class_float>` **bias**
- +-----------+-----------------+
- | *Default* | ``0.4`` |
- +-----------+-----------------+
- | *Setter* | set_bias(value) |
- +-----------+-----------------+
- | *Getter* | get_bias() |
- +-----------+-----------------+
- ----
- .. _class_GIProbeData_property_bounds:
- - :ref:`AABB<class_AABB>` **bounds**
- +-----------+------------------------------+
- | *Default* | ``AABB( 0, 0, 0, 1, 1, 1 )`` |
- +-----------+------------------------------+
- | *Setter* | set_bounds(value) |
- +-----------+------------------------------+
- | *Getter* | get_bounds() |
- +-----------+------------------------------+
- ----
- .. _class_GIProbeData_property_cell_size:
- - :ref:`float<class_float>` **cell_size**
- +-----------+----------------------+
- | *Default* | ``1.0`` |
- +-----------+----------------------+
- | *Setter* | set_cell_size(value) |
- +-----------+----------------------+
- | *Getter* | get_cell_size() |
- +-----------+----------------------+
- ----
- .. _class_GIProbeData_property_compress:
- - :ref:`bool<class_bool>` **compress**
- +-----------+---------------------+
- | *Default* | ``false`` |
- +-----------+---------------------+
- | *Setter* | set_compress(value) |
- +-----------+---------------------+
- | *Getter* | is_compressed() |
- +-----------+---------------------+
- ----
- .. _class_GIProbeData_property_dynamic_data:
- - :ref:`PoolIntArray<class_PoolIntArray>` **dynamic_data**
- +-----------+-------------------------+
- | *Default* | ``PoolIntArray( )`` |
- +-----------+-------------------------+
- | *Setter* | set_dynamic_data(value) |
- +-----------+-------------------------+
- | *Getter* | get_dynamic_data() |
- +-----------+-------------------------+
- ----
- .. _class_GIProbeData_property_dynamic_range:
- - :ref:`int<class_int>` **dynamic_range**
- +-----------+--------------------------+
- | *Default* | ``1`` |
- +-----------+--------------------------+
- | *Setter* | set_dynamic_range(value) |
- +-----------+--------------------------+
- | *Getter* | get_dynamic_range() |
- +-----------+--------------------------+
- ----
- .. _class_GIProbeData_property_energy:
- - :ref:`float<class_float>` **energy**
- +-----------+-------------------+
- | *Default* | ``1.0`` |
- +-----------+-------------------+
- | *Setter* | set_energy(value) |
- +-----------+-------------------+
- | *Getter* | get_energy() |
- +-----------+-------------------+
- ----
- .. _class_GIProbeData_property_interior:
- - :ref:`bool<class_bool>` **interior**
- +-----------+---------------------+
- | *Default* | ``false`` |
- +-----------+---------------------+
- | *Setter* | set_interior(value) |
- +-----------+---------------------+
- | *Getter* | is_interior() |
- +-----------+---------------------+
- ----
- .. _class_GIProbeData_property_normal_bias:
- - :ref:`float<class_float>` **normal_bias**
- +-----------+------------------------+
- | *Default* | ``0.4`` |
- +-----------+------------------------+
- | *Setter* | set_normal_bias(value) |
- +-----------+------------------------+
- | *Getter* | get_normal_bias() |
- +-----------+------------------------+
- ----
- .. _class_GIProbeData_property_propagation:
- - :ref:`float<class_float>` **propagation**
- +-----------+------------------------+
- | *Default* | ``1.0`` |
- +-----------+------------------------+
- | *Setter* | set_propagation(value) |
- +-----------+------------------------+
- | *Getter* | get_propagation() |
- +-----------+------------------------+
- ----
- .. _class_GIProbeData_property_to_cell_xform:
- - :ref:`Transform<class_Transform>` **to_cell_xform**
- +-----------+-----------------------------------------------------+
- | *Default* | ``Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )`` |
- +-----------+-----------------------------------------------------+
- | *Setter* | set_to_cell_xform(value) |
- +-----------+-----------------------------------------------------+
- | *Getter* | get_to_cell_xform() |
- +-----------+-----------------------------------------------------+
- .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
- .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
- .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
|
