This resource describes a mathematical curve by defining a set of points and tangents at each point. By default, it ranges between 0
and 1
on the X and Y axes, but these ranges can be changed.
Please note that many resources and nodes assume they are given unit curves. A unit curve is a curve whose domain (the X axis) is between 0
and 1
. Some examples of unit curve usage are CPUParticles2D.angle_curve and Line2D.width_curve.
Emitted when max_domain or min_domain is changed.
TANGENT_FREE = 0
The tangent on this side of the point is user-defined.
TANGENT_LINEAR = 1
The curve calculates the tangent on this side of the point as the slope halfway towards the adjacent point.
TANGENT_MODE_COUNT = 2
The total number of available tangent modes.
The number of points to include in the baked (i.e. cached) curve data.
The maximum domain (x-coordinate) that points can have.
The maximum value (y-coordinate) that points can have. Tangents can cause higher values between points.
The minimum domain (x-coordinate) that points can have.
The minimum value (y-coordinate) that points can have. Tangents can cause lower values between points.
The number of points describing the curve.
Adds a point to the curve. For each side, if the *_mode
is TANGENT_LINEAR, the *_tangent
angle (in degrees) uses the slope of the curve halfway to the adjacent point. Allows custom assignments to the *_tangent
angle if *_mode
is set to TANGENT_FREE.
Recomputes the baked cache of points for the curve.
Removes duplicate points, i.e. points that are less than 0.00001 units (engine epsilon value) away from their neighbor on the curve.
Removes all points from the curve.
Returns the difference between min_domain and max_domain.
Returns the left TangentMode for the point at index
.
Returns the left tangent angle (in degrees) for the point at index
.
Returns the curve coordinates for the point at index
.
Returns the right TangentMode for the point at index
.
Returns the right tangent angle (in degrees) for the point at index
.
Removes the point at index
from the curve.
Returns the Y value for the point that would exist at the X position offset
along the curve.
Returns the Y value for the point that would exist at the X position offset
along the curve using the baked cache. Bakes the curve's points if not already baked.
Sets the left TangentMode for the point at index
to mode
.
Sets the left tangent angle for the point at index
to tangent
.
Sets the offset from 0.5
.
Sets the right TangentMode for the point at index
to mode
.
Sets the right tangent angle for the point at index
to tangent
.
Assigns the vertical position y
to the point at index
.