Curve2D

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 Path2D, but can be manually sampled for other purposes. It keeps a cache of precalculated points along the curve, to speed up further calculations.

@GodotBaseClass

struct Curve2D {

enum string _GODOT_internal_name;

union __anonymous;

alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses);

package @nogc nothrow __gshared

bool _classBindingInitialized;

struct GDNativeClassBinding;

bool opEquals(Curve2D other);

typeof(null) opAssign(typeof(null) n);

bool opEquals(typeof(null) n);

size_t toHash();

mixin baseCasts ;

static Curve2D _new();

Dictionary _getData();

void _setData(Dictionary arg0);

void addPoint(Vector2 position, Vector2 _in, Vector2 _out, long at_position);

void clearPoints();

double getBakeInterval();

double getBakedLength();

PoolVector2Array getBakedPoints();

double getClosestOffset(Vector2 to_point);

Vector2 getClosestPoint(Vector2 to_point);

long getPointCount();

Vector2 getPointIn(long idx);

Vector2 getPointOut(long idx);

Vector2 getPointPosition(long idx);

Vector2 interpolate(long idx, double t);

Vector2 interpolateBaked(double offset, bool cubic);

Vector2 interpolatef(double fofs);

void removePoint(long idx);

void setBakeInterval(double distance);

void setPointIn(long idx, Vector2 position);

void setPointOut(long idx, Vector2 position);

void setPointPosition(long idx, Vector2 position);

PoolVector2Array tessellate(long max_stages, double tolerance_degrees);

Dictionary _data [@property getter];

Dictionary _data [@property setter];

double bakeInterval [@property getter];

double bakeInterval [@property setter];

}

Members

Aliases

BaseClasses alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses): Undocumented in source.

Functions

_getData Dictionary _getData()
_setData void _setData(Dictionary arg0)
addPoint void addPoint(Vector2 position, Vector2 _in, Vector2 _out, long at_position): 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 >= $(D getPointCount)), the point will be appended at the end of the point list.
clearPoints void clearPoints(): Removes all points from the curve.
getBakeInterval double getBakeInterval()
getBakedLength double getBakedLength(): Returns the total length of the curve, based on the cached points. Given enough density (see bakeInterval), it should be approximate enough.
getBakedPoints PoolVector2Array getBakedPoints(): Returns the cache of points as a PoolVector2Array.
getClosestOffset double getClosestOffset(Vector2 to_point): Returns the closest offset to to_point. This offset is meant to be used in interpolateBaked. to_point must be in this curve's local space.
getClosestPoint Vector2 getClosestPoint(Vector2 to_point): Returns the closest baked point (in curve's local space) to to_point. to_point must be in this curve's local space.
getPointCount long getPointCount(): Returns the number of points describing the curve.
getPointIn Vector2 getPointIn(long idx): 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).
getPointOut Vector2 getPointOut(long idx): 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).
getPointPosition Vector2 getPointPosition(long idx): 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).
interpolate Vector2 interpolate(long idx, double t): 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).
interpolateBaked Vector2 interpolateBaked(double offset, bool cubic): 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).
interpolatef Vector2 interpolatef(double fofs): Returns the position at the vertex fofs. It calls interpolate using the integer part of fofs as idx, and its fractional part as t.
opAssign typeof(null) opAssign(typeof(null) n)
opEquals bool opEquals(Curve2D other)
opEquals bool opEquals(typeof(null) n)
removePoint void removePoint(long idx): Deletes the point idx from the curve. Sends an error to the console if idx is out of bounds.
setBakeInterval void setBakeInterval(double distance)
setPointIn void setPointIn(long idx, 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. The position is relative to the vertex.
setPointOut void setPointOut(long idx, 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. The position is relative to the vertex.
setPointPosition void setPointPosition(long idx, Vector2 position): Sets the position for the vertex idx. If the index is out of bounds, the function sends an error to the console.
tessellate PoolVector2Array tessellate(long max_stages, double tolerance_degrees): 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.
toHash size_t toHash()

Mixins

__anonymous mixin baseCasts: Undocumented in source.

Properties

_data Dictionary _data [@property getter]
Dictionary _data [@property setter]
bakeInterval double bakeInterval [@property getter]
double bakeInterval [@property setter]: The distance in pixels between two adjacent cached points. Changing it forces the cache to be recomputed the next time the getBakedPoints or getBakedLength function is called. The smaller the distance, the more points in the cache and the more memory it will consume, so use with care.

Static functions

_new Curve2D _new(): Construct a new instance of Curve2D. Note: use memnew!Curve2D instead.

Static variables

_classBindingInitialized bool _classBindingInitialized;: Undocumented in source.

Structs

GDNativeClassBinding struct GDNativeClassBinding: Undocumented in source.

Unions

__anonymous union __anonymous: Undocumented in source.

Variables

_GODOT_internal_name enum string _GODOT_internal_name;: Undocumented in source.

Mixed In Members

From `mixin baseCasts`

as inout(To) as(): Undocumented in source. Be warned that the author may not have intended to support it.
as inout(To) as(): Undocumented in source. Be warned that the author may not have intended to support it.
as inout(ToRef) as(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast template opCast(To): Undocumented in source.
opCast template opCast(To): Undocumented in source.
opCast template opCast(ToRef): Undocumented in source.
opCast void* opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast godot_object opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast bool opCast(): Undocumented in source. Be warned that the author may not have intended to support it.

Meta

Source

See Implementation

godot curve2d structs

Curve2D