Skip to content

Latest commit

 

History

History
143 lines (84 loc) · 5.3 KB

class_occluderpolygon2d.rst

File metadata and controls

143 lines (84 loc) · 5.3 KB
Raw
github_url

hide

OccluderPolygon2D

Inherits: Resource<class_Resource> < RefCounted<class_RefCounted> < Object<class_Object>

Defines a 2D polygon for LightOccluder2D.

classref-introduction-group

Description

Editor facility that helps you draw a 2D polygon used as resource for LightOccluder2D<class_LightOccluder2D>.

classref-reftable-group

Properties

bool<class_bool> closed<class_OccluderPolygon2D_property_closed> true
CullMode<enum_OccluderPolygon2D_CullMode> cull_mode<class_OccluderPolygon2D_property_cull_mode> 0
PackedVector2Array<class_PackedVector2Array> polygon<class_OccluderPolygon2D_property_polygon> PackedVector2Array()

classref-section-separator

classref-descriptions-group

Enumerations

classref-enumeration

enum CullMode:

classref-enumeration-constant

CullMode<enum_OccluderPolygon2D_CullMode> CULL_DISABLED = 0

Culling is disabled. See cull_mode<class_OccluderPolygon2D_property_cull_mode>.

classref-enumeration-constant

CullMode<enum_OccluderPolygon2D_CullMode> CULL_CLOCKWISE = 1

Culling is performed in the clockwise direction. See cull_mode<class_OccluderPolygon2D_property_cull_mode>.

classref-enumeration-constant

CullMode<enum_OccluderPolygon2D_CullMode> CULL_COUNTER_CLOCKWISE = 2

Culling is performed in the counterclockwise direction. See cull_mode<class_OccluderPolygon2D_property_cull_mode>.

classref-section-separator

classref-descriptions-group

Property Descriptions

classref-property

bool<class_bool> closed = true

classref-property-setget

  • void set_closed ( bool<class_bool> value )
  • bool<class_bool> is_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.

classref-item-separator

classref-property

CullMode<enum_OccluderPolygon2D_CullMode> cull_mode = 0

classref-property-setget

  • void set_cull_mode ( CullMode<enum_OccluderPolygon2D_CullMode> value )
  • CullMode<enum_OccluderPolygon2D_CullMode> get_cull_mode ( )

The culling mode to use.

classref-item-separator

classref-property

PackedVector2Array<class_PackedVector2Array> polygon = PackedVector2Array()

classref-property-setget

  • void set_polygon ( PackedVector2Array<class_PackedVector2Array> value )
  • PackedVector2Array<class_PackedVector2Array> get_polygon ( )

A Vector2<class_Vector2> array with the index for polygon's vertices positions.

Note: The returned value is a copy of the underlying array, rather than a reference.