CanvasItem

Inherits: Node < Object

Inherited By: Node2D, Control

Category: Core

Brief Description

Base class of anything 2D.

Member Functions

void _draw ( ) virtual
float draw_char ( Font font, Vector2 position, String char, String next, Color modulate=Color( 1, 1, 1, 1 ) )
void draw_circle ( Vector2 position, float radius, Color color )
void draw_colored_polygon ( PoolVector2Array points, Color color, PoolVector2Array uvs=PoolVector2Array( ), Texture texture=null, Texture normal_map=null, bool antialiased=false )
void draw_line ( Vector2 from, Vector2 to, Color color, float width=1.0, bool antialiased=false )
void draw_multiline ( PoolVector2Array points, Color color, float width=1.0, bool antialiased=false )
void draw_multiline_colors ( PoolVector2Array points, PoolColorArray colors, float width=1.0, bool antialiased=false )
void draw_polygon ( PoolVector2Array points, PoolColorArray colors, PoolVector2Array uvs=PoolVector2Array( ), Texture texture=null, Texture normal_map=null, bool antialiased=false )
void draw_polyline ( PoolVector2Array points, Color color, float width=1.0, bool antialiased=false )
void draw_polyline_colors ( PoolVector2Array points, PoolColorArray colors, float width=1.0, bool antialiased=false )
void draw_primitive ( PoolVector2Array points, PoolColorArray colors, PoolVector2Array uvs, Texture texture=null, float width=1.0, Texture normal_map=null )
void draw_rect ( Rect2 rect, Color color, bool filled=true )
void draw_set_transform ( Vector2 position, float rotation, Vector2 scale )
void draw_set_transform_matrix ( Transform2D xform )
void draw_string ( Font font, Vector2 position, String text, Color modulate=Color( 1, 1, 1, 1 ), int clip_w=-1 )
void draw_style_box ( StyleBox style_box, Rect2 rect )
void draw_texture ( Texture texture, Vector2 position, Color modulate=Color( 1, 1, 1, 1 ), Texture normal_map=null )
void draw_texture_rect ( Texture texture, Rect2 rect, bool tile, Color modulate=Color( 1, 1, 1, 1 ), bool transpose=false, Texture normal_map=null )
void draw_texture_rect_region ( Texture texture, Rect2 rect, Rect2 src_rect, Color modulate=Color( 1, 1, 1, 1 ), bool transpose=false, Texture normal_map=null, bool clip_uv=true )
RID get_canvas ( ) const
RID get_canvas_item ( ) const
Transform2D get_canvas_transform ( ) const
Vector2 get_global_mouse_position ( ) const
Transform2D get_global_transform ( ) const
Transform2D get_global_transform_with_canvas ( ) const
Vector2 get_local_mouse_position ( ) const
Transform2D get_transform ( ) const
Rect2 get_viewport_rect ( ) const
Transform2D get_viewport_transform ( ) const
World2D get_world_2d ( ) const
void hide ( )
bool is_local_transform_notification_enabled ( ) const
bool is_set_as_toplevel ( ) const
bool is_transform_notification_enabled ( ) const
bool is_visible_in_tree ( ) const
Vector2 make_canvas_position_local ( Vector2 screen_point ) const
InputEvent make_input_local ( InputEvent event ) const
void set_as_toplevel ( bool enable )
void set_notify_local_transform ( bool enable )
void set_notify_transform ( bool enable )
void show ( )
void update ( )

Signals

  • draw ( )

Emitted when the CanvasItem must redraw. This can only be connected realtime, as deferred will not allow drawing.

  • hide ( )

Emitted when becoming hidden.

  • item_rect_changed ( )

Emitted when the item rect has changed.

  • visibility_changed ( )

Emitted when the visibility (hidden/visible) changes.

Member Variables

  • int light_mask - The rendering layers in which this CanvasItem responds to Light2D nodes. Default value: 1.
  • Material material - The material applied to textures on this CanvasItem. Default value: null.
  • Color modulate - The color applied to textures on this CanvasItem. Default value: Color(1, 1, 1, 1) (opaque “white”).
  • Color self_modulate - The color applied to textures on this CanvasItem. This is not inherited by children CanvasItems. Default value: Color(1, 1, 1, 1) (opaque “white”)..
  • bool show_behind_parent - If true the object draws behind its parent. Default value: false.
  • bool show_on_top - If true the object draws on top of its parent. Default value: true.
  • bool use_parent_material - If true the parent CanvasItem‘s material property is used as this one’s material. Default value: false.
  • bool visible - If true this CanvasItem is drawn. Default value: true.

