mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-08 10:10:54 +03:00
81 lines
4.0 KiB
ReStructuredText
81 lines
4.0 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
|
|
.. DO NOT EDIT THIS FILE, but the ArrayOccluder3D.xml source instead.
|
|
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
|
|
|
.. _class_ArrayOccluder3D:
|
|
|
|
ArrayOccluder3D
|
|
===============
|
|
|
|
**Inherits:** :ref:`Occluder3D<class_Occluder3D>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
|
|
|
|
3D polygon shape for use with occlusion culling in :ref:`OccluderInstance3D<class_OccluderInstance3D>`.
|
|
|
|
Description
|
|
-----------
|
|
|
|
``ArrayOccluder3D`` stores an arbitrary 3D polygon shape that can be used by the engine's occlusion culling system. This is analogous to :ref:`ArrayMesh<class_ArrayMesh>`, but for occluders.
|
|
|
|
See :ref:`OccluderInstance3D<class_OccluderInstance3D>`'s documentation for instructions on setting up occlusion culling.
|
|
|
|
Properties
|
|
----------
|
|
|
|
+-----------------------------------------------------+----------------------------------------------------------+--------------------------+
|
|
| :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`indices<class_ArrayOccluder3D_property_indices>` | ``PackedInt32Array()`` |
|
|
+-----------------------------------------------------+----------------------------------------------------------+--------------------------+
|
|
| :ref:`PackedVector3Array<class_PackedVector3Array>` | :ref:`vertices<class_ArrayOccluder3D_property_vertices>` | ``PackedVector3Array()`` |
|
|
+-----------------------------------------------------+----------------------------------------------------------+--------------------------+
|
|
|
|
Methods
|
|
-------
|
|
|
|
+------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_arrays<class_ArrayOccluder3D_method_set_arrays>` **(** :ref:`PackedVector3Array<class_PackedVector3Array>` vertices, :ref:`PackedInt32Array<class_PackedInt32Array>` indices **)** |
|
|
+------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_ArrayOccluder3D_property_indices:
|
|
|
|
- :ref:`PackedInt32Array<class_PackedInt32Array>` **indices**
|
|
|
|
+-----------+------------------------+
|
|
| *Default* | ``PackedInt32Array()`` |
|
|
+-----------+------------------------+
|
|
| *Setter* | set_indices(value) |
|
|
+-----------+------------------------+
|
|
| *Getter* | get_indices() |
|
|
+-----------+------------------------+
|
|
|
|
----
|
|
|
|
.. _class_ArrayOccluder3D_property_vertices:
|
|
|
|
- :ref:`PackedVector3Array<class_PackedVector3Array>` **vertices**
|
|
|
|
+-----------+--------------------------+
|
|
| *Default* | ``PackedVector3Array()`` |
|
|
+-----------+--------------------------+
|
|
| *Setter* | set_vertices(value) |
|
|
+-----------+--------------------------+
|
|
| *Getter* | get_vertices() |
|
|
+-----------+--------------------------+
|
|
|
|
Method Descriptions
|
|
-------------------
|
|
|
|
.. _class_ArrayOccluder3D_method_set_arrays:
|
|
|
|
- void **set_arrays** **(** :ref:`PackedVector3Array<class_PackedVector3Array>` vertices, :ref:`PackedInt32Array<class_PackedInt32Array>` indices **)**
|
|
|
|
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
|
|
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
|
|
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
|
|
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
|
|
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
|
|
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
|