Polygon2D

Inherits: Node2D < CanvasItem < Node < Object

Category: Core

Brief Description

A 2D polygon.

Properties

boolantialiased
Arraybones
Colorcolor
intinternal_vertex_count
floatinvert_border
boolinvert_enable
Vector2offset
PoolVector2Arraypolygon
Arraypolygons
NodePathskeleton
Texturetexture
Vector2texture_offset
floattexture_rotation
floattexture_rotation_degrees
Vector2texture_scale
PoolVector2Arrayuv
PoolColorArrayvertex_colors

Methods

voidadd_bone ( NodePath path, PoolRealArray weights )
voidclear_bones ( )
voiderase_bone ( int index )
intget_bone_count ( ) const
NodePathget_bone_path ( int index ) const
PoolRealArrayget_bone_weights ( int index ) const
voidset_bone_path ( int index, NodePath path )
voidset_bone_weights ( int index, PoolRealArray weights )

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.

Property Descriptions

Setterset_antialiased(value)
Getterget_antialiased()

If true, polygon edges will be anti-aliased. Default value: false.



Setterset_color(value)
Getterget_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.


  • int internal_vertex_count
Setterset_internal_vertex_count(value)
Getterget_internal_vertex_count()

Setterset_invert_border(value)
Getterget_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.


Setterset_invert(value)
Getterget_invert()

If true, polygon will be inverted, containing the area outside the defined points and extending to the invert_border. Default value: false.


Setterset_offset(value)
Getterget_offset()

The offset applied to each vertex.


Setterset_polygon(value)
Getterget_polygon()

The polygon’s list of vertices. The final point will be connected to the first. Note that this returns a copy of the PoolVector2Array rather than a reference.


Setterset_polygons(value)
Getterget_polygons()

Setterset_skeleton(value)
Getterget_skeleton()

Setterset_texture(value)
Getterget_texture()

The polygon’s fill texture. Use uv to set texture coordinates.


Setterset_texture_offset(value)
Getterget_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.


Setterset_texture_rotation(value)
Getterget_texture_rotation()

The texture’s rotation in radians.


  • float texture_rotation_degrees
Setterset_texture_rotation_degrees(value)
Getterget_texture_rotation_degrees()

The texture’s rotation in degrees.


Setterset_texture_scale(value)
Getterget_texture_scale()

Amount to multiply the uv coordinates when using a texture. Larger values make the texture smaller, and vice versa.


Setterset_uv(value)
Getterget_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).


Setterset_vertex_colors(value)
Getterget_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.

Method Descriptions


  • void clear_bones ( )

  • void erase_bone ( int index )

  • int get_bone_count ( ) const