Line2D¶
Inherits: Node2D < CanvasItem < Node < Object
Category: Core
Brief Description¶
A 2D line.
Properties¶
Methods¶
void | add_point ( Vector2 position ) |
void | clear_points ( ) |
int | get_point_count ( ) const |
Vector2 | get_point_position ( int i ) const |
void | remove_point ( int i ) |
void | set_point_position ( int i, Vector2 position ) |
Enumerations¶
enum LineJointMode:
- LINE_JOINT_SHARP = 0 — The line’s joints will be pointy. If
sharp_limit
is greater than the rotation of a joint, it becomes a bevel joint instead. - LINE_JOINT_BEVEL = 1 — The line’s joints will be bevelled/chamfered.
- LINE_JOINT_ROUND = 2 — The line’s joints will be rounded.
enum LineCapMode:
- LINE_CAP_NONE = 0 — Don’t have a line cap.
- LINE_CAP_BOX = 1 — Draws the line cap as a box.
- LINE_CAP_ROUND = 2 — Draws the line cap as a circle.
enum LineTextureMode:
- LINE_TEXTURE_NONE = 0 — Takes the left pixels of the texture and renders it over the whole line.
- LINE_TEXTURE_TILE = 1 — Tiles the texture over the line. The texture need to be imported with Repeat Enabled for it to work properly.
- LINE_TEXTURE_STRETCH = 2 — Stretches the texture across the line. Import the texture with Repeat Disabled for best results.
Description¶
A line through several points in 2D space.
Property Descriptions¶
- LineCapMode begin_cap_mode
Setter | set_begin_cap_mode(value) |
Getter | get_begin_cap_mode() |
Controls the style of the line’s first point. Use LINE_CAP_*
constants. Default value: LINE_CAP_NONE.
- Color default_color
Setter | set_default_color(value) |
Getter | get_default_color() |
The line’s color. Will not be used if a gradient is set.
- LineCapMode end_cap_mode
Setter | set_end_cap_mode(value) |
Getter | get_end_cap_mode() |
Controls the style of the line’s last point. Use LINE_CAP_*
constants. Default value: LINE_CAP_NONE.
- Gradient gradient
Setter | set_gradient(value) |
Getter | get_gradient() |
The gradient is drawn through the whole line from start to finish. The default color will not be used if a gradient is set.
- LineJointMode joint_mode
Setter | set_joint_mode(value) |
Getter | get_joint_mode() |
The style for the points between the start and the end.
- PoolVector2Array points
Setter | set_points(value) |
Getter | get_points() |
The points that form the lines. The line is drawn between every point set in this array.
- int round_precision
Setter | set_round_precision(value) |
Getter | get_round_precision() |
The smoothness of the rounded joints and caps. This is only used if a cap or joint is set as round.
- float sharp_limit
Setter | set_sharp_limit(value) |
Getter | get_sharp_limit() |
The direction difference in radians between vector points. This value is only used if joint mode
is set to LINE_JOINT_SHARP.
- Texture texture
Setter | set_texture(value) |
Getter | get_texture() |
The texture used for the line’s texture. Uses texture_mode
for drawing style.
- LineTextureMode texture_mode
Setter | set_texture_mode(value) |
Getter | get_texture_mode() |
The style to render the texture
on the line. Use LINE_TEXTURE_*
constants. Default value: LINE_TEXTURE_NONE.
- float width
Setter | set_width(value) |
Getter | get_width() |
The line’s width.
Method Descriptions¶
- void add_point ( Vector2 position )
Add a point at the position
. Appends the point at the end of the line.
- void clear_points ( )
Removes all points from the line.
- int get_point_count ( ) const
Returns the Line2D’s amount of points.
Returns point i
’s position.
- void remove_point ( int i )
Remove the point at index i
from the line.
Overwrites the position in point i
with the supplied position
.