mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-05 22:09:56 +03:00
207 lines
14 KiB
ReStructuredText
207 lines
14 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
|
|
.. DO NOT EDIT THIS FILE, but the VoxelGIData.xml source instead.
|
|
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
|
|
|
.. _class_VoxelGIData:
|
|
|
|
VoxelGIData
|
|
===========
|
|
|
|
**Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
|
|
|
|
|
|
|
|
Tutorials
|
|
---------
|
|
|
|
- `Third Person Shooter Demo <https://godotengine.org/asset-library/asset/678>`__
|
|
|
|
Properties
|
|
----------
|
|
|
|
+---------------------------+--------------------------------------------------------------------+-----------+
|
|
| :ref:`float<class_float>` | :ref:`bias<class_VoxelGIData_property_bias>` | ``1.5`` |
|
|
+---------------------------+--------------------------------------------------------------------+-----------+
|
|
| :ref:`float<class_float>` | :ref:`dynamic_range<class_VoxelGIData_property_dynamic_range>` | ``4.0`` |
|
|
+---------------------------+--------------------------------------------------------------------+-----------+
|
|
| :ref:`float<class_float>` | :ref:`energy<class_VoxelGIData_property_energy>` | ``1.0`` |
|
|
+---------------------------+--------------------------------------------------------------------+-----------+
|
|
| :ref:`bool<class_bool>` | :ref:`interior<class_VoxelGIData_property_interior>` | ``false`` |
|
|
+---------------------------+--------------------------------------------------------------------+-----------+
|
|
| :ref:`float<class_float>` | :ref:`normal_bias<class_VoxelGIData_property_normal_bias>` | ``0.0`` |
|
|
+---------------------------+--------------------------------------------------------------------+-----------+
|
|
| :ref:`float<class_float>` | :ref:`propagation<class_VoxelGIData_property_propagation>` | ``0.7`` |
|
|
+---------------------------+--------------------------------------------------------------------+-----------+
|
|
| :ref:`bool<class_bool>` | :ref:`use_two_bounces<class_VoxelGIData_property_use_two_bounces>` | ``false`` |
|
|
+---------------------------+--------------------------------------------------------------------+-----------+
|
|
|
|
Methods
|
|
-------
|
|
|
|
+-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`allocate<class_VoxelGIData_method_allocate>` **(** :ref:`Transform3D<class_Transform3D>` to_cell_xform, :ref:`AABB<class_AABB>` aabb, :ref:`Vector3<class_Vector3>` octree_size, :ref:`PackedByteArray<class_PackedByteArray>` octree_cells, :ref:`PackedByteArray<class_PackedByteArray>` data_cells, :ref:`PackedByteArray<class_PackedByteArray>` distance_field, :ref:`PackedInt32Array<class_PackedInt32Array>` level_counts **)** |
|
|
+-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`AABB<class_AABB>` | :ref:`get_bounds<class_VoxelGIData_method_get_bounds>` **(** **)** |const| |
|
|
+-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`get_data_cells<class_VoxelGIData_method_get_data_cells>` **(** **)** |const| |
|
|
+-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`get_level_counts<class_VoxelGIData_method_get_level_counts>` **(** **)** |const| |
|
|
+-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`get_octree_cells<class_VoxelGIData_method_get_octree_cells>` **(** **)** |const| |
|
|
+-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Vector3<class_Vector3>` | :ref:`get_octree_size<class_VoxelGIData_method_get_octree_size>` **(** **)** |const| |
|
|
+-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Transform3D<class_Transform3D>` | :ref:`get_to_cell_xform<class_VoxelGIData_method_get_to_cell_xform>` **(** **)** |const| |
|
|
+-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_VoxelGIData_property_bias:
|
|
|
|
- :ref:`float<class_float>` **bias**
|
|
|
|
+-----------+-----------------+
|
|
| *Default* | ``1.5`` |
|
|
+-----------+-----------------+
|
|
| *Setter* | set_bias(value) |
|
|
+-----------+-----------------+
|
|
| *Getter* | get_bias() |
|
|
+-----------+-----------------+
|
|
|
|
----
|
|
|
|
.. _class_VoxelGIData_property_dynamic_range:
|
|
|
|
- :ref:`float<class_float>` **dynamic_range**
|
|
|
|
+-----------+--------------------------+
|
|
| *Default* | ``4.0`` |
|
|
+-----------+--------------------------+
|
|
| *Setter* | set_dynamic_range(value) |
|
|
+-----------+--------------------------+
|
|
| *Getter* | get_dynamic_range() |
|
|
+-----------+--------------------------+
|
|
|
|
----
|
|
|
|
.. _class_VoxelGIData_property_energy:
|
|
|
|
- :ref:`float<class_float>` **energy**
|
|
|
|
+-----------+-------------------+
|
|
| *Default* | ``1.0`` |
|
|
+-----------+-------------------+
|
|
| *Setter* | set_energy(value) |
|
|
+-----------+-------------------+
|
|
| *Getter* | get_energy() |
|
|
+-----------+-------------------+
|
|
|
|
----
|
|
|
|
.. _class_VoxelGIData_property_interior:
|
|
|
|
- :ref:`bool<class_bool>` **interior**
|
|
|
|
+-----------+---------------------+
|
|
| *Default* | ``false`` |
|
|
+-----------+---------------------+
|
|
| *Setter* | set_interior(value) |
|
|
+-----------+---------------------+
|
|
| *Getter* | is_interior() |
|
|
+-----------+---------------------+
|
|
|
|
----
|
|
|
|
.. _class_VoxelGIData_property_normal_bias:
|
|
|
|
- :ref:`float<class_float>` **normal_bias**
|
|
|
|
+-----------+------------------------+
|
|
| *Default* | ``0.0`` |
|
|
+-----------+------------------------+
|
|
| *Setter* | set_normal_bias(value) |
|
|
+-----------+------------------------+
|
|
| *Getter* | get_normal_bias() |
|
|
+-----------+------------------------+
|
|
|
|
----
|
|
|
|
.. _class_VoxelGIData_property_propagation:
|
|
|
|
- :ref:`float<class_float>` **propagation**
|
|
|
|
+-----------+------------------------+
|
|
| *Default* | ``0.7`` |
|
|
+-----------+------------------------+
|
|
| *Setter* | set_propagation(value) |
|
|
+-----------+------------------------+
|
|
| *Getter* | get_propagation() |
|
|
+-----------+------------------------+
|
|
|
|
----
|
|
|
|
.. _class_VoxelGIData_property_use_two_bounces:
|
|
|
|
- :ref:`bool<class_bool>` **use_two_bounces**
|
|
|
|
+-----------+----------------------------+
|
|
| *Default* | ``false`` |
|
|
+-----------+----------------------------+
|
|
| *Setter* | set_use_two_bounces(value) |
|
|
+-----------+----------------------------+
|
|
| *Getter* | is_using_two_bounces() |
|
|
+-----------+----------------------------+
|
|
|
|
Method Descriptions
|
|
-------------------
|
|
|
|
.. _class_VoxelGIData_method_allocate:
|
|
|
|
- void **allocate** **(** :ref:`Transform3D<class_Transform3D>` to_cell_xform, :ref:`AABB<class_AABB>` aabb, :ref:`Vector3<class_Vector3>` octree_size, :ref:`PackedByteArray<class_PackedByteArray>` octree_cells, :ref:`PackedByteArray<class_PackedByteArray>` data_cells, :ref:`PackedByteArray<class_PackedByteArray>` distance_field, :ref:`PackedInt32Array<class_PackedInt32Array>` level_counts **)**
|
|
|
|
----
|
|
|
|
.. _class_VoxelGIData_method_get_bounds:
|
|
|
|
- :ref:`AABB<class_AABB>` **get_bounds** **(** **)** |const|
|
|
|
|
----
|
|
|
|
.. _class_VoxelGIData_method_get_data_cells:
|
|
|
|
- :ref:`PackedByteArray<class_PackedByteArray>` **get_data_cells** **(** **)** |const|
|
|
|
|
----
|
|
|
|
.. _class_VoxelGIData_method_get_level_counts:
|
|
|
|
- :ref:`PackedInt32Array<class_PackedInt32Array>` **get_level_counts** **(** **)** |const|
|
|
|
|
----
|
|
|
|
.. _class_VoxelGIData_method_get_octree_cells:
|
|
|
|
- :ref:`PackedByteArray<class_PackedByteArray>` **get_octree_cells** **(** **)** |const|
|
|
|
|
----
|
|
|
|
.. _class_VoxelGIData_method_get_octree_size:
|
|
|
|
- :ref:`Vector3<class_Vector3>` **get_octree_size** **(** **)** |const|
|
|
|
|
----
|
|
|
|
.. _class_VoxelGIData_method_get_to_cell_xform:
|
|
|
|
- :ref:`Transform3D<class_Transform3D>` **get_to_cell_xform** **(** **)** |const|
|
|
|
|
.. |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.)`
|
|
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
|
|
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
|
|
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
|