ArrayOccluder3D.xml 1.9 KB

1234567891011121314151617181920212223242526272829303132
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="ArrayOccluder3D" inherits="Occluder3D" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
  3. <brief_description>
  4. 3D polygon shape for use with occlusion culling in [OccluderInstance3D].
  5. </brief_description>
  6. <description>
  7. [ArrayOccluder3D] stores an arbitrary 3D polygon shape that can be used by the engine's occlusion culling system. This is analogous to [ArrayMesh], but for occluders.
  8. See [OccluderInstance3D]'s documentation for instructions on setting up occlusion culling.
  9. </description>
  10. <tutorials>
  11. </tutorials>
  12. <methods>
  13. <method name="set_arrays">
  14. <return type="void" />
  15. <param index="0" name="vertices" type="PackedVector3Array" />
  16. <param index="1" name="indices" type="PackedInt32Array" />
  17. <description>
  18. Sets [member indices] and [member vertices], while updating the final occluder only once after both values are set.
  19. </description>
  20. </method>
  21. </methods>
  22. <members>
  23. <member name="indices" type="PackedInt32Array" setter="set_indices" getter="get_indices" default="PackedInt32Array()">
  24. The occluder's index position. Indices determine which points from the [member vertices] array should be drawn, and in which order.
  25. [b]Note:[/b] The occluder is always updated after setting this value. If creating occluders procedurally, consider using [method set_arrays] instead to avoid updating the occluder twice when it's created.
  26. </member>
  27. <member name="vertices" type="PackedVector3Array" setter="set_vertices" getter="get_vertices" default="PackedVector3Array()">
  28. The occluder's vertex positions in local 3D coordinates.
  29. [b]Note:[/b] The occluder is always updated after setting this value. If creating occluders procedurally, consider using [method set_arrays] instead to avoid updating the occluder twice when it's created.
  30. </member>
  31. </members>
  32. </class>