class_sphereoccluder3d.rst 2.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
  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/4.0/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/4.0/doc/classes/SphereOccluder3D.xml.
  6. .. _class_SphereOccluder3D:
  7. SphereOccluder3D
  8. ================
  9. **Inherits:** :ref:`Occluder3D<class_Occluder3D>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  10. Spherical shape for use with occlusion culling in :ref:`OccluderInstance3D<class_OccluderInstance3D>`.
  11. .. rst-class:: classref-introduction-group
  12. Description
  13. -----------
  14. **SphereOccluder3D** stores a sphere shape that can be used by the engine's occlusion culling system.
  15. See :ref:`OccluderInstance3D<class_OccluderInstance3D>`'s documentation for instructions on setting up occlusion culling.
  16. .. rst-class:: classref-reftable-group
  17. Properties
  18. ----------
  19. .. table::
  20. :widths: auto
  21. +---------------------------+-------------------------------------------------------+---------+
  22. | :ref:`float<class_float>` | :ref:`radius<class_SphereOccluder3D_property_radius>` | ``1.0`` |
  23. +---------------------------+-------------------------------------------------------+---------+
  24. .. rst-class:: classref-section-separator
  25. ----
  26. .. rst-class:: classref-descriptions-group
  27. Property Descriptions
  28. ---------------------
  29. .. _class_SphereOccluder3D_property_radius:
  30. .. rst-class:: classref-property
  31. :ref:`float<class_float>` **radius** = ``1.0``
  32. .. rst-class:: classref-property-setget
  33. - void **set_radius** **(** :ref:`float<class_float>` value **)**
  34. - :ref:`float<class_float>` **get_radius** **(** **)**
  35. The sphere's radius in 3D units.
  36. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  37. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  38. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  39. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  40. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  41. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`