mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-04 14:11:02 +03:00
53 lines
2.2 KiB
ReStructuredText
53 lines
2.2 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 BoxOccluder3D.xml source instead.
|
|
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
|
|
|
.. _class_BoxOccluder3D:
|
|
|
|
BoxOccluder3D
|
|
=============
|
|
|
|
**Inherits:** :ref:`Occluder3D<class_Occluder3D>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
|
|
|
|
Cuboid shape for use with occlusion culling in :ref:`OccluderInstance3D<class_OccluderInstance3D>`.
|
|
|
|
Description
|
|
-----------
|
|
|
|
``BoxOccluder3D`` stores a cuboid shape that can be used by the engine's occlusion culling system.
|
|
|
|
See :ref:`OccluderInstance3D<class_OccluderInstance3D>`'s documentation for instructions on setting up occlusion culling.
|
|
|
|
Properties
|
|
----------
|
|
|
|
+-------------------------------+------------------------------------------------+----------------------+
|
|
| :ref:`Vector3<class_Vector3>` | :ref:`size<class_BoxOccluder3D_property_size>` | ``Vector3(1, 1, 1)`` |
|
|
+-------------------------------+------------------------------------------------+----------------------+
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_BoxOccluder3D_property_size:
|
|
|
|
- :ref:`Vector3<class_Vector3>` **size**
|
|
|
|
+-----------+----------------------+
|
|
| *Default* | ``Vector3(1, 1, 1)`` |
|
|
+-----------+----------------------+
|
|
| *Setter* | set_size(value) |
|
|
+-----------+----------------------+
|
|
| *Getter* | get_size() |
|
|
+-----------+----------------------+
|
|
|
|
The box's size in 3D units.
|
|
|
|
.. |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.)`
|