class_boxoccluder3d.rst 2.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253
  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/BoxOccluder3D.xml.
  6. .. _class_BoxOccluder3D:
  7. BoxOccluder3D
  8. =============
  9. **Inherits:** :ref:`Occluder3D<class_Occluder3D>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  10. Cuboid shape for use with occlusion culling in :ref:`OccluderInstance3D<class_OccluderInstance3D>`.
  11. Description
  12. -----------
  13. ``BoxOccluder3D`` stores a cuboid shape that can be used by the engine's occlusion culling system.
  14. See :ref:`OccluderInstance3D<class_OccluderInstance3D>`'s documentation for instructions on setting up occlusion culling.
  15. Properties
  16. ----------
  17. +-------------------------------+------------------------------------------------+----------------------+
  18. | :ref:`Vector3<class_Vector3>` | :ref:`size<class_BoxOccluder3D_property_size>` | ``Vector3(1, 1, 1)`` |
  19. +-------------------------------+------------------------------------------------+----------------------+
  20. Property Descriptions
  21. ---------------------
  22. .. _class_BoxOccluder3D_property_size:
  23. - :ref:`Vector3<class_Vector3>` **size**
  24. +-----------+----------------------+
  25. | *Default* | ``Vector3(1, 1, 1)`` |
  26. +-----------+----------------------+
  27. | *Setter* | set_size(value) |
  28. +-----------+----------------------+
  29. | *Getter* | get_size() |
  30. +-----------+----------------------+
  31. The box's size in 3D units.
  32. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  33. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  34. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  35. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  36. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  37. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`