| github_url: | hide |
|---|
Inherits: :ref:`Resource<class_Resource>` < :ref:`RefCounted<class_RefCounted>` < :ref:`Object<class_Object>`
Describes a Bézier curve in 2D space.
.. rst-class:: classref-introduction-group
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.
.. rst-class:: classref-reftable-group
| :ref:`float<class_float>` | :ref:`bake_interval<class_Curve2D_property_bake_interval>` | 5.0 |
| :ref:`int<class_int>` | :ref:`point_count<class_Curve2D_property_point_count>` | 0 |
.. rst-class:: classref-reftable-group
.. rst-class:: classref-section-separator
.. rst-class:: classref-descriptions-group
.. rst-class:: classref-property
:ref:`float<class_float>` bake_interval = 5.0 :ref:`🔗<class_Curve2D_property_bake_interval>`
.. rst-class:: classref-property-setget
- |void| set_bake_interval(value: :ref:`float<class_float>`)
- :ref:`float<class_float>` 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.
.. rst-class:: classref-item-separator
.. rst-class:: classref-property
:ref:`int<class_int>` point_count = 0 :ref:`🔗<class_Curve2D_property_point_count>`
.. rst-class:: classref-property-setget
- |void| set_point_count(value: :ref:`int<class_int>`)
- :ref:`int<class_int>` get_point_count()
The number of points describing the curve.
.. rst-class:: classref-section-separator
.. rst-class:: classref-descriptions-group
.. rst-class:: classref-method
|void| add_point(position: :ref:`Vector2<class_Vector2>`, in: :ref:`Vector2<class_Vector2>` = Vector2(0, 0), out: :ref:`Vector2<class_Vector2>` = Vector2(0, 0), index: :ref:`int<class_int>` = -1) :ref:`🔗<class_Curve2D_method_add_point>`
Adds a point with the specified position relative to the curve's own position, with control points in and out. Appends the new point at the end of the point list.
If index is given, the new point is inserted before the existing point identified by index index. Every existing point starting from index is shifted further down the list of points. The index must be greater than or equal to 0 and must not exceed the number of existing points in the line. See :ref:`point_count<class_Curve2D_property_point_count>`.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
|void| clear_points() :ref:`🔗<class_Curve2D_method_clear_points>`
Removes all points from the curve.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`float<class_float>` get_baked_length() |const| :ref:`🔗<class_Curve2D_method_get_baked_length>`
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.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`PackedVector2Array<class_PackedVector2Array>` get_baked_points() |const| :ref:`🔗<class_Curve2D_method_get_baked_points>`
Returns the cache of points as a :ref:`PackedVector2Array<class_PackedVector2Array>`.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`float<class_float>` get_closest_offset(to_point: :ref:`Vector2<class_Vector2>`) |const| :ref:`🔗<class_Curve2D_method_get_closest_offset>`
Returns the closest offset to to_point. This offset is meant to be used in :ref:`sample_baked<class_Curve2D_method_sample_baked>`.
to_point must be in this curve's local space.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`Vector2<class_Vector2>` get_closest_point(to_point: :ref:`Vector2<class_Vector2>`) |const| :ref:`🔗<class_Curve2D_method_get_closest_point>`
Returns the closest point on baked segments (in curve's local space) to to_point.
to_point must be in this curve's local space.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`Vector2<class_Vector2>` get_point_in(idx: :ref:`int<class_int>`) |const| :ref:`🔗<class_Curve2D_method_get_point_in>`
Returns the position of the control point leading to the vertex idx. The returned position is relative to the vertex idx. If the index is out of bounds, the function sends an error to the console, and returns (0, 0).
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`Vector2<class_Vector2>` get_point_out(idx: :ref:`int<class_int>`) |const| :ref:`🔗<class_Curve2D_method_get_point_out>`
Returns the position of the control point leading out of the vertex idx. The returned position is relative to the vertex idx. If the index is out of bounds, the function sends an error to the console, and returns (0, 0).
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`Vector2<class_Vector2>` get_point_position(idx: :ref:`int<class_int>`) |const| :ref:`🔗<class_Curve2D_method_get_point_position>`
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).
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
|void| remove_point(idx: :ref:`int<class_int>`) :ref:`🔗<class_Curve2D_method_remove_point>`
Deletes the point idx from the curve. Sends an error to the console if idx is out of bounds.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`Vector2<class_Vector2>` sample(idx: :ref:`int<class_int>`, t: :ref:`float<class_float>`) |const| :ref:`🔗<class_Curve2D_method_sample>`
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.0) 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).
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`Vector2<class_Vector2>` sample_baked(offset: :ref:`float<class_float>` = 0.0, cubic: :ref:`bool<class_bool>` = false) |const| :ref:`🔗<class_Curve2D_method_sample_baked>`
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).
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`Transform2D<class_Transform2D>` sample_baked_with_rotation(offset: :ref:`float<class_float>` = 0.0, cubic: :ref:`bool<class_bool>` = false) |const| :ref:`🔗<class_Curve2D_method_sample_baked_with_rotation>`
Similar to :ref:`sample_baked<class_Curve2D_method_sample_baked>`, but returns :ref:`Transform2D<class_Transform2D>` that includes a rotation along the curve, with :ref:`Transform2D.origin<class_Transform2D_property_origin>` as the point position and the :ref:`Transform2D.x<class_Transform2D_property_x>` vector pointing in the direction of the path at that point. Returns an empty transform if the length of the curve is 0.
var baked = curve.sample_baked_with_rotation(offset) # The returned Transform2D can be set directly. transform = baked # You can also read the origin and rotation separately from the returned Transform2D. position = baked.get_origin() rotation = baked.get_rotation()
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`Vector2<class_Vector2>` samplef(fofs: :ref:`float<class_float>`) |const| :ref:`🔗<class_Curve2D_method_samplef>`
Returns the position at the vertex fofs. It calls :ref:`sample<class_Curve2D_method_sample>` using the integer part of fofs as idx, and its fractional part as t.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
|void| set_point_in(idx: :ref:`int<class_int>`, position: :ref:`Vector2<class_Vector2>`) :ref:`🔗<class_Curve2D_method_set_point_in>`
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. The position is relative to the vertex.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
|void| set_point_out(idx: :ref:`int<class_int>`, position: :ref:`Vector2<class_Vector2>`) :ref:`🔗<class_Curve2D_method_set_point_out>`
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. The position is relative to the vertex.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
|void| set_point_position(idx: :ref:`int<class_int>`, position: :ref:`Vector2<class_Vector2>`) :ref:`🔗<class_Curve2D_method_set_point_position>`
Sets the position for the vertex idx. If the index is out of bounds, the function sends an error to the console.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`PackedVector2Array<class_PackedVector2Array>` tessellate(max_stages: :ref:`int<class_int>` = 5, tolerance_degrees: :ref:`float<class_float>` = 4) |const| :ref:`🔗<class_Curve2D_method_tessellate>`
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.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`PackedVector2Array<class_PackedVector2Array>` tessellate_even_length(max_stages: :ref:`int<class_int>` = 5, tolerance_length: :ref:`float<class_float>` = 20.0) |const| :ref:`🔗<class_Curve2D_method_tessellate_even_length>`
Returns a list of points along the curve, with almost uniform density. 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_length controls the maximal distance between two neighboring points, before the segment has to be subdivided.