godot-docs/classes/class_polygon2d.rst

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the Polygon2D.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_Polygon2D:

Polygon2D
=========

**Inherits:** :ref:`Node2D<class_node2d>` **<** :ref:`CanvasItem<class_canvasitem>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`

**Category:** Core

Brief Description
-----------------

A 2D polygon.

Member Functions
----------------

+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                       | :ref:`add_bone<class_Polygon2D_add_bone>` **(** :ref:`NodePath<class_nodepath>` path, :ref:`PoolRealArray<class_poolrealarray>` weights **)**        |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                       | :ref:`clear_bones<class_Polygon2D_clear_bones>` **(** **)**                                                                                          |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                       | :ref:`erase_bone<class_Polygon2D_erase_bone>` **(** :ref:`int<class_int>` index **)**                                                                |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                      | :ref:`get_bone_count<class_Polygon2D_get_bone_count>` **(** **)** const                                                                              |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`NodePath<class_nodepath>`            | :ref:`get_bone_path<class_Polygon2D_get_bone_path>` **(** :ref:`int<class_int>` index **)** const                                                    |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolRealArray<class_poolrealarray>`  | :ref:`get_bone_weights<class_Polygon2D_get_bone_weights>` **(** :ref:`int<class_int>` index **)** const                                              |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                       | :ref:`set_bone_path<class_Polygon2D_set_bone_path>` **(** :ref:`int<class_int>` index, :ref:`NodePath<class_nodepath>` path **)**                    |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                       | :ref:`set_bone_weights<class_Polygon2D_set_bone_weights>` **(** :ref:`int<class_int>` index, :ref:`PoolRealArray<class_poolrealarray>` weights **)** |
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+

Member Variables
----------------

  .. _class_Polygon2D_antialiased:

- :ref:`bool<class_bool>` **antialiased** - If ``true`` polygon edges will be anti-aliased. Default value: ``false``.

  .. _class_Polygon2D_bones:

- :ref:`Array<class_array>` **bones**

  .. _class_Polygon2D_color:

- :ref:`Color<class_color>` **color** - The polygon's fill color. If ``texture`` is defined, it will be multiplied by this color. It will also be the default color for vertices not set in ``vertex_colors``.

  .. _class_Polygon2D_invert_border:

- :ref:`float<class_float>` **invert_border** - Added padding applied to the bounding box when using ``invert``. Setting this value too small may result in a "Bad Polygon" error. Default value: ``100``.

  .. _class_Polygon2D_invert_enable:

- :ref:`bool<class_bool>` **invert_enable** - If ``true`` polygon will be inverted, containing the area outside the defined points and extending to the ``invert_border``. Default value: ``false``.

  .. _class_Polygon2D_offset:

- :ref:`Vector2<class_vector2>` **offset** - The offset applied to each vertex.

  .. _class_Polygon2D_polygon:

- :ref:`PoolVector2Array<class_poolvector2array>` **polygon** - The polygon's list of vertices. The final point will be connected to the first.

  .. _class_Polygon2D_skeleton:

- :ref:`NodePath<class_nodepath>` **skeleton**

  .. _class_Polygon2D_splits:

- :ref:`PoolIntArray<class_poolintarray>` **splits**

  .. _class_Polygon2D_texture:

- :ref:`Texture<class_texture>` **texture** - The polygon's fill texture. Use ``uv`` to set texture coordinates.

  .. _class_Polygon2D_texture_offset:

- :ref:`Vector2<class_vector2>` **texture_offset** - Amount to offset the polygon's ``texture``. If ``(0, 0)`` the texture's origin (its top-left corner) will be placed at the polygon's ``position``.

  .. _class_Polygon2D_texture_rotation:

- :ref:`float<class_float>` **texture_rotation** - The texture's rotation in radians.

  .. _class_Polygon2D_texture_rotation_degrees:

- :ref:`float<class_float>` **texture_rotation_degrees** - The texture's rotation in degrees.

  .. _class_Polygon2D_texture_scale:

- :ref:`Vector2<class_vector2>` **texture_scale** - Amount to multiply the ``uv`` coordinates when using a ``texture``. Larger values make the texture smaller, and vice versa.

  .. _class_Polygon2D_uv:

- :ref:`PoolVector2Array<class_poolvector2array>` **uv** - Texture coordinates for each vertex of the polygon. There should be one ``uv`` per polygon vertex. If there are fewer, undefined vertices will use ``(0, 0)``.

  .. _class_Polygon2D_vertex_colors:

- :ref:`PoolColorArray<class_poolcolorarray>` **vertex_colors** - Color for each vertex. Colors are interpolated between vertices, resulting in smooth gradients. There should be one per polygon vertex. If there are fewer, undefined vertices will use ``color``.


Description
-----------

A Polygon2D is defined by a set of points. Each point is connected to the next, with the final point being connected to the first, resulting in a closed polygon. Polygon2Ds can be filled with color (solid or gradient) or filled with a given texture.

Member Function Description
---------------------------

.. _class_Polygon2D_add_bone:

- void **add_bone** **(** :ref:`NodePath<class_nodepath>` path, :ref:`PoolRealArray<class_poolrealarray>` weights **)**

.. _class_Polygon2D_clear_bones:

- void **clear_bones** **(** **)**

.. _class_Polygon2D_erase_bone:

- void **erase_bone** **(** :ref:`int<class_int>` index **)**

.. _class_Polygon2D_get_bone_count:

- :ref:`int<class_int>` **get_bone_count** **(** **)** const

.. _class_Polygon2D_get_bone_path:

- :ref:`NodePath<class_nodepath>` **get_bone_path** **(** :ref:`int<class_int>` index **)** const

.. _class_Polygon2D_get_bone_weights:

- :ref:`PoolRealArray<class_poolrealarray>` **get_bone_weights** **(** :ref:`int<class_int>` index **)** const

.. _class_Polygon2D_set_bone_path:

- void **set_bone_path** **(** :ref:`int<class_int>` index, :ref:`NodePath<class_nodepath>` path **)**

.. _class_Polygon2D_set_bone_weights:

- void **set_bone_weights** **(** :ref:`int<class_int>` index, :ref:`PoolRealArray<class_poolrealarray>` weights **)**