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
----------------

+----------------------------+--------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`  | :ref:`get_texture_rotation<class_Polygon2D_get_texture_rotation>` **(** **)** const                                      |
+----------------------------+--------------------------------------------------------------------------------------------------------------------------+
| void                       | :ref:`set_texture_rotation<class_Polygon2D_set_texture_rotation>` **(** :ref:`float<class_float>` texture_rotation **)** |
+----------------------------+--------------------------------------------------------------------------------------------------------------------------+

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

  .. _class_Polygon2D_antialiased:

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

  .. _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_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 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_get_texture_rotation:

- :ref:`float<class_float>` **get_texture_rotation** **(** **)** const

Return the rotation in radians of the texture polygon.

.. _class_Polygon2D_set_texture_rotation:

- void **set_texture_rotation** **(** :ref:`float<class_float>` texture_rotation **)**

Set the amount of rotation of the polygon texture, ``texture_rotation`` is specified in radians and clockwise rotation.