| github_url: | hide |
|---|
Inherits: :ref:`Resource<class_Resource>` < :ref:`Reference<class_Reference>` < :ref:`Object<class_Object>`
Describes a Bézier curve in 2D space.
This class describes a Bézier curve in 2D space. It is mainly used to give a shape to a :ref:`Path2D<class_Path2D>`, but can be manually sampled for other purposes.
It keeps a cache of precalculated points along the curve, to speed up further calculations.
| :ref:`float<class_float>` | :ref:`bake_interval<class_Curve2D_property_bake_interval>` | 5.0 |
- :ref:`float<class_float>` bake_interval
| Default | 5.0 |
| Setter | set_bake_interval(value) |
| Getter | get_bake_interval() |
The distance in pixels between two adjacent cached points. Changing it forces the cache to be recomputed the next time the :ref:`get_baked_points<class_Curve2D_method_get_baked_points>` or :ref:`get_baked_length<class_Curve2D_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.
- void add_point ( :ref:`Vector2<class_Vector2>` position, :ref:`Vector2<class_Vector2>` in=Vector2( 0, 0 ), :ref:`Vector2<class_Vector2>` out=Vector2( 0, 0 ), :ref:`int<class_int>` at_position=-1 )
Adds a point to a curve at position, with control points in and out.
If at_position is given, the point is inserted before the point number at_position, moving that point (and every point after) after the inserted point. If at_position is not given, or is an illegal value (at_position <0 or at_position >= [method get_point_count]), the point will be appended at the end of the point list.
- void clear_points ( )
Removes all points from the curve.
- :ref:`float<class_float>` get_baked_length ( ) const
Returns the total length of the curve, based on the cached points. Given enough density (see :ref:`bake_interval<class_Curve2D_property_bake_interval>`), it should be approximate enough.
- :ref:`PackedVector2Array<class_PackedVector2Array>` get_baked_points ( ) const
Returns the cache of points as a :ref:`PackedVector2Array<class_PackedVector2Array>`.
- :ref:`float<class_float>` get_closest_offset ( :ref:`Vector2<class_Vector2>` to_point ) const
Returns the closest offset to to_point. This offset is meant to be used in :ref:`interpolate_baked<class_Curve2D_method_interpolate_baked>`.
to_point must be in this curve's local space.
- :ref:`Vector2<class_Vector2>` get_closest_point ( :ref:`Vector2<class_Vector2>` to_point ) const
Returns the closest point (in curve's local space) to to_point.
to_point must be in this curve's local space.
- :ref:`int<class_int>` get_point_count ( ) const
Returns the number of points describing the curve.
- :ref:`Vector2<class_Vector2>` get_point_in ( :ref:`int<class_int>` idx ) const
Returns the position of the control point leading to the vertex idx. If the index is out of bounds, the function sends an error to the console, and returns (0, 0).
- :ref:`Vector2<class_Vector2>` get_point_out ( :ref:`int<class_int>` idx ) const
Returns the position of the control point leading out of the vertex idx. If the index is out of bounds, the function sends an error to the console, and returns (0, 0).
- :ref:`Vector2<class_Vector2>` get_point_position ( :ref:`int<class_int>` idx ) const
Returns the position of the vertex idx. If the index is out of bounds, the function sends an error to the console, and returns (0, 0).
- :ref:`Vector2<class_Vector2>` interpolate ( :ref:`int<class_int>` idx, :ref:`float<class_float>` t ) const
Returns the position between the vertex idx and the vertex idx + 1, where t controls if the point is the first vertex (t = 0.0), the last vertex (t = 1.0), or in between. Values of t outside the range (0.0 >= t <=1) give strange, but predictable results.
If idx is out of bounds it is truncated to the first or last vertex, and t is ignored. If the curve has no points, the function sends an error to the console, and returns (0, 0).
- :ref:`Vector2<class_Vector2>` interpolate_baked ( :ref:`float<class_float>` offset, :ref:`bool<class_bool>` cubic=false ) const
Returns a point within the curve at position offset, where offset is measured as a pixel distance along the curve.
To do that, it finds the two cached points where the offset lies between, then interpolates the values. This interpolation is cubic if cubic is set to true, or linear if set to false.
Cubic interpolation tends to follow the curves better, but linear is faster (and often, precise enough).
- :ref:`Vector2<class_Vector2>` interpolatef ( :ref:`float<class_float>` fofs ) const
Returns the position at the vertex fofs. It calls :ref:`interpolate<class_Curve2D_method_interpolate>` using the integer part of fofs as idx, and its fractional part as t.
- void remove_point ( :ref:`int<class_int>` idx )
Deletes the point idx from the curve. Sends an error to the console if idx is out of bounds.
- void set_point_in ( :ref:`int<class_int>` idx, :ref:`Vector2<class_Vector2>` position )
Sets the position of the control point leading to the vertex idx. If the index is out of bounds, the function sends an error to the console.
- void set_point_out ( :ref:`int<class_int>` idx, :ref:`Vector2<class_Vector2>` position )
Sets the position of the control point leading out of the vertex idx. If the index is out of bounds, the function sends an error to the console.
- void set_point_position ( :ref:`int<class_int>` idx, :ref:`Vector2<class_Vector2>` position )
Sets the position for the vertex idx. If the index is out of bounds, the function sends an error to the console.
- :ref:`PackedVector2Array<class_PackedVector2Array>` tessellate ( :ref:`int<class_int>` max_stages=5, :ref:`float<class_float>` tolerance_degrees=4 ) const
Returns a list of points along the curve, with a curvature controlled point density. That is, the curvier parts will have more points than the straighter parts.
This approximation makes straight segments between each point, then subdivides those segments until the resulting shape is similar enough.
max_stages controls how many subdivisions a curve segment may face before it is considered approximate enough. Each subdivision splits the segment in half, so the default 5 stages may mean up to 32 subdivisions per curve segment. Increase with care!
tolerance_degrees controls how many degrees the midpoint of a segment may deviate from the real curve, before the segment has to be subdivided.