2017-09-12 22:42:36 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
2022-02-14 14:18:53 +01:00
<class name= "Curve" inherits= "Resource" version= "4.0" xmlns:xsi= "http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation= "../class.xsd" >
2017-09-12 22:42:36 +02:00
<brief_description >
2017-12-11 20:05:26 +01:00
A mathematic curve.
2017-09-12 22:42:36 +02:00
</brief_description>
<description >
2019-06-22 01:04:47 +02:00
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.
2022-08-05 09:54:46 +02:00
See also [Gradient] which is designed for color interpolation. See also [Curve2D] and [Curve3D].
2017-09-12 22:42:36 +02:00
</description>
<tutorials >
</tutorials>
<methods >
<method name= "add_point" >
2021-07-30 15:28:05 +02:00
<return type= "int" />
<argument index= "0" name= "position" type= "Vector2" />
<argument index= "1" name= "left_tangent" type= "float" default= "0" />
<argument index= "2" name= "right_tangent" type= "float" default= "0" />
<argument index= "3" name= "left_mode" type= "int" enum= "Curve.TangentMode" default= "0" />
<argument index= "4" name= "right_mode" type= "int" enum= "Curve.TangentMode" default= "0" />
2017-09-12 22:42:36 +02:00
<description >
2019-06-27 12:34:26 +02:00
Adds a point to the curve. For each side, if the [code]*_mode[/code] is [constant TANGENT_LINEAR], 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 [constant TANGENT_FREE].
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "bake" >
2021-07-30 15:28:05 +02:00
<return type= "void" />
2017-09-12 22:42:36 +02:00
<description >
2017-12-11 20:05:26 +01:00
Recomputes the baked cache of points for the curve.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "clean_dupes" >
2021-07-30 15:28:05 +02:00
<return type= "void" />
2017-09-12 22:42:36 +02:00
<description >
2017-12-11 20:05:26 +01:00
Removes points that are closer than [code]CMP_EPSILON[/code] (0.00001) units to their neighbor on the curve.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "clear_points" >
2021-07-30 15:28:05 +02:00
<return type= "void" />
2017-09-12 22:42:36 +02:00
<description >
2017-12-11 20:05:26 +01:00
Removes all points from the curve.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "get_point_left_mode" qualifiers= "const" >
2021-07-30 15:28:05 +02:00
<return type= "int" enum= "Curve.TangentMode" />
<argument index= "0" name= "index" type= "int" />
2017-09-12 22:42:36 +02:00
<description >
2019-06-22 01:04:47 +02:00
Returns the left [enum TangentMode] for the point at [code]index[/code].
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "get_point_left_tangent" qualifiers= "const" >
2021-07-30 15:28:05 +02:00
<return type= "float" />
<argument index= "0" name= "index" type= "int" />
2017-09-12 22:42:36 +02:00
<description >
2017-12-11 20:05:26 +01:00
Returns the left tangent angle (in degrees) for the point at [code]index[/code].
2017-09-12 22:42:36 +02:00
</description>
</method>
2017-09-10 15:37:49 +02:00
<method name= "get_point_position" qualifiers= "const" >
2021-07-30 15:28:05 +02:00
<return type= "Vector2" />
<argument index= "0" name= "index" type= "int" />
2017-09-12 22:42:36 +02:00
<description >
2017-12-11 20:05:26 +01:00
Returns the curve coordinates for the point at [code]index[/code].
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "get_point_right_mode" qualifiers= "const" >
2021-07-30 15:28:05 +02:00
<return type= "int" enum= "Curve.TangentMode" />
<argument index= "0" name= "index" type= "int" />
2017-09-12 22:42:36 +02:00
<description >
2019-06-22 01:04:47 +02:00
Returns the right [enum TangentMode] for the point at [code]index[/code].
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "get_point_right_tangent" qualifiers= "const" >
2021-07-30 15:28:05 +02:00
<return type= "float" />
<argument index= "0" name= "index" type= "int" />
2017-09-12 22:42:36 +02:00
<description >
2017-12-11 20:05:26 +01:00
Returns the right tangent angle (in degrees) for the point at [code]index[/code].
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "interpolate" qualifiers= "const" >
2021-07-30 15:28:05 +02:00
<return type= "float" />
<argument index= "0" name= "offset" type= "float" />
2017-09-12 22:42:36 +02:00
<description >
2019-06-22 01:04:47 +02:00
Returns the Y value for the point that would exist at the X position [code]offset[/code] along the curve.
2017-09-12 22:42:36 +02:00
</description>
</method>
2021-05-01 10:56:32 +02:00
<method name= "interpolate_baked" qualifiers= "const" >
2021-07-30 15:28:05 +02:00
<return type= "float" />
<argument index= "0" name= "offset" type= "float" />
2017-09-12 22:42:36 +02:00
<description >
2019-06-22 01:04:47 +02:00
Returns the Y value for the point that would exist at the X position [code]offset[/code] along the curve using the baked cache. Bakes the curve's points if not already baked.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "remove_point" >
2021-07-30 15:28:05 +02:00
<return type= "void" />
<argument index= "0" name= "index" type= "int" />
2017-09-12 22:42:36 +02:00
<description >
2017-12-11 20:05:26 +01:00
Removes the point at [code]index[/code] from the curve.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "set_point_left_mode" >
2021-07-30 15:28:05 +02:00
<return type= "void" />
<argument index= "0" name= "index" type= "int" />
<argument index= "1" name= "mode" type= "int" enum= "Curve.TangentMode" />
2017-09-12 22:42:36 +02:00
<description >
2019-06-22 01:04:47 +02:00
Sets the left [enum TangentMode] for the point at [code]index[/code] to [code]mode[/code].
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "set_point_left_tangent" >
2021-07-30 15:28:05 +02:00
<return type= "void" />
<argument index= "0" name= "index" type= "int" />
<argument index= "1" name= "tangent" type= "float" />
2017-09-12 22:42:36 +02:00
<description >
2017-12-11 20:05:26 +01:00
Sets the left tangent angle for the point at [code]index[/code] to [code]tangent[/code].
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "set_point_offset" >
2021-07-30 15:28:05 +02:00
<return type= "int" />
<argument index= "0" name= "index" type= "int" />
<argument index= "1" name= "offset" type= "float" />
2017-09-12 22:42:36 +02:00
<description >
2019-06-22 01:04:47 +02:00
Sets the offset from [code]0.5[/code].
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "set_point_right_mode" >
2021-07-30 15:28:05 +02:00
<return type= "void" />
<argument index= "0" name= "index" type= "int" />
<argument index= "1" name= "mode" type= "int" enum= "Curve.TangentMode" />
2017-09-12 22:42:36 +02:00
<description >
2019-06-22 01:04:47 +02:00
Sets the right [enum TangentMode] for the point at [code]index[/code] to [code]mode[/code].
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "set_point_right_tangent" >
2021-07-30 15:28:05 +02:00
<return type= "void" />
<argument index= "0" name= "index" type= "int" />
<argument index= "1" name= "tangent" type= "float" />
2017-09-12 22:42:36 +02:00
<description >
2017-12-11 20:05:26 +01:00
Sets the right tangent angle for the point at [code]index[/code] to [code]tangent[/code].
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "set_point_value" >
2021-07-30 15:28:05 +02:00
<return type= "void" />
<argument index= "0" name= "index" type= "int" />
<argument index= "1" name= "y" type= "float" />
2017-09-12 22:42:36 +02:00
<description >
2017-12-11 20:05:26 +01:00
Assigns the vertical position [code]y[/code] to the point at [code]index[/code].
2017-09-12 22:42:36 +02:00
</description>
</method>
</methods>
<members >
2019-06-29 12:38:01 +02:00
<member name= "bake_resolution" type= "int" setter= "set_bake_resolution" getter= "get_bake_resolution" default= "100" >
2017-12-11 20:05:26 +01:00
The number of points to include in the baked (i.e. cached) curve data.
2017-09-12 22:42:36 +02:00
</member>
2019-06-29 12:38:01 +02:00
<member name= "max_value" type= "float" setter= "set_max_value" getter= "get_max_value" default= "1.0" >
2019-06-29 15:24:23 +02:00
The maximum value the curve can reach.
2017-09-12 22:42:36 +02:00
</member>
2019-06-29 12:38:01 +02:00
<member name= "min_value" type= "float" setter= "set_min_value" getter= "get_min_value" default= "0.0" >
2019-06-29 15:24:23 +02:00
The minimum value the curve can reach.
2017-09-12 22:42:36 +02:00
</member>
2022-02-12 19:12:22 +01:00
<member name= "point_count" type= "int" setter= "set_point_count" getter= "get_point_count" default= "0" >
The number of points describing the curve.
</member>
2017-09-12 22:42:36 +02:00
</members>
<signals >
<signal name= "range_changed" >
<description >
2017-12-11 20:05:26 +01:00
Emitted when [member max_value] or [member min_value] is changed.
2017-09-12 22:42:36 +02:00
</description>
</signal>
</signals>
<constants >
2017-11-24 23:16:30 +01:00
<constant name= "TANGENT_FREE" value= "0" enum= "TangentMode" >
2017-12-11 20:05:26 +01:00
The tangent on this side of the point is user-defined.
2017-09-16 01:46:14 +02:00
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "TANGENT_LINEAR" value= "1" enum= "TangentMode" >
2017-12-11 20:05:26 +01:00
The curve calculates the tangent on this side of the point as the slope halfway towards the adjacent point.
2017-09-16 01:46:14 +02:00
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "TANGENT_MODE_COUNT" value= "2" enum= "TangentMode" >
2017-12-11 20:05:26 +01:00
The total number of available tangent modes.
2017-09-16 01:46:14 +02:00
</constant>
2017-09-12 22:42:36 +02:00
</constants>
</class>