mirror of
https://github.com/stan220/godot-docs.git
synced 2026-09-08 19:29:06 +00:00
92 lines
4.9 KiB
ReStructuredText
92 lines
4.9 KiB
ReStructuredText
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
|
.. DO NOT EDIT THIS FILE, but the OccluderPolygon2D.xml source instead.
|
|
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
|
|
|
.. _class_OccluderPolygon2D:
|
|
|
|
OccluderPolygon2D
|
|
=================
|
|
|
|
**Inherits:** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
|
|
|
**Category:** Core
|
|
|
|
Brief Description
|
|
-----------------
|
|
|
|
Defines a 2D polygon for LightOccluder2D.
|
|
|
|
Member Functions
|
|
----------------
|
|
|
|
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`get_cull_mode<class_OccluderPolygon2D_get_cull_mode>` **(** **)** const |
|
|
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`PoolVector2Array<class_poolvector2array>` | :ref:`get_polygon<class_OccluderPolygon2D_get_polygon>` **(** **)** const |
|
|
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`is_closed<class_OccluderPolygon2D_is_closed>` **(** **)** const |
|
|
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_closed<class_OccluderPolygon2D_set_closed>` **(** :ref:`bool<class_bool>` closed **)** |
|
|
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_cull_mode<class_OccluderPolygon2D_set_cull_mode>` **(** :ref:`int<class_int>` cull_mode **)** |
|
|
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_polygon<class_OccluderPolygon2D_set_polygon>` **(** :ref:`PoolVector2Array<class_poolvector2array>` polygon **)** |
|
|
+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
Member Variables
|
|
----------------
|
|
|
|
.. _class_OccluderPolygon2D_closed:
|
|
|
|
- :ref:`bool<class_bool>` **closed** - If ``true`` closes the polygon. A closed OccluderPolygon2D occludes the light coming from any direction. An opened OccluderPolygon2D occludes the light only at its outline's direction. Default value ``true``.
|
|
|
|
.. _class_OccluderPolygon2D_cull_mode:
|
|
|
|
- :ref:`int<class_int>` **cull_mode** - Set the direction of the occlusion culling when not ``CULL_DISABLED``. Default value ``DISABLED``.
|
|
|
|
.. _class_OccluderPolygon2D_polygon:
|
|
|
|
- :ref:`PoolVector2Array<class_poolvector2array>` **polygon** - A :ref:`Vector2<class_vector2>` array with the index for polygon's vertices positions.
|
|
|
|
|
|
Numeric Constants
|
|
-----------------
|
|
|
|
- **CULL_DISABLED** = **0** --- Culling mode for the occlusion. Disabled means no culling. See :ref:`cull_mode<class_OccluderPolygon2D_cull_mode>`.
|
|
- **CULL_CLOCKWISE** = **1** --- Culling mode for the occlusion. Sets the culling to be in clockwise direction. See :ref:`cull_mode<class_OccluderPolygon2D_cull_mode>`.
|
|
- **CULL_COUNTER_CLOCKWISE** = **2** --- Culling mode for the occlusion. Sets the culling to be in counter clockwise direction. See :ref:`cull_mode<class_OccluderPolygon2D_cull_mode>`.
|
|
|
|
Description
|
|
-----------
|
|
|
|
Editor facility that helps you draw a 2D polygon used as resource for :ref:`LightOccluder2D<class_lightoccluder2d>`.
|
|
|
|
Member Function Description
|
|
---------------------------
|
|
|
|
.. _class_OccluderPolygon2D_get_cull_mode:
|
|
|
|
- :ref:`int<class_int>` **get_cull_mode** **(** **)** const
|
|
|
|
.. _class_OccluderPolygon2D_get_polygon:
|
|
|
|
- :ref:`PoolVector2Array<class_poolvector2array>` **get_polygon** **(** **)** const
|
|
|
|
.. _class_OccluderPolygon2D_is_closed:
|
|
|
|
- :ref:`bool<class_bool>` **is_closed** **(** **)** const
|
|
|
|
.. _class_OccluderPolygon2D_set_closed:
|
|
|
|
- void **set_closed** **(** :ref:`bool<class_bool>` closed **)**
|
|
|
|
.. _class_OccluderPolygon2D_set_cull_mode:
|
|
|
|
- void **set_cull_mode** **(** :ref:`int<class_int>` cull_mode **)**
|
|
|
|
.. _class_OccluderPolygon2D_set_polygon:
|
|
|
|
- void **set_polygon** **(** :ref:`PoolVector2Array<class_poolvector2array>` polygon **)**
|
|
|
|
|