Home Explore Help
Sign In
Godot
/
godot-docs
mirror of https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: 75b51ec2f4
Branches Tags
godot-docs
/
classes
/
class_occluder3d.rst

class_occluder3d.rst 2.8 KB
History Raw

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556 
  1. :github_url: hide
    2. 

  2. 

  3. .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
    4. 

  4. .. DO NOT EDIT THIS FILE, but the Occluder3D.xml source instead.
    5. 

  5. .. The source is found in doc/classes or modules/<name>/doc_classes.
    6. 

  6. 

  7. .. _class_Occluder3D:
    8. 

  8. 

  9. Occluder3D
    10. 

  10. ==========
    11. 

  11. 

  12. **Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
    13. 

  13. 

  14. **Inherited By:** :ref:`ArrayOccluder3D<class_ArrayOccluder3D>`, :ref:`BoxOccluder3D<class_BoxOccluder3D>`, :ref:`PolygonOccluder3D<class_PolygonOccluder3D>`, :ref:`QuadOccluder3D<class_QuadOccluder3D>`, :ref:`SphereOccluder3D<class_SphereOccluder3D>`
    15. 

  15. 

  16. Occluder shape resource for use with occlusion culling in :ref:`OccluderInstance3D<class_OccluderInstance3D>`.
    17. 

  17. 

  18. Description
    19. 

  19. -----------
    20. 

  20. 

  21. ``Occluder3D`` stores an occluder shape that can be used by the engine's occlusion culling system.
    22. 

  22. 

  23. See :ref:`OccluderInstance3D<class_OccluderInstance3D>`'s documentation for instructions on setting up occlusion culling.
    24. 

  24. 

  25. Methods
    26. 

  26. -------
    27. 

  27. 

  28. +-----------------------------------------------------+-------------------------------------------------------------------------------+
    29. 

  29. | :ref:`PackedInt32Array<class_PackedInt32Array>`     | :ref:`get_indices<class_Occluder3D_method_get_indices>` **(** **)** |const|   |
    30. 

  30. +-----------------------------------------------------+-------------------------------------------------------------------------------+
    31. 

  31. | :ref:`PackedVector3Array<class_PackedVector3Array>` | :ref:`get_vertices<class_Occluder3D_method_get_vertices>` **(** **)** |const| |
    32. 

  32. +-----------------------------------------------------+-------------------------------------------------------------------------------+
    33. 

  33. 

  34. Method Descriptions
    35. 

  35. -------------------
    36. 

  36. 

  37. .. _class_Occluder3D_method_get_indices:
    38. 

  38. 

  39. - :ref:`PackedInt32Array<class_PackedInt32Array>` **get_indices** **(** **)** |const|
    40. 

  40. 

  41. Returns the occluder shape's vertex indices.
    42. 

  42. 

  43. ----
    44. 

  44. 

  45. .. _class_Occluder3D_method_get_vertices:
    46. 

  46. 

  47. - :ref:`PackedVector3Array<class_PackedVector3Array>` **get_vertices** **(** **)** |const|
    48. 

  48. 

  49. Returns the occluder shape's vertex positions.
    50. 

  50. 

  51. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
    52. 

  52. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
    53. 

  53. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
    54. 

  54. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
    55. 

  55. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
    56. 

  56. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
    57.