Skip to content

Latest commit

 

History

History
304 lines (188 loc) · 20.9 KB

class_curve.rst

File metadata and controls

304 lines (188 loc) · 20.9 KB
github_url:hide

Curve

Inherits: :ref:`Resource<class_Resource>` < :ref:`Reference<class_Reference>` < :ref:`Object<class_Object>`

A mathematic curve.

Description

A curve that can be saved and re-used for other objects. By default, it ranges between 0 and 1 on the Y axis and positions points relative to the 0.5 Y position.

Properties

:ref:`int<class_int>` :ref:`bake_resolution<class_Curve_property_bake_resolution>` 100
:ref:`float<class_float>` :ref:`max_value<class_Curve_property_max_value>` 1.0
:ref:`float<class_float>` :ref:`min_value<class_Curve_property_min_value>` 0.0

Methods

:ref:`int<class_int>` :ref:`add_point<class_Curve_method_add_point>` ( :ref:`Vector2<class_Vector2>` position, :ref:`float<class_float>` left_tangent=0, :ref:`float<class_float>` right_tangent=0, :ref:`TangentMode<enum_Curve_TangentMode>` left_mode=0, :ref:`TangentMode<enum_Curve_TangentMode>` right_mode=0 )
void :ref:`bake<class_Curve_method_bake>` ( )
void :ref:`clean_dupes<class_Curve_method_clean_dupes>` ( )
void :ref:`clear_points<class_Curve_method_clear_points>` ( )
:ref:`int<class_int>` :ref:`get_point_count<class_Curve_method_get_point_count>` ( ) const
:ref:`TangentMode<enum_Curve_TangentMode>` :ref:`get_point_left_mode<class_Curve_method_get_point_left_mode>` ( :ref:`int<class_int>` index ) const
:ref:`float<class_float>` :ref:`get_point_left_tangent<class_Curve_method_get_point_left_tangent>` ( :ref:`int<class_int>` index ) const
:ref:`Vector2<class_Vector2>` :ref:`get_point_position<class_Curve_method_get_point_position>` ( :ref:`int<class_int>` index ) const
:ref:`TangentMode<enum_Curve_TangentMode>` :ref:`get_point_right_mode<class_Curve_method_get_point_right_mode>` ( :ref:`int<class_int>` index ) const
:ref:`float<class_float>` :ref:`get_point_right_tangent<class_Curve_method_get_point_right_tangent>` ( :ref:`int<class_int>` index ) const
:ref:`float<class_float>` :ref:`interpolate<class_Curve_method_interpolate>` ( :ref:`float<class_float>` offset ) const
:ref:`float<class_float>` :ref:`interpolate_baked<class_Curve_method_interpolate_baked>` ( :ref:`float<class_float>` offset )
void :ref:`remove_point<class_Curve_method_remove_point>` ( :ref:`int<class_int>` index )
void :ref:`set_point_left_mode<class_Curve_method_set_point_left_mode>` ( :ref:`int<class_int>` index, :ref:`TangentMode<enum_Curve_TangentMode>` mode )
void :ref:`set_point_left_tangent<class_Curve_method_set_point_left_tangent>` ( :ref:`int<class_int>` index, :ref:`float<class_float>` tangent )
:ref:`int<class_int>` :ref:`set_point_offset<class_Curve_method_set_point_offset>` ( :ref:`int<class_int>` index, :ref:`float<class_float>` offset )
void :ref:`set_point_right_mode<class_Curve_method_set_point_right_mode>` ( :ref:`int<class_int>` index, :ref:`TangentMode<enum_Curve_TangentMode>` mode )
void :ref:`set_point_right_tangent<class_Curve_method_set_point_right_tangent>` ( :ref:`int<class_int>` index, :ref:`float<class_float>` tangent )
void :ref:`set_point_value<class_Curve_method_set_point_value>` ( :ref:`int<class_int>` index, :ref:`float<class_float>` y )

Signals

  • range_changed ( )

Emitted when :ref:`max_value<class_Curve_property_max_value>` or :ref:`min_value<class_Curve_property_min_value>` is changed.

Enumerations

enum TangentMode:

  • 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.

Property Descriptions

Default 100
Setter set_bake_resolution(value)
Getter get_bake_resolution()

The number of points to include in the baked (i.e. cached) curve data.

Default 1.0
Setter set_max_value(value)
Getter get_max_value()

The maximum value the curve can reach.

Default 0.0
Setter set_min_value(value)
Getter get_min_value()

The minimum value the curve can reach.

Method Descriptions

Adds a point to the curve. For each side, if the *_mode is :ref:`TANGENT_LINEAR<class_Curve_constant_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 :ref:`TANGENT_FREE<class_Curve_constant_TANGENT_FREE>`.

  • void bake ( )

Recomputes the baked cache of points for the curve.

  • void clean_dupes ( )

Removes points that are closer than CMP_EPSILON (0.00001) units to their neighbor on the curve.

  • void clear_points ( )

Removes all points from the curve.

Returns the number of points describing the curve.

Returns the left :ref:`TangentMode<enum_Curve_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 :ref:`TangentMode<enum_Curve_TangentMode>` for the point at index.

Returns the right tangent angle (in degrees) for the point at index.

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.

Removes the point at index from the curve.

Sets the left :ref:`TangentMode<enum_Curve_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 :ref:`TangentMode<enum_Curve_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.