godot-docs/classes/class_curve.rst

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the Curve.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_Curve:

Curve
=====

**Inherits:** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`

**Category:** Core

Brief Description
-----------------



Member Functions
----------------

+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`          | :ref:`add_point<class_Curve_add_point>`  **(** :ref:`Vector2<class_vector2>` position, :ref:`float<class_float>` left_tangent=0, :ref:`float<class_float>` right_tangent=0, :ref:`int<class_int>` left_mode=0, :ref:`int<class_int>` right_mode=0  **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`bake<class_Curve_bake>`  **(** **)**                                                                                                                                                                                                               |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`clean_dupes<class_Curve_clean_dupes>`  **(** **)**                                                                                                                                                                                                 |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`clear_points<class_Curve_clear_points>`  **(** **)**                                                                                                                                                                                               |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`          | :ref:`get_bake_resolution<class_Curve_get_bake_resolution>`  **(** **)** const                                                                                                                                                                           |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`      | :ref:`get_max_value<class_Curve_get_max_value>`  **(** **)** const                                                                                                                                                                                       |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`      | :ref:`get_min_value<class_Curve_get_min_value>`  **(** **)** const                                                                                                                                                                                       |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`          | :ref:`get_point_left_mode<class_Curve_get_point_left_mode>`  **(** :ref:`int<class_int>` index  **)** const                                                                                                                                              |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`      | :ref:`get_point_left_tangent<class_Curve_get_point_left_tangent>`  **(** :ref:`int<class_int>` index  **)** const                                                                                                                                        |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>`  | :ref:`get_point_position<class_Curve_get_point_position>`  **(** :ref:`int<class_int>` index  **)** const                                                                                                                                                |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`          | :ref:`get_point_right_mode<class_Curve_get_point_right_mode>`  **(** :ref:`int<class_int>` index  **)** const                                                                                                                                            |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`      | :ref:`get_point_right_tangent<class_Curve_get_point_right_tangent>`  **(** :ref:`int<class_int>` index  **)** const                                                                                                                                      |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`      | :ref:`interpolate<class_Curve_interpolate>`  **(** :ref:`float<class_float>` offset  **)** const                                                                                                                                                         |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`      | :ref:`interpolate_baked<class_Curve_interpolate_baked>`  **(** :ref:`float<class_float>` offset  **)**                                                                                                                                                   |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`remove_point<class_Curve_remove_point>`  **(** :ref:`int<class_int>` index  **)**                                                                                                                                                                  |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_bake_resolution<class_Curve_set_bake_resolution>`  **(** :ref:`int<class_int>` resolution  **)**                                                                                                                                               |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_max_value<class_Curve_set_max_value>`  **(** :ref:`float<class_float>` max  **)**                                                                                                                                                              |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_min_value<class_Curve_set_min_value>`  **(** :ref:`float<class_float>` min  **)**                                                                                                                                                              |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_point_left_mode<class_Curve_set_point_left_mode>`  **(** :ref:`int<class_int>` index, :ref:`int<class_int>` mode  **)**                                                                                                                        |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_point_left_tangent<class_Curve_set_point_left_tangent>`  **(** :ref:`int<class_int>` index, :ref:`float<class_float>` tangent  **)**                                                                                                           |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`          | :ref:`set_point_offset<class_Curve_set_point_offset>`  **(** :ref:`int<class_int>` index, :ref:`float<class_float>` offset  **)**                                                                                                                        |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_point_right_mode<class_Curve_set_point_right_mode>`  **(** :ref:`int<class_int>` index, :ref:`int<class_int>` mode  **)**                                                                                                                      |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_point_right_tangent<class_Curve_set_point_right_tangent>`  **(** :ref:`int<class_int>` index, :ref:`float<class_float>` tangent  **)**                                                                                                         |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_point_value<class_Curve_set_point_value>`  **(** :ref:`int<class_int>` index, :ref:`float<class_float>` y  **)**                                                                                                                               |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Signals
-------

-  **range_changed**  **(** **)**

Member Variables
----------------

- :ref:`Array<class_array>` **_data**
- :ref:`int<class_int>` **bake_resolution**
- :ref:`float<class_float>` **max_value**
- :ref:`float<class_float>` **min_value**

Numeric Constants
-----------------

- **TANGENT_FREE** = **0**
- **TANGENT_LINEAR** = **1**
- **TANGENT_MODE_COUNT** = **2**

Member Function Description
---------------------------

.. _class_Curve_add_point:

- :ref:`int<class_int>`  **add_point**  **(** :ref:`Vector2<class_vector2>` position, :ref:`float<class_float>` left_tangent=0, :ref:`float<class_float>` right_tangent=0, :ref:`int<class_int>` left_mode=0, :ref:`int<class_int>` right_mode=0  **)**

.. _class_Curve_bake:

- void  **bake**  **(** **)**

.. _class_Curve_clean_dupes:

- void  **clean_dupes**  **(** **)**

.. _class_Curve_clear_points:

- void  **clear_points**  **(** **)**

.. _class_Curve_get_bake_resolution:

- :ref:`int<class_int>`  **get_bake_resolution**  **(** **)** const

.. _class_Curve_get_max_value:

- :ref:`float<class_float>`  **get_max_value**  **(** **)** const

.. _class_Curve_get_min_value:

- :ref:`float<class_float>`  **get_min_value**  **(** **)** const

.. _class_Curve_get_point_left_mode:

- :ref:`int<class_int>`  **get_point_left_mode**  **(** :ref:`int<class_int>` index  **)** const

.. _class_Curve_get_point_left_tangent:

- :ref:`float<class_float>`  **get_point_left_tangent**  **(** :ref:`int<class_int>` index  **)** const

.. _class_Curve_get_point_position:

- :ref:`Vector2<class_vector2>`  **get_point_position**  **(** :ref:`int<class_int>` index  **)** const

.. _class_Curve_get_point_right_mode:

- :ref:`int<class_int>`  **get_point_right_mode**  **(** :ref:`int<class_int>` index  **)** const

.. _class_Curve_get_point_right_tangent:

- :ref:`float<class_float>`  **get_point_right_tangent**  **(** :ref:`int<class_int>` index  **)** const

.. _class_Curve_interpolate:

- :ref:`float<class_float>`  **interpolate**  **(** :ref:`float<class_float>` offset  **)** const

.. _class_Curve_interpolate_baked:

- :ref:`float<class_float>`  **interpolate_baked**  **(** :ref:`float<class_float>` offset  **)**

.. _class_Curve_remove_point:

- void  **remove_point**  **(** :ref:`int<class_int>` index  **)**

.. _class_Curve_set_bake_resolution:

- void  **set_bake_resolution**  **(** :ref:`int<class_int>` resolution  **)**

.. _class_Curve_set_max_value:

- void  **set_max_value**  **(** :ref:`float<class_float>` max  **)**

.. _class_Curve_set_min_value:

- void  **set_min_value**  **(** :ref:`float<class_float>` min  **)**

.. _class_Curve_set_point_left_mode:

- void  **set_point_left_mode**  **(** :ref:`int<class_int>` index, :ref:`int<class_int>` mode  **)**

.. _class_Curve_set_point_left_tangent:

- void  **set_point_left_tangent**  **(** :ref:`int<class_int>` index, :ref:`float<class_float>` tangent  **)**

.. _class_Curve_set_point_offset:

- :ref:`int<class_int>`  **set_point_offset**  **(** :ref:`int<class_int>` index, :ref:`float<class_float>` offset  **)**

.. _class_Curve_set_point_right_mode:

- void  **set_point_right_mode**  **(** :ref:`int<class_int>` index, :ref:`int<class_int>` mode  **)**

.. _class_Curve_set_point_right_tangent:

- void  **set_point_right_tangent**  **(** :ref:`int<class_int>` index, :ref:`float<class_float>` tangent  **)**

.. _class_Curve_set_point_value:

- void  **set_point_value**  **(** :ref:`int<class_int>` index, :ref:`float<class_float>` y  **)**