From 3533e01eab22d2389fa70b4a47169be46a15ab2f Mon Sep 17 00:00:00 2001 From: Will Nations Date: Mon, 11 Dec 2017 13:05:26 -0600 Subject: [PATCH] [DOCS] Animation, CanvasItem, Curve3D, Curve --- doc/classes/Animation.xml | 3 +++ doc/classes/CanvasItem.xml | 30 ++++++++++++++++-------------- doc/classes/Curve.xml | 27 +++++++++++++++++++++++++++ doc/classes/Curve3D.xml | 2 ++ 4 files changed, 48 insertions(+), 14 deletions(-) diff --git a/doc/classes/Animation.xml b/doc/classes/Animation.xml index 93b01a466b4..dd248d18f7c 100644 --- a/doc/classes/Animation.xml +++ b/doc/classes/Animation.xml @@ -38,6 +38,7 @@ + Adds a new track that is a copy of the given track from [code]to_animation[/code]. @@ -260,6 +261,7 @@ + Returns [code]true[/code] if the track at index [code]idx[/code] is enabled. @@ -319,6 +321,7 @@ + Enables/disables the given track. Tracks are enabled by default. diff --git a/doc/classes/CanvasItem.xml b/doc/classes/CanvasItem.xml index cf0b482b07d..bd20cfcf5df 100644 --- a/doc/classes/CanvasItem.xml +++ b/doc/classes/CanvasItem.xml @@ -36,7 +36,7 @@ - Draw a string character using a custom font. Returns the advance, depending on the char width and kerning with an optional next char. + Draws a string character using a custom font. Returns the advance, depending on the char width and kerning with an optional next char. @@ -49,7 +49,7 @@ - Draw a colored circle. + Draws a colored circle. @@ -68,7 +68,7 @@ - Draw a colored polygon of any amount of points, convex or concave. + Draws a colored polygon of any amount of points, convex or concave. @@ -85,7 +85,7 @@ - Draw a line from a 2D point to another, with a given color and width. It can be optionally antialiased. + Draws a line from a 2D point to another, with a given color and width. It can be optionally antialiased. @@ -100,6 +100,7 @@ + Draws multiple, parallel lines with a uniform [code]color[/code] and [code]width[/code] and optional antialiasing. @@ -114,6 +115,7 @@ + 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]. @@ -132,7 +134,7 @@ - Draw a polygon of any amount of points, convex or concave. + Draws a polygon of any amount of points, convex or concave. @@ -147,7 +149,7 @@ - Draw a polyline with a uniform [code]color[/code] and [code]width[/code] and optional antialiasing. + Draws interconnected line segments with a uniform [code]color[/code] and [code]width[/code] and optional antialiasing. @@ -162,7 +164,7 @@ - Draw a polyline 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]. + 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]. @@ -181,7 +183,7 @@ - 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. + 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. @@ -194,7 +196,7 @@ - Draw a colored rectangle. + Draws a colored rectangle. @@ -233,7 +235,7 @@ - Draw a string using a custom font. + Draws a string using a custom font. @@ -244,7 +246,7 @@ - Draw a styled rectangle. + Draws a styled rectangle. @@ -259,7 +261,7 @@ - Draw a texture at a given position. + Draws a texture at a given position. @@ -278,7 +280,7 @@ - Draw a textured rectangle at a given position, optionally modulated by a color. Transpose swaps the x and y coordinates when reading the texture. + Draws a textured rectangle at a given position, optionally modulated by a color. Transpose swaps the x and y coordinates when reading the texture. @@ -299,7 +301,7 @@ - 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. + Draws a textured rectangle region at a given position, optionally modulated by a color. Transpose swaps the x and y coordinates when reading the texture. diff --git a/doc/classes/Curve.xml b/doc/classes/Curve.xml index 3e1158ca3b7..f7ef9a182cd 100644 --- a/doc/classes/Curve.xml +++ b/doc/classes/Curve.xml @@ -1,8 +1,10 @@ + A mathematic curve. + A curve that can be saved and re-used for other objects. By default it ranges between [code]0[/code] and [code]1[/code] on the y-axis and positions points relative to the [code]0.5[/code] y-position. @@ -23,24 +25,28 @@ + Adds a point to the curve. For each side, if the [code]*_mode[/code] is [code]TANGENT_LINEAR[/code], the [code]*_tangent[/code] angle (in degrees) uses the slope of the curve halfway to the adjacent point. Allows custom assignments to the [code]*_tangent[/code] angle if [code]*_mode[/code] is set to [code]TANGENT_FREE[/code]. + Recomputes the baked cache of points for the curve. + Removes points that are closer than [code]CMP_EPSILON[/code] (0.00001) units to their neighbor on the curve. + Removes all points from the curve. @@ -49,6 +55,7 @@ + Returns the left [code]TangentMode[/code] for the point at [code]index[/code]. @@ -57,6 +64,7 @@ + Returns the left tangent angle (in degrees) for the point at [code]index[/code]. @@ -65,6 +73,7 @@ + Returns the curve coordinates for the point at [code]index[/code]. @@ -73,6 +82,7 @@ + Returns the right [code]TangentMode[/code] for the point at [code]index[/code]. @@ -81,6 +91,7 @@ + Returns the right tangent angle (in degrees) for the point at [code]index[/code]. @@ -89,12 +100,14 @@ + Returns the y value for the point that would exist at x-position [code]offset[/code] along the curve. + Returns the y value for the point that would exist at x-position [code]offset[/code] along the curve using the baked cache. Bakes the curve's points if not already baked. @@ -105,6 +118,7 @@ + Removes the point at [code]index[/code] from the curve. @@ -115,6 +129,7 @@ + Sets the left [code]TangentMode[/code] for the point at [code]index[/code] to [code]mode[/code]. @@ -125,6 +140,7 @@ + Sets the left tangent angle for the point at [code]index[/code] to [code]tangent[/code]. @@ -135,6 +151,7 @@ + Sets the offset from [code]0.5[/code] @@ -145,6 +162,7 @@ + Sets the right [code]TangentMode[/code] for the point at [code]index[/code] to [code]mode[/code]. @@ -155,6 +173,7 @@ + Sets the right tangent angle for the point at [code]index[/code] to [code]tangent[/code]. @@ -165,29 +184,37 @@ + Assigns the vertical position [code]y[/code] to the point at [code]index[/code]. + The number of points to include in the baked (i.e. cached) curve data. + The maximum value the curve can reach. Default value: [code]1[/code]. + The minimum value the curve can reach. Default value: [code]0[/code]. + Emitted when [member max_value] or [member min_value] is changed. + The tangent on this side of the point is user-defined. + The curve calculates the tangent on this side of the point as the slope halfway towards the adjacent point. + The total number of available tangent modes. diff --git a/doc/classes/Curve3D.xml b/doc/classes/Curve3D.xml index e30ae856175..91d7a9bed8e 100644 --- a/doc/classes/Curve3D.xml +++ b/doc/classes/Curve3D.xml @@ -32,6 +32,7 @@ + Removes all points from the curve. @@ -203,6 +204,7 @@ + The distance in meters between two adjacent cached points. Changing it forces the cache to be recomputed the next time the [method get_baked_points] or [method get_baked_length] function is called. The smaller the distance, the more points in the cache and the more memory it will consume, so use with care.