class_boxoccluder3d.rst 2.2 KB

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