godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/doc/classes/CanvasItem.xml

597 lines
22 KiB
XML
Raw Normal View History

Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
doc: Bump version to 3.2
2019-04-01 10:33:56 +00:00
<class name="CanvasItem" inherits="Node" category="Core" version="3.2">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<brief_description>
Base class of anything 2D.
</brief_description>
<description>
Improve the CanvasItem documentation This makes it clear that line width and antialiasing in `draw_multiline()` aren't implemented yet (see #16448).
2019-05-14 07:08:22 +00:00
Base class of anything 2D. Canvas items are laid out in a tree; children inherit and extend their parent's transform. CanvasItem is extended by [Control] for anything GUI-related, and by [Node2D] for anything related to the 2D engine.
Any CanvasItem can draw. For this, [method update] must be called, then [constant NOTIFICATION_DRAW] will be received on idle time to request redraw. Because of this, canvas items don't need to be redrawn on every frame, improving the performance significantly. Several functions for drawing on the CanvasItem are provided (see [code]draw_*[/code] functions). However, they can only be used inside the [method Object._notification], signal or [method _draw] virtual functions.
Canvas items are drawn in tree order. By default, children are on top of their parents so a root CanvasItem will be drawn behind everything. This behavior can be changed on a per-item basis.
A CanvasItem can also be hidden, which will also hide its children. It provides many ways to change parameters such as modulation (for itself and its children) and self modulation (only for itself), as well as its blend mode.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
Ultimately, a transform notification can be requested, which will notify the node that its global position changed in case the parent tree changed.
</description>
<tutorials>
doc: Use HTTPS for docs.godotengine.org and point to latest branch Fixes #23509.
2018-11-05 07:46:27 +00:00
<link>https://docs.godotengine.org/en/latest/tutorials/2d/2d_transforms.html</link>
<link>https://docs.godotengine.org/en/latest/tutorials/2d/custom_drawing_in_2d.html</link>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</tutorials>
<methods>
<method name="_draw" qualifiers="virtual">
<return type="void">
</return>
<description>
Called (if exists) to draw the canvas item.
</description>
</method>
<method name="draw_char">
<return type="float">
</return>
<argument index="0" name="font" type="Font">
</argument>
Rename pos to position in user facing methods and variables Rename user facing methods and variables as well as the corresponding C++ methods according to the folloming changes: * pos -> position * rot -> rotation * loc -> location C++ variables are left as is.
2017-09-10 13:37:49 +00:00
<argument index="1" name="position" type="Vector2">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
<argument index="2" name="char" type="String">
</argument>
<argument index="3" name="next" type="String">
</argument>
<argument index="4" name="modulate" type="Color" default="Color( 1, 1, 1, 1 )">
</argument>
<description>
Improve the CanvasItem documentation This makes it clear that line width and antialiasing in `draw_multiline()` aren't implemented yet (see #16448).
2019-05-14 07:08:22 +00:00
Draws a string character using a custom font. Returns the advance, depending on the character width and kerning with an optional next character.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="draw_circle">
<return type="void">
</return>
Rename pos to position in user facing methods and variables Rename user facing methods and variables as well as the corresponding C++ methods according to the folloming changes: * pos -> position * rot -> rotation * loc -> location C++ variables are left as is.
2017-09-10 13:37:49 +00:00
<argument index="0" name="position" type="Vector2">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
<argument index="1" name="radius" type="float">
</argument>
<argument index="2" name="color" type="Color">
</argument>
<description>
[DOCS] Animation, CanvasItem, Curve3D, Curve
2017-12-11 19:05:26 +00:00
Draws a colored circle.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="draw_colored_polygon">
<return type="void">
</return>
<argument index="0" name="points" type="PoolVector2Array">
</argument>
<argument index="1" name="color" type="Color">
</argument>
<argument index="2" name="uvs" type="PoolVector2Array" default="PoolVector2Array( )">
</argument>
<argument index="3" name="texture" type="Texture" default="null">
</argument>
<argument index="4" name="normal_map" type="Texture" default="null">
</argument>
<argument index="5" name="antialiased" type="bool" default="false">
</argument>
<description>
[DOCS] Animation, CanvasItem, Curve3D, Curve
2017-12-11 19:05:26 +00:00
Draws a colored polygon of any amount of points, convex or concave.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="draw_line">
<return type="void">
</return>
<argument index="0" name="from" type="Vector2">
</argument>
<argument index="1" name="to" type="Vector2">
</argument>
<argument index="2" name="color" type="Color">
</argument>
<argument index="3" name="width" type="float" default="1.0">
</argument>
<argument index="4" name="antialiased" type="bool" default="false">
</argument>
<description>
[DOCS] Animation, CanvasItem, Curve3D, Curve
2017-12-11 19:05:26 +00:00
Draws a line from a 2D point to another, with a given color and width. It can be optionally antialiased.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
[DOCS] Sync classref with current source
2018-02-25 06:19:42 +00:00
<method name="draw_mesh">
<return type="void">
</return>
<argument index="0" name="mesh" type="Mesh">
</argument>
<argument index="1" name="texture" type="Texture">
</argument>
<argument index="2" name="normal_map" type="Texture" default="null">
</argument>
Added inspector plugin documentation. Fixed plugin bindings.
2019-04-23 19:39:09 +00:00
<argument index="3" name="transform" type="Transform2D" default="Transform2D( 1, 0, 0, 1, 0, 0 )">
</argument>
<argument index="4" name="modulate" type="Color" default="Color( 1, 1, 1, 1 )">
</argument>
[DOCS] Sync classref with current source
2018-02-25 06:19:42 +00:00
<description>
</description>
</method>
doc: Sync classref with current source
2017-12-09 23:43:30 +00:00
<method name="draw_multiline">
<return type="void">
</return>
<argument index="0" name="points" type="PoolVector2Array">
</argument>
<argument index="1" name="color" type="Color">
</argument>
<argument index="2" name="width" type="float" default="1.0">
</argument>
<argument index="3" name="antialiased" type="bool" default="false">
</argument>
<description>
Improve the CanvasItem documentation This makes it clear that line width and antialiasing in `draw_multiline()` aren't implemented yet (see #16448).
2019-05-14 07:08:22 +00:00
Draws multiple, parallel lines with a uniform [code]color[/code]. [code]width[/code] and [code]antialiased[/code] are currently not implemented and have no effect.
doc: Sync classref with current source
2017-12-09 23:43:30 +00:00
</description>
</method>
<method name="draw_multiline_colors">
<return type="void">
</return>
<argument index="0" name="points" type="PoolVector2Array">
</argument>
<argument index="1" name="colors" type="PoolColorArray">
</argument>
<argument index="2" name="width" type="float" default="1.0">
</argument>
<argument index="3" name="antialiased" type="bool" default="false">
</argument>
<description>
[DOCS] Animation, CanvasItem, Curve3D, Curve
2017-12-11 19:05:26 +00:00
Draws multiple, parallel lines with a uniform [code]width[/code], segment-by-segment coloring, and optional antialiasing. Colors assigned to line segments match by index between [code]points[/code] and [code]colors[/code].
doc: Sync classref with current source
2017-12-09 23:43:30 +00:00
</description>
</method>
[DOCS] Sync classref with current source
2018-02-25 06:19:42 +00:00
<method name="draw_multimesh">
<return type="void">
</return>
doc: Sync classref with current source
2018-12-13 14:12:25 +00:00
<argument index="0" name="multimesh" type="MultiMesh">
[DOCS] Sync classref with current source
2018-02-25 06:19:42 +00:00
</argument>
<argument index="1" name="texture" type="Texture">
</argument>
<argument index="2" name="normal_map" type="Texture" default="null">
</argument>
<description>
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<method name="draw_polygon">
<return type="void">
</return>
<argument index="0" name="points" type="PoolVector2Array">
</argument>
<argument index="1" name="colors" type="PoolColorArray">
</argument>
<argument index="2" name="uvs" type="PoolVector2Array" default="PoolVector2Array( )">
</argument>
<argument index="3" name="texture" type="Texture" default="null">
</argument>
<argument index="4" name="normal_map" type="Texture" default="null">
</argument>
<argument index="5" name="antialiased" type="bool" default="false">
</argument>
<description>
[DOCS] Animation, CanvasItem, Curve3D, Curve
2017-12-11 19:05:26 +00:00
Draws a polygon of any amount of points, convex or concave.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="draw_polyline">
<return type="void">
</return>
<argument index="0" name="points" type="PoolVector2Array">
</argument>
<argument index="1" name="color" type="Color">
</argument>
<argument index="2" name="width" type="float" default="1.0">
</argument>
<argument index="3" name="antialiased" type="bool" default="false">
</argument>
<description>
[DOCS] Animation, CanvasItem, Curve3D, Curve
2017-12-11 19:05:26 +00:00
Draws interconnected line segments with a uniform [code]color[/code] and [code]width[/code] and optional antialiasing.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="draw_polyline_colors">
<return type="void">
</return>
<argument index="0" name="points" type="PoolVector2Array">
</argument>
<argument index="1" name="colors" type="PoolColorArray">
</argument>
<argument index="2" name="width" type="float" default="1.0">
</argument>
<argument index="3" name="antialiased" type="bool" default="false">
</argument>
<description>
[DOCS] Animation, CanvasItem, Curve3D, Curve
2017-12-11 19:05:26 +00:00
Draws interconnected line segments with a uniform [code]width[/code], segment-by-segment coloring, and optional antialiasing. Colors assigned to line segments match by index between [code]points[/code] and [code]colors[/code].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="draw_primitive">
<return type="void">
</return>
<argument index="0" name="points" type="PoolVector2Array">
</argument>
<argument index="1" name="colors" type="PoolColorArray">
</argument>
<argument index="2" name="uvs" type="PoolVector2Array">
</argument>
<argument index="3" name="texture" type="Texture" default="null">
</argument>
<argument index="4" name="width" type="float" default="1.0">
</argument>
<argument index="5" name="normal_map" type="Texture" default="null">
</argument>
<description>
Improve the CanvasItem documentation This makes it clear that line width and antialiasing in `draw_multiline()` aren't implemented yet (see #16448).
2019-05-14 07:08:22 +00:00
Draws a custom primitive. 1 point for a point, 2 points for a line, 3 points for a triangle and 4 points for a quad.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="draw_rect">
<return type="void">
</return>
<argument index="0" name="rect" type="Rect2">
</argument>
<argument index="1" name="color" type="Color">
</argument>
<argument index="2" name="filled" type="bool" default="true">
</argument>
<description>
[DOCS] Animation, CanvasItem, Curve3D, Curve
2017-12-11 19:05:26 +00:00
Draws a colored rectangle.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="draw_set_transform">
<return type="void">
</return>
Rename pos to position in user facing methods and variables Rename user facing methods and variables as well as the corresponding C++ methods according to the folloming changes: * pos -> position * rot -> rotation * loc -> location C++ variables are left as is.
2017-09-10 13:37:49 +00:00
<argument index="0" name="position" type="Vector2">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
doc: Sync classref with current source [ci skip]
2017-09-23 08:59:35 +00:00
<argument index="1" name="rotation" type="float">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
<argument index="2" name="scale" type="Vector2">
</argument>
<description>
[DOCS] CanvasItem/Material/Layer, ClassDB, CollisionObject(2D)
2017-12-07 19:17:08 +00:00
Sets a custom transform for drawing via components. Anything drawn afterwards will be transformed by this.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="draw_set_transform_matrix">
<return type="void">
</return>
<argument index="0" name="xform" type="Transform2D">
</argument>
<description>
[DOCS] CanvasItem/Material/Layer, ClassDB, CollisionObject(2D)
2017-12-07 19:17:08 +00:00
Sets a custom transform for drawing via matrix. Anything drawn afterwards will be transformed by this.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="draw_string">
<return type="void">
</return>
<argument index="0" name="font" type="Font">
</argument>
Rename pos to position in user facing methods and variables Rename user facing methods and variables as well as the corresponding C++ methods according to the folloming changes: * pos -> position * rot -> rotation * loc -> location C++ variables are left as is.
2017-09-10 13:37:49 +00:00
<argument index="1" name="position" type="Vector2">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
<argument index="2" name="text" type="String">
</argument>
<argument index="3" name="modulate" type="Color" default="Color( 1, 1, 1, 1 )">
</argument>
<argument index="4" name="clip_w" type="int" default="-1">
</argument>
<description>
[DOCS] Animation, CanvasItem, Curve3D, Curve
2017-12-11 19:05:26 +00:00
Draws a string using a custom font.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="draw_style_box">
<return type="void">
</return>
<argument index="0" name="style_box" type="StyleBox">
</argument>
<argument index="1" name="rect" type="Rect2">
</argument>
<description>
[DOCS] Animation, CanvasItem, Curve3D, Curve
2017-12-11 19:05:26 +00:00
Draws a styled rectangle.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="draw_texture">
<return type="void">
</return>
<argument index="0" name="texture" type="Texture">
</argument>
Rename pos to position in user facing methods and variables Rename user facing methods and variables as well as the corresponding C++ methods according to the folloming changes: * pos -> position * rot -> rotation * loc -> location C++ variables are left as is.
2017-09-10 13:37:49 +00:00
<argument index="1" name="position" type="Vector2">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
<argument index="2" name="modulate" type="Color" default="Color( 1, 1, 1, 1 )">
</argument>
<argument index="3" name="normal_map" type="Texture" default="null">
</argument>
<description>
[DOCS] Animation, CanvasItem, Curve3D, Curve
2017-12-11 19:05:26 +00:00
Draws a texture at a given position.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="draw_texture_rect">
<return type="void">
</return>
<argument index="0" name="texture" type="Texture">
</argument>
<argument index="1" name="rect" type="Rect2">
</argument>
<argument index="2" name="tile" type="bool">
</argument>
<argument index="3" name="modulate" type="Color" default="Color( 1, 1, 1, 1 )">
</argument>
<argument index="4" name="transpose" type="bool" default="false">
</argument>
<argument index="5" name="normal_map" type="Texture" default="null">
</argument>
<description>
Improve the CanvasItem documentation This makes it clear that line width and antialiasing in `draw_multiline()` aren't implemented yet (see #16448).
2019-05-14 07:08:22 +00:00
Draws a textured rectangle at a given position, optionally modulated by a color. If [code]transpose[/code] is [code]true[/code], the texture will have its X and Y coordinates swapped.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="draw_texture_rect_region">
<return type="void">
</return>
<argument index="0" name="texture" type="Texture">
</argument>
<argument index="1" name="rect" type="Rect2">
</argument>
<argument index="2" name="src_rect" type="Rect2">
</argument>
<argument index="3" name="modulate" type="Color" default="Color( 1, 1, 1, 1 )">
</argument>
<argument index="4" name="transpose" type="bool" default="false">
</argument>
<argument index="5" name="normal_map" type="Texture" default="null">
</argument>
<argument index="6" name="clip_uv" type="bool" default="true">
</argument>
<description>
Improve the CanvasItem documentation This makes it clear that line width and antialiasing in `draw_multiline()` aren't implemented yet (see #16448).
2019-05-14 07:08:22 +00:00
Draws a textured rectangle region at a given position, optionally modulated by a color. If [code]transpose[/code] is [code]true[/code], the texture will have its X and Y coordinates swapped.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
doc: Sync classref with current source
2018-09-10 22:18:05 +00:00
<method name="force_update_transform">
<return type="void">
</return>
<description>
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<method name="get_canvas" qualifiers="const">
<return type="RID">
</return>
<description>
Change "Return" to "Returns" where necessary in XML documentation In many of the XML files it had been noted that when the documentation refers to a return value, both "Return" and "Returns" are used. This has now been fixed to only say "Returns". Fixes #28867
2019-05-24 02:15:43 +00:00
Returns the [RID] of the [World2D] canvas where this item is in.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="get_canvas_item" qualifiers="const">
<return type="RID">
</return>
<description>
Change "Return" to "Returns" where necessary in XML documentation In many of the XML files it had been noted that when the documentation refers to a return value, both "Return" and "Returns" are used. This has now been fixed to only say "Returns". Fixes #28867
2019-05-24 02:15:43 +00:00
Returns the canvas item RID used by [VisualServer] for this item.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="get_canvas_transform" qualifiers="const">
<return type="Transform2D">
</return>
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-21 23:04:47 +00:00
Gets the transform matrix of this item's canvas.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="get_global_mouse_position" qualifiers="const">
<return type="Vector2">
</return>
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-21 23:04:47 +00:00
Gets the global position of the mouse.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="get_global_transform" qualifiers="const">
<return type="Transform2D">
</return>
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-21 23:04:47 +00:00
Gets the global transform matrix of this item.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="get_global_transform_with_canvas" qualifiers="const">
<return type="Transform2D">
</return>
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-21 23:04:47 +00:00
Gets the global transform matrix of this item in relation to the canvas.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
Rename pos to position in user facing methods and variables Rename user facing methods and variables as well as the corresponding C++ methods according to the folloming changes: * pos -> position * rot -> rotation * loc -> location C++ variables are left as is.
2017-09-10 13:37:49 +00:00
<method name="get_local_mouse_position" qualifiers="const">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<return type="Vector2">
</return>
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-21 23:04:47 +00:00
Gets the mouse position relative to this item's position.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="get_transform" qualifiers="const">
<return type="Transform2D">
</return>
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-21 23:04:47 +00:00
Gets the transform matrix of this item.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="get_viewport_rect" qualifiers="const">
<return type="Rect2">
</return>
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-21 23:04:47 +00:00
Gets the viewport's boundaries as a [Rect2].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="get_viewport_transform" qualifiers="const">
<return type="Transform2D">
</return>
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-21 23:04:47 +00:00
Gets this item's transform in relation to the viewport.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="get_world_2d" qualifiers="const">
<return type="World2D">
</return>
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-21 23:04:47 +00:00
Gets the [World2D] where this item is in.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="hide">
<return type="void">
</return>
<description>
Improve the CanvasItem documentation This makes it clear that line width and antialiasing in `draw_multiline()` aren't implemented yet (see #16448).
2019-05-14 07:08:22 +00:00
Hide the CanvasItem if it's currently visible.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="is_local_transform_notification_enabled" qualifiers="const">
<return type="bool">
</return>
<description>
[DOCS] CanvasItem/Material/Layer, ClassDB, CollisionObject(2D)
2017-12-07 19:17:08 +00:00
Returns [code]true[/code] if local transform notifications are communicated to children.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="is_set_as_toplevel" qualifiers="const">
<return type="bool">
</return>
<description>
Improve the CanvasItem documentation This makes it clear that line width and antialiasing in `draw_multiline()` aren't implemented yet (see #16448).
2019-05-14 07:08:22 +00:00
Returns [code]true[/code] if the node is set as top-level. See [method set_as_toplevel].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="is_transform_notification_enabled" qualifiers="const">
<return type="bool">
</return>
<description>
[DOCS] CanvasItem/Material/Layer, ClassDB, CollisionObject(2D)
2017-12-07 19:17:08 +00:00
Returns [code]true[/code] if global transform notifications are communicated to children.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="is_visible_in_tree" qualifiers="const">
<return type="bool">
</return>
<description>
More precise description for is_visible_in_tree
2018-01-21 11:09:57 +00:00
Returns [code]true[/code] if the node is present in the [SceneTree], its [member visible] property is [code]true[/code] and its inherited visibility is also [code]true[/code].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
Rename pos to position in user facing methods and variables Rename user facing methods and variables as well as the corresponding C++ methods according to the folloming changes: * pos -> position * rot -> rotation * loc -> location C++ variables are left as is.
2017-09-10 13:37:49 +00:00
<method name="make_canvas_position_local" qualifiers="const">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<return type="Vector2">
</return>
<argument index="0" name="screen_point" type="Vector2">
</argument>
<description>
[DOCS] CanvasItem/Material/Layer, ClassDB, CollisionObject(2D)
2017-12-07 19:17:08 +00:00
Assigns [code]screen_point[/code] as this node's new local transform.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="make_input_local" qualifiers="const">
<return type="InputEvent">
</return>
<argument index="0" name="event" type="InputEvent">
</argument>
<description>
[DOCS] CanvasItem/Material/Layer, ClassDB, CollisionObject(2D)
2017-12-07 19:17:08 +00:00
Transformations issued by [code]event[/code]'s inputs are applied in local space instead of global space.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="set_as_toplevel">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
Improve the CanvasItem documentation This makes it clear that line width and antialiasing in `draw_multiline()` aren't implemented yet (see #16448).
2019-05-14 07:08:22 +00:00
If [code]enable[/code] is [code]true[/code], the node won't inherit its transform from parent canvas items.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="set_notify_local_transform">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
[DOCS] CanvasItem/Material/Layer, ClassDB, CollisionObject(2D)
2017-12-07 19:17:08 +00:00
If [code]enable[/code] is [code]true[/code], children will be updated with local transform data.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="set_notify_transform">
<return type="void">
</return>
<argument index="0" name="enable" type="bool">
</argument>
<description>
[DOCS] CanvasItem/Material/Layer, ClassDB, CollisionObject(2D)
2017-12-07 19:17:08 +00:00
If [code]enable[/code] is [code]true[/code], children will be updated with global transform data.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="show">
<return type="void">
</return>
<description>
Improve the CanvasItem documentation This makes it clear that line width and antialiasing in `draw_multiline()` aren't implemented yet (see #16448).
2019-05-14 07:08:22 +00:00
Show the CanvasItem if it's currently hidden. For controls that inherit [Popup], the correct way to make them visible is to call one of the multiple [code]popup*()[/code] functions instead.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="update">
<return type="void">
</return>
<description>
Improve the CanvasItem documentation This makes it clear that line width and antialiasing in `draw_multiline()` aren't implemented yet (see #16448).
2019-05-14 07:08:22 +00:00
Queue the CanvasItem for update. [constant NOTIFICATION_DRAW] will be called on idle time to request redraw.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
</methods>
<members>
doc: Sync classref with current source [ci skip]
2017-09-13 06:49:40 +00:00
<member name="light_mask" type="int" setter="set_light_mask" getter="get_light_mask">
ClassRef: Replace [code]CurrentClass[/code] with [CurrentClass] Modified makerst to generate code tags for these to avoid hyperlinks to the same class.
2019-03-29 22:37:35 +00:00
The rendering layers in which this [CanvasItem] responds to [Light2D] nodes. Default value: [code]1[/code].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 06:49:40 +00:00
<member name="material" type="Material" setter="set_material" getter="get_material">
ClassRef: Replace [code]CurrentClass[/code] with [CurrentClass] Modified makerst to generate code tags for these to avoid hyperlinks to the same class.
2019-03-29 22:37:35 +00:00
The material applied to textures on this [CanvasItem]. Default value: [code]null[/code].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 06:49:40 +00:00
<member name="modulate" type="Color" setter="set_modulate" getter="get_modulate">
ClassRef: Replace [code]CurrentClass[/code] with [CurrentClass] Modified makerst to generate code tags for these to avoid hyperlinks to the same class.
2019-03-29 22:37:35 +00:00
The color applied to textures on this [CanvasItem]. Default value: [code]Color(1, 1, 1, 1)[/code] (opaque "white").
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 06:49:40 +00:00
<member name="self_modulate" type="Color" setter="set_self_modulate" getter="get_self_modulate">
ClassRef: Replace [code]CurrentClass[/code] with [CurrentClass] Modified makerst to generate code tags for these to avoid hyperlinks to the same class.
2019-03-29 22:37:35 +00:00
The color applied to textures on this [CanvasItem]. This is not inherited by children [CanvasItem]s. Default value: [code]Color(1, 1, 1, 1)[/code] (opaque "white")..
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 06:49:40 +00:00
<member name="show_behind_parent" type="bool" setter="set_draw_behind_parent" getter="is_draw_behind_parent_enabled">
doc: Add missing commas after "If true/false"
2018-12-20 12:46:54 +00:00
If [code]true[/code], the object draws behind its parent. Default value: [code]false[/code].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 06:49:40 +00:00
<member name="show_on_top" type="bool" setter="_set_on_top" getter="_is_on_top">
doc: Add missing commas after "If true/false"
2018-12-20 12:46:54 +00:00
If [code]true[/code], the object draws on top of its parent. Default value: [code]true[/code].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 06:49:40 +00:00
<member name="use_parent_material" type="bool" setter="set_use_parent_material" getter="get_use_parent_material">
ClassRef: Replace [code]CurrentClass[/code] with [CurrentClass] Modified makerst to generate code tags for these to avoid hyperlinks to the same class.
2019-03-29 22:37:35 +00:00
If [code]true[/code], the parent [CanvasItem]'s [member material] property is used as this one's material. Default value: [code]false[/code].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 06:49:40 +00:00
<member name="visible" type="bool" setter="set_visible" getter="is_visible">
Improve the CanvasItem documentation This makes it clear that line width and antialiasing in `draw_multiline()` aren't implemented yet (see #16448).
2019-05-14 07:08:22 +00:00
If [code]true[/code], this [CanvasItem] is drawn. Default value: [code]true[/code]. For controls that inherit [Popup], the correct way to make them visible is to call one of the multiple [code]popup*()[/code] functions instead.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
</members>
<signals>
<signal name="draw">
<description>
Emitted when the CanvasItem must redraw. This can only be connected realtime, as deferred will not allow drawing.
</description>
</signal>
<signal name="hide">
<description>
Emitted when becoming hidden.
</description>
</signal>
<signal name="item_rect_changed">
<description>
Emitted when the item rect has changed.
</description>
</signal>
<signal name="visibility_changed">
<description>
Emitted when the visibility (hidden/visible) changes.
</description>
</signal>
</signals>
<constants>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="BLEND_MODE_MIX" value="0" enum="BlendMode">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
Mix blending mode. Colors are assumed to be independent of the alpha (opacity) value.
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="BLEND_MODE_ADD" value="1" enum="BlendMode">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
Additive blending mode.
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="BLEND_MODE_SUB" value="2" enum="BlendMode">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
Subtractive blending mode.
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="BLEND_MODE_MUL" value="3" enum="BlendMode">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
Multiplicative blending mode.
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="BLEND_MODE_PREMULT_ALPHA" value="4" enum="BlendMode">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
Mix blending mode. Colors are assumed to be premultiplied by the alpha (opacity) value.
</constant>
Sync classref with current source
2018-05-12 07:38:00 +00:00
<constant name="BLEND_MODE_DISABLED" value="5" enum="BlendMode">
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-21 23:04:47 +00:00
Disables blending mode. Colors including alpha are written as-is. Only applicable for render targets with a transparent background. No lighting will be applied.
Sync classref with current source
2018-05-12 07:38:00 +00:00
</constant>
doc: Sync classref with current source
2019-04-15 12:49:41 +00:00
<constant name="NOTIFICATION_TRANSFORM_CHANGED" value="2000">
Improve the CanvasItem documentation This makes it clear that line width and antialiasing in `draw_multiline()` aren't implemented yet (see #16448).
2019-05-14 07:08:22 +00:00
The CanvasItem's transform has changed. This notification is only received if enabled by [method set_notify_transform] or [method set_notify_local_transform].
classref: Sync with current source Also fix hyperlink references to same class as per the guidelines. [ci skip]
2017-10-22 10:56:11 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="NOTIFICATION_DRAW" value="30">
Improve the CanvasItem documentation This makes it clear that line width and antialiasing in `draw_multiline()` aren't implemented yet (see #16448).
2019-05-14 07:08:22 +00:00
The CanvasItem is requested to draw.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="NOTIFICATION_VISIBILITY_CHANGED" value="31">
Improve the CanvasItem documentation This makes it clear that line width and antialiasing in `draw_multiline()` aren't implemented yet (see #16448).
2019-05-14 07:08:22 +00:00
The CanvasItem's visibility has changed.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="NOTIFICATION_ENTER_CANVAS" value="32">
Improve the CanvasItem documentation This makes it clear that line width and antialiasing in `draw_multiline()` aren't implemented yet (see #16448).
2019-05-14 07:08:22 +00:00
The CanvasItem has entered the canvas.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="NOTIFICATION_EXIT_CANVAS" value="33">
Improve the CanvasItem documentation This makes it clear that line width and antialiasing in `draw_multiline()` aren't implemented yet (see #16448).
2019-05-14 07:08:22 +00:00
The CanvasItem has exited the canvas.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constant>
</constants>
</class>