class_arrayoccluder3d.rst 4.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293
  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/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ArrayOccluder3D.xml.
  6. .. _class_ArrayOccluder3D:
  7. ArrayOccluder3D
  8. ===============
  9. **Inherits:** :ref:`Occluder3D<class_Occluder3D>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  10. 3D polygon shape for use with occlusion culling in :ref:`OccluderInstance3D<class_OccluderInstance3D>`.
  11. Description
  12. -----------
  13. ``ArrayOccluder3D`` stores an arbitrary 3D polygon shape that can be used by the engine's occlusion culling system. This is analogous to :ref:`ArrayMesh<class_ArrayMesh>`, but for occluders.
  14. See :ref:`OccluderInstance3D<class_OccluderInstance3D>`'s documentation for instructions on setting up occlusion culling.
  15. Properties
  16. ----------
  17. +-----------------------------------------------------+----------------------------------------------------------+--------------------------+
  18. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`indices<class_ArrayOccluder3D_property_indices>` | ``PackedInt32Array()`` |
  19. +-----------------------------------------------------+----------------------------------------------------------+--------------------------+
  20. | :ref:`PackedVector3Array<class_PackedVector3Array>` | :ref:`vertices<class_ArrayOccluder3D_property_vertices>` | ``PackedVector3Array()`` |
  21. +-----------------------------------------------------+----------------------------------------------------------+--------------------------+
  22. Methods
  23. -------
  24. +------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  25. | void | :ref:`set_arrays<class_ArrayOccluder3D_method_set_arrays>` **(** :ref:`PackedVector3Array<class_PackedVector3Array>` vertices, :ref:`PackedInt32Array<class_PackedInt32Array>` indices **)** |
  26. +------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  27. Property Descriptions
  28. ---------------------
  29. .. _class_ArrayOccluder3D_property_indices:
  30. - :ref:`PackedInt32Array<class_PackedInt32Array>` **indices**
  31. +-----------+------------------------+
  32. | *Default* | ``PackedInt32Array()`` |
  33. +-----------+------------------------+
  34. | *Setter* | set_indices(value) |
  35. +-----------+------------------------+
  36. | *Getter* | get_indices() |
  37. +-----------+------------------------+
  38. .. container:: contribute
  39. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  40. ----
  41. .. _class_ArrayOccluder3D_property_vertices:
  42. - :ref:`PackedVector3Array<class_PackedVector3Array>` **vertices**
  43. +-----------+--------------------------+
  44. | *Default* | ``PackedVector3Array()`` |
  45. +-----------+--------------------------+
  46. | *Setter* | set_vertices(value) |
  47. +-----------+--------------------------+
  48. | *Getter* | get_vertices() |
  49. +-----------+--------------------------+
  50. .. container:: contribute
  51. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  52. Method Descriptions
  53. -------------------
  54. .. _class_ArrayOccluder3D_method_set_arrays:
  55. - void **set_arrays** **(** :ref:`PackedVector3Array<class_PackedVector3Array>` vertices, :ref:`PackedInt32Array<class_PackedInt32Array>` indices **)**
  56. .. container:: contribute
  57. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  58. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  59. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  60. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  61. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  62. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  63. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`