Numeric Constants

  • BLEND_MODE_MIX = 0 — Mix blending mode. Colors are assumed to be independent of the alpha (opacity) value.
  • BLEND_MODE_ADD = 1 — Additive blending mode.
  • BLEND_MODE_SUB = 2 — Subtractive blending mode.
  • BLEND_MODE_MUL = 3 — Multiplicative blending mode.
  • BLEND_MODE_PREMULT_ALPHA = 4 — Mix blending mode. Colors are assumed to be premultiplied by the alpha (opacity) value.
  • NOTIFICATION_TRANSFORM_CHANGED = 29 — Canvas item transform has changed. Only received if requested.
  • NOTIFICATION_DRAW = 30 — CanvasItem is requested to draw.
  • NOTIFICATION_VISIBILITY_CHANGED = 31 — Canvas item visibility has changed.
  • NOTIFICATION_ENTER_CANVAS = 32 — Canvas item has entered the canvas.
  • NOTIFICATION_EXIT_CANVAS = 33 — Canvas item has exited the canvas.

Description

Base class of anything 2D. Canvas items are laid out in a tree and children inherit and extend the transform of their parent. CanvasItem is extended by Control, for anything GUI related, and by Node2D for anything 2D engine related.

Any CanvasItem can draw. For this, the “update” function must be called, then NOTIFICATION_DRAW will be received on idle time to request redraw. Because of this, canvas items don’t need to be redraw on every frame, improving the performance significantly. Several functions for drawing on the CanvasItem are provided (see draw_* functions). They can only be used inside the notification, signal or _draw() overrides function, though.

Canvas items are draw in tree order. By default, children are on top of their parents so a root CanvasItem will be drawn behind everything (this can be changed per item though).

Canvas items can also be hidden (hiding also their subtree). They provide many means for changing standard parameters such as opacity (for it and the subtree) and self opacity, blend mode.

Ultimately, a transform notification can be requested, which will notify the node that its global position changed in case the parent tree changed.

Member Function Description

  • void _draw ( ) virtual

Called (if exists) to draw the canvas item.

Draw a string character using a custom font. Returns the advance, depending on the char width and kerning with an optional next char.

Draw a colored circle.

Draw a colored polygon of any amount of points, convex or concave.

Draw a line from a 2D point to another, with a given color and width. It can be optionally antialiased.

Draw a polygon of any amount of points, convex or concave.

Draw a polyline with a uniform color and width and optional antialiasing.

Draw a polyline with a uniform width, segment-by-segment coloring, and optional antialiasing. Colors assigned to line segments match by index between points and colors.

Draw a custom primitive, 1 point for a point, 2 points for a line, 3 points for a triangle and 4 points for a quad.

Draw a colored rectangle.

Sets a custom transform for drawing via components. Anything drawn afterwards will be transformed by this.

Sets a custom transform for drawing via matrix. Anything drawn afterwards will be transformed by this.

Draw a string using a custom font.

Draw a styled rectangle.

Draw a texture at a given position.

Draw a textured rectangle at a given position, optionally modulated by a color. Transpose swaps the x and y coordinates when reading the texture.

Draw a textured rectangle region at a given position, optionally modulated by a color. Transpose swaps the x and y coordinates when reading the texture.

  • RID get_canvas ( ) const

Return the RID of the World2D canvas where this item is in.

  • RID get_canvas_item ( ) const

Return the canvas item RID used by VisualServer for this item.

Get the transform matrix of this item’s canvas.

  • Vector2 get_global_mouse_position ( ) const

Get the global position of the mouse.

Get the global transform matrix of this item.

  • Transform2D get_global_transform_with_canvas ( ) const

Get the global transform matrix of this item in relation to the canvas.

  • Vector2 get_local_mouse_position ( ) const

Get the mouse position relative to this item’s position.

Get the transform matrix of this item.

  • Rect2 get_viewport_rect ( ) const

Get the viewport’s boundaries as a Rect2.

Get this item’s transform in relation to the viewport.

Get the World2D where this item is in.

  • void hide ( )

Hide the CanvasItem currently visible.

  • bool is_local_transform_notification_enabled ( ) const

Returns true if local transform notifications are communicated to children.

  • bool is_set_as_toplevel ( ) const

Return if set as toplevel. See set_as_toplevel.

  • bool is_transform_notification_enabled ( ) const

Returns true if global transform notifications are communicated to children.

  • bool is_visible_in_tree ( ) const

Returns true if the node is in the SceneTree and is visible on-screen.

Assigns screen_point as this node’s new local transform.

Transformations issued by event‘s inputs are applied in local space instead of global space.

  • void set_as_toplevel ( bool enable )

Sets as top level. This means that it will not inherit transform from parent canvas items.

  • void set_notify_local_transform ( bool enable )

If enable is true, children will be updated with local transform data.

  • void set_notify_transform ( bool enable )

If enable is true, children will be updated with global transform data.

  • void show ( )

Show the CanvasItem currently hidden.

  • void update ( )

Queue the CanvasItem for update. NOTIFICATION_DRAW will be called on idle time to request redraw.