PathFollow2D

Point sampler for a Path2D.

This node takes its parent Path2D, and returns the coordinates of a point within it, given a distance from the first vertex. It is useful for making other nodes follow a path, without coding the movement pattern. For that, the nodes must be children of this node. The descendant nodes will then move accordingly when setting an offset in this node.

Members

Aliases

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

Functions

getCubicInterpolation
bool getCubicInterpolation()
getHOffset
double getHOffset()
getLookahead
double getLookahead()
getOffset
double getOffset()
getUnitOffset
double getUnitOffset()
getVOffset
double getVOffset()
hasLoop
bool hasLoop()
isRotating
bool isRotating()
opAssign
typeof(null) opAssign(typeof(null) n)
opEquals
bool opEquals(PathFollow2D other)
opEquals
bool opEquals(typeof(null) n)
setCubicInterpolation
void setCubicInterpolation(bool enable)
setHOffset
void setHOffset(double h_offset)
setLookahead
void setLookahead(double lookahead)
setLoop
void setLoop(bool loop)
setOffset
void setOffset(double offset)
setRotate
void setRotate(bool enable)
setUnitOffset
void setUnitOffset(double unit_offset)
setVOffset
void setVOffset(double v_offset)
toHash
size_t toHash()

Mixins

__anonymous
mixin baseCasts
Undocumented in source.

Properties

cubicInterp
bool cubicInterp [@property getter]
bool cubicInterp [@property setter]

If true, the position between two cached points is interpolated cubically, and linearly otherwise. The points along the Curve2D of the Path2D are precomputed before use, for faster calculations. The point at the requested offset is then calculated interpolating between two adjacent cached points. This may present a problem if the curve makes sharp turns, as the cached points may not follow the curve closely enough. There are two answers to this problem: either increase the number of cached points and increase memory consumption, or make a cubic interpolation between two points at the cost of (slightly) slower calculations.

hOffset
double hOffset [@property getter]
double hOffset [@property setter]

The node's offset along the curve.

lookahead
double lookahead [@property getter]
double lookahead [@property setter]

How far to look ahead of the curve to calculate the tangent if the node is rotating. E.g. shorter lookaheads will lead to faster rotations.

loop
bool loop [@property getter]
bool loop [@property setter]

If true, any offset outside the path's length will wrap around, instead of stopping at the ends. Use it for cyclic paths.

offset
double offset [@property getter]
double offset [@property setter]

The distance along the path in pixels.

rotate
bool rotate [@property getter]
bool rotate [@property setter]

If true, this node rotates to follow the path, making its descendants rotate.

unitOffset
double unitOffset [@property getter]
double unitOffset [@property setter]

The distance along the path as a number in the range 0.0 (for the first vertex) to 1.0 (for the last). This is just another way of expressing the offset within the path, as the offset supplied is multiplied internally by the path's length.

vOffset
double vOffset [@property getter]
double vOffset [@property setter]

The node's offset perpendicular to the curve.

Static functions

_new
PathFollow2D _new()

Construct a new instance of PathFollow2D. Note: use memnew!PathFollow2D 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