Polygon2D
Inherits: Node2D < CanvasItem < Node < Object
Category: Core
Brief Description
A 2D polygon.
Properties
Methods
void | add_bone ( NodePath path, PoolRealArray weights ) |
void | clear_bones ( ) |
void | erase_bone ( int index ) |
int | get_bone_count ( ) const |
NodePath | get_bone_path ( int index ) const |
PoolRealArray | get_bone_weights ( int index ) const |
void | set_bone_path ( int index, NodePath path ) |
void | set_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
- bool antialiased
Setter | set_antialiased(value) |
Getter | get_antialiased() |
If true
, polygon edges will be anti-aliased. Default value: false
.
- Array bones
- Color color
Setter | set_color(value) |
Getter | get_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
Setter | set_internal_vertex_count(value) |
Getter | get_internal_vertex_count() |
- float invert_border
Setter | set_invert_border(value) |
Getter | get_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
.
- bool invert_enable
Setter | set_invert(value) |
Getter | get_invert() |
If true
, polygon will be inverted, containing the area outside the defined points and extending to the invert_border
. Default value: false
.
- Vector2 offset
Setter | set_offset(value) |
Getter | get_offset() |
The offset applied to each vertex.
- PoolVector2Array polygon
Setter | set_polygon(value) |
Getter | get_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.
- Array polygons
Setter | set_polygons(value) |
Getter | get_polygons() |
- NodePath skeleton
Setter | set_skeleton(value) |
Getter | get_skeleton() |
- Texture texture
Setter | set_texture(value) |
Getter | get_texture() |
The polygon’s fill texture. Use uv
to set texture coordinates.
- Vector2 texture_offset
Setter | set_texture_offset(value) |
Getter | get_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
.
- float texture_rotation
Setter | set_texture_rotation(value) |
Getter | get_texture_rotation() |
The texture’s rotation in radians.
- float texture_rotation_degrees
Setter | set_texture_rotation_degrees(value) |
Getter | get_texture_rotation_degrees() |
The texture’s rotation in degrees.
- Vector2 texture_scale
Setter | set_texture_scale(value) |
Getter | get_texture_scale() |
Amount to multiply the uv
coordinates when using a texture
. Larger values make the texture smaller, and vice versa.
Setter | set_uv(value) |
Getter | get_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)
.
- PoolColorArray vertex_colors
Setter | set_vertex_colors(value) |
Getter | get_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 add_bone ( NodePath path, PoolRealArray weights )
- void clear_bones ( )
- void erase_bone ( int index )
- int get_bone_count ( ) const
- PoolRealArray get_bone_weights ( int index ) const
- void set_bone_weights ( int index, PoolRealArray weights )